kibana/api_docs/dashboard.devdocs.json
2022-10-29 00:46:56 -04:00

2214 lines
No EOL
72 KiB
JSON

{
"id": "dashboard",
"client": {
"classes": [],
"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/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/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.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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.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/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.isFullScreenMode",
"type": "boolean",
"tags": [],
"label": "isFullScreenMode",
"description": [],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.timeslice",
"type": "Object",
"tags": [],
"label": "timeslice",
"description": [],
"signature": [
"[number, number] | undefined"
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.timeRestore",
"type": "boolean",
"tags": [],
"label": "timeRestore",
"description": [],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.useMargins",
"type": "boolean",
"tags": [],
"label": "useMargins",
"description": [],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.syncTooltips",
"type": "CompoundType",
"tags": [],
"label": "syncTooltips",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.syncCursor",
"type": "CompoundType",
"tags": [],
"label": "syncCursor",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/dashboard/public/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.panels",
"type": "Object",
"tags": [],
"label": "panels",
"description": [],
"signature": [
"{ [panelId: string]: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardContainerInput.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/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"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
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel",
"type": "Interface",
"tags": [],
"label": "SavedDashboardPanel",
"description": [
"\nA saved dashboard panel parsed directly from the Dashboard Attributes panels JSON"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.embeddableConfig",
"type": "Object",
"tags": [],
"label": "embeddableConfig",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.Serializable",
"text": "Serializable"
},
"; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.panelRefName",
"type": "string",
"tags": [],
"label": "panelRefName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.panelIndex",
"type": "string",
"tags": [],
"label": "panelIndex",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.SavedDashboardPanel.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "dashboard",
"id": "def-public.DASHBOARD_CONTAINER_TYPE",
"type": "string",
"tags": [],
"label": "DASHBOARD_CONTAINER_TYPE",
"description": [],
"signature": [
"\"dashboard\""
],
"path": "src/plugins/dashboard/public/dashboard_constants.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/locator.ts",
"deprecated": false,
"trackAdoption": 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": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"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.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
" & ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
")[] | undefined; savedQuery?: string | undefined; tags?: string[] | undefined; options?: ",
"DashboardOptions",
" | undefined; controlGroupInput?: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.SerializableControlGroupInput",
"text": "SerializableControlGroupInput"
},
" | undefined; }"
],
"path": "src/plugins/dashboard/public/locator.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardConstants.PRINT_DASHBOARD_URL",
"type": "string",
"tags": [],
"label": "PRINT_DASHBOARD_URL",
"description": [],
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardConstants.DASHBOARD_SAVED_OBJECT_TYPE",
"type": "string",
"tags": [],
"label": "DASHBOARD_SAVED_OBJECT_TYPE",
"description": [],
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"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.getDashboardContainerByValueRenderer",
"type": "Function",
"tags": [],
"label": "getDashboardContainerByValueRenderer",
"description": [],
"signature": [
"() => React.FC<Props>"
],
"path": "src/plugins/dashboard/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"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": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.ISavedObjectsRepository",
"text": "ISavedObjectsRepository"
},
", \"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,
"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": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.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/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/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/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/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/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/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/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/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/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/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/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/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.timeRestore",
"type": "boolean",
"tags": [],
"label": "timeRestore",
"description": [],
"path": "src/plugins/dashboard/common/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/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.panelsJSON",
"type": "string",
"tags": [],
"label": "panelsJSON",
"description": [],
"path": "src/plugins/dashboard/common/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.version",
"type": "number",
"tags": [],
"label": "version",
"description": [],
"path": "src/plugins/dashboard/common/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/dashboard/common/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/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerStateWithType",
"type": "Interface",
"tags": [],
"label": "DashboardContainerStateWithType",
"description": [
"--------------------------------------------------------------------\nDashboard container types\n -----------------------------------------------------------------------\n\nTypes below this line are copied here because so many important types are tied up in public. These types should be\nmoved from public into common."
],
"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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerStateWithType.panels",
"type": "Object",
"tags": [],
"label": "panels",
"description": [],
"signature": [
"{ [panelId: string]: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "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,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerStateWithType.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/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/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/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState",
"type": "Interface",
"tags": [],
"label": "DashboardPanelState",
"description": [
"--------------------------------------------------------------------\nDashboard panel types\n -----------------------------------------------------------------------\n\nThe dashboard panel format expected by the embeddable container."
],
"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/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/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/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/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": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.Serializable",
"text": "Serializable"
},
"; }"
],
"path": "src/plugins/dashboard/common/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/dashboard/common/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/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/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.panelIndex",
"type": "string",
"tags": [],
"label": "panelIndex",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "src/plugins/dashboard/common/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/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"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
}
]
}
}