ede34a84a2
* Clean up api doc infra * updated docs * Update api dics # Conflicts: # api_docs/actions.mdx # api_docs/alerting.json # api_docs/core.mdx # api_docs/core_application.mdx # api_docs/core_chrome.mdx # api_docs/core_http.mdx # api_docs/core_saved_objects.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_index_patterns.json # api_docs/data_index_patterns.mdx # api_docs/data_query.mdx # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/expressions.mdx # api_docs/interactive_setup.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.json # api_docs/rule_registry.json # api_docs/saved_objects.json # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/url_forwarding.json
180 lines
4.7 KiB
JSON
180 lines
4.7 KiB
JSON
{
|
|
"id": "canvas",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-public.WithKibanaProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "WithKibanaProps",
|
|
"description": [],
|
|
"path": "x-pack/plugins/canvas/public/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-public.WithKibanaProps.kibana",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibana",
|
|
"description": [],
|
|
"signature": [
|
|
"{ services: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
" & ",
|
|
"CanvasStartDeps",
|
|
" & { canvas: ",
|
|
"CanvasServices",
|
|
"; }; }"
|
|
],
|
|
"path": "x-pack/plugins/canvas/public/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "canvas",
|
|
"id": "def-public.CanvasSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CanvasSetup",
|
|
"description": [
|
|
"\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."
|
|
],
|
|
"signature": [
|
|
"CanvasApi"
|
|
],
|
|
"path": "x-pack/plugins/canvas/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "canvas",
|
|
"id": "def-public.CanvasStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CanvasStart",
|
|
"description": [],
|
|
"signature": [
|
|
"void"
|
|
],
|
|
"path": "x-pack/plugins/canvas/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-common.CANVAS_APP_LOCATOR",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CANVAS_APP_LOCATOR",
|
|
"description": [],
|
|
"signature": [
|
|
"\"CANVAS_APP_LOCATOR\""
|
|
],
|
|
"path": "x-pack/plugins/canvas/common/locator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-common.CanvasAppLocator",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CanvasAppLocator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "canvas",
|
|
"scope": "common",
|
|
"docId": "kibCanvasPluginApi",
|
|
"section": "def-common.CanvasAppLocatorParams",
|
|
"text": "CanvasAppLocatorParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/canvas/common/locator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-common.CanvasAppLocatorParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CanvasAppLocatorParams",
|
|
"description": [],
|
|
"signature": [
|
|
"{ view: \"workpadPDF\"; id: string; page: number; }"
|
|
],
|
|
"path": "x-pack/plugins/canvas/common/locator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-common.UI_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "UI_SETTINGS",
|
|
"description": [],
|
|
"path": "x-pack/plugins/canvas/common/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "canvas",
|
|
"id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENABLE_LABS_UI",
|
|
"description": [],
|
|
"path": "x-pack/plugins/canvas/common/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |