mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
2662 lines
No EOL
91 KiB
JSON
2662 lines
No EOL
91 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/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
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardListingTable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "DashboardListingTable",
|
|
"description": [],
|
|
"signature": [
|
|
"(props: ",
|
|
"DashboardListingProps",
|
|
") => JSX.Element"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_listing/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardListingTable.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardListingProps"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_listing/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardRenderer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "DashboardRenderer",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ForwardRefExoticComponent<",
|
|
"DashboardRendererProps",
|
|
" & React.RefAttributes<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.AwaitingDashboardAPI",
|
|
"text": "AwaitingDashboardAPI"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardRenderer.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardTopNav",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "DashboardTopNav",
|
|
"description": [],
|
|
"signature": [
|
|
"(props: ",
|
|
"DashboardTopNavProps",
|
|
") => JSX.Element"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_top_nav/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardTopNav.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardTopNavProps"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_top_nav/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.getDashboardLocatorParamsFromEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDashboardLocatorParamsFromEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesTimeRange",
|
|
"text": "PublishesTimeRange"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesFilters",
|
|
"text": "PublishesFilters"
|
|
},
|
|
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; } & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasParentApi",
|
|
"text": "HasParentApi"
|
|
},
|
|
"<Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesUnifiedSearch",
|
|
"text": "PublishesUnifiedSearch"
|
|
},
|
|
">>>, options: ",
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.DashboardDrilldownOptions",
|
|
"text": "DashboardDrilldownOptions"
|
|
},
|
|
") => Partial<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardLocatorParams",
|
|
"text": "DashboardLocatorParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_app/locator/get_dashboard_locator_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.getDashboardLocatorParamsFromEmbeddable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesTimeRange",
|
|
"text": "PublishesTimeRange"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesFilters",
|
|
"text": "PublishesFilters"
|
|
},
|
|
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; } & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasParentApi",
|
|
"text": "HasParentApi"
|
|
},
|
|
"<Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesUnifiedSearch",
|
|
"text": "PublishesUnifiedSearch"
|
|
},
|
|
">>>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_app/locator/get_dashboard_locator_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.getDashboardLocatorParamsFromEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "presentationUtil",
|
|
"scope": "public",
|
|
"docId": "kibPresentationUtilPluginApi",
|
|
"section": "def-public.DashboardDrilldownOptions",
|
|
"text": "DashboardDrilldownOptions"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_app/locator/get_dashboard_locator_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardCreationOptions",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.getInitialInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInitialInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Partial<",
|
|
"SavedDashboardInput",
|
|
">) | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.getIncomingEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncomingEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
},
|
|
" | undefined) | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.useSearchSessionsIntegration",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useSearchSessionsIntegration",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.searchSessionSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSessionSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"{ sessionIdToRestore?: string | undefined; sessionIdUrlChangeObservable?: ",
|
|
"Observable",
|
|
"<string | undefined> | undefined; getSearchSessionIdFromURL: () => string | undefined; removeSessionIdFromUrl: () => void; createSessionRestorationDataProvider: (container: ",
|
|
"DashboardContainer",
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.SearchSessionInfoProvider",
|
|
"text": "SearchSessionInfoProvider"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">; } | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.useControlGroupIntegration",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useControlGroupIntegration",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.useSessionStorageIntegration",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useSessionStorageIntegration",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.useUnifiedSearchIntegration",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "useUnifiedSearchIntegration",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.unifiedSearchSettings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "unifiedSearchSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kbnUrlStateStorage: ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.IKbnUrlStateStorage",
|
|
"text": "IKbnUrlStateStorage"
|
|
},
|
|
"; } | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.validateLoadedSavedObject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "validateLoadedSavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
"((result: ",
|
|
"LoadDashboardReturn",
|
|
") => \"valid\" | \"invalid\" | \"redirected\") | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.validateLoadedSavedObject.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [],
|
|
"signature": [
|
|
"LoadDashboardReturn"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.isEmbeddedExternally",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isEmbeddedExternally",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.getEmbeddableAppContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableAppContext",
|
|
"description": [],
|
|
"signature": [
|
|
"((dashboardId?: string | undefined) => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableAppContext",
|
|
"text": "EmbeddableAppContext"
|
|
},
|
|
") | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardCreationOptions.getEmbeddableAppContext.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "dashboardId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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.IProvidesLegacyPanelPlacementSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IProvidesLegacyPanelPlacementSettings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.IProvidesLegacyPanelPlacementSettings",
|
|
"text": "IProvidesLegacyPanelPlacementSettings"
|
|
},
|
|
"<InputType, AttributesType>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/panel_placement/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.IProvidesLegacyPanelPlacementSettings.getLegacyPanelPlacementSettings",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLegacyPanelPlacementSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: InputType, attributes?: AttributesType | undefined) => Partial<",
|
|
"PanelPlacementSettings",
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/panel_placement/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.IProvidesLegacyPanelPlacementSettings.getLegacyPanelPlacementSettings.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"InputType"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/panel_placement/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.IProvidesLegacyPanelPlacementSettings.getLegacyPanelPlacementSettings.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"AttributesType | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/panel_placement/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.PanelPlacementStrategy",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "PanelPlacementStrategy",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.AwaitingDashboardAPI",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "AwaitingDashboardAPI",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "public",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-public.DashboardAPI",
|
|
"text": "DashboardAPI"
|
|
},
|
|
" | null"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_api.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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.DASHBOARD_GRID_COLUMN_COUNT",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "DASHBOARD_GRID_COLUMN_COUNT",
|
|
"description": [],
|
|
"signature": [
|
|
"48"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardAPI",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardAPI",
|
|
"description": [],
|
|
"signature": [
|
|
"DashboardContainer",
|
|
" & Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasType",
|
|
"text": "HasType"
|
|
},
|
|
"<\"dashboard\"> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesTimeRange",
|
|
"text": "PublishesTimeRange"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesFilters",
|
|
"text": "PublishesFilters"
|
|
},
|
|
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; } & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesPanelTitle",
|
|
"text": "PublishesPanelTitle"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesSavedObjectId",
|
|
"text": "PublishesSavedObjectId"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_api.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.DashboardLocatorParams",
|
|
"text": "DashboardLocatorParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardLocatorParams",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardLocatorParams",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<Omit<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
", \"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_container/types.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
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.findDashboardsService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "findDashboardsService",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
"FindDashboardsService",
|
|
">"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.registerDashboardPanelPlacementSetting",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerDashboardPanelPlacementSetting",
|
|
"description": [],
|
|
"signature": [
|
|
"<SerializedState extends object = object>(embeddableType: string, getPanelPlacementSettings: ",
|
|
"GetPanelPlacementSettings",
|
|
"<SerializedState>) => void"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.registerDashboardPanelPlacementSetting.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-public.DashboardStart.registerDashboardPanelPlacementSetting.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPanelPlacementSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"GetPanelPlacementSettings",
|
|
"<SerializedState>"
|
|
],
|
|
"path": "src/plugins/dashboard/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"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"
|
|
},
|
|
", removeLegacyVersion?: boolean | undefined) => ",
|
|
{
|
|
"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": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeLegacyVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | 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.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"
|
|
},
|
|
">, removeLegacyVersion: boolean | undefined) => ",
|
|
{
|
|
"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": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeLegacyVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | 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.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 = [] }: ",
|
|
"DashboardAttributesAndReferences",
|
|
", deps: ",
|
|
"InjectExtractDeps",
|
|
") => ",
|
|
"DashboardAttributesAndReferences"
|
|
],
|
|
"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": [
|
|
"DashboardAttributesAndReferences"
|
|
],
|
|
"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": [
|
|
"InjectExtractDeps"
|
|
],
|
|
"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 = [] }: ",
|
|
"DashboardAttributesAndReferences",
|
|
", deps: ",
|
|
"InjectExtractDeps",
|
|
") => ",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.DashboardAttributes",
|
|
"text": "DashboardAttributes"
|
|
}
|
|
],
|
|
"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": [
|
|
"DashboardAttributesAndReferences"
|
|
],
|
|
"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": [
|
|
"InjectExtractDeps"
|
|
],
|
|
"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.prefixReferencesFromPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prefixReferencesFromPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string, references: ",
|
|
{
|
|
"pluginId": "@kbn/content-management-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnContentManagementUtilsPluginApi",
|
|
"section": "def-common.Reference",
|
|
"text": "Reference"
|
|
},
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "@kbn/content-management-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnContentManagementUtilsPluginApi",
|
|
"section": "def-common.Reference",
|
|
"text": "Reference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.prefixReferencesFromPanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.prefixReferencesFromPanel.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/content-management-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnContentManagementUtilsPluginApi",
|
|
"section": "def-common.Reference",
|
|
"text": "Reference"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"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.DashboardContainerInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DashboardContainerInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.DashboardContainerInput",
|
|
"text": "DashboardContainerInput"
|
|
},
|
|
" 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.DashboardContainerInput.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.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/common/dashboard_container/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.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/common/dashboard_container/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.executionContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "executionContext",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ",
|
|
{
|
|
"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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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.DashboardContainerInput.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": [
|
|
"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
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardPanelState.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThis version key was used to store Kibana version information from versions 7.3.0 -> 8.11.0.\nAs of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the\nembeddable's input. This key is needed for BWC, but its value will be removed on Dashboard save."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardPanelState.references",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [
|
|
"\nReact embeddables are serialized and may pass references that are later used in factory's deserialize method."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/content-management-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnContentManagementUtilsPluginApi",
|
|
"section": "def-common.Reference",
|
|
"text": "Reference"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/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/content_management/v1/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/content_management/v1/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/content_management/v1/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/common/content_management/v1/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/content_management/v1/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel.gridData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "gridData",
|
|
"description": [],
|
|
"signature": [
|
|
"GridData"
|
|
],
|
|
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel.panelIndex",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "panelIndex",
|
|
"description": [],
|
|
"path": "src/plugins/dashboard/common/content_management/v1/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/content_management/v1/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.SavedDashboardPanel.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [
|
|
"\nThis version key was used to store Kibana version information from versions 7.3.0 -> 8.11.0.\nAs of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the\nembeddable's input. (embeddableConfig in this type)."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "dashboard",
|
|
"id": "def-common.DashboardAttributes",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DashboardAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "dashboard",
|
|
"scope": "common",
|
|
"docId": "kibDashboardPluginApi",
|
|
"section": "def-common.DashboardAttributes",
|
|
"text": "DashboardAttributes"
|
|
},
|
|
", \"controlGroupInput\"> & { controlGroupInput?: ControlGroupAttributesV2 | undefined; }"
|
|
],
|
|
"path": "src/plugins/dashboard/common/content_management/v2/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/dashboard/common/dashboard_container/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; version?: string | undefined; tags?: string[] | undefined; title?: string | undefined; description?: string | undefined; viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; timeRestore?: boolean | 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; query?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | 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; 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; timeslice?: [number, number] | undefined; isEmbeddedExternally?: 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
|
|
}
|
|
]
|
|
}
|
|
} |