{ "id": "embeddable", "client": { "classes": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer", "type": "Class", "tags": [], "label": "EmbeddableStateTransfer", "description": [ "\nA wrapper around the session storage which provides strongly typed helper methods\nfor common incoming and outgoing states used by the embeddable infrastructure.\n" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.isTransferInProgress", "type": "boolean", "tags": [], "label": "isTransferInProgress", "description": [], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$1", "type": "Function", "tags": [], "label": "navigateToApp", "description": [], "signature": [ "(appId: string, options?: ", "NavigateToAppOptions", " | undefined) => Promise" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$2", "type": "Object", "tags": [], "label": "currentAppId$", "description": [], "signature": [ "Observable", "" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$3", "type": "Object", "tags": [], "label": "appList", "description": [], "signature": [ "ReadonlyMap | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.Unnamed.$4", "type": "Object", "tags": [], "label": "customStorage", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.Storage", "text": "Storage" }, " | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getAppNameFromId", "type": "Function", "tags": [], "label": "getAppNameFromId", "description": [ "\nFetches an internationalized app title when given an appId." ], "signature": [ "(appId: string) => string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getAppNameFromId.$1", "type": "string", "tags": [], "label": "appId", "description": [ "- The id of the app to fetch the title for" ], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState", "type": "Function", "tags": [], "label": "getIncomingEditorState", "description": [ "\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" ], "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" }, " | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$1", "type": "string", "tags": [], "label": "appId", "description": [ "- The app to fetch incomingEditorState for" ], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$2", "type": "CompoundType", "tags": [], "label": "removeAfterFetch", "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.clearEditorState", "type": "Function", "tags": [], "label": "clearEditorState", "description": [ "\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" ], "signature": [ "(appId?: string | undefined) => void" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.clearEditorState.$1", "type": "string", "tags": [], "label": "appId", "description": [ "- The app to fetch incomingEditorState for" ], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage", "type": "Function", "tags": [], "label": "getIncomingEmbeddablePackage", "description": [ "\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n" ], "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" }, " | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$1", "type": "string", "tags": [], "label": "appId", "description": [ "- The app to fetch EmbeddablePackageState for" ], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$2", "type": "CompoundType", "tags": [], "label": "removeAfterFetch", "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor", "type": "Function", "tags": [], "label": "navigateToEditor", "description": [ "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}" ], "signature": [ "(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; skipAppLeave?: boolean | undefined; state: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" }, "; } | undefined) => Promise" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$1", "type": "string", "tags": [], "label": "appId", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.path", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.openInNewTab", "type": "CompoundType", "tags": [], "label": "openInNewTab", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.skipAppLeave", "type": "CompoundType", "tags": [], "label": "skipAppLeave", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" } ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage", "type": "Function", "tags": [], "label": "navigateToWithEmbeddablePackage", "description": [ "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}" ], "signature": [ "(appId: string, options?: { path?: string | undefined; state: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" }, "; } | undefined) => Promise" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$1", "type": "string", "tags": [], "label": "appId", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.path", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" } ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.PanelIncompatibleError", "type": "Class", "tags": [], "label": "PanelIncompatibleError", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.PanelIncompatibleError", "text": "PanelIncompatibleError" }, " extends Error" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_incompatible_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.PanelIncompatibleError.code", "type": "string", "tags": [], "label": "code", "description": [], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_incompatible_error.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.PanelIncompatibleError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_incompatible_error.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError", "type": "Class", "tags": [], "label": "PanelNotFoundError", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.PanelNotFoundError", "text": "PanelNotFoundError" }, " extends Error" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_not_found_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError.code", "type": "string", "tags": [], "label": "code", "description": [], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_not_found_error.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.PanelNotFoundError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/panel_not_found_error.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "embeddable", "id": "def-public.isMultiValueClickTriggerContext", "type": "Function", "tags": [], "label": "isMultiValueClickTriggerContext", "description": [], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, ") => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.MultiValueClickContext", "text": "MultiValueClickContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.isMultiValueClickTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.isRangeSelectTriggerContext", "type": "Function", "tags": [], "label": "isRangeSelectTriggerContext", "description": [], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, ") => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.RangeSelectContext", "text": "RangeSelectContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.isRowClickTriggerContext", "type": "Function", "tags": [], "label": "isRowClickTriggerContext", "description": [], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, ") => context is ", { "pluginId": "@kbn/ui-actions-browser", "scope": "common", "docId": "kibKbnUiActionsBrowserPluginApi", "section": "def-common.RowClickContext", "text": "RowClickContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.isRowClickTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.isValueClickTriggerContext", "type": "Function", "tags": [], "label": "isValueClickTriggerContext", "description": [], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, ") => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ValueClickContext", "text": "ValueClickContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.isValueClickTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.openAddFromLibraryFlyout", "type": "Function", "tags": [], "label": "openAddFromLibraryFlyout", "description": [], "signature": [ "({ container, onClose, }: { container: ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.CanAddNewPanel", "text": "CanAddNewPanel" }, "; onClose?: (() => void) | undefined; }) => ", "OverlayRef" ], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/open_add_from_library_flyout.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.openAddFromLibraryFlyout.$1", "type": "Object", "tags": [], "label": "{\n container,\n onClose,\n}", "description": [], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/open_add_from_library_flyout.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.openAddFromLibraryFlyout.$1.container", "type": "Object", "tags": [], "label": "container", "description": [], "signature": [ { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.CanAddNewPanel", "text": "CanAddNewPanel" } ], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/open_add_from_library_flyout.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.openAddFromLibraryFlyout.$1.onClose", "type": "Function", "tags": [], "label": "onClose", "description": [], "signature": [ "(() => void) | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/open_add_from_library_flyout.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer", "type": "Function", "tags": [], "label": "ReactEmbeddableRenderer", "description": [ "\nRenders a component from the React Embeddable registry into a Presentation Panel.\n\nTODO: Rename this to simply `Embeddable` when the legacy Embeddable system is removed." ], "signature": [ " = ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.DefaultEmbeddableApi", "text": "DefaultEmbeddableApi" }, ", ParentApi extends ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSerializedChildState", "text": "HasSerializedChildState" }, " = ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSerializedChildState", "text": "HasSerializedChildState" }, ">({ type, maybeId, getParentApi, panelProps, onAnyStateChange, onApiAvailable, hidePanelChrome, }: { type: string; maybeId?: string | undefined; getParentApi: () => ParentApi; onApiAvailable?: ((api: Api) => void) | undefined; panelProps?: Pick<", { "pluginId": "presentationPanel", "scope": "public", "docId": "kibPresentationPanelPluginApi", "section": "def-public.PresentationPanelProps", "text": "PresentationPanelProps" }, ", \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined; hidePanelChrome?: boolean | undefined; onAnyStateChange?: ((state: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, ") => void) | undefined; }) => React.JSX.Element" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1", "type": "Object", "tags": [], "label": "{\n type,\n maybeId,\n getParentApi,\n panelProps,\n onAnyStateChange,\n onApiAvailable,\n hidePanelChrome,\n}", "description": [], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.maybeId", "type": "string", "tags": [], "label": "maybeId", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.getParentApi", "type": "Function", "tags": [], "label": "getParentApi", "description": [], "signature": [ "() => ParentApi" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable", "type": "Function", "tags": [], "label": "onApiAvailable", "description": [], "signature": [ "((api: Api) => void) | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable.$1", "type": "Uncategorized", "tags": [], "label": "api", "description": [], "signature": [ "Api" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.panelProps", "type": "Object", "tags": [], "label": "panelProps", "description": [], "signature": [ "Pick<", { "pluginId": "presentationPanel", "scope": "public", "docId": "kibPresentationPanelPluginApi", "section": "def-public.PresentationPanelProps", "text": "PresentationPanelProps" }, ", \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.hidePanelChrome", "type": "CompoundType", "tags": [], "label": "hidePanelChrome", "description": [], "signature": [ "boolean | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange", "type": "Function", "tags": [], "label": "onAnyStateChange", "description": [ "\nThis `onAnyStateChange` callback allows the parent to keep track of the state of the embeddable\nas it changes. This is **not** expected to change over the lifetime of the component." ], "signature": [ "((state: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, ") => void) | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.useAddFromLibraryTypes", "type": "Function", "tags": [], "label": "useAddFromLibraryTypes", "description": [], "signature": [ "() => ", { "pluginId": "savedObjectsFinder", "scope": "public", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-public.SavedObjectMetaData", "text": "SavedObjectMetaData" }, "<", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">[]" ], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "embeddable", "id": "def-public.DefaultEmbeddableApi", "type": "Interface", "tags": [], "label": "DefaultEmbeddableApi", "description": [ "\nThe default embeddable API that all Embeddables must implement.\n\nBefore adding anything to this interface, please be certain that it belongs in *every* embeddable." ], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.DefaultEmbeddableApi", "text": "DefaultEmbeddableApi" }, " extends ", "DefaultPresentationPanelApi", ",", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasType", "text": "HasType" }, ",", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesPhaseEvents", "text": "PublishesPhaseEvents" }, ",Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnsavedChanges", "text": "PublishesUnsavedChanges" }, ">,", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasSerializableState", "text": "HasSerializableState" }, ",", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasSnapshottableState", "text": "HasSnapshottableState" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState", "type": "Interface", "tags": [], "label": "EmbeddableEditorState", "description": [ "\nA state package that contains information an editor will need to create or edit an embeddable then redirect back." ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.originatingApp", "type": "string", "tags": [], "label": "originatingApp", "description": [], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.originatingPath", "type": "string", "tags": [], "label": "originatingPath", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.embeddableId", "type": "string", "tags": [], "label": "embeddableId", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.valueInput", "type": "Uncategorized", "tags": [], "label": "valueInput", "description": [], "signature": [ "object | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableEditorState.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session" ], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState", "type": "Interface", "tags": [], "label": "EmbeddablePackageState", "description": [ "\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container." ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.type", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.input", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "\nFor react embeddables, this input must be runtime state." ], "signature": [ "object" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.embeddableId", "type": "string", "tags": [], "label": "embeddableId", "description": [], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.size", "type": "Object", "tags": [], "label": "size", "description": [], "signature": [ "{ width?: number | undefined; height?: number | undefined; } | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePackageState.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [ "\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session" ], "signature": [ "string | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.EnhancementRegistryDefinition", "type": "Interface", "tags": [], "label": "EnhancementRegistryDefinition", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "

extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "

>" ], "path": "src/platform/plugins/shared/embeddable/public/enhancements/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EnhancementRegistryDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/enhancements/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory", "type": "Interface", "tags": [], "label": "ReactEmbeddableFactory", "description": [ "\nThe React Embeddable Factory interface is used to register a series of functions that\ncreate and manage an embeddable instance.\n\nEmbeddables are React components that manage their own state, can be serialized and\ndeserialized, and return an API that can be used to interact with them imperatively." ], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ReactEmbeddableFactory", "text": "ReactEmbeddableFactory" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.type", "type": "string", "tags": [], "label": "type", "description": [ "\nA unique key for the type of this embeddable. The React Embeddable Renderer will use this type\nto find this factory." ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.deserializeState", "type": "Function", "tags": [], "label": "deserializeState", "description": [ "\nA required asynchronous function that transforms serialized state into runtime state.\n\nThis could be used to:\n- Load state from some external store\n- Inject references provided by the parent\n- Migrate the state to a newer version (this must be undone when serializing)" ], "signature": [ "(panelState: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, ") => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.MaybePromise", "text": "MaybePromise" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.deserializeState.$1", "type": "Object", "tags": [], "label": "panelState", "description": [], "signature": [ { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable", "type": "Function", "tags": [], "label": "buildEmbeddable", "description": [ "\nA required async function that builds your embeddable component and a linked API instance. The API\nand component will be combined together by the ReactEmbeddableRenderer. Initial state will contain the result of\nthe deserialize function.\n\nThe returned API must extend {@link HasSerializableState} which does the opposite of the deserializeState\nfunction." ], "signature": [ "(initialRuntimeState: RuntimeState, buildApi: (apiRegistration: ", "BuildReactEmbeddableApiRegistration", ", comparators: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.StateComparators", "text": "StateComparators" }, ") => Api & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasSnapshottableState", "text": "HasSnapshottableState" }, ", uuid: string, parentApi: unknown, setApi: (api: ", "SetReactEmbeddableApiRegistration", ") => Api, lastSavedRuntimeState: RuntimeState) => Promise<{ Component: React.FC<{}>; api: Api; }>" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$1", "type": "Uncategorized", "tags": [], "label": "initialRuntimeState", "description": [], "signature": [ "RuntimeState" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$2", "type": "Function", "tags": [], "label": "buildApi", "description": [], "signature": [ "(apiRegistration: ", "BuildReactEmbeddableApiRegistration", ", comparators: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.StateComparators", "text": "StateComparators" }, ") => Api & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasSnapshottableState", "text": "HasSnapshottableState" }, "" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$3", "type": "string", "tags": [], "label": "uuid", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$4", "type": "Unknown", "tags": [], "label": "parentApi", "description": [], "signature": [ "unknown" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$5", "type": "Function", "tags": [], "label": "setApi", "description": [], "signature": [ "(api: ", "SetReactEmbeddableApiRegistration", ") => Api" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", "id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$6", "type": "Uncategorized", "tags": [], "label": "lastSavedRuntimeState", "description": [], "signature": [ "RuntimeState" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "embeddable", "id": "def-public.ViewMode", "type": "Enum", "tags": [], "label": "ViewMode", "description": [], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "embeddable", "id": "def-public.CELL_VALUE_TRIGGER", "type": "string", "tags": [], "label": "CELL_VALUE_TRIGGER", "description": [], "signature": [ "\"CELL_VALUE_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.CellValueContext", "type": "Type", "tags": [], "label": "CellValueContext", "description": [], "signature": [ "Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.EmbeddableApiContext", "text": "EmbeddableApiContext" }, "> & { data: { value?: any; eventId?: string | undefined; columnMeta?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" }, " | undefined; }[]; }" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ChartActionContext", "type": "Type", "tags": [], "label": "ChartActionContext", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ValueClickContext", "text": "ValueClickContext" }, " | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.RangeSelectContext", "text": "RangeSelectContext" }, " | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.MultiValueClickContext", "text": "MultiValueClickContext" }, " | ", { "pluginId": "@kbn/ui-actions-browser", "scope": "common", "docId": "kibKbnUiActionsBrowserPluginApi", "section": "def-common.RowClickContext", "text": "RowClickContext" } ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.CONTEXT_MENU_TRIGGER", "type": "string", "tags": [], "label": "CONTEXT_MENU_TRIGGER", "description": [], "signature": [ "\"CONTEXT_MENU_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.MULTI_VALUE_CLICK_TRIGGER", "type": "string", "tags": [], "label": "MULTI_VALUE_CLICK_TRIGGER", "description": [], "signature": [ "\"MULTI_VALUE_CLICK_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.MultiValueClickContext", "type": "Type", "tags": [], "label": "MultiValueClickContext", "description": [], "signature": [ "Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.EmbeddableApiContext", "text": "EmbeddableApiContext" }, "> & { data: { data: { table: Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", \"columns\" | \"rows\">; cells: { column: number; row: number; }[]; relation?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.BooleanRelation", "text": "BooleanRelation" }, " | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.PANEL_BADGE_TRIGGER", "type": "string", "tags": [], "label": "PANEL_BADGE_TRIGGER", "description": [], "signature": [ "\"PANEL_BADGE_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.PANEL_NOTIFICATION_TRIGGER", "type": "string", "tags": [], "label": "PANEL_NOTIFICATION_TRIGGER", "description": [], "signature": [ "\"PANEL_NOTIFICATION_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.RangeSelectContext", "type": "Type", "tags": [], "label": "RangeSelectContext", "description": [], "signature": [ "Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.EmbeddableApiContext", "text": "EmbeddableApiContext" }, "> & { data: { table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, "; column: number; range: number[]; timeFieldName?: string | undefined; }; }" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.SELECT_RANGE_TRIGGER", "type": "string", "tags": [], "label": "SELECT_RANGE_TRIGGER", "description": [], "signature": [ "\"SELECT_RANGE_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.VALUE_CLICK_TRIGGER", "type": "string", "tags": [], "label": "VALUE_CLICK_TRIGGER", "description": [], "signature": [ "\"VALUE_CLICK_TRIGGER\"" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ValueClickContext", "type": "Type", "tags": [], "label": "ValueClickContext", "description": [], "signature": [ "Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.EmbeddableApiContext", "text": "EmbeddableApiContext" }, "> & { data: { data: { table: Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", \"columns\" | \"rows\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_ANNOTATION_GROUP", "type": "Object", "tags": [], "label": "ADD_PANEL_ANNOTATION_GROUP", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_ANNOTATION_GROUP.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_ANNOTATION_GROUP.getDisplayName", "type": "Function", "tags": [], "label": "getDisplayName", "description": [], "signature": [ "() => string" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_ANNOTATION_GROUP.order", "type": "number", "tags": [], "label": "order", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_OTHER_GROUP", "type": "Object", "tags": [], "label": "ADD_PANEL_OTHER_GROUP", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_OTHER_GROUP.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_OTHER_GROUP.getDisplayName", "type": "Function", "tags": [], "label": "getDisplayName", "description": [], "signature": [ "() => string" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_OTHER_GROUP.getIconType", "type": "Function", "tags": [], "label": "getIconType", "description": [], "signature": [ "() => string" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_OTHER_GROUP.order", "type": "number", "tags": [], "label": "order", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_VISUALIZATION_GROUP", "type": "Object", "tags": [], "label": "ADD_PANEL_VISUALIZATION_GROUP", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_VISUALIZATION_GROUP.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_VISUALIZATION_GROUP.getDisplayName", "type": "Function", "tags": [], "label": "getDisplayName", "description": [], "signature": [ "() => string" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_VISUALIZATION_GROUP.getIconType", "type": "Function", "tags": [], "label": "getIconType", "description": [], "signature": [ "() => string" ], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-public.ADD_PANEL_VISUALIZATION_GROUP.order", "type": "number", "tags": [], "label": "order", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/add_panel_groups.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.cellValueTrigger", "type": "Object", "tags": [], "label": "cellValueTrigger", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.cellValueTrigger.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.cellValueTrigger.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.cellValueTrigger.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger", "type": "Object", "tags": [], "label": "contextMenuTrigger", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.contextMenuTrigger.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger", "type": "Object", "tags": [], "label": "panelBadgeTrigger", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.panelBadgeTrigger.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger", "type": "Object", "tags": [], "label": "panelNotificationTrigger", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.title", "type": "string", "tags": [], "label": "title", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.panelNotificationTrigger.description", "type": "string", "tags": [], "label": "description", "description": [], "path": "src/platform/plugins/shared/embeddable/public/ui_actions/triggers.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "setup": { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup", "type": "Interface", "tags": [], "label": "EmbeddableSetup", "description": [], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerAddFromLibraryType", "type": "Function", "tags": [], "label": "registerAddFromLibraryType", "description": [ "\nRegister a saved object type with the \"Add from library\" flyout.\n" ], "signature": [ "({ onAdd, savedObjectType, savedObjectName, getIconForSavedObject, getSavedObjectSubType, getTooltipForSavedObject, }: { onAdd: (container: ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.CanAddNewPanel", "text": "CanAddNewPanel" }, ", savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, "<", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">) => void; savedObjectType: string; savedObjectName: string; getIconForSavedObject: (savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => ", "IconType", "; getSavedObjectSubType?: ((savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => string) | undefined; getTooltipForSavedObject?: ((savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => string) | undefined; }) => void" ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerAddFromLibraryType.$1", "type": "Object", "tags": [], "label": "__0", "description": [], "signature": [ "{ onAdd: (container: ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.CanAddNewPanel", "text": "CanAddNewPanel" }, ", savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, "<", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">) => void; savedObjectType: string; savedObjectName: string; getIconForSavedObject: (savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => ", "IconType", "; getSavedObjectSubType?: ((savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => string) | undefined; getTooltipForSavedObject?: ((savedObject: ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.SavedObjectCommon", "text": "SavedObjectCommon" }, ") => string) | undefined; }" ], "path": "src/platform/plugins/shared/embeddable/public/add_from_library/registry.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory", "type": "Function", "tags": [], "label": "registerReactEmbeddableFactory", "description": [ "\nRegisters an async {@link ReactEmbeddableFactory} getter." ], "signature": [ " = ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.DefaultEmbeddableApi", "text": "DefaultEmbeddableApi" }, ">(type: string, getFactory: () => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ReactEmbeddableFactory", "text": "ReactEmbeddableFactory" }, ">) => void" ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory.$1", "type": "string", "tags": [], "label": "type", "description": [], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_registry.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory.$2", "type": "Function", "tags": [], "label": "getFactory", "description": [], "signature": [ "() => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ReactEmbeddableFactory", "text": "ReactEmbeddableFactory" }, ">" ], "path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_registry.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] } ] }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerEnhancement", "type": "Function", "tags": [ "deprecated" ], "label": "registerEnhancement", "description": [], "signature": [ "(enhancement: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ">) => void" ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "uiActionsEnhanced", "path": "src/platform/plugins/shared/ui_actions_enhanced/public/plugin.ts" } ], "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetup.registerEnhancement.$1", "type": "Object", "tags": [], "label": "enhancement", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ">" ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart", "type": "Interface", "tags": [], "label": "EmbeddableStart", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableStart", "text": "EmbeddableStart" }, " extends ", { "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/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getStateTransfer", "type": "Function", "tags": [], "label": "getStateTransfer", "description": [], "signature": [ "(storage?: ", { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.Storage", "text": "Storage" }, " | undefined) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableStateTransfer", "text": "EmbeddableStateTransfer" } ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getStateTransfer.$1", "type": "Object", "tags": [], "label": "storage", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.Storage", "text": "Storage" }, " | undefined" ], "path": "src/platform/plugins/shared/embeddable/public/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "embeddable", "id": "def-server.EmbeddableRegistryDefinition", "type": "Interface", "tags": [], "label": "EmbeddableRegistryDefinition", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "

extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "

>" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-server.EmbeddableRegistryDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-server.EnhancementRegistryDefinition", "type": "Interface", "tags": [], "label": "EnhancementRegistryDefinition", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "

extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "

>" ], "path": "src/platform/plugins/shared/embeddable/server/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-server.EnhancementRegistryDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/server/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup", "type": "Interface", "tags": [], "label": "EmbeddableSetup", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EmbeddableSetup", "text": "EmbeddableSetup" }, " extends ", { "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/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEmbeddableFactory", "type": "Function", "tags": [], "label": "registerEmbeddableFactory", "description": [], "signature": [ "(factory: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ">) => void" ], "path": "src/platform/plugins/shared/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEmbeddableFactory.$1", "type": "Object", "tags": [], "label": "factory", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ">" ], "path": "src/platform/plugins/shared/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEnhancement", "type": "Function", "tags": [], "label": "registerEnhancement", "description": [], "signature": [ "(enhancement: ", { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ">) => void" ], "path": "src/platform/plugins/shared/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.registerEnhancement.$1", "type": "Object", "tags": [], "label": "enhancement", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ">" ], "path": "src/platform/plugins/shared/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-server.EmbeddableSetup.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/platform/plugins/shared/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "embeddable", "id": "def-server.EmbeddableStart", "type": "Type", "tags": [], "label": "EmbeddableStart", "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/embeddable/server/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "parentPluginId": "embeddable", "id": "def-common.isSavedObjectEmbeddableInput", "type": "Function", "tags": [], "label": "isSavedObjectEmbeddableInput", "description": [], "signature": [ "(input: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ") => boolean" ], "path": "src/platform/plugins/shared/embeddable/common/lib/saved_object_embeddable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.isSavedObjectEmbeddableInput.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "path": "src/platform/plugins/shared/embeddable/common/lib/saved_object_embeddable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract", "type": "Interface", "tags": [], "label": "CommonEmbeddableStartContract", "description": [], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", "type": "Function", "tags": [], "label": "getEmbeddableFactory", "description": [], "signature": [ "((embeddableFactoryId: string) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, "> & { isContainerType: boolean; }) | undefined" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory.$1", "type": "string", "tags": [], "label": "embeddableFactoryId", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEnhancement", "type": "Function", "tags": [], "label": "getEnhancement", "description": [], "signature": [ "(enhancementId: string) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ">" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.CommonEmbeddableStartContract.getEnhancement.$1", "type": "string", "tags": [], "label": "enhancementId", "description": [], "signature": [ "string" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-common.EmbeddableRegistryDefinition", "type": "Interface", "tags": [], "label": "EmbeddableRegistryDefinition", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "

extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "

>" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.EmbeddableRegistryDefinition.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-common.SavedObjectEmbeddableInput", "type": "Interface", "tags": [], "label": "SavedObjectEmbeddableInput", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "path": "src/platform/plugins/shared/embeddable/common/lib/saved_object_embeddable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", "id": "def-common.SavedObjectEmbeddableInput.savedObjectId", "type": "string", "tags": [], "label": "savedObjectId", "description": [], "path": "src/platform/plugins/shared/embeddable/common/lib/saved_object_embeddable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "embeddable", "id": "def-common.ViewMode", "type": "Enum", "tags": [], "label": "ViewMode", "description": [], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "embeddable", "id": "def-common.EmbeddableInput", "type": "Type", "tags": [], "label": "EmbeddableInput", "description": [], "signature": [ "{ version?: string | undefined; viewMode?: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.ViewMode", "text": "ViewMode" }, " | undefined; title?: string | undefined; description?: string | undefined; id: string; 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; executionContext?: ", "KibanaExecutionContext", " | undefined; }" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-common.EmbeddablePersistableStateService", "type": "Type", "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/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "embeddable", "id": "def-common.EmbeddableStateWithType", "type": "Type", "tags": [], "label": "EmbeddableStateWithType", "description": [], "signature": [ "{ enhancements?: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, " | undefined; type: string; }" ], "path": "src/platform/plugins/shared/embeddable/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }