kibana/api_docs/dashboard.devdocs.json

3562 lines
No EOL
125 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": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerInput",
"text": "DashboardContainerInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
">"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"dashboard\""
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.controlGroup",
"type": "Object",
"tags": [],
"label": "controlGroup",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupContainer",
"text": "ControlGroupContainer"
},
" | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.onDestroyControlGroup",
"type": "Function",
"tags": [],
"label": "onDestroyControlGroup",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "initialInput",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerInput",
"text": "DashboardContainerInput"
}
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.Unnamed.$2",
"type": "number",
"tags": [],
"label": "dashboardCreationStartTime",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"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/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.Unnamed.$4",
"type": "Object",
"tags": [],
"label": "creationOptions",
"description": [],
"signature": [
"DashboardCreationOptions",
" | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getDashboardSavedObjectId",
"type": "Function",
"tags": [],
"label": "getDashboardSavedObjectId",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getInputAsValueType",
"type": "Function",
"tags": [],
"label": "getInputAsValueType",
"description": [],
"signature": [
"() => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
}
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.untilInitialized",
"type": "Function",
"tags": [],
"label": "untilInitialized",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.reportPerformanceMetrics",
"type": "Function",
"tags": [],
"label": "reportPerformanceMetrics",
"description": [],
"signature": [
"(stats: ",
"DashboardRenderPerformanceStats",
") => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.reportPerformanceMetrics.$1",
"type": "Object",
"tags": [],
"label": "stats",
"description": [],
"signature": [
"DashboardRenderPerformanceStats"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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, any>>(factory: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<TEmbeddableInput, any, TEmbeddable, unknown>, partial?: Partial<TEmbeddableInput>) => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<TEmbeddableInput>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": 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, unknown>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": 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/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getExplicitInputIsEqual",
"type": "Function",
"tags": [],
"label": "getExplicitInputIsEqual",
"description": [],
"signature": [
"(lastExplicitInput: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
") => Promise<boolean>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getExplicitInputIsEqual.$1",
"type": "Object",
"tags": [],
"label": "lastExplicitInput",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
}
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getReduxEmbeddableTools",
"type": "Function",
"tags": [],
"label": "getReduxEmbeddableTools",
"description": [],
"signature": [
"() => ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableTools",
"text": "ReduxEmbeddableTools"
},
"<",
"DashboardReduxState",
", { setControlGroupState: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.PersistableControlGroupInput",
"text": "PersistableControlGroupInput"
},
" | undefined; type: string; }) => void; setPanels: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
},
"; type: string; }) => void; setStateFromSaveModal: (state: ",
"DashboardReduxState",
", action: { payload: ",
"DashboardStateFromSaveModal",
"; type: string; }) => void; setDescription: (state: ",
"DashboardReduxState",
", action: { payload: string | undefined; type: string; }) => void; setViewMode: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.ViewMode",
"text": "ViewMode"
},
"; type: string; }) => void; setTags: (state: ",
"DashboardReduxState",
", action: { payload: string[]; type: string; }) => void; setTitle: (state: ",
"DashboardReduxState",
", action: { payload: string; type: string; }) => void; setSearchSessionId: (state: ",
"DashboardReduxState",
", action: { payload: string | undefined; type: string; }) => void; setHasUnsavedChanges: (state: ",
"DashboardReduxState",
", action: { payload: boolean | undefined; type: string; }) => void; setLastSavedInput: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
"; type: string; }) => void; resetToLastSavedInput: (state: ",
"DashboardReduxState",
") => void; setUseMargins: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setSyncCursor: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setSyncColors: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setSyncTooltips: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setHidePanelTitles: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setFiltersAndQuery: (state: ",
"DashboardReduxState",
", action: { payload: Pick<",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
", \"query\" | \"filters\">; type: string; }) => void; setLastReloadRequestTimeToNow: (state: ",
"DashboardReduxState",
") => void; setFilters: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; type: string; }) => void; setQuery: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"; type: string; }) => void; setSavedQueryId: (state: ",
"DashboardReduxState",
", action: { payload: string | undefined; type: string; }) => void; setTimeRestore: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; setTimeRange: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; type: string; }) => void; setRefreshInterval: (state: ",
"DashboardReduxState",
", action: { payload: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; type: string; }) => void; setTimeslice: (state: ",
"DashboardReduxState",
", action: { payload: [number, number] | undefined; type: string; }) => void; setExpandedPanelId: (state: ",
"DashboardReduxState",
", action: { payload: string | undefined; type: string; }) => void; setFullScreenMode: (state: ",
"DashboardReduxState",
", action: { payload: boolean; type: string; }) => void; }>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"(dom: HTMLElement) => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.render.$1",
"type": "Object",
"tags": [],
"label": "dom",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getInheritedInput",
"type": "Function",
"tags": [],
"label": "getInheritedInput",
"description": [],
"signature": [
"(id: string) => ",
"InheritedChildInput"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getInheritedInput.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.isExpectingIdChange",
"type": "Function",
"tags": [],
"label": "isExpectingIdChange",
"description": [
"\nSometimes when the ID changes, it's due to a clone operation, or a save as operation. In these cases,\nmost of the state hasn't actually changed, so there isn't any reason to destroy this container and\nload up a fresh one. When an id change is in progress, the renderer can check this method, and if it returns\ntrue, the renderer can safely skip destroying and rebuilding the container."
],
"signature": [
"() => boolean"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.expectIdChange",
"type": "Function",
"tags": [],
"label": "expectIdChange",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.runClone",
"type": "Function",
"tags": [],
"label": "runClone",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
") => Promise<",
"SaveDashboardReturn",
" | undefined>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.runSaveAs",
"type": "Function",
"tags": [],
"label": "runSaveAs",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
") => Promise<",
"SaveDashboardReturn",
" | undefined>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.runQuickSave",
"type": "Function",
"tags": [],
"label": "runQuickSave",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
") => Promise<",
"SaveDashboardReturn",
">"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.showOptions",
"type": "Function",
"tags": [],
"label": "showOptions",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
", anchorElement: HTMLElement) => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.showOptions.$1",
"type": "Object",
"tags": [],
"label": "anchorElement",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/show_options_popover.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.addFromLibrary",
"type": "Function",
"tags": [],
"label": "addFromLibrary",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
") => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.replacePanel",
"type": "Function",
"tags": [],
"label": "replacePanel",
"description": [],
"signature": [
"(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
", previousPanelState: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "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) => Promise<string>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.replacePanel.$1",
"type": "Object",
"tags": [],
"label": "previousPanelState",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
">"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.replacePanel.$2",
"type": "Object",
"tags": [],
"label": "newPanelState",
"description": [],
"signature": [
"{ type?: string | undefined; explicitInput?: (Partial<{ id: string; }> & { id: string; }) | undefined; }"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.replacePanel.$3",
"type": "CompoundType",
"tags": [],
"label": "generateNewId",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.showPlaceholderUntil",
"type": "Function",
"tags": [],
"label": "showPlaceholderUntil",
"description": [],
"signature": [
"<TPlacementMethodArgs extends ",
"IPanelPlacementArgs",
">(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
", 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/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"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/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.showPlaceholderUntil.$2",
"type": "Function",
"tags": [],
"label": "placementMethod",
"description": [],
"signature": [
"PanelPlacementMethod",
"<TPlacementMethodArgs> | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.showPlaceholderUntil.$3",
"type": "Uncategorized",
"tags": [],
"label": "placementArgs",
"description": [],
"signature": [
"TPlacementMethodArgs | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"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, any> = ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<EEI, EEO, any>>(this: ",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardContainer",
"text": "DashboardContainer"
},
", type: string, explicitInput: Partial<EEI>, embeddableId?: string | undefined) => Promise<string | ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable"
},
" | E>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$2",
"type": "Object",
"tags": [],
"label": "explicitInput",
"description": [],
"signature": [
"{ [P in keyof EEI]?: EEI[P] | undefined; }"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.addOrUpdateEmbeddable.$3",
"type": "string",
"tags": [],
"label": "embeddableId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/api/panel_management.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.forceRefresh",
"type": "Function",
"tags": [],
"label": "forceRefresh",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.onDataViewsUpdate$",
"type": "Object",
"tags": [],
"label": "onDataViewsUpdate$",
"description": [],
"signature": [
"Subject",
"<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.resetToLastSavedState",
"type": "Function",
"tags": [],
"label": "resetToLastSavedState",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getAllDataViews",
"type": "Function",
"tags": [],
"label": "getAllDataViews",
"description": [
"\nGets all the dataviews that are actively being used in the dashboard"
],
"signature": [
"() => ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [
"An array of dataviews"
]
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.setAllDataViews",
"type": "Function",
"tags": [],
"label": "setAllDataViews",
"description": [
"\nUse this to set the dataviews that are used in the dashboard when they change/update"
],
"signature": [
"(newDataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]) => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.setAllDataViews.$1",
"type": "Array",
"tags": [],
"label": "newDataViews",
"description": [
"The new array of dataviews that will overwrite the old dataviews array"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getExpandedPanelId",
"type": "Function",
"tags": [],
"label": "getExpandedPanelId",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.openOverlay",
"type": "Function",
"tags": [],
"label": "openOverlay",
"description": [],
"signature": [
"(ref: ",
{
"pluginId": "@kbn/core-mount-utils-browser",
"scope": "common",
"docId": "kibKbnCoreMountUtilsBrowserPluginApi",
"section": "def-common.OverlayRef",
"text": "OverlayRef"
},
") => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.openOverlay.$1",
"type": "Object",
"tags": [],
"label": "ref",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-mount-utils-browser",
"scope": "common",
"docId": "kibKbnCoreMountUtilsBrowserPluginApi",
"section": "def-common.OverlayRef",
"text": "OverlayRef"
}
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.clearOverlays",
"type": "Function",
"tags": [],
"label": "clearOverlays",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.setExpandedPanelId",
"type": "Function",
"tags": [],
"label": "setExpandedPanelId",
"description": [],
"signature": [
"(newId?: string | undefined) => void"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.setExpandedPanelId.$1",
"type": "string",
"tags": [],
"label": "newId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getPanelCount",
"type": "Function",
"tags": [],
"label": "getPanelCount",
"description": [],
"signature": [
"() => number"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainer.getPanelTitles",
"type": "Function",
"tags": [],
"label": "getPanelTitles",
"description": [],
"signature": [
"() => Promise<string[]>"
],
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "dashboard",
"id": "def-public.cleanEmptyKeys",
"type": "Function",
"tags": [],
"label": "cleanEmptyKeys",
"description": [],
"signature": [
"(stateObj: Record<string, unknown>) => Record<string, unknown>"
],
"path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.cleanEmptyKeys.$1",
"type": "Object",
"tags": [],
"label": "stateObj",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardFeatureFlagConfig",
"type": "Interface",
"tags": [],
"label": "DashboardFeatureFlagConfig",
"description": [],
"path": "src/plugins/dashboard/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardFeatureFlagConfig.allowByValueEmbeddables",
"type": "boolean",
"tags": [],
"label": "allowByValueEmbeddables",
"description": [],
"path": "src/plugins/dashboard/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "dashboard",
"id": "def-public.DASHBOARD_APP_ID",
"type": "string",
"tags": [],
"label": "DASHBOARD_APP_ID",
"description": [],
"signature": [
"\"dashboards\""
],
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
"deprecated": false,
"trackAdoption": 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/dashboard_container/index.ts",
"deprecated": false,
"trackAdoption": 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/dashboard_app/locator/locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardAppLocatorParams",
"type": "Type",
"tags": [],
"label": "DashboardAppLocatorParams",
"description": [],
"signature": [
"Partial<Omit<",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
", \"executionContext\" | \"panels\" | \"controlGroupInput\" | \"isEmbeddedExternally\">> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
" & ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
")[] | undefined; controlGroupInput?: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.SerializableControlGroupInput",
"text": "SerializableControlGroupInput"
},
" | undefined; }"
],
"path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.LEGACY_DASHBOARD_APP_ID",
"type": "string",
"tags": [],
"label": "LEGACY_DASHBOARD_APP_ID",
"description": [],
"signature": [
"\"dashboard\""
],
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "dashboard",
"id": "def-public.DashboardSetup",
"type": "Interface",
"tags": [],
"label": "DashboardSetup",
"description": [],
"path": "src/plugins/dashboard/public/plugin.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [
{
"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,
"trackAdoption": 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,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "dashboard",
"id": "def-server.findByValueEmbeddables",
"type": "Function",
"tags": [],
"label": "findByValueEmbeddables",
"description": [],
"signature": [
"(savedObjectClient: Pick<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.ISavedObjectsRepository",
"text": "ISavedObjectsRepository"
},
", \"find\">, embeddableType: string) => Promise<{ [key: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }[]>"
],
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-server.findByValueEmbeddables.$1",
"type": "Object",
"tags": [],
"label": "savedObjectClient",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.ISavedObjectsRepository",
"text": "ISavedObjectsRepository"
},
", \"find\">"
],
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels",
"type": "Function",
"tags": [],
"label": "convertPanelMapToSavedPanels",
"description": [],
"signature": [
"(panels: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
},
", version: string) => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"[]"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels.$1",
"type": "Object",
"tags": [],
"label": "panels",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels.$2",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel",
"type": "Function",
"tags": [],
"label": "convertPanelStateToSavedDashboardPanel",
"description": [],
"signature": [
"(panelState: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
">, version: string) => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel.$1",
"type": "Object",
"tags": [],
"label": "panelState",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
">"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel.$2",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedDashboardPanelToPanelState",
"type": "Function",
"tags": [],
"label": "convertSavedDashboardPanelToPanelState",
"description": [],
"signature": [
"(savedDashboardPanel: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
") => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<TEmbeddableInput>"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedDashboardPanelToPanelState.$1",
"type": "Object",
"tags": [],
"label": "savedDashboardPanel",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedPanelsToPanelMap",
"type": "Function",
"tags": [],
"label": "convertSavedPanelsToPanelMap",
"description": [],
"signature": [
"(panels?: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"[] | undefined) => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedPanelsToPanelMap.$1",
"type": "Array",
"tags": [],
"label": "panels",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"[] | undefined"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.createExtract",
"type": "Function",
"tags": [],
"label": "createExtract",
"description": [],
"signature": [
"(persistableStateService: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
},
") => (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: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }"
],
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.createExtract.$1",
"type": "Object",
"tags": [],
"label": "persistableStateService",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.createInject",
"type": "Function",
"tags": [],
"label": "createInject",
"description": [],
"signature": [
"(persistableStateService: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
},
") => (state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
", references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.createInject.$1",
"type": "Object",
"tags": [],
"label": "persistableStateService",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.extractReferences",
"type": "Function",
"tags": [],
"label": "extractReferences",
"description": [],
"signature": [
"({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ",
"ExtractDeps",
") => SavedObjectAttributesAndReferences"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.extractReferences.$1",
"type": "Object",
"tags": [],
"label": "{ attributes, references = [] }",
"description": [],
"signature": [
"SavedObjectAttributesAndReferences"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.extractReferences.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"ExtractDeps"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.injectReferences",
"type": "Function",
"tags": [],
"label": "injectReferences",
"description": [],
"signature": [
"({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ",
"InjectDeps",
") => ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.injectReferences.$1",
"type": "Object",
"tags": [],
"label": "{ attributes, references = [] }",
"description": [],
"signature": [
"SavedObjectAttributesAndReferences"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.injectReferences.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"InjectDeps"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes",
"type": "Interface",
"tags": [],
"label": "DashboardAttributes",
"description": [
"\nThe attributes of the dashboard saved object. This interface should be the\nsource of truth for the latest dashboard attributes shape after all migrations."
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.controlGroupInput",
"type": "CompoundType",
"tags": [],
"label": "controlGroupInput",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.RawControlGroupAttributes",
"text": "RawControlGroupAttributes"
},
" | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.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/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.timeRestore",
"type": "boolean",
"tags": [],
"label": "timeRestore",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.optionsJSON",
"type": "string",
"tags": [],
"label": "optionsJSON",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.useMargins",
"type": "CompoundType",
"tags": [],
"label": "useMargins",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.panelsJSON",
"type": "string",
"tags": [],
"label": "panelsJSON",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.timeFrom",
"type": "string",
"tags": [],
"label": "timeFrom",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.timeTo",
"type": "string",
"tags": [],
"label": "timeTo",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.kibanaSavedObjectMeta",
"type": "Object",
"tags": [],
"label": "kibanaSavedObjectMeta",
"description": [],
"signature": [
"{ searchSourceJSON: string; }"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities",
"type": "Interface",
"tags": [],
"label": "DashboardCapabilities",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities.showWriteControls",
"type": "boolean",
"tags": [],
"label": "showWriteControls",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities.saveQuery",
"type": "boolean",
"tags": [],
"label": "saveQuery",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities.createNew",
"type": "boolean",
"tags": [],
"label": "createNew",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities.show",
"type": "boolean",
"tags": [],
"label": "show",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardCapabilities.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: boolean",
"description": [],
"signature": [
"[key: string]: boolean"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput",
"type": "Interface",
"tags": [],
"label": "DashboardContainerByValueInput",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.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/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.timeRestore",
"type": "boolean",
"tags": [],
"label": "timeRestore",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.timeRange",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.timeslice",
"type": "Object",
"tags": [],
"label": "timeslice",
"description": [],
"signature": [
"[number, number] | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.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/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.viewMode",
"type": "Enum",
"tags": [],
"label": "viewMode",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.ViewMode",
"text": "ViewMode"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.isEmbeddedExternally",
"type": "CompoundType",
"tags": [],
"label": "isEmbeddedExternally",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.executionContext",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.hidePanelTitles",
"type": "boolean",
"tags": [],
"label": "hidePanelTitles",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.syncTooltips",
"type": "boolean",
"tags": [],
"label": "syncTooltips",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.useMargins",
"type": "boolean",
"tags": [],
"label": "useMargins",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.syncColors",
"type": "boolean",
"tags": [],
"label": "syncColors",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.syncCursor",
"type": "boolean",
"tags": [],
"label": "syncCursor",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.controlGroupInput",
"type": "Object",
"tags": [],
"label": "controlGroupInput",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.PersistableControlGroupInput",
"text": "PersistableControlGroupInput"
},
" | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByValueInput.panels",
"type": "Object",
"tags": [],
"label": "panels",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions",
"type": "Interface",
"tags": [],
"label": "DashboardOptions",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.hidePanelTitles",
"type": "boolean",
"tags": [],
"label": "hidePanelTitles",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.useMargins",
"type": "boolean",
"tags": [],
"label": "useMargins",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncColors",
"type": "boolean",
"tags": [],
"label": "syncColors",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncTooltips",
"type": "boolean",
"tags": [],
"label": "syncTooltips",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncCursor",
"type": "boolean",
"tags": [],
"label": "syncCursor",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelMap",
"type": "Interface",
"tags": [],
"label": "DashboardPanelMap",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelMap.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: DashboardPanelState<SavedObjectEmbeddableInput>",
"description": [],
"signature": [
"[key: string]: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
">"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState",
"type": "Interface",
"tags": [],
"label": "DashboardPanelState",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<TEmbeddableInput> extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.PanelState",
"text": "PanelState"
},
"<TEmbeddableInput>"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.gridData",
"type": "Object",
"tags": [],
"label": "gridData",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.GridData",
"text": "GridData"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.panelRefName",
"type": "string",
"tags": [],
"label": "panelRefName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData",
"type": "Interface",
"tags": [],
"label": "GridData",
"description": [
"\nGrid type for React Grid Layout"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.w",
"type": "number",
"tags": [],
"label": "w",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.h",
"type": "number",
"tags": [],
"label": "h",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.x",
"type": "number",
"tags": [],
"label": "x",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.y",
"type": "number",
"tags": [],
"label": "y",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.GridData.i",
"type": "string",
"tags": [],
"label": "i",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel",
"type": "Interface",
"tags": [],
"label": "SavedDashboardPanel",
"description": [
"\nA saved dashboard panel parsed directly from the Dashboard Attributes panels JSON"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.embeddableConfig",
"type": "Object",
"tags": [],
"label": "embeddableConfig",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
"; }"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.panelRefName",
"type": "string",
"tags": [],
"label": "panelRefName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.gridData",
"type": "Object",
"tags": [],
"label": "gridData",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.GridData",
"text": "GridData"
}
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.panelIndex",
"type": "string",
"tags": [],
"label": "panelIndex",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByReferenceInput",
"type": "Type",
"tags": [],
"label": "DashboardContainerByReferenceInput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
" & { panels: never; }"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerInput",
"type": "Type",
"tags": [],
"label": "DashboardContainerInput",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByValueInput"
},
" | ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByReferenceInput",
"text": "DashboardContainerByReferenceInput"
}
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.ParsedDashboardAttributes",
"type": "Type",
"tags": [],
"label": "ParsedDashboardAttributes",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardAttributes",
"text": "DashboardAttributes"
},
", \"panelsJSON\" | \"optionsJSON\"> & { panels: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"[]; options: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardOptions",
"text": "DashboardOptions"
},
"; }"
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SharedDashboardState",
"type": "Type",
"tags": [],
"label": "SharedDashboardState",
"description": [
"\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map"
],
"signature": [
"{ id?: string | undefined; tags?: string[] | undefined; description?: string | undefined; title?: string | undefined; query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | 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; executionContext?: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; viewMode?: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.ViewMode",
"text": "ViewMode"
},
" | undefined; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; timeslice?: [number, number] | undefined; controlGroupInput?: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.PersistableControlGroupInput",
"text": "PersistableControlGroupInput"
},
" | undefined; isEmbeddedExternally?: boolean | undefined; timeRestore?: boolean | undefined; useMargins?: boolean | undefined; panels?: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"[] | undefined; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}