kibana/api_docs/canvas.json
Stacey Gammon cecdcc538e
API docs clean up (#93508)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00

116 lines
2.8 KiB
JSON

{
"id": "canvas",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.WithKibanaProps",
"type": "Interface",
"label": "WithKibanaProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.WithKibanaProps.kibana",
"type": "Object",
"label": "kibana",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 16
},
"signature": [
"{ services: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
" & ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasStartDeps",
"text": "CanvasStartDeps"
},
" & { canvas: ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasServices",
"text": "CanvasServices"
},
"; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 15
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.CanvasSetup",
"type": "Type",
"label": "CanvasSetup",
"tags": [
"public"
],
"description": [
"\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 63
},
"signature": [
"CanvasApi"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.CanvasStart",
"type": "Type",
"label": "CanvasStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 64
},
"signature": [
"void"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}