{ "id": "dashboard", "client": { "classes": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition", "type": "Class", "tags": [], "label": "DashboardAppLocatorDefinition", "description": [], "signature": [ "DashboardAppLocatorDefinition", " implements ", { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorDefinition", "text": "LocatorDefinition" }, "<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" }, ">" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "\"DASHBOARD_APP_LOCATOR\"" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition.Unnamed.$1", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ "DashboardAppLocatorDependencies" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition.getLocation", "type": "Function", "tags": [], "label": "getLocation", "description": [], "signature": [ "(params: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" }, ") => Promise<{ app: string; path: string; state: Record & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, "; }>" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorDefinition.getLocation.$1", "type": "CompoundType", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" } ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "dashboard", "id": "def-public.cleanEmptyKeys", "type": "Function", "tags": [], "label": "cleanEmptyKeys", "description": [], "signature": [ "(stateObj: Record) => Record" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.cleanEmptyKeys.$1", "type": "Object", "tags": [], "label": "stateObj", "description": [], "signature": [ "Record" ], "path": "src/platform/plugins/shared/dashboard/common/locator/locator.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardListingTable", "type": "Function", "tags": [], "label": "DashboardListingTable", "description": [], "signature": [ "(props: ", "DashboardListingProps", ") => React.JSX.Element" ], "path": "src/platform/plugins/shared/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/platform/plugins/shared/dashboard/public/dashboard_listing/index.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardTopNav", "type": "Function", "tags": [], "label": "DashboardTopNav", "description": [], "signature": [ "(props: ", "DashboardTopNavProps", ") => React.JSX.Element" ], "path": "src/platform/plugins/shared/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/platform/plugins/shared/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; canEditUnifiedSearch?: (() => 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" }, ">>, options: ", { "pluginId": "presentationUtil", "scope": "public", "docId": "kibPresentationUtilPluginApi", "section": "def-public.DashboardDrilldownOptions", "text": "DashboardDrilldownOptions" }, ") => Partial<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" }, ">" ], "path": "src/platform/plugins/shared/dashboard/common/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; canEditUnifiedSearch?: (() => 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" }, ">>" ], "path": "src/platform/plugins/shared/dashboard/common/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/platform/plugins/shared/dashboard/common/locator/get_dashboard_locator_params.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.LazyDashboardRenderer", "type": "Function", "tags": [], "label": "LazyDashboardRenderer", "description": [], "signature": [ "(props: ", { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardRendererProps", "text": "DashboardRendererProps" }, ") => React.JSX.Element" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/lazy_dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.LazyDashboardRenderer.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardRendererProps", "text": "DashboardRendererProps" } ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/lazy_dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions", "type": "Interface", "tags": [], "label": "DashboardCreationOptions", "description": [], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.getInitialInput", "type": "Function", "tags": [], "label": "getInitialInput", "description": [], "signature": [ "(() => Partial<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardState", "text": "DashboardState" }, ">) | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "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/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.useSearchSessionsIntegration", "type": "CompoundType", "tags": [], "label": "useSearchSessionsIntegration", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.searchSessionSettings", "type": "Object", "tags": [], "label": "searchSessionSettings", "description": [], "signature": [ "{ sessionIdToRestore?: string | undefined; sessionIdUrlChangeObservable?: ", "Observable", " | undefined; getSearchSessionIdFromURL: () => string | undefined; removeSessionIdFromUrl: () => void; createSessionRestorationDataProvider: (dashboardApi: ", { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardApi", "text": "DashboardApi" }, ") => ", { "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/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.useSessionStorageIntegration", "type": "CompoundType", "tags": [], "label": "useSessionStorageIntegration", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.useUnifiedSearchIntegration", "type": "CompoundType", "tags": [], "label": "useUnifiedSearchIntegration", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "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/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "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/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.validateLoadedSavedObject.$1", "type": "Object", "tags": [], "label": "result", "description": [], "signature": [ "LoadDashboardReturn" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.fullScreenMode", "type": "CompoundType", "tags": [], "label": "fullScreenMode", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.isEmbeddedExternally", "type": "CompoundType", "tags": [], "label": "isEmbeddedExternally", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "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/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardCreationOptions.getEmbeddableAppContext.$1", "type": "string", "tags": [], "label": "dashboardId", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps", "type": "Interface", "tags": [], "label": "DashboardRendererProps", "description": [], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.onApiAvailable", "type": "Function", "tags": [], "label": "onApiAvailable", "description": [], "signature": [ "((api: ", { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardApi", "text": "DashboardApi" }, ") => void) | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.onApiAvailable.$1", "type": "CompoundType", "tags": [], "label": "api", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardApi", "text": "DashboardApi" } ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.savedObjectId", "type": "string", "tags": [], "label": "savedObjectId", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.showPlainSpinner", "type": "CompoundType", "tags": [], "label": "showPlainSpinner", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.dashboardRedirect", "type": "Function", "tags": [], "label": "dashboardRedirect", "description": [], "signature": [ "DashboardRedirect", " | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.getCreationOptions", "type": "Function", "tags": [], "label": "getCreationOptions", "description": [], "signature": [ "(() => Promise<", { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardCreationOptions", "text": "DashboardCreationOptions" }, ">) | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardRendererProps.locator", "type": "Object", "tags": [], "label": "locator", "description": [], "signature": [ "Pick<", { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, "<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" }, ">, \"navigate\" | \"getRedirectUrl\"> | undefined" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_renderer/dashboard_renderer.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.SearchDashboardsResponse", "type": "Interface", "tags": [], "label": "SearchDashboardsResponse", "description": [], "path": "src/platform/plugins/shared/dashboard/public/services/dashboard_content_management_service/lib/find_dashboards.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.SearchDashboardsResponse.total", "type": "number", "tags": [], "label": "total", "description": [], "path": "src/platform/plugins/shared/dashboard/public/services/dashboard_content_management_service/lib/find_dashboards.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.SearchDashboardsResponse.hits", "type": "Array", "tags": [], "label": "hits", "description": [], "signature": [ "Readonly<{ error?: Readonly<{ metadata?: Readonly<{} & {}> | undefined; } & { error: string; message: string; statusCode: number; }> | undefined; version?: string | undefined; namespaces?: string[] | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; managed?: boolean | undefined; originId?: string | undefined; } & { id: string; type: string; attributes: Readonly<{ tags?: string[] | undefined; } & { title: string; description: string; timeRestore: boolean; }>; references: Readonly<{} & { id: string; type: string; name: string; }>[]; }>[]" ], "path": "src/platform/plugins/shared/dashboard/public/services/dashboard_content_management_service/lib/find_dashboards.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "dashboard", "id": "def-public.PanelPlacementStrategy", "type": "Enum", "tags": [], "label": "PanelPlacementStrategy", "description": [], "path": "src/platform/plugins/shared/dashboard/public/plugin_constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "dashboard", "id": "def-public.DASHBOARD_API_TYPE", "type": "string", "tags": [], "label": "DASHBOARD_API_TYPE", "description": [], "signature": [ "\"dashboard\"" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.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/platform/plugins/shared/dashboard/common/constants.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/platform/plugins/shared/dashboard/common/content_management/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardApi", "type": "Type", "tags": [], "label": "DashboardApi", "description": [], "signature": [ { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.CanExpandPanels", "text": "CanExpandPanels" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasAppContext", "text": "HasAppContext" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasExecutionContext", "text": "HasExecutionContext" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasRuntimeChildState", "text": "HasRuntimeChildState" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSaveNotification", "text": "HasSaveNotification" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSerializedChildState", "text": "HasSerializedChildState" }, " & ", { "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.HasUniqueId", "text": "HasUniqueId" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.PresentationContainer", "text": "PresentationContainer" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataLoading", "text": "PublishesDataLoading" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataViews", "text": "PublishesDataViews" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDescription", "text": "PublishesDescription" }, " & Pick<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesTitle", "text": "PublishesTitle" }, ", \"title$\"> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesReload", "text": "PublishesReload" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesSavedObjectId", "text": "PublishesSavedObjectId" }, " & ", { "pluginId": "@kbn/esql-types", "scope": "common", "docId": "kibKbnEsqlTypesPluginApi", "section": "def-common.PublishesESQLVariables", "text": "PublishesESQLVariables" }, " & ", "PublishesSearchSession", " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.PublishesSettings", "text": "PublishesSettings" }, " & ", { "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; canEditUnifiedSearch?: (() => 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.PublishesViewMode", "text": "PublishesViewMode" }, " & { setViewMode: (viewMode: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.ViewMode", "text": "ViewMode" }, ") => void; } & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.TrackContentfulRender", "text": "TrackContentfulRender" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.TracksOverlays", "text": "TracksOverlays" }, " & { asyncResetToLastSavedState: () => Promise; controlGroupApi$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupApi", "text": "ControlGroupApi" }, " | undefined>; fullScreenMode$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; focusedPanelId$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; setFocusedPanelId: (id: string | undefined) => void; forceRefresh: () => void; getSettings: () => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardSettings", "text": "DashboardSettings" }, "; getSerializedState: () => { attributes: ", { "pluginId": "dashboard", "scope": "server", "docId": "kibDashboardPluginApi", "section": "def-server.DashboardAttributes", "text": "DashboardAttributes" }, "; references: ", { "pluginId": "@kbn/content-management-utils", "scope": "server", "docId": "kibKbnContentManagementUtilsPluginApi", "section": "def-server.Reference", "text": "Reference" }, "[]; }; getDashboardPanelFromId: (id: string) => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelState", "text": "DashboardPanelState" }, "; hasOverlays$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; hasUnsavedChanges$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; highlightPanel: (panelRef: HTMLDivElement) => void; highlightPanelId$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; isEmbeddedExternally: boolean; isManaged: boolean; locator?: Pick<", { "pluginId": "share", "scope": "common", "docId": "kibSharePluginApi", "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, "<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardLocatorParams", "text": "DashboardLocatorParams" }, ">, \"navigate\" | \"getRedirectUrl\"> | undefined; panels$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" }, ">; runInteractiveSave: () => Promise<", "SaveDashboardReturn", " | undefined>; runQuickSave: () => Promise; scrollToPanel: (panelRef: HTMLDivElement) => void; scrollToPanelId$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; scrollToTop: () => void; setFilters: (filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined) => void; setFullScreenMode: (fullScreenMode: boolean) => void; setHighlightPanelId: (id: string | undefined) => void; setPanels: (panels: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" }, ") => void; setQuery: (query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined) => void; setScrollToPanelId: (id: string | undefined) => void; setSettings: (settings: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardSettings", "text": "DashboardSettings" }, ") => void; setTags: (tags: string[]) => void; setTimeRange: (timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined) => void; unifiedSearchFilters$: ", { "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.Filter", "text": "Filter" }, "[] | undefined>; untilEmbeddableLoaded: (id: string) => Promise; }" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.RedirectToProps", "type": "Type", "tags": [], "label": "RedirectToProps", "description": [], "signature": [ "{ destination: \"dashboard\"; id?: string | undefined; useReplace?: boolean | undefined; editMode?: boolean | undefined; } | { destination: \"listing\"; filter?: string | undefined; useReplace?: boolean | undefined; }" ], "path": "src/platform/plugins/shared/dashboard/public/dashboard_app/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "start": { "parentPluginId": "dashboard", "id": "def-public.DashboardStart", "type": "Interface", "tags": [], "label": "DashboardStart", "description": [], "path": "src/platform/plugins/shared/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardStart.findDashboardsService", "type": "Function", "tags": [], "label": "findDashboardsService", "description": [], "signature": [ "() => Promise<", "FindDashboardsService", ">" ], "path": "src/platform/plugins/shared/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "dashboard", "id": "def-public.DashboardStart.registerDashboardPanelPlacementSetting", "type": "Function", "tags": [], "label": "registerDashboardPanelPlacementSetting", "description": [], "signature": [ "(embeddableType: string, getPanelPlacementSettings: ", "GetPanelPlacementSettings", ") => void" ], "path": "src/platform/plugins/shared/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/platform/plugins/shared/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", "" ], "path": "src/platform/plugins/shared/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "dashboard", "id": "def-server.DashboardAttributes", "type": "Type", "tags": [], "label": "DashboardAttributes", "description": [], "signature": [ "Omit | undefined; timeFrom?: string | undefined; timeTo?: string | undefined; controlGroupInput?: Readonly<{ enhancements?: Record | undefined; } & { controls: Readonly<{ id?: string | undefined; controlConfig?: Record | undefined; } & { type: string; order: number; grow: boolean; width: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, "; }>[]; chainingSystem: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupChainingSystem", "text": "ControlGroupChainingSystem" }, "; labelPosition: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlLabelPosition", "text": "ControlLabelPosition" }, "; autoApplySelections: boolean; ignoreParentSettings: Readonly<{} & { ignoreFilters: boolean; ignoreQuery: boolean; ignoreTimerange: boolean; ignoreValidations: boolean; }>; }> | undefined; } & { options: Readonly<{} & { hidePanelTitles: boolean; useMargins: boolean; syncColors: boolean; syncTooltips: boolean; syncCursor: boolean; }>; title: string; description: string; kibanaSavedObjectMeta: Readonly<{ searchSource?: Readonly<{ type?: string | undefined; sort?: Record | Readonly<{ numeric_type?: \"date\" | \"date_nanos\" | \"long\" | \"double\" | undefined; } & { order: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SortDirection", "text": "SortDirection" }, "; }>>[] | undefined; filter?: Readonly<{ query?: Record | undefined; $state?: Readonly<{} & { store: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.FilterStateStore", "text": "FilterStateStore" }, "; }> | undefined; } & { meta: Readonly<{ params?: any; key?: string | undefined; value?: string | undefined; type?: string | undefined; alias?: string | null | undefined; index?: string | undefined; disabled?: boolean | undefined; field?: string | undefined; group?: string | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; isMultiIndex?: boolean | undefined; } & {}>; }>[] | undefined; query?: Readonly<{} & { query: string | Record; language: string; }> | undefined; } & {}> | undefined; } & {}>; timeRestore: boolean; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; }>, \"panels\"> & { panels: ", { "pluginId": "dashboard", "scope": "server", "docId": "kibDashboardPluginApi", "section": "def-server.DashboardPanel", "text": "DashboardPanel" }, "[]; }" ], "path": "src/platform/plugins/shared/dashboard/server/content_management/v3/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-server.DashboardAttributes", "type": "Type", "tags": [], "label": "DashboardAttributes", "description": [], "signature": [ "{ readonly version?: number | undefined; readonly timeRestore?: boolean | undefined; readonly refreshInterval?: Readonly<{ section?: number | undefined; display?: string | undefined; } & { value: number; pause: boolean; }> | undefined; readonly hits?: number | undefined; readonly timeFrom?: string | undefined; readonly timeTo?: string | undefined; readonly controlGroupInput?: Readonly<{ chainingSystem?: string | undefined; panelsJSON?: string | undefined; controlStyle?: string | undefined; ignoreParentSettingsJSON?: string | undefined; showApplySelections?: boolean | undefined; } & {}> | undefined; readonly optionsJSON?: string | undefined; readonly title: string; readonly description: string; readonly kibanaSavedObjectMeta: Readonly<{ searchSourceJSON?: string | undefined; } & {}>; readonly panelsJSON: string; }" ], "path": "src/platform/plugins/shared/dashboard/server/dashboard_saved_object/schema/v2/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-server.DashboardPanel", "type": "Type", "tags": [], "label": "DashboardPanel", "description": [], "signature": [ "Omit | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>, \"panelConfig\"> & { panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record | undefined; savedObjectId?: string | undefined; } & {}> & { [key: string]: any; }; gridData: ", "GridData", "; }" ], "path": "src/platform/plugins/shared/dashboard/server/content_management/v3/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-server.PUBLIC_API_PATH", "type": "string", "tags": [], "label": "PUBLIC_API_PATH", "description": [], "signature": [ "\"/api/dashboards/dashboard\"" ], "path": "src/platform/plugins/shared/dashboard/server/api/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "dashboard", "id": "def-server.DashboardPluginSetup", "type": "Interface", "tags": [], "label": "DashboardPluginSetup", "description": [], "path": "src/platform/plugins/shared/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/platform/plugins/shared/dashboard/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-server.DashboardPluginStart.getContentClient", "type": "Function", "tags": [], "label": "getContentClient", "description": [ "\nUse getContentClient().getForRequest to get a scoped client to perform CRUD and search operations for dashboards using the methods available in the {@link DashboardStorage} class.\n" ], "signature": [ "() => { getForRequest: ({ requestHandlerContext, version, }: { requestHandlerContext: ", "RequestHandlerContext", "; request: ", "KibanaRequest", "; version?: number | undefined; }) => ", "IContentClient", "; } | undefined" ], "path": "src/platform/plugins/shared/dashboard/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities", "type": "Interface", "tags": [], "label": "DashboardCapabilities", "description": [], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.showWriteControls", "type": "boolean", "tags": [], "label": "showWriteControls", "description": [], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.createNew", "type": "boolean", "tags": [], "label": "createNew", "description": [], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.show", "type": "boolean", "tags": [], "label": "show", "description": [], "path": "src/platform/plugins/shared/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/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelMap", "type": "Interface", "tags": [], "label": "DashboardPanelMap", "description": [], "path": "src/platform/plugins/shared/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", "description": [], "signature": [ "[key: string]: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelState", "text": "DashboardPanelState" }, "" ], "path": "src/platform/plugins/shared/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" }, "" ], "path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelState.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelState.explicitInput", "type": "Uncategorized", "tags": [], "label": "explicitInput", "description": [], "signature": [ "PanelState" ], "path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelState.gridData", "type": "CompoundType", "tags": [], "label": "gridData", "description": [], "signature": [ "Omit, \"i\"> & { readonly i: string; }" ], "path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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": "server", "docId": "kibKbnContentManagementUtilsPluginApi", "section": "def-server.Reference", "text": "Reference" }, "[] | undefined" ], "path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState", "type": "Interface", "tags": [], "label": "DashboardState", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardState", "text": "DashboardState" }, " extends ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardSettings", "text": "DashboardSettings" } ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardState.query", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.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/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.refreshInterval", "type": "Object", "tags": [], "label": "refreshInterval", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.viewMode", "type": "CompoundType", "tags": [], "label": "viewMode", "description": [], "signature": [ "\"edit\" | \"view\" | \"print\" | \"preview\"" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.panels", "type": "Object", "tags": [], "label": "panels", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" } ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.references", "type": "Array", "tags": [], "label": "references", "description": [ "\nTemporary. Currently Dashboards are in charge of providing references to all of their children.\nEventually this will be removed in favour of the Dashboard injecting references serverside." ], "signature": [ { "pluginId": "@kbn/content-management-utils", "scope": "server", "docId": "kibKbnContentManagementUtilsPluginApi", "section": "def-server.Reference", "text": "Reference" }, "[] | undefined" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.controlGroupInput", "type": "Object", "tags": [], "label": "controlGroupInput", "description": [ "\nSerialized control group state.\nContains state loaded from dashboard saved object" ], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupSerializedState", "text": "ControlGroupSerializedState" }, " | undefined" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardState.controlGroupState", "type": "Object", "tags": [], "label": "controlGroupState", "description": [ "\nRuntime control group state.\nContains state passed from dashboard locator\nUse runtime state when building input for portable dashboards" ], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.DefaultControlState", "text": "DefaultControlState" }, ">> | undefined" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.InjectExtractDeps", "type": "Interface", "tags": [], "label": "InjectExtractDeps", "description": [], "path": "src/platform/plugins/shared/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.InjectExtractDeps.embeddablePersistableStateService", "type": "Object", "tags": [], "label": "embeddablePersistableStateService", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ">" ], "path": "src/platform/plugins/shared/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardLocatorParams", "type": "Type", "tags": [], "label": "DashboardLocatorParams", "description": [], "signature": [ "Partial> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (Omit | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>, \"panelConfig\"> & { panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record | undefined; savedObjectId?: string | undefined; } & {}> & { [key: string]: any; }; gridData: ", "GridData", "; } & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ")[] | undefined; controlGroupState?: (Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.DefaultControlState", "text": "DefaultControlState" }, ">> & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ") | undefined; }" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardSettings", "type": "Type", "tags": [], "label": "DashboardSettings", "description": [], "signature": [ "Readonly<{} & { hidePanelTitles: boolean; useMargins: boolean; syncColors: boolean; syncTooltips: boolean; syncCursor: boolean; }> & { description?: string | undefined; tags: string[]; timeRestore: boolean; title: string; }" ], "path": "src/platform/plugins/shared/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }