kibana/api_docs/controls.mdx

58 lines
1.7 KiB
Text

---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibControlsPluginApi
slug: /kibana-dev-docs/api/controls
title: "controls"
image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin
date: 2024-08-13
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';
The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls
Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 380 | 0 | 371 | 27 |
## Client
### Objects
<DocDefinitionList data={controlsObj.client.objects}/>
### Functions
<DocDefinitionList data={controlsObj.client.functions}/>
### Classes
<DocDefinitionList data={controlsObj.client.classes}/>
### Interfaces
<DocDefinitionList data={controlsObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={controlsObj.client.misc}/>
## Server
### Functions
<DocDefinitionList data={controlsObj.server.functions}/>
## Common
### Functions
<DocDefinitionList data={controlsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={controlsObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={controlsObj.common.misc}/>