6723fa583f
* Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs
42 lines
1.1 KiB
Plaintext
42 lines
1.1 KiB
Plaintext
---
|
|
id: kibCanvasPluginApi
|
|
slug: /kibana-dev-docs/api/canvas
|
|
title: "canvas"
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the canvas plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
|
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 canvasObj from './canvas.json';
|
|
|
|
Adds Canvas application 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 |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 9 | 0 | 8 | 3 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[canvasObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[canvasObj.client.start]}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={canvasObj.client.interfaces}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={canvasObj.common.objects}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={canvasObj.common.misc}/>
|
|
|