{ "id": "dashboard", "client": { "classes": [], "functions": [ { "parentPluginId": "dashboard", "id": "def-public.cleanEmptyKeys", "type": "Function", "tags": [], "label": "cleanEmptyKeys", "description": [], "signature": [ "(stateObj: Record) => Record" ], "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" ], "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 } ], "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<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardContainerInput", "text": "DashboardContainerInput" }, ">) | 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", " | 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: ", "LoadDashboardFromSavedObjectReturn", ") => boolean) | 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": [ "LoadDashboardFromSavedObjectReturn" ], "path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "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 } ], "enums": [], "misc": [ { "parentPluginId": "dashboard", "id": "def-public.AwaitingDashboardAPI", "type": "Type", "tags": [], "label": "AwaitingDashboardAPI", "description": [], "signature": [ "DashboardContainer", " | 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.DashboardAPI", "type": "Type", "tags": [], "label": "DashboardAPI", "description": [], "signature": [ "DashboardContainer" ], "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.DashboardAppLocatorParams", "text": "DashboardAppLocatorParams" }, ">" ], "path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorParams", "type": "Type", "tags": [], "label": "DashboardAppLocatorParams", "description": [], "signature": [ "Partial> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, " & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ")[] | undefined; controlGroupInput?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.SerializableControlGroupInput", "text": "SerializableControlGroupInput" }, " | undefined; }" ], "path": "src/plugins/dashboard/public/dashboard_app/locator/locator.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-public.LEGACY_DASHBOARD_APP_ID", "type": "string", "tags": [], "label": "LEGACY_DASHBOARD_APP_ID", "description": [], "signature": [ "\"dashboard\"" ], "path": "src/plugins/dashboard/public/dashboard_constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "dashboard", "id": "def-public.DashboardSetup", "type": "Interface", "tags": [], "label": "DashboardSetup", "description": [], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardSetup.locator", "type": "Object", "tags": [], "label": "locator", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardAppLocator", "text": "DashboardAppLocator" }, " | undefined" ], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "dashboard", "id": "def-public.DashboardStart", "type": "Interface", "tags": [], "label": "DashboardStart", "description": [], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-public.DashboardStart.locator", "type": "Object", "tags": [], "label": "locator", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardAppLocator", "text": "DashboardAppLocator" }, " | undefined" ], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-public.DashboardStart.dashboardFeatureFlagConfig", "type": "Object", "tags": [], "label": "dashboardFeatureFlagConfig", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "public", "docId": "kibDashboardPluginApi", "section": "def-public.DashboardFeatureFlagConfig", "text": "DashboardFeatureFlagConfig" } ], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, "trackAdoption": false }, { "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": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [ { "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables", "type": "Function", "tags": [], "label": "findByValueEmbeddables", "description": [], "signature": [ "(savedObjectClient: Pick<", { "pluginId": "@kbn/core-saved-objects-api-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "section": "def-common.ISavedObjectsRepository", "text": "ISavedObjectsRepository" }, ", \"find\">, embeddableType: string) => Promise<{ [key: string]: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.Serializable", "text": "Serializable" }, "; }[]>" ], "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables.$1", "type": "Object", "tags": [], "label": "savedObjectClient", "description": [], "signature": [ "Pick<", { "pluginId": "@kbn/core-saved-objects-api-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "section": "def-common.ISavedObjectsRepository", "text": "ISavedObjectsRepository" }, ", \"find\">" ], "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "dashboard", "id": "def-server.findByValueEmbeddables.$2", "type": "string", "tags": [], "label": "embeddableType", "description": [], "signature": [ "string" ], "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "dashboard", "id": "def-server.DashboardPluginSetup", "type": "Interface", "tags": [], "label": "DashboardPluginSetup", "description": [], "path": "src/plugins/dashboard/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "dashboard", "id": "def-server.DashboardPluginStart", "type": "Interface", "tags": [], "label": "DashboardPluginStart", "description": [], "path": "src/plugins/dashboard/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "parentPluginId": "dashboard", "id": "def-common.convertPanelMapToSavedPanels", "type": "Function", "tags": [], "label": "convertPanelMapToSavedPanels", "description": [], "signature": [ "(panels: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" }, ", version: string) => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, "[]" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.convertPanelMapToSavedPanels.$1", "type": "Object", "tags": [], "label": "panels", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "dashboard", "id": "def-common.convertPanelMapToSavedPanels.$2", "type": "string", "tags": [], "label": "version", "description": [], "signature": [ "string" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.convertPanelStateToSavedDashboardPanel", "type": "Function", "tags": [], "label": "convertPanelStateToSavedDashboardPanel", "description": [], "signature": [ "(panelState: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelState", "text": "DashboardPanelState" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, ">, version: string) => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.convertPanelStateToSavedDashboardPanel.$1", "type": "Object", "tags": [], "label": "panelState", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelState", "text": "DashboardPanelState" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, ">" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "dashboard", "id": "def-common.convertPanelStateToSavedDashboardPanel.$2", "type": "string", "tags": [], "label": "version", "description": [], "signature": [ "string" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.convertSavedDashboardPanelToPanelState", "type": "Function", "tags": [], "label": "convertSavedDashboardPanelToPanelState", "description": [], "signature": [ "(savedDashboardPanel: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, ") => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelState", "text": "DashboardPanelState" }, "" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.convertSavedDashboardPanelToPanelState.$1", "type": "Object", "tags": [], "label": "savedDashboardPanel", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.convertSavedPanelsToPanelMap", "type": "Function", "tags": [], "label": "convertSavedPanelsToPanelMap", "description": [], "signature": [ "(panels?: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, "[] | undefined) => ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardPanelMap", "text": "DashboardPanelMap" } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.convertSavedPanelsToPanelMap.$1", "type": "Array", "tags": [], "label": "panels", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, "[] | undefined" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.createExtract", "type": "Function", "tags": [], "label": "createExtract", "description": [], "signature": [ "(persistableStateService: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddablePersistableStateService", "text": "EmbeddablePersistableStateService" }, ") => (state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ") => { state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.createExtract.$1", "type": "Object", "tags": [], "label": "persistableStateService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddablePersistableStateService", "text": "EmbeddablePersistableStateService" } ], "path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.createInject", "type": "Function", "tags": [], "label": "createInject", "description": [], "signature": [ "(persistableStateService: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddablePersistableStateService", "text": "EmbeddablePersistableStateService" }, ") => (state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.createInject.$1", "type": "Object", "tags": [], "label": "persistableStateService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddablePersistableStateService", "text": "EmbeddablePersistableStateService" } ], "path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.extractReferences", "type": "Function", "tags": [], "label": "extractReferences", "description": [], "signature": [ "({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ", "ExtractDeps", ") => SavedObjectAttributesAndReferences" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.extractReferences.$1", "type": "Object", "tags": [], "label": "{ attributes, references = [] }", "description": [], "signature": [ "SavedObjectAttributesAndReferences" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "dashboard", "id": "def-common.extractReferences.$2", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ "ExtractDeps" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.injectReferences", "type": "Function", "tags": [], "label": "injectReferences", "description": [], "signature": [ "({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ", "InjectDeps", ") => ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectAttributes", "text": "SavedObjectAttributes" } ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.injectReferences.$1", "type": "Object", "tags": [], "label": "{ attributes, references = [] }", "description": [], "signature": [ "SavedObjectAttributesAndReferences" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "dashboard", "id": "def-common.injectReferences.$2", "type": "Object", "tags": [], "label": "deps", "description": [], "signature": [ "InjectDeps" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes", "type": "Interface", "tags": [], "label": "DashboardAttributes", "description": [ "\nThe attributes of the dashboard saved object. This interface should be the\nsource of truth for the latest dashboard attributes shape after all migrations." ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.controlGroupInput", "type": "CompoundType", "tags": [], "label": "controlGroupInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" }, " | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.refreshInterval", "type": "Object", "tags": [], "label": "refreshInterval", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.timeRestore", "type": "boolean", "tags": [], "label": "timeRestore", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.optionsJSON", "type": "string", "tags": [], "label": "optionsJSON", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.useMargins", "type": "CompoundType", "tags": [], "label": "useMargins", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.panelsJSON", "type": "string", "tags": [], "label": "panelsJSON", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.timeFrom", "type": "string", "tags": [], "label": "timeFrom", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.version", "type": "number", "tags": [], "label": "version", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.timeTo", "type": "string", "tags": [], "label": "timeTo", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardAttributes.kibanaSavedObjectMeta", "type": "Object", "tags": [], "label": "kibanaSavedObjectMeta", "description": [], "signature": [ "{ searchSourceJSON: string; }" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities", "type": "Interface", "tags": [], "label": "DashboardCapabilities", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.showWriteControls", "type": "boolean", "tags": [], "label": "showWriteControls", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.saveQuery", "type": "boolean", "tags": [], "label": "saveQuery", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.createNew", "type": "boolean", "tags": [], "label": "createNew", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.show", "type": "boolean", "tags": [], "label": "show", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardCapabilities.Unnamed", "type": "IndexSignature", "tags": [], "label": "[key: string]: boolean", "description": [], "signature": [ "[key: string]: boolean" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.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": [ { "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.controlGroupInput", "type": "Object", "tags": [], "label": "controlGroupInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined" ], "path": "src/plugins/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.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", "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" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "" ], "path": "src/plugins/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelState.gridData", "type": "Object", "tags": [], "label": "gridData", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.GridData", "text": "GridData" } ], "path": "src/plugins/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.DashboardPanelState.panelRefName", "type": "string", "tags": [], "label": "panelRefName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.GridData", "type": "Interface", "tags": [], "label": "GridData", "description": [ "\nGrid type for React Grid Layout" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.GridData.w", "type": "number", "tags": [], "label": "w", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.GridData.h", "type": "number", "tags": [], "label": "h", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.GridData.x", "type": "number", "tags": [], "label": "x", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.GridData.y", "type": "number", "tags": [], "label": "y", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.GridData.i", "type": "string", "tags": [], "label": "i", "description": [], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel", "type": "Interface", "tags": [], "label": "SavedDashboardPanel", "description": [ "\nA saved dashboard panel parsed directly from the Dashboard Attributes panels JSON" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.embeddableConfig", "type": "Object", "tags": [], "label": "embeddableConfig", "description": [], "signature": [ "{ [key: string]: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.Serializable", "text": "Serializable" }, "; }" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.id", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.panelRefName", "type": "string", "tags": [], "label": "panelRefName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.gridData", "type": "Object", "tags": [], "label": "gridData", "description": [], "signature": [ { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.GridData", "text": "GridData" } ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.panelIndex", "type": "string", "tags": [], "label": "panelIndex", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.version", "type": "string", "tags": [], "label": "version", "description": [], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "dashboard", "id": "def-common.SavedDashboardPanel.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "dashboard", "id": "def-common.DashboardContainerByReferenceInput", "type": "Type", "tags": [], "label": "DashboardContainerByReferenceInput", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" } ], "path": "src/plugins/dashboard/common/dashboard_container/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.ParsedDashboardAttributes", "type": "Type", "tags": [], "label": "ParsedDashboardAttributes", "description": [], "signature": [ "Omit<", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardAttributes", "text": "DashboardAttributes" }, ", \"panelsJSON\" | \"optionsJSON\"> & { panels: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, "[]; options: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.DashboardOptions", "text": "DashboardOptions" }, "; }" ], "path": "src/plugins/dashboard/common/dashboard_saved_object/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dashboard", "id": "def-common.SharedDashboardState", "type": "Type", "tags": [], "label": "SharedDashboardState", "description": [ "\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map" ], "signature": [ "{ id?: string | undefined; tags?: string[] | undefined; description?: string | undefined; title?: string | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined; refreshInterval?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.RefreshInterval", "text": "RefreshInterval" }, " | undefined; filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined; executionContext?: ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined; viewMode?: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.ViewMode", "text": "ViewMode" }, " | undefined; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; timeslice?: [number, number] | undefined; controlGroupInput?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined; isEmbeddedExternally?: boolean | undefined; timeRestore?: boolean | undefined; useMargins?: boolean | undefined; panels?: ", { "pluginId": "dashboard", "scope": "common", "docId": "kibDashboardPluginApi", "section": "def-common.SavedDashboardPanel", "text": "SavedDashboardPanel" }, "[] | undefined; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "dashboard", "id": "def-common.UI_SETTINGS", "type": "Object", "tags": [], "label": "UI_SETTINGS", "description": [], "path": "src/plugins/dashboard/common/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dashboard", "id": "def-common.UI_SETTINGS.ENABLE_LABS_UI", "type": "string", "tags": [], "label": "ENABLE_LABS_UI", "description": [], "path": "src/plugins/dashboard/common/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ] } }