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

871 lines
28 KiB
JSON

{
"id": "discoverEnhanced",
"client": {
"classes": [
{
"id": "def-public.DiscoverEnhancedPlugin",
"type": "Class",
"tags": [],
"label": "DiscoverEnhancedPlugin",
"description": [],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedPlugin",
"text": "DiscoverEnhancedPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<void, void, ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
},
", ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
">"
],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedPlugin.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 43
},
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "common",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-common.Config",
"text": "Config"
}
]
},
{
"id": "def-public.DiscoverEnhancedPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 45
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
", unknown>, { uiActions, share }: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
", unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 50
}
},
{
"type": "Object",
"label": "{ uiActions, share }",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedSetupDependencies",
"text": "DiscoverEnhancedSetupDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 51
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 49
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
", plugins: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
},
") => void"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
}
},
{
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.DiscoverEnhancedStartDependencies",
"text": "DiscoverEnhancedStartDependencies"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 69
}
},
{
"id": "def-public.DiscoverEnhancedPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 71
}
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 40
},
"initialIsOpen": false
},
{
"id": "def-public.ExploreDataChartAction",
"type": "Class",
"tags": [],
"label": "ExploreDataChartAction",
"description": [
"\nThis is \"Explore underlying data\" action which appears in popup context\nmenu when user clicks a value in visualization or brushes a time range."
],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartAction",
"text": "ExploreDataChartAction"
},
" extends ",
"AbstractExploreDataAction",
"<",
"ExploreDataChartActionContext",
"> implements ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
"ExploreDataChartActionContext"
],
"children": [
{
"tags": [],
"id": "def-public.ExploreDataChartAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 35
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataChartAction.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 37
},
"signature": [
"\"ACTION_EXPLORE_DATA_CHART\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataChartAction.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 39
},
"signature": [
"200"
]
},
{
"id": "def-public.ExploreDataChartAction.isCompatible",
"type": "Function",
"label": "isCompatible",
"signature": [
"(context: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
},
") => Promise<boolean>"
],
"description": [],
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 41
}
},
{
"id": "def-public.ExploreDataChartAction.getUrl",
"type": "Function",
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 47
}
}
],
"signature": [
"(context: ",
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataChartActionContext",
"text": "ExploreDataChartActionContext"
},
") => Promise<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.KibanaURL",
"text": "KibanaURL"
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 46
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts",
"lineNumber": 32
},
"initialIsOpen": false
},
{
"id": "def-public.ExploreDataContextMenuAction",
"type": "Class",
"tags": [],
"label": "ExploreDataContextMenuAction",
"description": [
"\nThis is \"Explore underlying data\" action which appears in the context\nmenu of a dashboard panel."
],
"signature": [
{
"pluginId": "discoverEnhanced",
"scope": "public",
"docId": "kibDiscoverEnhancedPluginApi",
"section": "def-public.ExploreDataContextMenuAction",
"text": "ExploreDataContextMenuAction"
},
" extends ",
"AbstractExploreDataAction",
"<EmbeddableQueryContext> implements ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<EmbeddableQueryContext>"
],
"children": [
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 37
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 39
},
"signature": [
"\"ACTION_EXPLORE_DATA\""
]
},
{
"tags": [],
"id": "def-public.ExploreDataContextMenuAction.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 41
},
"signature": [
"200"
]
},
{
"id": "def-public.ExploreDataContextMenuAction.getUrl",
"type": "Function",
"children": [
{
"type": "Object",
"label": "context",
"isRequired": true,
"signature": [
"EmbeddableQueryContext"
],
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43
}
}
],
"signature": [
"(context: EmbeddableQueryContext) => Promise<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.KibanaURL",
"text": "KibanaURL"
},
">"
],
"description": [],
"label": "getUrl",
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 43
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts",
"lineNumber": 34
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.DiscoverEnhancedSetupDependencies",
"type": "Interface",
"label": "DiscoverEnhancedSetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.discover",
"type": "Object",
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 25
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverSetup",
"text": "DiscoverSetup"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy",
"type": "Object",
"label": "kibanaLegacy",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 27
},
"signature": [
"{} | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 28
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginSetup",
"text": "SharePluginSetup"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedSetupDependencies.uiActions",
"type": "Object",
"label": "uiActions",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 29
},
"signature": [
"Pick<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"id": "def-public.DiscoverEnhancedStartDependencies",
"type": "Interface",
"label": "DiscoverEnhancedStartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.discover",
"type": "Object",
"label": "discover",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.DiscoverStart",
"text": "DiscoverStart"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 34
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.kibanaLegacy",
"type": "Object",
"label": "kibanaLegacy",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 35
},
"signature": [
"{ dashboardConfig: ",
{
"pluginId": "kibanaLegacy",
"scope": "public",
"docId": "kibKibanaLegacyPluginApi",
"section": "def-public.DashboardConfig",
"text": "DashboardConfig"
},
"; loadFontAwesome: () => Promise<void>; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 36
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginStart",
"text": "SharePluginStart"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.DiscoverEnhancedStartDependencies.uiActions",
"type": "Object",
"label": "uiActions",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 37
},
"signature": [
"Pick<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
", ",
"MethodKeysOf",
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
">>"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"lineNumber": 32
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.Config",
"type": "Interface",
"label": "Config",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.Config.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 9
},
"signature": [
"{ exploreDataInChart: { enabled: boolean; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/discover_enhanced/common/config.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}