kibana/api_docs/dashboard_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

1035 lines
34 KiB
JSON

{
"id": "dashboardEnhanced",
"client": {
"classes": [
{
"id": "def-public.AbstractDashboardDrilldown",
"type": "Class",
"tags": [],
"label": "AbstractDashboardDrilldown",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "public",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-public.AbstractDashboardDrilldown",
"text": "AbstractDashboardDrilldown"
},
"<Context> implements ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.DrilldownDefinition",
"text": "DrilldownDefinition"
},
"<",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", Context, ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.BaseActionFactoryContext",
"text": "BaseActionFactoryContext"
},
">"
],
"children": [
{
"id": "def-public.AbstractDashboardDrilldown.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "public",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-public.Params",
"text": "Params"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 36
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 36
}
},
{
"tags": [],
"id": "def-public.AbstractDashboardDrilldown.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-public.AbstractDashboardDrilldown.supportedTriggers",
"type": "Function",
"label": "supportedTriggers",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 40
},
"signature": [
"() => string[]"
]
},
{
"id": "def-public.AbstractDashboardDrilldown.getURL",
"type": "Function",
"label": "getURL",
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.KibanaURL",
"text": "KibanaURL"
},
">"
],
"description": [],
"children": [
{
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 42
}
},
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 42
}
},
{
"tags": [],
"id": "def-public.AbstractDashboardDrilldown.order",
"type": "number",
"label": "order",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 44
},
"signature": [
"100"
]
},
{
"id": "def-public.AbstractDashboardDrilldown.getDisplayName",
"type": "Function",
"children": [],
"signature": [
"() => string"
],
"description": [],
"label": "getDisplayName",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 46
},
"tags": [],
"returnComment": []
},
{
"tags": [],
"id": "def-public.AbstractDashboardDrilldown.euiIcon",
"type": "string",
"label": "euiIcon",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 48
},
"signature": [
"\"dashboardApp\""
]
},
{
"tags": [],
"id": "def-public.AbstractDashboardDrilldown.CollectConfig",
"type": "Function",
"label": "CollectConfig",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 54
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.BaseActionFactoryContext",
"text": "BaseActionFactoryContext"
},
">>"
]
},
{
"id": "def-public.AbstractDashboardDrilldown.createConfig",
"type": "Function",
"children": [],
"signature": [
"() => { dashboardId: string; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"description": [],
"label": "createConfig",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 56
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.AbstractDashboardDrilldown.isConfigValid",
"type": "Function",
"children": [
{
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 62
}
}
],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
") => config is ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"description": [],
"label": "isConfigValid",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 62
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.AbstractDashboardDrilldown.getHref",
"type": "Function",
"children": [
{
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 67
}
},
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 67
}
}
],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<string>"
],
"description": [],
"label": "getHref",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 67
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.AbstractDashboardDrilldown.execute",
"type": "Function",
"children": [
{
"type": "Object",
"label": "config",
"isRequired": true,
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 72
}
},
{
"type": "Uncategorized",
"label": "context",
"isRequired": true,
"signature": [
"Context"
],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 72
}
}
],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<void>"
],
"description": [],
"label": "execute",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 72
},
"tags": [],
"returnComment": []
},
{
"id": "def-public.AbstractDashboardDrilldown.urlGenerator",
"type": "Object",
"label": "urlGenerator",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 77
},
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardUrlGenerator",
"text": "DashboardUrlGenerator"
}
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 34
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-public.Params",
"type": "Interface",
"label": "Params",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.Params.start",
"type": "Function",
"label": "start",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 27
},
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartServicesGetter",
"text": "StartServicesGetter"
},
"<{ uiActionsEnhanced: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
},
"; data: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
},
"; dashboard: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardStart",
"text": "DashboardStart"
},
"; }, unknown, ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-public.SetupDependencies",
"type": "Interface",
"label": "SetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 17
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
}
]
},
{
"tags": [],
"id": "def-public.SetupDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 18
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
},
{
"tags": [],
"id": "def-public.SetupDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginSetup",
"text": "SharePluginSetup"
}
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.StartDependencies",
"type": "Interface",
"label": "StartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.StartDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 23
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 24
},
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 25
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.share",
"type": "CompoundType",
"label": "share",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 26
},
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePluginStart",
"text": "SharePluginStart"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.dashboard",
"type": "Object",
"label": "dashboard",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 27
},
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardStart",
"text": "DashboardStart"
}
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 22
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.Config",
"type": "Type",
"label": "Config",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts",
"lineNumber": 11
},
"signature": [
"{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.SetupContract",
"type": "Interface",
"label": "SetupContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 31
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.StartContract",
"type": "Interface",
"label": "StartContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"lineNumber": 34
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-server.SetupDependencies",
"type": "Interface",
"label": "SetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 13
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.SetupContract",
"text": "SetupContract"
}
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-server.StartDependencies",
"type": "Interface",
"label": "StartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.StartDependencies.uiActionsEnhanced",
"type": "Uncategorized",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 17
},
"signature": [
"void"
]
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 16
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-server.SetupContract",
"type": "Interface",
"label": "SetupContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 21
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-server.StartContract",
"type": "Interface",
"label": "StartContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"lineNumber": 24
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.createExtract",
"type": "Function",
"children": [
{
"id": "def-common.createExtract.{\n- drilldownId,\n}",
"type": "Object",
"label": "{\n drilldownId,\n}",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-common.createExtract.{\n- drilldownId,\n}.drilldownId",
"type": "string",
"label": "drilldownId",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 49
}
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 48
}
}
],
"signature": [
"({ drilldownId, }: { drilldownId: string; }) => (state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => { state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"; references: ",
"SavedObjectReference",
"[]; }"
],
"description": [],
"label": "createExtract",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 46
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.createInject",
"type": "Function",
"children": [
{
"id": "def-common.createInject.{\n- drilldownId,\n}",
"type": "Object",
"label": "{\n drilldownId,\n}",
"tags": [],
"description": [],
"children": [
{
"tags": [],
"id": "def-common.createInject.{\n- drilldownId,\n}.drilldownId",
"type": "string",
"label": "drilldownId",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 34
}
}
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 33
}
}
],
"signature": [
"({ drilldownId, }: { drilldownId: string; }) => (state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
", references: ",
"SavedObjectReference",
"[]) => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"description": [],
"label": "createInject",
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"lineNumber": 31
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"id": "def-common.DrilldownConfig",
"type": "Type",
"label": "DrilldownConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts",
"lineNumber": 9
},
"signature": [
"{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.EMBEDDABLE_TO_DASHBOARD_DRILLDOWN",
"type": "string",
"label": "EMBEDDABLE_TO_DASHBOARD_DRILLDOWN",
"description": [
"\nNOTE: DO NOT CHANGE THIS STRING WITHOUT CAREFUL CONSIDERATOIN, BECAUSE IT IS\nSTORED IN SAVED OBJECTS.\n\nAlso temporary dashboard drilldown migration code inside embeddable plugin relies on it\nx-pack/plugins/embeddable_enhanced/public/embeddables/embeddable_action_storage.ts"
],
"source": {
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts",
"lineNumber": 15
},
"signature": [
"\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\""
],
"initialIsOpen": false
}
],
"objects": []
}
}