kibana/api_docs/embeddable.mdx
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

77 lines
2 KiB
Plaintext

---
id: kibEmbeddablePluginApi
slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the embeddable plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
warning: 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.
---
import embeddableObj from './embeddable.json';
Adds embeddables service to Kibana
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 469 | 5 | 393 | 3 |
## Client
### Setup
<DocDefinitionList data={[embeddableObj.client.setup]}/>
### Start
<DocDefinitionList data={[embeddableObj.client.start]}/>
### Objects
<DocDefinitionList data={embeddableObj.client.objects}/>
### Functions
<DocDefinitionList data={embeddableObj.client.functions}/>
### Classes
<DocDefinitionList data={embeddableObj.client.classes}/>
### Interfaces
<DocDefinitionList data={embeddableObj.client.interfaces}/>
### Enums
<DocDefinitionList data={embeddableObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={embeddableObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[embeddableObj.server.setup]}/>
### Start
<DocDefinitionList data={[embeddableObj.server.start]}/>
### Interfaces
<DocDefinitionList data={embeddableObj.server.interfaces}/>
## Common
### Objects
<DocDefinitionList data={embeddableObj.common.objects}/>
### Functions
<DocDefinitionList data={embeddableObj.common.functions}/>
### Interfaces
<DocDefinitionList data={embeddableObj.common.interfaces}/>
### Enums
<DocDefinitionList data={embeddableObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={embeddableObj.common.misc}/>