3162 lines
111 KiB
JSON
3162 lines
111 KiB
JSON
{
|
|
"id": "dashboard",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DashboardContainer",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainer",
|
|
"text": "DashboardContainer"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<",
|
|
"InheritedChildInput",
|
|
", ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"dashboard\""
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.controlGroup",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controlGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.ControlGroupContainer",
|
|
"text": "ControlGroupContainer"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.getPanelCount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPanelCount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardContainerServices"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.Unnamed.$4",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "controlGroup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.ControlGroupContainer",
|
|
"text": "ControlGroupContainer"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.createNewPanelState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createNewPanelState",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEmbeddableInput extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", TEmbeddable extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, any>>(factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, any, TEmbeddable, ",
|
|
"SavedObjectAttributes",
|
|
">, partial?: Partial<TEmbeddableInput>) => ",
|
|
"DashboardPanelState",
|
|
"<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.createNewPanelState.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, any, TEmbeddable, ",
|
|
"SavedObjectAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.createNewPanelState.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "partial",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.showPlaceholderUntil",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showPlaceholderUntil",
|
|
"description": [],
|
|
"signature": [
|
|
"<TPlacementMethodArgs extends ",
|
|
"IPanelPlacementArgs",
|
|
">(newStateComplete: Promise<Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; }>>>, placementMethod?: ",
|
|
"PanelPlacementMethod",
|
|
"<TPlacementMethodArgs> | undefined, placementArgs?: TPlacementMethodArgs | undefined) => void"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.showPlaceholderUntil.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newStateComplete",
|
|
"description": [],
|
|
"signature": [
|
|
"Promise<Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; }>>>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.showPlaceholderUntil.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "placementMethod",
|
|
"description": [],
|
|
"signature": [
|
|
"PanelPlacementMethod",
|
|
"<TPlacementMethodArgs> | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.showPlaceholderUntil.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "placementArgs",
|
|
"description": [],
|
|
"signature": [
|
|
"TPlacementMethodArgs | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.replacePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replacePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(previousPanelState: ",
|
|
"DashboardPanelState",
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">, newPanelState: Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; }>>, generateNewId?: boolean | undefined) => void"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.replacePanel.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "previousPanelState",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardPanelState",
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.replacePanel.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newPanelState",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; }>>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.replacePanel.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "generateNewId",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addOrUpdateEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", EEO extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>, embeddableId?: string | undefined) => Promise<void | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | E>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "explicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"(dom: HTMLElement) => void"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dom",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.getInheritedInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInheritedInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string) => ",
|
|
"InheritedChildInput"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainer.getInheritedInput.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DashboardContainerFactoryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerFactoryDefinition",
|
|
"text": "DashboardContainerFactoryDefinition"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainer",
|
|
"text": "DashboardContainer"
|
|
},
|
|
", ",
|
|
"SavedObjectAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.isContainerType",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isContainerType",
|
|
"description": [],
|
|
"signature": [
|
|
"true"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"dashboard\""
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartServices",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"DashboardContainerServices",
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "persistableStateService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddablePersistableStateService",
|
|
"text": "EmbeddablePersistableStateService"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.isEditable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEditable",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.getDefaultInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDefaultInput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Partial<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [],
|
|
"signature": [
|
|
"(initialInput: ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
", parent?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainer",
|
|
"text": "DashboardContainer"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.create.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.create.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.inject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "inject",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
", references: ",
|
|
"SavedObjectReference",
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.inject.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.inject.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.extract",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extract",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
") => { state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
"; references: ",
|
|
"SavedObjectReference",
|
|
"[]; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerFactoryDefinition.extract.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.createDashboardEditUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createDashboardEditUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string | undefined, editMode: boolean | undefined) => string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.createDashboardEditUrl.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.createDashboardEditUrl.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "editMode",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.createDashboardUrlGenerator",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "createDashboardUrlGenerator",
|
|
"description": [],
|
|
"signature": [
|
|
"(getStartServices: () => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoader",
|
|
"text": "SavedObjectLoader"
|
|
},
|
|
"; }>) => ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorsDefinition",
|
|
"text": "UrlGeneratorsDefinition"
|
|
},
|
|
"<\"DASHBOARD_APP_URL_GENERATOR\">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": true,
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.createDashboardUrlGenerator.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartServices",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoader",
|
|
"text": "SavedObjectLoader"
|
|
},
|
|
"; }>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardContainerInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.dashboardCapabilities",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dashboardCapabilities",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardAppCapabilities",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.controlGroupInput",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controlGroupInput",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardControlGroupInput",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.refreshConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "refreshConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.isEmbeddedExternally",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isEmbeddedExternally",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.isFullScreenMode",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isFullScreenMode",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.expandedPanelId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expandedPanelId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.useMargins",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useMargins",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.syncColors",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "syncColors",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.viewMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "viewMode",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"{ query: string | { [key: string]: any; }; language: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.panels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panels",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [panelId: string]: ",
|
|
"DashboardPanelState",
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { [k: string]: unknown; }>; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardContainerInput.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaExecutionContext",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardFeatureFlagConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardFeatureFlagConfig",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardFeatureFlagConfig.allowByValueEmbeddables",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowByValueEmbeddables",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardSavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardSavedObject",
|
|
"text": "DashboardSavedObject"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.timeRestore",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "timeRestore",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.timeTo",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeTo",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.timeFrom",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeFrom",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.panelsJSON",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelsJSON",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.optionsJSON",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "optionsJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.uiStateJSON",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uiStateJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.lastSavedTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "lastSavedTitle",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.refreshInterval",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "refreshInterval",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.searchSource",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"signature": [
|
|
"{ create: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; history: Record<string, any>[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, value: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; removeField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; setFields: (newFields: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; getId: () => string; getFields: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"; getField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K, recurse?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]; getOwnField: <K extends \"type\" | \"query\" | \"source\" | \"sort\" | \"version\" | \"filter\" | \"highlight\" | \"highlightAll\" | \"trackTotalHits\" | \"aggs\" | \"from\" | \"size\" | \"fields\" | \"fieldsFromSource\" | \"index\" | \"searchAfter\" | \"timeout\" | \"terminate_after\" | \"parent\">(field: K) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"[K]; createCopy: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; createChild: (options?: {}) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; setParent: (parent?: Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceOptions",
|
|
"text": "SearchSourceOptions"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
"; getParent: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
" | undefined; fetch$: (options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<",
|
|
"SearchResponse",
|
|
"<any>>>; fetch: (options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
") => Promise<",
|
|
"SearchResponse",
|
|
"<any>>; onRequestStart: (handler: (searchSource: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
", options?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; getSerializedFields: (recurse?: boolean) => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
"; serialize: () => { searchSourceJSON: string; references: ",
|
|
"SavedObjectReference",
|
|
"[]; }; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.getQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.getFilters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilters",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.getFullEditPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFullEditPath",
|
|
"description": [],
|
|
"signature": [
|
|
"(editMode?: boolean | undefined) => string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.getFullEditPath.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "editMode",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.outcome",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "outcome",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.aliasId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aliasId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSavedObject.controlGroupInput",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controlGroupInput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ controlStyle?: \"twoLine\" | \"oneLine\" | undefined; panelsJSON?: string | undefined; } | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "DashboardUrlGeneratorState",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": true,
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.dashboardId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dashboardId",
|
|
"description": [
|
|
"\nIf given, the dashboard saved object with this id will be loaded. If not given,\na new, unsaved dashboard will be loaded up."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [
|
|
"\nOptionally set the time range in the time picker."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.refreshInterval",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "refreshInterval",
|
|
"description": [
|
|
"\nOptionally set the refresh interval."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [
|
|
"\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [
|
|
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.useHash",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useHash",
|
|
"description": [
|
|
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.preserveSavedFilters",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "preserveSavedFilters",
|
|
"description": [
|
|
"\nWhen `true` filters from saved filters from destination dashboard as merged with applied filters\nWhen `false` applied filters take precedence and override saved filters\n\ntrue is default"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.viewMode",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "viewMode",
|
|
"description": [
|
|
"\nView mode of the dashboard."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"\nSearch search session ID to restore.\n(Background search)"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.panels",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "panels",
|
|
"description": [
|
|
"\nList of dashboard panels"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel730ToLatest",
|
|
"text": "SavedDashboardPanel730ToLatest"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGeneratorState.savedQuery",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedQuery",
|
|
"description": [
|
|
"\nSaved query ID"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DASHBOARD_APP_URL_GENERATOR",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DASHBOARD_APP_URL_GENERATOR",
|
|
"description": [],
|
|
"signature": [
|
|
"\"DASHBOARD_APP_URL_GENERATOR\""
|
|
],
|
|
"path": "src/plugins/dashboard/public/url_generator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DASHBOARD_CONTAINER_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DASHBOARD_CONTAINER_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"dashboard\""
|
|
],
|
|
"path": "src/plugins/dashboard/public/application/embeddable/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardAppLocator",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardAppLocator",
|
|
"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": "src/plugins/dashboard/public/locator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardAppLocatorParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardAppLocatorParams",
|
|
"description": [
|
|
"\nWe use `type` instead of `interface` to avoid having to extend this type with\n`SerializableRecord`. See https://github.com/microsoft/TypeScript/issues/15300."
|
|
],
|
|
"signature": [
|
|
"{ dashboardId?: string | undefined; timeRange?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; refreshInterval?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
" | undefined; filters?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined; query?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; searchSessionId?: string | undefined; panels?: ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel730ToLatest",
|
|
"text": "SavedDashboardPanel730ToLatest"
|
|
},
|
|
"[] | undefined; savedQuery?: string | undefined; options?: ",
|
|
"DashboardOptions",
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/plugins/dashboard/public/locator.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardUrlGenerator",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardUrlGenerator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "public",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-public.UrlGeneratorContract",
|
|
"text": "UrlGeneratorContract"
|
|
},
|
|
"<\"DASHBOARD_APP_URL_GENERATOR\">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.SavedDashboardPanel",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel",
|
|
"description": [
|
|
"\nThis should always represent the latest dashboard panel shape, after all possible migrations."
|
|
],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
|
"text": "RawSavedDashboardPanel730ToLatest"
|
|
},
|
|
", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DashboardConstants",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.LANDING_PAGE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "LANDING_PAGE_PATH",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.CREATE_NEW_DASHBOARD_URL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CREATE_NEW_DASHBOARD_URL",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.VIEW_DASHBOARD_URL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VIEW_DASHBOARD_URL",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.ADD_EMBEDDABLE_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ADD_EMBEDDABLE_ID",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.ADD_EMBEDDABLE_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ADD_EMBEDDABLE_TYPE",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.DASHBOARDS_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DASHBOARDS_ID",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.DASHBOARD_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "DASHBOARD_ID",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.SEARCH_SESSION_ID",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SEARCH_SESSION_ID",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.CHANGE_CHECK_DEBOUNCE",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "CHANGE_CHECK_DEBOUNCE",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardConstants.CHANGE_APPLY_DEBOUNCE",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "CHANGE_APPLY_DEBOUNCE",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardSetup",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardSetup.locator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "locator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardAppLocator",
|
|
"text": "DashboardAppLocator"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardStart",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.getSavedDashboardLoader",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSavedDashboardLoader",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoader",
|
|
"text": "SavedObjectLoader"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.getDashboardContainerByValueRenderer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDashboardContainerByValueRenderer",
|
|
"description": [],
|
|
"signature": [
|
|
"() => React.FC<Props>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.dashboardUrlGenerator",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "dashboardUrlGenerator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardUrlGenerator",
|
|
"text": "DashboardUrlGenerator"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"references": [
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_links.tsx"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_cti_links/index.tsx"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.locator",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "locator",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardAppLocator",
|
|
"text": "DashboardAppLocator"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.dashboardFeatureFlagConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dashboardFeatureFlagConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardFeatureFlagConfig",
|
|
"text": "DashboardFeatureFlagConfig"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-server.findByValueEmbeddables",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "findByValueEmbeddables",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedObjectClient: Pick<Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRepository",
|
|
"text": "SavedObjectsRepository"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">, embeddableType: string) => Promise<{ [key: string]: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.Serializable",
|
|
"text": "Serializable"
|
|
},
|
|
"; }[]>"
|
|
],
|
|
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-server.findByValueEmbeddables.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRepository",
|
|
"text": "SavedObjectsRepository"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">, \"find\">"
|
|
],
|
|
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-server.findByValueEmbeddables.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-server.DashboardPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardPluginSetup",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-server.DashboardPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardPluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "migratePanelsTo730",
|
|
"description": [],
|
|
"signature": [
|
|
"(panels: (",
|
|
"RawSavedDashboardPanelTo60",
|
|
" | ",
|
|
"RawSavedDashboardPanel610",
|
|
" | ",
|
|
"RawSavedDashboardPanel620",
|
|
" | Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanelTo60",
|
|
"text": "SavedDashboardPanelTo60"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel610",
|
|
"text": "SavedDashboardPanel610"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel620",
|
|
"text": "SavedDashboardPanel620"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel630",
|
|
"text": "SavedDashboardPanel630"
|
|
},
|
|
")[], version: string, useMargins: boolean, uiState: { [key: string]: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
"; } | undefined) => ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
|
"text": "RawSavedDashboardPanel730ToLatest"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "panels",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
"RawSavedDashboardPanelTo60",
|
|
" | ",
|
|
"RawSavedDashboardPanel610",
|
|
" | ",
|
|
"RawSavedDashboardPanel620",
|
|
" | Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanelTo60",
|
|
"text": "SavedDashboardPanelTo60"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel610",
|
|
"text": "SavedDashboardPanel610"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel620",
|
|
"text": "SavedDashboardPanel620"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.SavedDashboardPanel630",
|
|
"text": "SavedDashboardPanel630"
|
|
},
|
|
")[]"
|
|
],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730.$3",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useMargins",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiState",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.migratePanelsTo730.$4.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/dashboard/common/migrate_to_730_panels.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardContainerStateWithType",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardContainerStateWithType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.DashboardContainerStateWithType",
|
|
"text": "DashboardContainerStateWithType"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardContainerStateWithType.panels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panels",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [panelId: string]: ",
|
|
"DashboardPanelState",
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { [k: string]: unknown; }>; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardContainerStateWithType.controlGroupInput",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "controlGroupInput",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardContainerControlGroupInput",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardDoc700To720",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardDoc700To720",
|
|
"description": [],
|
|
"signature": [
|
|
"Doc<DashboardAttributesTo720>"
|
|
],
|
|
"path": "src/plugins/dashboard/common/bwc/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardDoc730ToLatest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardDoc730ToLatest",
|
|
"description": [],
|
|
"signature": [
|
|
"Doc<DashboardAttributes>"
|
|
],
|
|
"path": "src/plugins/dashboard/common/bwc/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardDocPre700",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardDocPre700",
|
|
"description": [],
|
|
"signature": [
|
|
"DocPre700<DashboardAttributesTo720>"
|
|
],
|
|
"path": "src/plugins/dashboard/common/bwc/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.GridData",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GridData",
|
|
"description": [],
|
|
"signature": [
|
|
"{ w: number; h: number; x: number; y: number; i: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/embeddable/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.RawSavedDashboardPanel730ToLatest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RawSavedDashboardPanel730ToLatest",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/bwc/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel610",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel610",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"RawSavedDashboardPanel610",
|
|
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel620",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel620",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel630",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel630",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel640To720",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel640To720",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<",
|
|
"RawSavedDashboardPanel620",
|
|
", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\">, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel730ToLatest",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanel730ToLatest",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.RawSavedDashboardPanel730ToLatest",
|
|
"text": "RawSavedDashboardPanel730ToLatest"
|
|
},
|
|
", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanelTo60",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedDashboardPanelTo60",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
"RawSavedDashboardPanelTo60",
|
|
", \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.UI_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "UI_SETTINGS",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/common/index.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.UI_SETTINGS.ENABLE_LABS_UI",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENABLE_LABS_UI",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/common/index.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |