kibana/api_docs/dashboard_enhanced.json
Stacey Gammon e92a945ab1
Add packages to our API documentation (#113564) (#114513)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
# Conflicts:
#	api_docs/alerting.mdx
#	api_docs/apm.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/custom_integrations.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.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/embeddable.json
#	api_docs/event_log.mdx
#	api_docs/fleet.mdx
#	api_docs/home.json
#	api_docs/index_management.json
#	api_docs/interactive_setup.mdx
#	api_docs/kibana_legacy.json
#	api_docs/kibana_legacy.mdx
#	api_docs/observability.mdx
#	api_docs/plugin_directory.mdx
#	api_docs/security_oss.mdx
2021-10-11 13:58:18 -04:00

1052 lines
37 KiB
JSON

{
"id": "dashboardEnhanced",
"client": {
"classes": [
{
"parentPluginId": "dashboardEnhanced",
"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"
},
">"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "public",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-public.Params",
"text": "Params"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.supportedTriggers",
"type": "Function",
"tags": [],
"label": "supportedTriggers",
"description": [],
"signature": [
"() => string[]"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getLocation.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getLocation.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"100"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.euiIcon",
"type": "string",
"tags": [],
"label": "euiIcon",
"description": [],
"signature": [
"\"dashboardApp\""
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.CollectConfig",
"type": "Function",
"tags": [],
"label": "CollectConfig",
"description": [],
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<",
{
"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"
},
">>"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.createConfig",
"type": "Function",
"tags": [],
"label": "createConfig",
"description": [],
"signature": [
"() => { dashboardId: string; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.isConfigValid",
"type": "Function",
"tags": [],
"label": "isConfigValid",
"description": [],
"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"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.isConfigValid.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getHref",
"type": "Function",
"tags": [],
"label": "getHref",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<string>"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getHref.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.getHref.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.execute",
"type": "Function",
"tags": [],
"label": "execute",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
},
", context: Context) => Promise<void>"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.execute.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "dashboardEnhanced",
"scope": "common",
"docId": "kibDashboardEnhancedPluginApi",
"section": "def-common.DrilldownConfig",
"text": "DrilldownConfig"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.execute.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.AbstractDashboardDrilldown.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardAppLocatorParams",
"text": "DashboardAppLocatorParams"
},
">"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.Params",
"type": "Interface",
"tags": [],
"label": "Params",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.Params.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.StartServices",
"text": "StartServices"
},
"<{ 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"
},
">"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.SetupDependencies",
"type": "Interface",
"tags": [],
"label": "SetupDependencies",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.SetupDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.SetupDependencies.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"signature": [
"{ register: (shareMenuProvider: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShareMenuProvider",
"text": "ShareMenuProvider"
},
") => void; } & { urlGenerators: ",
"UrlGeneratorsSetup",
"; url: ",
"UrlService",
"<unknown>; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">): void; setAnonymousAccessServiceProvider: (provider: () => ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.AnonymousAccessServiceContract",
"text": "AnonymousAccessServiceContract"
},
") => void; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies",
"type": "Interface",
"tags": [],
"label": "StartDependencies",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies.uiActionsEnhanced",
"type": "Object",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies.share",
"type": "CompoundType",
"tags": [],
"label": "share",
"description": [],
"signature": [
"{ toggleShareContextMenu: (options: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions",
"text": "ShowShareMenuOptions"
},
") => void; } & { urlGenerators: ",
"UrlGeneratorsStart",
"; url: ",
"UrlService",
"<unknown>; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">): void; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartDependencies.dashboard",
"type": "Object",
"tags": [],
"label": "dashboard",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardStart",
"text": "DashboardStart"
}
],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-public.Config",
"type": "Type",
"tags": [],
"label": "Config",
"description": [],
"signature": [
"{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "dashboardEnhanced",
"id": "def-public.SetupContract",
"type": "Interface",
"tags": [],
"label": "SetupContract",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "dashboardEnhanced",
"id": "def-public.StartContract",
"type": "Interface",
"tags": [],
"label": "StartContract",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-server.SetupDependencies",
"type": "Interface",
"tags": [],
"label": "SetupDependencies",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-server.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.SetupContract",
"text": "SetupContract"
}
],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-server.StartDependencies",
"type": "Interface",
"tags": [],
"label": "StartDependencies",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-server.StartDependencies.uiActionsEnhanced",
"type": "Uncategorized",
"tags": [],
"label": "uiActionsEnhanced",
"description": [],
"signature": [
"void"
],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "dashboardEnhanced",
"id": "def-server.SetupContract",
"type": "Interface",
"tags": [],
"label": "SetupContract",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "dashboardEnhanced",
"id": "def-server.StartContract",
"type": "Interface",
"tags": [],
"label": "StartContract",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createExtract",
"type": "Function",
"tags": [],
"label": "createExtract",
"description": [],
"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",
"[]; }"
],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createExtract.$1",
"type": "Object",
"tags": [],
"label": "{\n drilldownId,\n}",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createExtract.$1.drilldownId",
"type": "string",
"tags": [],
"label": "drilldownId",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createInject",
"type": "Function",
"tags": [],
"label": "createInject",
"description": [],
"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"
}
],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createInject.$1",
"type": "Object",
"tags": [],
"label": "{\n drilldownId,\n}",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.createInject.$1.drilldownId",
"type": "string",
"tags": [],
"label": "drilldownId",
"description": [],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.DrilldownConfig",
"type": "Type",
"tags": [],
"label": "DrilldownConfig",
"description": [],
"signature": [
"{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboardEnhanced",
"id": "def-common.EMBEDDABLE_TO_DASHBOARD_DRILLDOWN",
"type": "string",
"tags": [],
"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"
],
"signature": [
"\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\""
],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}