87a5b22626
* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
1086 lines
43 KiB
JSON
1086 lines
43 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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L38"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L40"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L44"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L46"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L48"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L54"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L56"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L77"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L34"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L17"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L18"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L19"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L23"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L24"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L25"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L26"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L27"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L22"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L27"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L26"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts#L11"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L31"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L34"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L13"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L12"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L17"
|
|
},
|
|
"signature": [
|
|
"void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_enhanced/server/plugin.ts",
|
|
"lineNumber": 16,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L21"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L24"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L49"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L48"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L46"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L34"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L33"
|
|
}
|
|
}
|
|
],
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L31"
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts#L15"
|
|
},
|
|
"signature": [
|
|
"\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts#L9"
|
|
},
|
|
"signature": [
|
|
"{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |