kibana/api_docs/dashboard.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

71 lines
1.8 KiB
Plaintext

---
id: kibDashboardPluginApi
slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the dashboard plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
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 dashboardObj from './dashboard.json';
Adds the Dashboard app to Kibana
Contact [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 |
|-------------------|-----------|------------------------|-----------------|
| 145 | 1 | 132 | 10 |
## Client
### Setup
<DocDefinitionList data={[dashboardObj.client.setup]}/>
### Start
<DocDefinitionList data={[dashboardObj.client.start]}/>
### Objects
<DocDefinitionList data={dashboardObj.client.objects}/>
### Functions
<DocDefinitionList data={dashboardObj.client.functions}/>
### Classes
<DocDefinitionList data={dashboardObj.client.classes}/>
### Interfaces
<DocDefinitionList data={dashboardObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[dashboardObj.server.setup]}/>
### Start
<DocDefinitionList data={[dashboardObj.server.start]}/>
### Functions
<DocDefinitionList data={dashboardObj.server.functions}/>
## Common
### Objects
<DocDefinitionList data={dashboardObj.common.objects}/>
### Functions
<DocDefinitionList data={dashboardObj.common.functions}/>
### Interfaces
<DocDefinitionList data={dashboardObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.common.misc}/>