{ "id": "embeddable", "client": { "classes": [ { "id": "def-public.AddPanelAction", "type": "Class", "tags": [], "label": "AddPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.AddPanelAction", "text": "AddPanelAction" }, " implements ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.Action", "text": "Action" }, "" ], "children": [ { "tags": [], "id": "def-public.AddPanelAction.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 24 }, "signature": [ "\"ACTION_ADD_PANEL\"" ] }, { "tags": [], "id": "def-public.AddPanelAction.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 25 }, "signature": [ "\"ACTION_ADD_PANEL\"" ] }, { "id": "def-public.AddPanelAction.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Function", "label": "getFactory", "isRequired": true, "signature": [ " IterableIterator<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 29 } }, { "type": "Object", "label": "overlays", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayStart", "text": "OverlayStart" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 30 } }, { "type": "Object", "label": "notifications", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.NotificationsStart", "text": "NotificationsStart" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 31 } }, { "type": "CompoundType", "label": "SavedObjectFinder", "isRequired": true, "signature": [ "React.ComponentType" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 32 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 27 } }, { "id": "def-public.AddPanelAction.getDisplayName", "type": "Function", "label": "getDisplayName", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 35 } }, { "id": "def-public.AddPanelAction.getIconType", "type": "Function", "label": "getIconType", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 41 } }, { "id": "def-public.AddPanelAction.isCompatible", "type": "Function", "label": "isCompatible", "signature": [ "(context: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.ActionExecutionContext", "text": "ActionExecutionContext" }, ") => Promise" ], "description": [], "children": [ { "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.ActionExecutionContext", "text": "ActionExecutionContext" }, "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 45 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 45 } }, { "id": "def-public.AddPanelAction.execute", "type": "Function", "label": "execute", "signature": [ "(context: ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.ActionExecutionContext", "text": "ActionExecutionContext" }, ") => Promise" ], "description": [], "children": [ { "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.ActionExecutionContext", "text": "ActionExecutionContext" }, "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 50 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 50 } } ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.AttributeService", "type": "Class", "tags": [], "label": "AttributeService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.AttributeService", "text": "AttributeService" }, "" ], "children": [ { "id": "def-public.AttributeService.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 49 } }, { "type": "Function", "label": "showSaveModal", "isRequired": true, "signature": [ "(saveModal: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element) => void" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 50 } }, { "type": "Function", "label": "i18nContext", "isRequired": true, "signature": [ "({ children }: { children: React.ReactNode; }) => JSX.Element" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 54 } }, { "type": "Object", "label": "toasts", "isRequired": true, "signature": [ "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.ToastsApi", "text": "ToastsApi" }, ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 55 } }, { "type": "Object", "label": "options", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.AttributeServiceOptions", "text": "AttributeServiceOptions" }, "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 56 } }, { "type": "Function", "label": "getEmbeddableFactory", "isRequired": false, "signature": [ "((embeddableFactoryId: string) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 48 } }, { "id": "def-public.AttributeService.unwrapAttributes", "type": "Function", "label": "unwrapAttributes", "signature": [ "(input: ValType | RefType) => Promise" ], "description": [], "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ "ValType | RefType" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 74 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 74 } }, { "id": "def-public.AttributeService.wrapAttributes", "type": "Function", "label": "wrapAttributes", "signature": [ "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>" ], "description": [], "children": [ { "type": "Uncategorized", "label": "newAttributes", "isRequired": true, "signature": [ "SavedObjectAttributes" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 84 } }, { "type": "boolean", "label": "useRefType", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 85 } }, { "type": "CompoundType", "label": "input", "isRequired": false, "signature": [ "ValType | RefType | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 86 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 83 } }, { "id": "def-public.AttributeService.inputIsRefType", "type": "Function", "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ "ValType | RefType" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 116 } } ], "signature": [ "(input: ValType | RefType) => input is RefType" ], "description": [], "label": "inputIsRefType", "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 116 }, "tags": [], "returnComment": [] }, { "id": "def-public.AttributeService.getExplicitInputFromEmbeddable", "type": "Function", "label": "getExplicitInputFromEmbeddable", "signature": [ "(embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">) => ValType | RefType" ], "description": [], "children": [ { "type": "Object", "label": "embeddable", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 120 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 120 } }, { "id": "def-public.AttributeService.getInputAsValueType", "type": "Function", "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ "ValType | RefType" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 125 } } ], "signature": [ "(input: ValType | RefType) => Promise" ], "description": [], "label": "getInputAsValueType", "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 125 }, "tags": [], "returnComment": [] }, { "id": "def-public.AttributeService.getInputAsRefType", "type": "Function", "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ "ValType | RefType" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 138 } }, { "type": "CompoundType", "label": "saveOptions", "isRequired": false, "signature": [ "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 139 } } ], "signature": [ "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" ], "description": [], "label": "getInputAsRefType", "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 137 }, "tags": [], "returnComment": [] } ], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 41 }, "initialIsOpen": false }, { "id": "def-public.Container", "type": "Class", "tags": [], "label": "Container", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Container", "text": "Container" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Embeddable", "text": "Embeddable" }, " implements ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "" ], "children": [ { "tags": [], "id": "def-public.Container.isContainer", "type": "boolean", "label": "isContainer", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 34 } }, { "id": "def-public.Container.children", "type": "Object", "tags": [], "children": [], "description": [], "label": "children", "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 35 } }, { "id": "def-public.Container.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Uncategorized", "label": "input", "isRequired": true, "signature": [ "TContainerInput" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 42 } }, { "type": "Uncategorized", "label": "output", "isRequired": true, "signature": [ "TContainerOutput" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 43 } }, { "type": "Function", "label": "getFactory", "isRequired": true, "signature": [ ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 45 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 41 } }, { "id": "def-public.Container.updateInputForChild", "type": "Function", "label": "updateInputForChild", "signature": [ "(id: string, changes: Partial) => void" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 57 } }, { "type": "Object", "label": "changes", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 58 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 56 } }, { "id": "def-public.Container.reload", "type": "Function", "label": "reload", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 78 } }, { "id": "def-public.Container.addNewEmbeddable", "type": "Function", "label": "addNewEmbeddable", "signature": [ "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 86 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 82 } }, { "id": "def-public.Container.removeEmbeddable", "type": "Function", "label": "removeEmbeddable", "signature": [ "(embeddableId: string) => void" ], "description": [], "children": [ { "type": "string", "label": "embeddableId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 98 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 98 } }, { "id": "def-public.Container.getChildIds", "type": "Function", "label": "getChildIds", "signature": [ "() => string[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 106 } }, { "id": "def-public.Container.getChild", "type": "Function", "label": "getChild", "signature": [ ">(id: string) => E" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 110 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 110 } }, { "id": "def-public.Container.getInputForChild", "type": "Function", "label": "getInputForChild", "signature": [ "(embeddableId: string) => TEmbeddableInput" ], "description": [], "children": [ { "type": "string", "label": "embeddableId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 115 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 114 } }, { "id": "def-public.Container.destroy", "type": "Function", "label": "destroy", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 146 } }, { "id": "def-public.Container.untilEmbeddableLoaded", "type": "Function", "label": "untilEmbeddableLoaded", "signature": [ ">(id: string) => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, " | TEmbeddable>" ], "description": [], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 153 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 152 } }, { "id": "def-public.Container.createNewPanelState", "type": "Function", "label": "createNewPanelState", "signature": [ ">(factory: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, ", partial?: Partial) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" } ], "description": [], "children": [ { "type": "Object", "label": "factory", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 184 } }, { "type": "Object", "label": "partial", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 185 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 180 } }, { "id": "def-public.Container.getPanelState", "type": "Function", "label": "getPanelState", "signature": [ "(embeddableId: string) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "" ], "description": [], "children": [ { "type": "string", "label": "embeddableId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 205 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 204 } }, { "id": "def-public.Container.getInheritedInput", "type": "Function", "label": "getInheritedInput", "signature": [ "(id: string) => TChildInput" ], "description": [ "\nReturn state that comes from the container and is passed down to the child. For instance, time range and\nfilters are common inherited input state. Note that any state stored in `this.input.panels[embeddableId].explicitInput`\nwill override inherited input." ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 219 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 219 } } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/container.ts", "lineNumber": 27 }, "initialIsOpen": false }, { "id": "def-public.EditPanelAction", "type": "Class", "tags": [], "label": "EditPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EditPanelAction", "text": "EditPanelAction" }, " implements ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.Action", "text": "Action" }, "" ], "children": [ { "tags": [], "id": "def-public.EditPanelAction.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 38 }, "signature": [ "\"editPanel\"" ] }, { "tags": [], "id": "def-public.EditPanelAction.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 39 }, "signature": [ "\"editPanel\"" ] }, { "tags": [], "id": "def-public.EditPanelAction.order", "type": "number", "label": "order", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 40 } }, { "tags": [], "id": "def-public.EditPanelAction.currentAppId", "type": "string", "label": "currentAppId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 41 }, "signature": [ "string | undefined" ] }, { "id": "def-public.EditPanelAction.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Function", "label": "getEmbeddableFactory", "isRequired": true, "signature": [ " string" ], "description": [], "children": [ { "type": "Object", "label": "{ embeddable }", "isRequired": true, "signature": [ "ActionContext" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 55 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 55 } }, { "id": "def-public.EditPanelAction.getIconType", "type": "Function", "label": "getIconType", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 68 } }, { "id": "def-public.EditPanelAction.isCompatible", "type": "Function", "label": "isCompatible", "signature": [ "({ embeddable }: ActionContext) => Promise" ], "description": [], "children": [ { "type": "Object", "label": "{ embeddable }", "isRequired": true, "signature": [ "ActionContext" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 72 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 72 } }, { "id": "def-public.EditPanelAction.execute", "type": "Function", "label": "execute", "signature": [ "(context: ActionContext) => Promise" ], "description": [], "children": [ { "type": "Object", "label": "context", "isRequired": true, "signature": [ "ActionContext" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 83 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 83 } }, { "id": "def-public.EditPanelAction.getAppTarget", "type": "Function", "label": "getAppTarget", "signature": [ "({ embeddable }: ActionContext) => NavigationContext | undefined" ], "description": [], "children": [ { "type": "Object", "label": "{ embeddable }", "isRequired": true, "signature": [ "ActionContext" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 104 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 104 } }, { "id": "def-public.EditPanelAction.getHref", "type": "Function", "label": "getHref", "signature": [ "({ embeddable }: ActionContext) => Promise" ], "description": [], "children": [ { "type": "Object", "label": "{ embeddable }", "isRequired": true, "signature": [ "ActionContext" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 121 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 121 } } ], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 37 }, "initialIsOpen": false }, { "id": "def-public.Embeddable", "type": "Class", "tags": [], "label": "Embeddable", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Embeddable", "text": "Embeddable" }, " implements ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "" ], "children": [ { "tags": [], "id": "def-public.Embeddable.runtimeId", "type": "number", "label": "runtimeId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 27 } }, { "tags": [], "id": "def-public.Embeddable.runtimeId", "type": "number", "label": "runtimeId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 29 } }, { "tags": [], "id": "def-public.Embeddable.parent", "type": "Object", "label": "parent", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 31 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ] }, { "tags": [], "id": "def-public.Embeddable.isContainer", "type": "boolean", "label": "isContainer", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 32 } }, { "tags": [], "id": "def-public.Embeddable.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 33 } }, { "tags": [], "id": "def-public.Embeddable.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 34 } }, { "tags": [], "id": "def-public.Embeddable.fatalError", "type": "Object", "label": "fatalError", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 35 }, "signature": [ "Error | undefined" ] }, { "tags": [], "id": "def-public.Embeddable.output", "type": "Uncategorized", "label": "output", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 37 }, "signature": [ "TEmbeddableOutput" ] }, { "tags": [], "id": "def-public.Embeddable.input", "type": "Uncategorized", "label": "input", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 38 }, "signature": [ "TEmbeddableInput" ] }, { "tags": [], "id": "def-public.Embeddable.renderComplete", "type": "Object", "label": "renderComplete", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 43 }, "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.RenderCompleteDispatcher", "text": "RenderCompleteDispatcher" } ] }, { "id": "def-public.Embeddable.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Uncategorized", "label": "input", "isRequired": true, "signature": [ "TEmbeddableInput" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 } }, { "type": "Uncategorized", "label": "output", "isRequired": true, "signature": [ "TEmbeddableOutput" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 } }, { "type": "Object", "label": "parent", "isRequired": false, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 51 } }, { "id": "def-public.Embeddable.getIsContainer", "type": "Function", "label": "getIsContainer", "signature": [ "() => this is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 89 } }, { "id": "def-public.Embeddable.reload", "type": "Function", "label": "reload", "signature": [ "() => void" ], "description": [ "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 106 } }, { "id": "def-public.Embeddable.getUpdated$", "type": "Function", "label": "getUpdated$", "signature": [ "() => Readonly<", "Observable", ">" ], "description": [ "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip any state handling in case `reload` already handled it." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 114 } }, { "id": "def-public.Embeddable.getInput$", "type": "Function", "label": "getInput$", "signature": [ "() => Readonly<", "Observable", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 121 } }, { "id": "def-public.Embeddable.getOutput$", "type": "Function", "label": "getOutput$", "signature": [ "() => Readonly<", "Observable", ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 125 } }, { "id": "def-public.Embeddable.getOutput", "type": "Function", "label": "getOutput", "signature": [ "() => Readonly" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 129 } }, { "id": "def-public.Embeddable.getInput", "type": "Function", "label": "getInput", "signature": [ "() => Readonly" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 133 } }, { "id": "def-public.Embeddable.getTitle", "type": "Function", "label": "getTitle", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 137 } }, { "id": "def-public.Embeddable.getRoot", "type": "Function", "label": "getRoot", "signature": [ "() => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, "> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" } ], "description": [ "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 145 } }, { "id": "def-public.Embeddable.updateInput", "type": "Function", "label": "updateInput", "signature": [ "(changes: Partial) => void" ], "description": [], "children": [ { "type": "Object", "label": "changes", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 153 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 153 } }, { "id": "def-public.Embeddable.render", "type": "Function", "label": "render", "signature": [ "(el: HTMLElement) => void" ], "description": [], "children": [ { "type": "Object", "label": "el", "isRequired": true, "signature": [ "HTMLElement" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 165 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 165 } }, { "id": "def-public.Embeddable.getInspectorAdapters", "type": "Function", "label": "getInspectorAdapters", "signature": [ "() => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined" ], "description": [ "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." ], "children": [], "tags": [ "return" ], "returnComment": [ "Inspector adapters that will be used to open an inspector for." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 180 } }, { "id": "def-public.Embeddable.destroy", "type": "Function", "label": "destroy", "signature": [ "() => void" ], "description": [ "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add any additional clean up tasks, like unmounting and unsubscribing." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 188 } }, { "id": "def-public.Embeddable.updateOutput", "type": "Function", "label": "updateOutput", "signature": [ "(outputChanges: Partial) => void" ], "description": [], "children": [ { "type": "Object", "label": "outputChanges", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 200 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 200 } }, { "id": "def-public.Embeddable.onFatalError", "type": "Function", "label": "onFatalError", "signature": [ "(e: Error) => void" ], "description": [], "children": [ { "type": "Object", "label": "e", "isRequired": true, "signature": [ "Error" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 211 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 211 } }, { "id": "def-public.Embeddable.supportedTriggers", "type": "Function", "label": "supportedTriggers", "signature": [ "() => string[]" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 239 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableChildPanel", "type": "Class", "tags": [], "label": "EmbeddableChildPanel", "description": [ "\nThis component can be used by embeddable containers using react to easily render children. It waits\nfor the child to be initialized, showing a loading indicator until that is complete." ], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableChildPanel", "text": "EmbeddableChildPanel" }, " extends React.Component<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableChildPanelProps", "text": "EmbeddableChildPanelProps" }, ", State, any>" ], "children": [ { "tags": [], "id": "def-public.EmbeddableChildPanel.mounted", "type": "boolean", "label": "mounted", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 36 } }, { "tags": [], "id": "def-public.EmbeddableChildPanel.embeddable", "type": "CompoundType", "label": "embeddable", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 37 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, "> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" } ] }, { "id": "def-public.EmbeddableChildPanel.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableChildPanelProps", "text": "EmbeddableChildPanelProps" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 40 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 40 } }, { "id": "def-public.EmbeddableChildPanel.componentDidMount", "type": "Function", "label": "componentDidMount", "signature": [ "() => Promise" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 49 } }, { "id": "def-public.EmbeddableChildPanel.componentWillUnmount", "type": "Function", "label": "componentWillUnmount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 59 } }, { "id": "def-public.EmbeddableChildPanel.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 66 } } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableFactoryNotFoundError", "type": "Class", "tags": [], "label": "EmbeddableFactoryNotFoundError", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryNotFoundError", "text": "EmbeddableFactoryNotFoundError" }, " extends Error" ], "children": [ { "tags": [], "id": "def-public.EmbeddableFactoryNotFoundError.code", "type": "string", "label": "code", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 25 } }, { "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 27 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 27 } } ], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 24 }, "initialIsOpen": false }, { "id": "def-public.EmbeddablePanel", "type": "Class", "tags": [], "label": "EmbeddablePanel", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePanel", "text": "EmbeddablePanel" }, " extends React.Component" ], "children": [ { "id": "def-public.EmbeddablePanel.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 96 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 96 } }, { "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", "type": "Function", "label": "UNSAFE_componentWillMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 153 } }, { "id": "def-public.EmbeddablePanel.componentWillUnmount", "type": "Function", "label": "componentWillUnmount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 187 } }, { "id": "def-public.EmbeddablePanel.onFocus", "type": "Function", "children": [ { "type": "string", "label": "focusedPanelIndex", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 199 } } ], "signature": [ "(focusedPanelIndex: string) => void" ], "description": [], "label": "onFocus", "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 199 }, "tags": [], "returnComment": [] }, { "id": "def-public.EmbeddablePanel.onBlur", "type": "Function", "children": [ { "type": "string", "label": "blurredPanelIndex", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 203 } } ], "signature": [ "(blurredPanelIndex: string) => void" ], "description": [], "label": "onBlur", "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 203 }, "tags": [], "returnComment": [] }, { "id": "def-public.EmbeddablePanel.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 209 } }, { "id": "def-public.EmbeddablePanel.componentDidMount", "type": "Function", "label": "componentDidMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 251 } }, { "id": "def-public.EmbeddablePanel.closeMyContextMenuPanel", "type": "Function", "children": [], "signature": [ "() => void" ], "description": [], "label": "closeMyContextMenuPanel", "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 274 }, "tags": [], "returnComment": [] } ], "source": { "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", "lineNumber": 89 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableRoot", "type": "Class", "tags": [], "label": "EmbeddableRoot", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableRoot", "text": "EmbeddableRoot" }, " extends React.Component" ], "children": [ { "id": "def-public.EmbeddableRoot.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 25 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 25 } }, { "id": "def-public.EmbeddableRoot.componentDidMount", "type": "Function", "label": "componentDidMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 31 } }, { "id": "def-public.EmbeddableRoot.componentDidUpdate", "type": "Function", "label": "componentDidUpdate", "signature": [ "(prevProps?: Props | undefined) => void" ], "description": [], "children": [ { "type": "Object", "label": "prevProps", "isRequired": false, "signature": [ "Props | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 38 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 38 } }, { "id": "def-public.EmbeddableRoot.shouldComponentUpdate", "type": "Function", "label": "shouldComponentUpdate", "signature": [ "(newProps: Props) => boolean" ], "description": [], "children": [ { "type": "Object", "label": "newProps", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 59 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 59 } }, { "id": "def-public.EmbeddableRoot.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 69 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableStateTransfer", "type": "Class", "tags": [ "public" ], "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" ], "children": [ { "tags": [], "id": "def-public.EmbeddableStateTransfer.isTransferInProgress", "type": "boolean", "label": "isTransferInProgress", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 30 } }, { "id": "def-public.EmbeddableStateTransfer.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Function", "label": "navigateToApp", "isRequired": true, "signature": [ "(appId: string, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.NavigateToAppOptions", "text": "NavigateToAppOptions" }, " | undefined) => Promise" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 34 } }, { "type": "Object", "label": "currentAppId$", "isRequired": true, "signature": [ "Observable", "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 35 } }, { "type": "Object", "label": "appList", "isRequired": false, "signature": [ "ReadonlyMap | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 36 } }, { "type": "Object", "label": "customStorage", "isRequired": false, "signature": [ { "pluginId": "kibanaUtils", "scope": "public", "docId": "kibKibanaUtilsPluginApi", "section": "def-public.Storage", "text": "Storage" }, " | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 37 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 33 } }, { "id": "def-public.EmbeddableStateTransfer.getAppNameFromId", "type": "Function", "children": [ { "type": "string", "label": "appId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 50 } } ], "signature": [ "(appId: string) => string | undefined" ], "description": [ "\nFetches an internationalized app title when given an appId." ], "label": "getAppNameFromId", "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 50 }, "tags": [], "returnComment": [] }, { "id": "def-public.EmbeddableStateTransfer.getIncomingEditorState", "type": "Function", "label": "getIncomingEditorState", "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" }, " | undefined" ], "description": [ "\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" ], "children": [ { "type": "string", "label": "appId", "isRequired": true, "signature": [ "string" ], "description": [ "- The app to fetch incomingEditorState for" ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 59 } }, { "type": "CompoundType", "label": "removeAfterFetch", "isRequired": false, "signature": [ "boolean | undefined" ], "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 60 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 58 } }, { "id": "def-public.EmbeddableStateTransfer.clearEditorState", "type": "Function", "label": "clearEditorState", "signature": [ "(appId?: string | undefined) => void" ], "description": [ "\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n" ], "children": [ { "type": "string", "label": "appId", "isRequired": false, "signature": [ "string | undefined" ], "description": [ "- The app to fetch incomingEditorState for" ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 78 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 78 } }, { "id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage", "type": "Function", "label": "getIncomingEmbeddablePackage", "signature": [ "(appId: string, removeAfterFetch?: boolean | undefined) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" }, " | undefined" ], "description": [ "\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n" ], "children": [ { "type": "string", "label": "appId", "isRequired": true, "signature": [ "string" ], "description": [ "- The app to fetch EmbeddablePackageState for" ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 97 } }, { "type": "CompoundType", "label": "removeAfterFetch", "isRequired": false, "signature": [ "boolean | undefined" ], "description": [ "- Whether to remove the package state after fetch to prevent duplicates." ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 98 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 96 } }, { "id": "def-public.EmbeddableStateTransfer.navigateToEditor", "type": "Function", "label": "navigateToEditor", "signature": [ "(appId: string, options?: { path?: string | undefined; state: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" }, "; } | undefined) => Promise" ], "description": [ "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}" ], "children": [ { "type": "string", "label": "appId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 115 } }, { "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options", "type": "Object", "label": "options", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.path", "type": "string", "label": "path", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 117 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableStateTransfer.navigateToEditor.options.state", "type": "Object", "label": "state", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 118 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableEditorState", "text": "EmbeddableEditorState" } ] } ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 116 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 114 } }, { "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage", "type": "Function", "label": "navigateToWithEmbeddablePackage", "signature": [ "(appId: string, options?: { path?: string | undefined; state: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" }, "; } | undefined) => Promise" ], "description": [ "\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}" ], "children": [ { "type": "string", "label": "appId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 132 } }, { "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options", "type": "Object", "label": "options", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.path", "type": "string", "label": "path", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 133 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.state", "type": "Object", "label": "state", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 133 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddablePackageState", "text": "EmbeddablePackageState" } ] } ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 133 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 131 } } ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "id": "def-public.ErrorEmbeddable", "type": "Class", "tags": [], "label": "ErrorEmbeddable", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Embeddable", "text": "Embeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">" ], "children": [ { "tags": [], "id": "def-public.ErrorEmbeddable.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 26 }, "signature": [ "\"error\"" ] }, { "tags": [], "id": "def-public.ErrorEmbeddable.error", "type": "CompoundType", "label": "error", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 27 }, "signature": [ "string | Error" ] }, { "id": "def-public.ErrorEmbeddable.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "CompoundType", "label": "error", "isRequired": true, "signature": [ "string | Error" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 } }, { "type": "Object", "label": "input", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 } }, { "type": "Object", "label": "parent", "isRequired": false, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 30 } }, { "id": "def-public.ErrorEmbeddable.reload", "type": "Function", "label": "reload", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 35 } }, { "id": "def-public.ErrorEmbeddable.render", "type": "Function", "label": "render", "signature": [ "(dom: HTMLElement) => void" ], "description": [], "children": [ { "type": "Object", "label": "dom", "isRequired": true, "signature": [ "HTMLElement" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 37 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 37 } }, { "id": "def-public.ErrorEmbeddable.destroy", "type": "Function", "label": "destroy", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 57 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 25 }, "initialIsOpen": false }, { "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" ], "children": [ { "tags": [], "id": "def-public.PanelNotFoundError.code", "type": "string", "label": "code", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 13 } }, { "id": "def-public.PanelNotFoundError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 15 } } ], "source": { "path": "src/plugins/embeddable/public/lib/errors.ts", "lineNumber": 12 }, "initialIsOpen": false } ], "functions": [ { "id": "def-public.defaultEmbeddableFactoryProvider", "type": "Function", "children": [ { "type": "CompoundType", "label": "def", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" }, "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", "lineNumber": 22 } } ], "signature": [ "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "lineNumber": 83 } } ], "signature": [ "(props: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableRendererProps", "text": "EmbeddableRendererProps" }, ") => JSX.Element" ], "description": [ "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" ], "label": "EmbeddableRenderer", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "lineNumber": 82 }, "tags": [ "public" ], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isContextMenuTriggerContext", "type": "Function", "children": [ { "type": "Unknown", "label": "context", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 115 } } ], "signature": [ "(context: unknown) => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableContext", "text": "EmbeddableContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>" ], "description": [], "label": "isContextMenuTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 115 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isEmbeddable", "type": "Function", "children": [ { "type": "Unknown", "label": "x", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", "lineNumber": 11 } } ], "signature": [ "(x: unknown) => x is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">" ], "description": [], "label": "isEmbeddable", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isErrorEmbeddable", "type": "Function", "label": "isErrorEmbeddable", "signature": [ "(embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, " | TEmbeddable) => boolean" ], "description": [], "children": [ { "type": "CompoundType", "label": "embeddable", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, " | TEmbeddable" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 20 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "lineNumber": 19 }, "initialIsOpen": false }, { "id": "def-public.isRangeSelectTriggerContext", "type": "Function", "children": [ { "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 107 } } ], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>) => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.RangeSelectContext", "text": "RangeSelectContext" } ], "description": [], "label": "isRangeSelectTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 106 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isReferenceOrValueEmbeddable", "type": "Function", "label": "isReferenceOrValueEmbeddable", "signature": [ "(incoming: unknown) => boolean" ], "description": [], "children": [ { "type": "Unknown", "label": "incoming", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 38 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 37 }, "initialIsOpen": false }, { "id": "def-public.isRowClickTriggerContext", "type": "Function", "children": [ { "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 110 } } ], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>) => context is ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.RowClickContext", "text": "RowClickContext" } ], "description": [], "label": "isRowClickTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 110 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.isSavedObjectEmbeddableInput", "type": "Function", "label": "isSavedObjectEmbeddableInput", "signature": [ "(input: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, ") => boolean" ], "description": [], "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 16 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 15 }, "initialIsOpen": false }, { "id": "def-public.isValueClickTriggerContext", "type": "Function", "children": [ { "type": "CompoundType", "label": "context", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 103 } } ], "signature": [ "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ChartActionContext", "text": "ChartActionContext" }, "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">>) => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ValueClickContext", "text": "ValueClickContext" } ], "description": [], "label": "isValueClickTriggerContext", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 102 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.openAddPanelFlyout", "type": "Function", "label": "openAddPanelFlyout", "signature": [ "(options: { embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, ">; getFactory: , ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, ">" ] }, { "tags": [], "id": "def-public.openAddPanelFlyout.options.getFactory", "type": "Function", "label": "getFactory", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 18 }, "signature": [ " IterableIterator<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ] }, { "tags": [], "id": "def-public.openAddPanelFlyout.options.overlays", "type": "Object", "label": "overlays", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 20 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.OverlayStart", "text": "OverlayStart" } ] }, { "tags": [], "id": "def-public.openAddPanelFlyout.options.notifications", "type": "Object", "label": "notifications", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 21 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.NotificationsStart", "text": "NotificationsStart" } ] }, { "tags": [], "id": "def-public.openAddPanelFlyout.options.SavedObjectFinder", "type": "CompoundType", "label": "SavedObjectFinder", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 22 }, "signature": [ "React.ComponentType" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 16 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "lineNumber": 16 }, "initialIsOpen": false }, { "id": "def-public.withEmbeddableSubscription", "type": "Function", "children": [ { "type": "CompoundType", "label": "WrappedComponent", "isRequired": true, "signature": [ "React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", "lineNumber": 19 } } ], "signature": [ " = ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, ", ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>" ], "description": [], "label": "withEmbeddableSubscription", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.Adapters", "type": "Interface", "label": "Adapters", "description": [ "\nThe interface that the adapters used to open an inspector have to fullfill." ], "tags": [], "children": [ { "tags": [], "id": "def-public.Adapters.requests", "type": "Object", "label": "requests", "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 15 }, "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" }, " | undefined" ] }, { "id": "def-public.Adapters.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 16 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/inspector/common/adapters/types.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-public.ContainerInput", "type": "Interface", "label": "ContainerInput", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ContainerInput.hidePanelTitles", "type": "CompoundType", "label": "hidePanelTitles", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 25 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.ContainerInput.panels", "type": "Object", "label": "panels", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 26 }, "signature": [ "{ [key: string]: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "; }" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 24 }, "initialIsOpen": false }, { "id": "def-public.ContainerOutput", "type": "Interface", "label": "ContainerOutput", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ContainerOutput.embeddableLoaded", "type": "Object", "label": "embeddableLoaded", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 21 }, "signature": [ "{ [key: string]: boolean; }" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 20 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableChildPanelProps", "type": "Interface", "label": "EmbeddableChildPanelProps", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableChildPanelProps.embeddableId", "type": "string", "label": "embeddableId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 19 } }, { "tags": [], "id": "def-public.EmbeddableChildPanelProps.className", "type": "string", "label": "className", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 20 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableChildPanelProps.container", "type": "Object", "label": "container", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 21 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, ">" ] }, { "tags": [], "id": "def-public.EmbeddableChildPanelProps.PanelComponent", "type": "Function", "label": "PanelComponent", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 22 }, "signature": [ "React.FC<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">; hideHeader?: boolean | undefined; }>" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableContext", "type": "Interface", "label": "EmbeddableContext", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableContext", "text": "EmbeddableContext" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableContext.embeddable", "type": "Uncategorized", "label": "embeddable", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 15 }, "signature": [ "T" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableEditorState", "type": "Interface", "label": "EmbeddableEditorState", "description": [ "\nA state package that contains information an editor will need to create or edit an embeddable then redirect back." ], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-public.EmbeddableEditorState.originatingApp", "type": "string", "label": "originatingApp", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-public.EmbeddableEditorState.embeddableId", "type": "string", "label": "embeddableId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 20 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableEditorState.valueInput", "type": "Object", "label": "valueInput", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 21 }, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, " | undefined" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableFactory", "type": "Interface", "label": "EmbeddableFactory", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, " extends ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ">" ], "description": [ "\nEmbeddableFactories create and initialize an embeddable instance" ], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableFactory.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 41 } }, { "tags": [], "id": "def-public.EmbeddableFactory.isEditable", "type": "Function", "label": "isEditable", "description": [ "\nReturns whether the current user should be allowed to edit this type of\nembeddable. Most of the time this should be based off the capabilities service, hence it's async." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 47 }, "signature": [ "() => Promise" ] }, { "tags": [], "id": "def-public.EmbeddableFactory.savedObjectMetaData", "type": "Object", "label": "savedObjectMetaData", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 49 }, "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectMetaData", "text": "SavedObjectMetaData" }, " | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableFactory.isContainerType", "type": "boolean", "label": "isContainerType", "description": [ "\nTrue if is this factory create embeddables that are Containers. Used in the add panel to\nconditionally show whether these can be added to another container. It's just not\nsupported right now, but once nested containers are officially supported we can probably get\nrid of this interface." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 57 } }, { "id": "def-public.EmbeddableFactory.getDisplayName", "type": "Function", "label": "getDisplayName", "signature": [ "() => string" ], "description": [ "\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 63 } }, { "id": "def-public.EmbeddableFactory.canCreateNew", "type": "Function", "label": "canCreateNew", "signature": [ "() => boolean" ], "description": [ "\nIf false, this type of embeddable can't be created with the \"createNew\" functionality. Instead,\nuse createFromSavedObject, where an existing saved object must first exist." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 69 } }, { "id": "def-public.EmbeddableFactory.getDefaultInput", "type": "Function", "label": "getDefaultInput", "signature": [ "(partial: Partial) => Partial" ], "description": [ "\nCan be used to get any default input, to be passed in to during the creation process. Default\ninput will not be stored in a parent container, so any inherited input from a container will trump\ndefault input parameters." ], "children": [ { "type": "Object", "label": "partial", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 77 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 77 } }, { "id": "def-public.EmbeddableFactory.getExplicitInput", "type": "Function", "label": "getExplicitInput", "signature": [ "() => Promise>" ], "description": [ "\nCan be used to request explicit input from the user, to be passed in to `EmbeddableFactory:create`.\nExplicit input is stored on the parent container for this embeddable. It overrides any inherited\ninput passed down from the parent container." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 84 } }, { "id": "def-public.EmbeddableFactory.createFromSavedObject", "type": "Function", "label": "createFromSavedObject", "signature": [ "(savedObjectId: string, input: Partial, parent?: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined) => Promise" ], "description": [ "\nCreates a new embeddable instance based off the saved object id." ], "children": [ { "type": "string", "label": "savedObjectId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 94 } }, { "type": "Object", "label": "input", "isRequired": true, "signature": [ "Partial" ], "description": [ "- some input may come from a parent, or user, if it's not stored with the saved object. For example, the time\nrange of the parent container." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 95 } }, { "type": "Object", "label": "parent", "isRequired": false, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 96 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 93 } }, { "id": "def-public.EmbeddableFactory.create", "type": "Function", "label": "create", "signature": [ "(initialInput: TEmbeddableInput, parent?: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined) => Promise" ], "description": [ "\nResolves to undefined if a new Embeddable cannot be directly created and the user will instead be redirected\nelsewhere.\n\nThis will likely change in future iterations when we improve in place editing capabilities." ], "children": [ { "type": "Uncategorized", "label": "initialInput", "isRequired": true, "signature": [ "TEmbeddableInput" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 106 } }, { "type": "Object", "label": "parent", "isRequired": false, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 107 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 105 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableInstanceConfiguration", "type": "Interface", "label": "EmbeddableInstanceConfiguration", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableInstanceConfiguration.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-public.EmbeddableInstanceConfiguration.savedObjectId", "type": "string", "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 20 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 18 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableOutput", "type": "Interface", "label": "EmbeddableOutput", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableOutput.loading", "type": "CompoundType", "label": "loading", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 23 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.error", "type": "Object", "label": "error", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 25 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableError", "text": "EmbeddableError" }, " | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.editUrl", "type": "string", "label": "editUrl", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 26 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.editApp", "type": "string", "label": "editApp", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 27 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.editPath", "type": "string", "label": "editPath", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 28 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.defaultTitle", "type": "string", "label": "defaultTitle", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 29 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 30 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.editable", "type": "CompoundType", "label": "editable", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 31 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.EmbeddableOutput.savedObjectId", "type": "string", "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 32 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-public.EmbeddablePackageState", "type": "Interface", "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." ], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-public.EmbeddablePackageState.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 35 } }, { "tags": [], "id": "def-public.EmbeddablePackageState.input", "type": "CompoundType", "label": "input", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 36 }, "signature": [ "Optional", "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", \"id\"> | ", "Optional", "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, ", \"id\">" ] }, { "tags": [], "id": "def-public.EmbeddablePackageState.embeddableId", "type": "string", "label": "embeddableId", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 37 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableSetupDependencies", "type": "Interface", "label": "EmbeddableSetupDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableSetupDependencies.uiActions", "type": "Object", "label": "uiActions", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 54 }, "signature": [ "Pick<", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.UiActionsService", "text": "UiActionsService" }, ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" ] } ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 53 }, "initialIsOpen": false }, { "id": "def-public.EmbeddableStartDependencies", "type": "Interface", "label": "EmbeddableStartDependencies", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableStartDependencies.uiActions", "type": "Object", "label": "uiActions", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 58 }, "signature": [ "Pick<", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.UiActionsService", "text": "UiActionsService" }, ", ", "MethodKeysOf", "<", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.UiActionsService", "text": "UiActionsService" }, ">>" ] }, { "tags": [], "id": "def-public.EmbeddableStartDependencies.inspector", "type": "Object", "label": "inspector", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 59 }, "signature": [ { "pluginId": "inspector", "scope": "public", "docId": "kibInspectorPluginApi", "section": "def-public.Start", "text": "Start" } ] } ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 57 }, "initialIsOpen": false }, { "id": "def-public.EnhancementRegistryDefinition", "type": "Interface", "label": "EnhancementRegistryDefinition", "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" }, "

>" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EnhancementRegistryDefinition.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/types.ts", "lineNumber": 28 } } ], "source": { "path": "src/plugins/embeddable/public/types.ts", "lineNumber": 26 }, "initialIsOpen": false }, { "id": "def-public.IContainer", "type": "Interface", "label": "IContainer", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "" ], "description": [], "tags": [], "children": [ { "id": "def-public.IContainer.untilEmbeddableLoaded", "type": "Function", "label": "untilEmbeddableLoaded", "signature": [ ">(id: string) => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, " | TEmbeddable>" ], "description": [ "\nCall if you want to wait until an embeddable with that id has finished loading." ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 40 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 39 } }, { "id": "def-public.IContainer.getInputForChild", "type": "Function", "label": "getInputForChild", "signature": [ "(id: string) => EEI" ], "description": [ "\nReturns the input for the given child. Uses a combination of explicit input\nfor the child stored on the parent and derived/inherited input taken from the\ncontainer itself." ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 49 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 49 } }, { "id": "def-public.IContainer.updateInputForChild", "type": "Function", "label": "updateInputForChild", "signature": [ "(id: string, changes: Partial) => void" ], "description": [ "\nChanges the input for a given child. Note, this will override any inherited state taken from\nthe container itself." ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 57 } }, { "type": "Object", "label": "changes", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 57 } }, { "id": "def-public.IContainer.getChild", "type": "Function", "label": "getChild", "signature": [ " = ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Embeddable", "text": "Embeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ], "description": [ "\nReturns the child embeddable with the given id." ], "children": [ { "type": "string", "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 63 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 63 } }, { "id": "def-public.IContainer.removeEmbeddable", "type": "Function", "label": "removeEmbeddable", "signature": [ "(embeddableId: string) => void" ], "description": [ "\nRemoves the embeddable with the given id." ], "children": [ { "type": "string", "label": "embeddableId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 69 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 69 } }, { "id": "def-public.IContainer.addNewEmbeddable", "type": "Function", "label": "addNewEmbeddable", "signature": [ "" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 81 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 75 } } ], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "lineNumber": 31 }, "initialIsOpen": false }, { "id": "def-public.IEmbeddable", "type": "Interface", "label": "IEmbeddable", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.IEmbeddable.isContainer", "type": "boolean", "label": "isContainer", "description": [ "\nIs this embeddable an instance of a Container class, can it contain\nnested embeddables?" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 43 } }, { "tags": [], "id": "def-public.IEmbeddable.parent", "type": "Object", "label": "parent", "description": [ "\nIf this embeddable is nested inside a container, this will contain\na reference to its parent." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 49 }, "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ] }, { "tags": [], "id": "def-public.IEmbeddable.type", "type": "string", "label": "type", "description": [ "\nThe type of embeddable, this is what will be used to take a serialized\nembeddable and find the correct factory for which to create an instance of it." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 55 } }, { "tags": [], "id": "def-public.IEmbeddable.id", "type": "string", "label": "id", "description": [ "\nA unique identifier for this embeddable. Mainly only used by containers to map their\nPanel States to a child embeddable instance." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 61 } }, { "tags": [], "id": "def-public.IEmbeddable.runtimeId", "type": "number", "label": "runtimeId", "description": [ "\nUnique ID an embeddable is assigned each time it is initialized. This ID\nis different for different instances of the same embeddable. For example,\nif the same dashboard is rendered twice on the screen, all embeddable\ninstances will have a unique `runtimeId`." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 69 }, "signature": [ "number | undefined" ] }, { "tags": [], "id": "def-public.IEmbeddable.enhancements", "type": "Uncategorized", "label": "enhancements", "description": [ "\nExtra abilities added to Embeddable by `*_enhanced` plugins." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 74 }, "signature": [ "object | undefined" ] }, { "tags": [], "id": "def-public.IEmbeddable.fatalError", "type": "Object", "label": "fatalError", "description": [ "\nIf this embeddable has encountered a fatal error, that error will be stored here" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 79 }, "signature": [ "Error | undefined" ] }, { "id": "def-public.IEmbeddable.getIsContainer", "type": "Function", "label": "getIsContainer", "signature": [ "() => this is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, ">" ], "description": [ "\nA functional representation of the isContainer variable, but helpful for typescript to\nknow the shape if this returns true" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 85 } }, { "id": "def-public.IEmbeddable.getInput", "type": "Function", "label": "getInput", "signature": [ "() => Readonly" ], "description": [ "\nGet the input used to instantiate this embeddable. The input is a serialized representation of\nthis embeddable instance and can be used to clone or re-instantiate it. Input state:\n\n- Can be updated externally\n- Can change multiple times for a single embeddable instance.\n\nExamples: title, pie slice colors, custom search columns and sort order." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 96 } }, { "id": "def-public.IEmbeddable.getOutput", "type": "Function", "label": "getOutput", "signature": [ "() => Readonly" ], "description": [ "\nOutput state is:\n\n- State that should not change once the embeddable is instantiated, or\n- State that is derived from the input state, or\n- State that only the embeddable instance itself knows about, or the factory.\n\nExamples: editUrl, title taken from a saved object, if your input state was first name and\n last name, your output state could be greeting." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 108 } }, { "id": "def-public.IEmbeddable.updateInput", "type": "Function", "label": "updateInput", "signature": [ "(changes: Partial) => void" ], "description": [ "\nUpdates input state with the given changes." ], "children": [ { "type": "Object", "label": "changes", "isRequired": true, "signature": [ "Partial" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 114 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 114 } }, { "id": "def-public.IEmbeddable.getInput$", "type": "Function", "label": "getInput$", "signature": [ "() => Readonly<", "Observable", ">" ], "description": [ "\nReturns an observable which will be notified when input state changes." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 119 } }, { "id": "def-public.IEmbeddable.getOutput$", "type": "Function", "label": "getOutput$", "signature": [ "() => Readonly<", "Observable", ">" ], "description": [ "\nReturns an observable which will be notified when output state changes." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 124 } }, { "id": "def-public.IEmbeddable.getTitle", "type": "Function", "label": "getTitle", "signature": [ "() => string | undefined" ], "description": [ "\nReturns the title of this embeddable." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 129 } }, { "id": "def-public.IEmbeddable.getRoot", "type": "Function", "label": "getRoot", "signature": [ "() => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, "> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IContainer", "text": "IContainer" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" } ], "description": [ "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 135 } }, { "id": "def-public.IEmbeddable.render", "type": "Function", "label": "render", "signature": [ "(domNode: Element | HTMLElement) => void" ], "description": [ "\nRenders the embeddable at the given node." ], "children": [ { "type": "CompoundType", "label": "domNode", "isRequired": true, "signature": [ "Element | HTMLElement" ], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 141 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 141 } }, { "id": "def-public.IEmbeddable.reload", "type": "Function", "label": "reload", "signature": [ "() => void" ], "description": [ "\nReload the embeddable so output and rendering is up to date. Especially relevant\nif the embeddable takes relative time as input (e.g. now to now-15)" ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 147 } }, { "id": "def-public.IEmbeddable.getInspectorAdapters", "type": "Function", "label": "getInspectorAdapters", "signature": [ "() => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined" ], "description": [ "\nAn embeddable can return inspector adapters if it wants the inspector to be\navailable via the context menu of that panel." ], "children": [], "tags": [ "return" ], "returnComment": [ "Inspector adapters that will be used to open an inspector for." ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 154 } }, { "id": "def-public.IEmbeddable.destroy", "type": "Function", "label": "destroy", "signature": [ "() => void" ], "description": [ "\nCleans up subscriptions, destroy nodes mounted from calls to render." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 159 } }, { "id": "def-public.IEmbeddable.supportedTriggers", "type": "Function", "label": "supportedTriggers", "signature": [ "() => string[]" ], "description": [ "\nList of triggers that this embeddable will execute." ], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 164 } } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "lineNumber": 35 }, "initialIsOpen": false }, { "id": "def-public.OutputSpec", "type": "Interface", "label": "OutputSpec", "description": [], "tags": [], "children": [ { "id": "def-public.OutputSpec.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 24 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.PanelState", "type": "Interface", "label": "PanelState", "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.PanelState.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-public.PanelState.explicitInput", "type": "CompoundType", "label": "explicitInput", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 62 }, "signature": [ "Partial & { id: string; }" ] } ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-public.PropertySpec", "type": "Interface", "label": "PropertySpec", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.PropertySpec.displayName", "type": "string", "label": "displayName", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-public.PropertySpec.accessPath", "type": "string", "label": "accessPath", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 19 } }, { "tags": [], "id": "def-public.PropertySpec.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 20 } }, { "tags": [], "id": "def-public.PropertySpec.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-public.PropertySpec.value", "type": "string", "label": "value", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 22 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/types.ts", "lineNumber": 17 }, "initialIsOpen": false }, { "id": "def-public.RangeSelectContext", "type": "Interface", "label": "RangeSelectContext", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.RangeSelectContext", "text": "RangeSelectContext" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.RangeSelectContext.embeddable", "type": "Uncategorized", "label": "embeddable", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 33 }, "signature": [ "T | undefined" ] }, { "tags": [], "id": "def-public.RangeSelectContext.data", "type": "Object", "label": "data", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 34 }, "signature": [ "{ table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, "; column: number; range: number[]; timeFieldName?: string | undefined; }" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 32 }, "initialIsOpen": false }, { "id": "def-public.ReferenceOrValueEmbeddable", "type": "Interface", "label": "ReferenceOrValueEmbeddable", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ReferenceOrValueEmbeddable", "text": "ReferenceOrValueEmbeddable" }, "" ], "description": [ "\nAny embeddable that implements this interface will be able to use input that is\neither by reference (backed by a saved object) OR by value, (provided\nby the container)." ], "tags": [ "public" ], "children": [ { "tags": [], "id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType", "type": "Function", "label": "inputIsRefType", "description": [ "\ndetermines whether the input is by value or by reference." ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 24 }, "signature": [ "(input: ValTypeInput | RefTypeInput) => input is RefTypeInput" ] }, { "tags": [], "id": "def-public.ReferenceOrValueEmbeddable.getInputAsValueType", "type": "Function", "label": "getInputAsValueType", "description": [ "\nGets the embeddable's current input as its Value type" ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 29 }, "signature": [ "() => Promise" ] }, { "tags": [], "id": "def-public.ReferenceOrValueEmbeddable.getInputAsRefType", "type": "Function", "label": "getInputAsRefType", "description": [ "\nGets the embeddable's current input as its Reference type" ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 34 }, "signature": [ "() => Promise" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "lineNumber": 17 }, "initialIsOpen": false }, { "id": "def-public.SavedObjectEmbeddableInput", "type": "Interface", "label": "SavedObjectEmbeddableInput", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedObjectEmbeddableInput.savedObjectId", "type": "string", "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 12 } } ], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-public.ValueClickContext", "type": "Interface", "label": "ValueClickContext", "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ValueClickContext", "text": "ValueClickContext" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ValueClickContext.embeddable", "type": "Uncategorized", "label": "embeddable", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 19 }, "signature": [ "T | undefined" ] }, { "tags": [], "id": "def-public.ValueClickContext.data", "type": "Object", "label": "data", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 20 }, "signature": [ "{ data: { table: Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }" ] } ], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 18 }, "initialIsOpen": false } ], "enums": [ { "id": "def-public.ViewMode", "type": "Enum", "label": "ViewMode", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 11 }, "initialIsOpen": false } ], "misc": [ { "tags": [], "id": "def-public.ACTION_ADD_PANEL", "type": "string", "label": "ACTION_ADD_PANEL", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "lineNumber": 17 }, "signature": [ "\"ACTION_ADD_PANEL\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ACTION_EDIT_PANEL", "type": "string", "label": "ACTION_EDIT_PANEL", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "lineNumber": 25 }, "signature": [ "\"editPanel\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.ATTRIBUTE_SERVICE_KEY", "type": "string", "label": "ATTRIBUTE_SERVICE_KEY", "description": [ "\nThe attribute service is a shared, generic service that embeddables can use to provide the functionality\nrequired to fulfill the requirements of the ReferenceOrValueEmbeddable interface. The attribute_service\ncan also be used as a higher level wrapper to transform an embeddable input shape that references a saved object\ninto an embeddable input shape that contains that saved object's attributes by value." ], "source": { "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "lineNumber": 30 }, "signature": [ "\"attributes\"" ], "initialIsOpen": false }, { "id": "def-public.ChartActionContext", "type": "Type", "label": "ChartActionContext", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 42 }, "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": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.RowClickContext", "text": "RowClickContext" } ], "initialIsOpen": false }, { "tags": [], "id": "def-public.CONTEXT_MENU_TRIGGER", "type": "string", "label": "CONTEXT_MENU_TRIGGER", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 47 }, "signature": [ "\"CONTEXT_MENU_TRIGGER\"" ], "initialIsOpen": false }, { "id": "def-public.EmbeddableFactoryDefinition", "type": "Type", "label": "EmbeddableFactoryDefinition", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts", "lineNumber": 14 }, "signature": [ "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>" ], "initialIsOpen": false }, { "id": "def-public.EmbeddableInput", "type": "Type", "label": "EmbeddableInput", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 16 }, "signature": [ "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" ], "initialIsOpen": false }, { "id": "def-public.EmbeddablePanelHOC", "type": "Type", "label": "EmbeddablePanelHOC", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 98 }, "signature": [ "(props: React.PropsWithChildren<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null" ], "initialIsOpen": false }, { "id": "def-public.EmbeddableRendererProps", "type": "Type", "label": "EmbeddableRendererProps", "tags": [], "description": [ "\nThis type is a publicly exposed props of {@link EmbeddableRenderer}\nUnion is used to validate that or factory or embeddable is passed in, but it can't be both simultaneously\nIn case when embeddable is passed in, input is optional, because there is already an input inside of embeddable object\nIn case when factory is used, then input is required, because it will be used as initial input to create an embeddable object" ], "source": { "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "lineNumber": 21 }, "signature": [ "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.PANEL_BADGE_TRIGGER", "type": "string", "label": "PANEL_BADGE_TRIGGER", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 58 }, "signature": [ "\"PANEL_BADGE_TRIGGER\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.PANEL_NOTIFICATION_TRIGGER", "type": "string", "label": "PANEL_NOTIFICATION_TRIGGER", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 69 }, "signature": [ "\"PANEL_NOTIFICATION_TRIGGER\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.SELECT_RANGE_TRIGGER", "type": "string", "label": "SELECT_RANGE_TRIGGER", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 80 }, "signature": [ "\"SELECT_RANGE_TRIGGER\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.VALUE_CLICK_TRIGGER", "type": "string", "label": "VALUE_CLICK_TRIGGER", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 91 }, "signature": [ "\"VALUE_CLICK_TRIGGER\"" ], "initialIsOpen": false } ], "objects": [ { "id": "def-public.contextMenuTrigger", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.contextMenuTrigger.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 49 } }, { "tags": [], "id": "def-public.contextMenuTrigger.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 50 } }, { "tags": [], "id": "def-public.contextMenuTrigger.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 53 } } ], "description": [], "label": "contextMenuTrigger", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 48 }, "initialIsOpen": false }, { "id": "def-public.panelBadgeTrigger", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.panelBadgeTrigger.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 60 } }, { "tags": [], "id": "def-public.panelBadgeTrigger.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 61 } }, { "tags": [], "id": "def-public.panelBadgeTrigger.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 64 } } ], "description": [], "label": "panelBadgeTrigger", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 59 }, "initialIsOpen": false }, { "id": "def-public.panelNotificationTrigger", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.panelNotificationTrigger.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 71 } }, { "tags": [], "id": "def-public.panelNotificationTrigger.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 72 } }, { "tags": [], "id": "def-public.panelNotificationTrigger.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 75 } } ], "description": [], "label": "panelNotificationTrigger", "source": { "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "lineNumber": 70 }, "initialIsOpen": false } ], "setup": { "id": "def-public.EmbeddableSetup", "type": "Interface", "label": "EmbeddableSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableSetup.registerEmbeddableFactory", "type": "Function", "label": "registerEmbeddableFactory", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 63 }, "signature": [ " = ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, ">(id: string, factory: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" } ] }, { "tags": [], "id": "def-public.EmbeddableSetup.registerEnhancement", "type": "Function", "label": "registerEnhancement", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 71 }, "signature": [ "(enhancement: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, ">) => void" ] }, { "tags": [], "id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider", "type": "Function", "label": "setCustomEmbeddableFactoryProvider", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 72 }, "signature": [ "(customProvider: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryProvider", "text": "EmbeddableFactoryProvider" }, ") => void" ] } ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 62 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-public.EmbeddableStart", "type": "Interface", "label": "EmbeddableStart", "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" }, ">" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.EmbeddableStart.getEmbeddableFactory", "type": "Function", "label": "getEmbeddableFactory", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 76 }, "signature": [ " IterableIterator<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } ] }, { "tags": [], "id": "def-public.EmbeddableStart.EmbeddablePanel", "type": "Function", "label": "EmbeddablePanel", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 84 }, "signature": [ "React.FC<{ embeddable: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ">; hideHeader?: boolean | undefined; }>" ] }, { "tags": [], "id": "def-public.EmbeddableStart.getStateTransfer", "type": "Function", "label": "getStateTransfer", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 85 }, "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" } ] }, { "tags": [], "id": "def-public.EmbeddableStart.getAttributeService", "type": "Function", "label": "getAttributeService", "description": [], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 86 }, "signature": [ "(type: string, options: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.AttributeServiceOptions", "text": "AttributeServiceOptions" } ] } ], "source": { "path": "src/plugins/embeddable/public/plugin.tsx", "lineNumber": 75 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [ { "id": "def-server.EmbeddableRegistryDefinition", "type": "Interface", "label": "EmbeddableRegistryDefinition", "signature": [ { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "

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

>" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EmbeddableRegistryDefinition.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 32 } } ], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "id": "def-server.EnhancementRegistryDefinition", "type": "Interface", "label": "EnhancementRegistryDefinition", "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" }, "

>" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EnhancementRegistryDefinition.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 21 } } ], "source": { "path": "src/plugins/embeddable/server/types.ts", "lineNumber": 19 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "id": "def-server.EmbeddableSetup", "type": "Interface", "label": "EmbeddableSetup", "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" }, ">" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EmbeddableSetup.registerEmbeddableFactory", "type": "Function", "label": "registerEmbeddableFactory", "description": [], "source": { "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 28 }, "signature": [ "(factory: ", { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ">) => void" ] }, { "tags": [], "id": "def-server.EmbeddableSetup.registerEnhancement", "type": "Function", "label": "registerEnhancement", "description": [], "source": { "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 29 }, "signature": [ "(enhancement: ", { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", "section": "def-server.EnhancementRegistryDefinition", "text": "EnhancementRegistryDefinition" }, "<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, ">) => void" ] } ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", "lineNumber": 27 }, "lifecycle": "setup", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "id": "def-common.extractBaseEmbeddableInput", "type": "Function", "children": [ { "type": "CompoundType", "label": "state", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 20 } } ], "signature": [ "(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: ", "SavedObjectReference", "[]; }" ], "description": [], "label": "extractBaseEmbeddableInput", "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getExtractFunction", "type": "Function", "children": [ { "type": "Object", "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/extract.ts", "lineNumber": 13 } } ], "signature": [ "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" }, ") => (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: ", "SavedObjectReference", "[]; }" ], "description": [], "label": "getExtractFunction", "source": { "path": "src/plugins/embeddable/common/lib/extract.ts", "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getInjectFunction", "type": "Function", "children": [ { "type": "Object", "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/inject.ts", "lineNumber": 14 } } ], "signature": [ "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" }, ") => (state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", references: ", "SavedObjectReference", "[]) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "description": [], "label": "getInjectFunction", "source": { "path": "src/plugins/embeddable/common/lib/inject.ts", "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getMigrateFunction", "type": "Function", "children": [ { "type": "Object", "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate.ts", "lineNumber": 13 } } ], "signature": [ "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" }, ") => (state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" }, ", version: string) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.SerializableState", "text": "SerializableState" } ], "description": [], "label": "getMigrateFunction", "source": { "path": "src/plugins/embeddable/common/lib/migrate.ts", "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.getTelemetryFunction", "type": "Function", "children": [ { "type": "Object", "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/telemetry.ts", "lineNumber": 12 } } ], "signature": [ "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.CommonEmbeddableStartContract", "text": "CommonEmbeddableStartContract" }, ") => (state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", telemetryData?: Record) => Record" ], "description": [], "label": "getTelemetryFunction", "source": { "path": "src/plugins/embeddable/common/lib/telemetry.ts", "lineNumber": 12 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.injectBaseEmbeddableInput", "type": "Function", "children": [ { "type": "CompoundType", "label": "state", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 25 } }, { "type": "Array", "label": "references", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 26 } } ], "signature": [ "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", references: ", "SavedObjectReference", "[]) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "description": [], "label": "injectBaseEmbeddableInput", "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-common.isSavedObjectEmbeddableInput", "type": "Function", "label": "isSavedObjectEmbeddableInput", "signature": [ "(input: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" }, ") => boolean" ], "description": [], "children": [ { "type": "CompoundType", "label": "input", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, " | ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.SavedObjectEmbeddableInput", "text": "SavedObjectEmbeddableInput" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 16 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 15 }, "initialIsOpen": false }, { "id": "def-common.telemetryBaseEmbeddableInput", "type": "Function", "children": [ { "type": "CompoundType", "label": "state", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 14 } }, { "type": "Object", "label": "telemetryData", "isRequired": true, "signature": [ "Record" ], "description": [], "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 15 } } ], "signature": [ "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", telemetryData: Record) => Record" ], "description": [], "label": "telemetryBaseEmbeddableInput", "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-common.CommonEmbeddableStartContract", "type": "Interface", "label": "CommonEmbeddableStartContract", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", "type": "Function", "label": "getEmbeddableFactory", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 70 }, "signature": [ "(embeddableFactoryId: string) => any" ] }, { "tags": [], "id": "def-common.CommonEmbeddableStartContract.getEnhancement", "type": "Function", "label": "getEnhancement", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 71 }, "signature": [ "(enhancementId: string) => any" ] } ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 69 }, "initialIsOpen": false }, { "id": "def-common.PanelState", "type": "Interface", "label": "PanelState", "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.PanelState.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-common.PanelState.explicitInput", "type": "CompoundType", "label": "explicitInput", "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 62 }, "signature": [ "Partial & { id: string; }" ] } ], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-common.SavedObjectEmbeddableInput", "type": "Interface", "label": "SavedObjectEmbeddableInput", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SavedObjectEmbeddableInput.savedObjectId", "type": "string", "label": "savedObjectId", "description": [], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 12 } } ], "source": { "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", "lineNumber": 11 }, "initialIsOpen": false } ], "enums": [ { "id": "def-common.ViewMode", "type": "Enum", "label": "ViewMode", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 11 }, "initialIsOpen": false } ], "misc": [ { "id": "def-common.EmbeddableInput", "type": "Type", "label": "EmbeddableInput", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 16 }, "signature": [ "{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }" ], "initialIsOpen": false }, { "id": "def-common.EmbeddablePersistableStateService", "type": "Type", "label": "EmbeddablePersistableStateService", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 67 }, "signature": [ "PersistableStateService" ], "initialIsOpen": false }, { "id": "def-common.EmbeddableStateWithType", "type": "Type", "label": "EmbeddableStateWithType", "tags": [], "description": [], "source": { "path": "src/plugins/embeddable/common/types.ts", "lineNumber": 65 }, "signature": [ "EmbeddableInput & { type: string; }" ], "initialIsOpen": false } ], "objects": [ { "id": "def-common.baseEmbeddableMigrations", "type": "Object", "tags": [], "children": [], "description": [], "label": "baseEmbeddableMigrations", "source": { "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", "lineNumber": 31 }, "initialIsOpen": false } ] } }