10389 lines
361 KiB
JSON
10389 lines
361 KiB
JSON
{
|
|
"id": "embeddable",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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"
|
|
},
|
|
"<ActionContext>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ACTION_ADD_PANEL\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ACTION_ADD_PANEL\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllFactories",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
">, ",
|
|
"SavedObjectAttributes",
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "overlays",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifications",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.NotificationsStart",
|
|
"text": "NotificationsStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$5",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "SavedObjectFinder",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentType<any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.Unnamed.$6",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUiCounter",
|
|
"description": [],
|
|
"signature": [
|
|
"((appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.getIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIconType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.isCompatible",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCompatible",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<ActionContext>) => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.isCompatible.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<ActionContext>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.execute",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "execute",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<ActionContext>) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AddPanelAction.execute.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionExecutionContext",
|
|
"text": "ActionExecutionContext"
|
|
},
|
|
"<ActionContext>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "AttributeService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.AttributeService",
|
|
"text": "AttributeService"
|
|
},
|
|
"<SavedObjectAttributes, ValType, RefType>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showSaveModal",
|
|
"description": [],
|
|
"signature": [
|
|
"(saveModal: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "i18nContext",
|
|
"description": [],
|
|
"signature": [
|
|
"({ children }: { children: React.ReactNode; }) => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.ToastsApi",
|
|
"text": "ToastsApi"
|
|
},
|
|
", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$5",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"AttributeServiceOptions",
|
|
"<SavedObjectAttributes>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$6",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactory",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
">, ",
|
|
"SavedObjectAttributes",
|
|
">) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.unwrapAttributes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "unwrapAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ValType | RefType) => Promise<SavedObjectAttributes>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.unwrapAttributes.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValType | RefType"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.wrapAttributes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "wrapAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise<Pick<ValType | RefType, Exclude<keyof ValType & keyof RefType, \"id\">>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.wrapAttributes.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "newAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.wrapAttributes.$2",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useRefType",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.wrapAttributes.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValType | RefType | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.inputIsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "inputIsRefType",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ValType | RefType) => input is RefType"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.inputIsRefType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValType | RefType"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getExplicitInputFromEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInputFromEmbeddable",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getExplicitInputFromEmbeddable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getInputAsValueType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsValueType",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ValType | RefType) => Promise<ValType>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getInputAsValueType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValType | RefType"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getInputAsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsRefType",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise<RefType>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getInputAsRefType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValType | RefType"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.getInputAsRefType.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "saveOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Container",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<TChildInput, TContainerInput, TContainerOutput> extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<TContainerInput, TContainerOutput> implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<TChildInput, TContainerInput, TContainerOutput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.isContainer",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isContainer",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.children",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "children",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"TContainerInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [],
|
|
"signature": [
|
|
"TContainerOutput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed.$3",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Container",
|
|
"text": "Container"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.setChildLoaded",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setChildLoaded",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.setChildLoaded.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.updateInputForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateInputForChild",
|
|
"description": [],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(id: string, changes: Partial<EEI>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.updateInputForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.updateInputForChild.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.reload",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reload",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addNewEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", EEO extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | E>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "explicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.removeEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"(embeddableId: string) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.removeEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getChildIds",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getChildIds",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getChild",
|
|
"description": [],
|
|
"signature": [
|
|
"<E extends ",
|
|
{
|
|
"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"
|
|
},
|
|
">>(id: string) => E"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getInputForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputForChild",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEmbeddableInput extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(embeddableId: string) => TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getInputForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.untilEmbeddableLoaded",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untilEmbeddableLoaded",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEmbeddable extends ",
|
|
{
|
|
"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"
|
|
},
|
|
">>(id: string) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.untilEmbeddableLoaded.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createNewPanelState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createNewPanelState",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEmbeddableInput extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", TEmbeddable extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, any>>(factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, any, TEmbeddable, ",
|
|
"SavedObjectAttributes",
|
|
">, partial?: Partial<TEmbeddableInput>) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createNewPanelState.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, any, TEmbeddable, ",
|
|
"SavedObjectAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createNewPanelState.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "partial",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getPanelState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPanelState",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEmbeddableInput extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(embeddableId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getPanelState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getInheritedInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInheritedInput",
|
|
"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 state stored in `this.input.panels[embeddableId].explicitInput`\nwill override inherited input."
|
|
],
|
|
"signature": [
|
|
"(id: string) => TChildInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getInheritedInput.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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"
|
|
},
|
|
"<ActionContext>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"editPanel\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"\"editPanel\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.currentAppId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "currentAppId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.Unnamed.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "application",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ApplicationStart",
|
|
"text": "ApplicationStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "stateTransfer",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableStateTransfer",
|
|
"text": "EmbeddableStateTransfer"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"({ embeddable }: ActionContext) => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getDisplayName.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ embeddable }",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionContext"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIconType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.isCompatible",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCompatible",
|
|
"description": [],
|
|
"signature": [
|
|
"({ embeddable }: ActionContext) => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.isCompatible.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ embeddable }",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionContext"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.execute",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "execute",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ActionContext) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.execute.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionContext"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getAppTarget",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAppTarget",
|
|
"description": [],
|
|
"signature": [
|
|
"({ embeddable }: ActionContext) => NavigationContext | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getAppTarget.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ embeddable }",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionContext"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getHref",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getHref",
|
|
"description": [],
|
|
"signature": [
|
|
"({ embeddable }: ActionContext) => Promise<string>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EditPanelAction.getHref.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ embeddable }",
|
|
"description": [],
|
|
"signature": [
|
|
"ActionContext"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<TEmbeddableInput, TEmbeddableOutput> implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, TEmbeddableOutput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.runtimeId",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "runtimeId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.runtimeId",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "runtimeId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.parent",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.isContainer",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isContainer",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.deferEmbeddableLoad",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "deferEmbeddableLoad",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.fatalError",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fatalError",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.output",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [],
|
|
"signature": [
|
|
"TEmbeddableOutput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.input",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.renderComplete",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "renderComplete",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.RenderCompleteDispatcher",
|
|
"text": "RenderCompleteDispatcher"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.destroyed",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "destroyed",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.Unnamed.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.Unnamed.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "output",
|
|
"description": [],
|
|
"signature": [
|
|
"TEmbeddableOutput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getIsContainer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIsContainer",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.reload",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reload",
|
|
"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$"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getUpdated$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUpdated$",
|
|
"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 state handling in case `reload` already handled it."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"Observable",
|
|
"<TEmbeddableInput | TEmbeddableOutput>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getInput$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInput$",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"Observable",
|
|
"<TEmbeddableInput>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getOutput$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOutput$",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"Observable",
|
|
"<TEmbeddableOutput>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getOutput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOutput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Readonly<TEmbeddableOutput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Readonly<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getTitle",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRoot",
|
|
"description": [
|
|
"\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent."
|
|
],
|
|
"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"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.updateInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(changes: Partial<TEmbeddableInput>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.updateInput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"(el: HTMLElement) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "el",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getInspectorAdapters",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getInspectorAdapters",
|
|
"description": [
|
|
"\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [
|
|
"Inspector adapters that will be used to open an inspector for."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [
|
|
"\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add additional clean up tasks, like un-mounting and unsubscribing."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setInitializationFinished",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setInitializationFinished",
|
|
"description": [
|
|
"\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.updateOutput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateOutput",
|
|
"description": [],
|
|
"signature": [
|
|
"(outputChanges: Partial<TEmbeddableOutput>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.updateOutput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "outputChanges",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableOutput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.onFatalError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFatalError",
|
|
"description": [],
|
|
"signature": [
|
|
"(e: Error) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.onFatalError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "e",
|
|
"description": [],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.supportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "supportedTriggers",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.mounted",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "mounted",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.embeddable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableChildPanelProps",
|
|
"text": "EmbeddableChildPanelProps"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.componentDidMount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentDidMount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.componentWillUnmount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentWillUnmount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanel.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactoryNotFoundError.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactoryNotFoundError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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<Props, State, any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"Props"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UNSAFE_componentWillMount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.componentWillUnmount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentWillUnmount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.onFocus",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFocus",
|
|
"description": [],
|
|
"signature": [
|
|
"(focusedPanelIndex: string) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.onFocus.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "focusedPanelIndex",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.onBlur",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onBlur",
|
|
"description": [],
|
|
"signature": [
|
|
"(blurredPanelIndex: string) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.onBlur.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "blurredPanelIndex",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.componentDidMount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentDidMount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.closeMyContextMenuPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "closeMyContextMenuPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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<Props, {}, any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"Props"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.componentDidMount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentDidMount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.componentDidUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "componentDidUpdate",
|
|
"description": [],
|
|
"signature": [
|
|
"(prevProps?: Props | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.componentDidUpdate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "prevProps",
|
|
"description": [],
|
|
"signature": [
|
|
"Props | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.shouldComponentUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shouldComponentUpdate",
|
|
"description": [],
|
|
"signature": [
|
|
"(newProps: Props) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.shouldComponentUpdate.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newProps",
|
|
"description": [],
|
|
"signature": [
|
|
"Props"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "EmbeddableStateTransfer",
|
|
"description": [
|
|
"\nA wrapper around the session storage which provides strongly typed helper methods\nfor common incoming and outgoing states used by the embeddable infrastructure.\n"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.isTransferInProgress",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isTransferInProgress",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToApp",
|
|
"description": [],
|
|
"signature": [
|
|
"(appId: string, options?: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "currentAppId$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<string | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appList",
|
|
"description": [],
|
|
"signature": [
|
|
"ReadonlyMap<string, ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.PublicAppInfo",
|
|
"text": "PublicAppInfo"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "customStorage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getAppNameFromId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAppNameFromId",
|
|
"description": [
|
|
"\nFetches an internationalized app title when given an appId."
|
|
],
|
|
"signature": [
|
|
"(appId: string) => string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getAppNameFromId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The id of the app to fetch the title for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncomingEditorState",
|
|
"description": [
|
|
"\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"
|
|
],
|
|
"signature": [
|
|
"(appId: string, removeAfterFetch?: boolean | undefined) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch incomingEditorState for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeAfterFetch",
|
|
"description": [
|
|
"- Whether to remove the package state after fetch to prevent duplicates."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.clearEditorState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearEditorState",
|
|
"description": [
|
|
"\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"
|
|
],
|
|
"signature": [
|
|
"(appId?: string | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.clearEditorState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch incomingEditorState for"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncomingEmbeddablePackage",
|
|
"description": [
|
|
"\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n"
|
|
],
|
|
"signature": [
|
|
"(appId: string, removeAfterFetch?: boolean | undefined) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch EmbeddablePackageState for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeAfterFetch",
|
|
"description": [
|
|
"- Whether to remove the package state after fetch to prevent duplicates."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToEditor",
|
|
"description": [
|
|
"\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}"
|
|
],
|
|
"signature": [
|
|
"(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
},
|
|
"; } | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.openInNewTab",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "openInNewTab",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToWithEmbeddablePackage",
|
|
"description": [
|
|
"\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}"
|
|
],
|
|
"signature": [
|
|
"(appId: string, options?: { path?: string | undefined; state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
},
|
|
"; } | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"\"error\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.reload",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reload",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"(dom: HTMLElement) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.render.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dom",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelNotFoundError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PanelNotFoundError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.PanelNotFoundError",
|
|
"text": "PanelNotFoundError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelNotFoundError.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelNotFoundError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.defaultEmbeddableFactoryProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "defaultEmbeddableFactoryProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>, T extends ",
|
|
"SavedObjectAttributes",
|
|
" = ",
|
|
"SavedObjectAttributes",
|
|
">(def: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<I, O, E, T>) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, T>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.defaultEmbeddableFactoryProvider.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "def",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<I, O, E, T>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRenderer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "EmbeddableRenderer",
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(props: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableRendererProps",
|
|
"text": "EmbeddableRendererProps"
|
|
},
|
|
"<I>) => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRenderer.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [
|
|
"- {@link EmbeddableRendererProps}"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableRendererProps",
|
|
"text": "EmbeddableRendererProps"
|
|
},
|
|
"<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isContextMenuTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isContextMenuTriggerContext",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isContextMenuTriggerContext.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEmbeddable",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isEmbeddable.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "x",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isErrorEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isErrorEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"(embeddable: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isErrorEmbeddable.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRangeSelectTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRangeSelectTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRangeSelectTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isReferenceOrValueEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isReferenceOrValueEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"(incoming: unknown) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isReferenceOrValueEmbeddable.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "incoming",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRowClickTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRowClickTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRowClickTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isSavedObjectEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isSavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isSavedObjectEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isValueClickTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isValueClickTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isValueClickTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"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"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openAddPanelFlyout",
|
|
"description": [],
|
|
"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: <I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined; getAllFactories: () => 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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
">, ",
|
|
"SavedObjectAttributes",
|
|
">>; overlays: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
},
|
|
"; notifications: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.NotificationsStart",
|
|
"text": "NotificationsStart"
|
|
},
|
|
"; SavedObjectFinder: React.ComponentType<any>; showCreateNewMenu?: boolean | undefined; reportUiCounter?: ((appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void) | undefined; }) => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.embeddable",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.getFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.getFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableFactoryId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.getAllFactories",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllFactories",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
">, ",
|
|
"SavedObjectAttributes",
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.overlays",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "overlays",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayStart",
|
|
"text": "OverlayStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.notifications",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "notifications",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.NotificationsStart",
|
|
"text": "NotificationsStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.SavedObjectFinder",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "SavedObjectFinder",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentClass<any, any> | React.FunctionComponent<any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.showCreateNewMenu",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "showCreateNewMenu",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.reportUiCounter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportUiCounter",
|
|
"description": [],
|
|
"signature": [
|
|
"((appName: string, type: ",
|
|
{
|
|
"pluginId": "@kbn/analytics",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsPluginApi",
|
|
"section": "def-common.UiCounterMetricType",
|
|
"text": "UiCounterMetricType"
|
|
},
|
|
", eventNames: string | string[], count?: number | undefined) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.useEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n input,\n factory,\n onInputUpdated,\n}: EmbeddableRendererWithFactory<I>) => readonly [",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
"> | undefined, boolean, string | undefined]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.useEmbeddableFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n input,\n factory,\n onInputUpdated,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"EmbeddableRendererWithFactory<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.withEmbeddableSubscription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "withEmbeddableSubscription",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>, ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.withEmbeddableSubscription.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "WrappedComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Adapters",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Adapters",
|
|
"description": [
|
|
"\nThe interface that the adapters used to open an inspector have to fullfill."
|
|
],
|
|
"path": "src/plugins/inspector/common/adapters/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Adapters.requests",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "requests",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.RequestAdapter",
|
|
"text": "RequestAdapter"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/inspector/common/adapters/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Adapters.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/inspector/common/adapters/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ContainerInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ContainerInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<PanelExplicitInput> extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ContainerInput.hidePanelTitles",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hidePanelTitles",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ContainerInput.panels",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panels",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<PanelExplicitInput & ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { id: string; }>; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ContainerOutput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ContainerOutput",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ContainerOutput.embeddableLoaded",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddableLoaded",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [key: string]: boolean; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableChildPanelProps",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.embeddableId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.container",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "container",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.PanelComponent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "PanelComponent",
|
|
"description": [],
|
|
"signature": [
|
|
"React.FunctionComponent<{ 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; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.PanelComponent.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P & { children?: React.ReactNode; }"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableChildPanelProps.PanelComponent.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableContext",
|
|
"text": "EmbeddableContext"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContext.embeddable",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableEditorState",
|
|
"description": [
|
|
"\nA state package that contains information an editor will need to create or edit an embeddable then redirect back."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.originatingApp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originatingApp",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.originatingPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "originatingPath",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.embeddableId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.valueInput",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "valueInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableFactory",
|
|
"description": [
|
|
"\nEmbeddableFactories create and initialize an embeddable instance"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, TEmbeddableOutput, TEmbeddable, TSavedObjectAttributes> 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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.isEditable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"() => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.savedObjectMetaData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectMetaData",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectMetaData",
|
|
"text": "SavedObjectMetaData"
|
|
},
|
|
"<TSavedObjectAttributes> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.grouping",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "grouping",
|
|
"description": [
|
|
"\nIndicates the grouping this factory should appear in a sub-menu. Example, this is used for grouping\noptions in the editors menu in Dashboard for creating new embeddables"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.PresentableGrouping",
|
|
"text": "PresentableGrouping"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.isContainerType",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [
|
|
"\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers."
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIconType",
|
|
"description": [
|
|
"\nReturns an EUI Icon type to be displayed in a menu."
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDescription",
|
|
"description": [
|
|
"\nReturns a description about the embeddable."
|
|
],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.canCreateNew",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "canCreateNew",
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getDefaultInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDefaultInput",
|
|
"description": [
|
|
"\nCan be used to get the default input, to be passed in to during the creation process. Default\ninput will not be stored in a parent container, so all inherited input from a container will trump\ndefault input parameters."
|
|
],
|
|
"signature": [
|
|
"(partial: Partial<TEmbeddableInput>) => Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getDefaultInput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "partial",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getExplicitInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInput",
|
|
"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 all inherited\ninput passed down from the parent container."
|
|
],
|
|
"signature": [
|
|
"() => Promise<Partial<TEmbeddableInput>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.createFromSavedObject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createFromSavedObject",
|
|
"description": [
|
|
"\nCreates a new embeddable instance based off the saved object id."
|
|
],
|
|
"signature": [
|
|
"(savedObjectId: string, input: Partial<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<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.createFromSavedObject.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.createFromSavedObject.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "input",
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.createFromSavedObject.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"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."
|
|
],
|
|
"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<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.create.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"signature": [
|
|
"TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.create.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableInstanceConfiguration",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableInstanceConfiguration",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableInstanceConfiguration.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableInstanceConfiguration.savedObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableOutput",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.loading",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "loading",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.error",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"EmbeddableError",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.editUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "editUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.editApp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "editApp",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.editPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "editPath",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.defaultTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.editable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "editable",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.savedObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddablePackageState",
|
|
"description": [
|
|
"\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.input",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"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\">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.embeddableId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetupDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableSetupDependencies",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetupDependencies.uiActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiActions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly addTriggerAction: (triggerId: string, action: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<object>>(definition: A) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<",
|
|
"ActionContext",
|
|
"<A>>; readonly registerTrigger: (trigger: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Trigger",
|
|
"text": "Trigger"
|
|
},
|
|
") => void; readonly unregisterAction: (actionId: string) => void; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableStartDependencies",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.uiActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiActions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly clear: () => void; readonly addTriggerAction: (triggerId: string, action: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<object>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<object>>(definition: A) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<",
|
|
"ActionContext",
|
|
"<A>>; readonly registerTrigger: (trigger: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Trigger",
|
|
"text": "Trigger"
|
|
},
|
|
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
|
|
"TriggerContract",
|
|
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: <T extends ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<object>>(id: string) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<",
|
|
"ActionContext",
|
|
"<T>>; readonly getTriggerActions: (triggerId: string) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly fork: () => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.UiActionsService",
|
|
"text": "UiActionsService"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.inspector",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "inspector",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "public",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-public.Start",
|
|
"text": "Start"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EnhancementRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnhancementRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<P> extends Partial<",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<P>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EnhancementRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IContainer",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<Inherited, I, O> extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.untilEmbeddableLoaded",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untilEmbeddableLoaded",
|
|
"description": [
|
|
"\nCall if you want to wait until an embeddable with that id has finished loading."
|
|
],
|
|
"signature": [
|
|
"<TEmbeddable extends ",
|
|
{
|
|
"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"
|
|
},
|
|
">>(id: string) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | TEmbeddable>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.untilEmbeddableLoaded.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.getInputForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputForChild",
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(id: string) => EEI"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.getInputForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.updateInputForChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateInputForChild",
|
|
"description": [
|
|
"\nChanges the input for a given child. Note, this will override all inherited state taken from\nthe container itself."
|
|
],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(id: string, changes: Partial<EEI>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.updateInputForChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.updateInputForChild.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.getChild",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getChild",
|
|
"description": [
|
|
"\nReturns the child embeddable with the given id."
|
|
],
|
|
"signature": [
|
|
"<E 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"
|
|
},
|
|
"> = ",
|
|
{
|
|
"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"
|
|
},
|
|
">>(id: string) => E"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.getChild.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.setChildLoaded",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setChildLoaded",
|
|
"description": [
|
|
"\nEmbeddables which have deferEmbeddableLoad set to true need to manually call setChildLoaded\non their parent container to communicate when they have finished loading."
|
|
],
|
|
"signature": [
|
|
"<E extends ",
|
|
{
|
|
"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.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"
|
|
},
|
|
">>(embeddable: E) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.setChildLoaded.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [
|
|
"- the embeddable to set"
|
|
],
|
|
"signature": [
|
|
"E"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.removeEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeEmbeddable",
|
|
"description": [
|
|
"\nRemoves the embeddable with the given id."
|
|
],
|
|
"signature": [
|
|
"(embeddableId: string) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.removeEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.addNewEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addNewEmbeddable",
|
|
"description": [
|
|
"\nAdds a new embeddable to the container. `explicitInput` may partially specify the required embeddable input,\nbut the remainder must come from inherited container state."
|
|
],
|
|
"signature": [
|
|
"<EEI extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", EEO extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<EEI, EEO> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<EEI, EEO>>(type: string, explicitInput: Partial<EEI>) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | E>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.addNewEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.addNewEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "explicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IEmbeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.isContainer",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isContainer",
|
|
"description": [
|
|
"\nIs this embeddable an instance of a Container class, can it contain\nnested embeddables?"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.parent",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parent",
|
|
"description": [
|
|
"\nIf this embeddable is nested inside a container, this will contain\na reference to its parent."
|
|
],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nA unique identifier for this embeddable. Mainly only used by containers to map their\nPanel States to a child embeddable instance."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.deferEmbeddableLoad",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "deferEmbeddableLoad",
|
|
"description": [
|
|
"\nIf set to true, defer embeddable load tells the container that this embeddable\ntype isn't completely loaded when the constructor returns. This embeddable\nwill have to manually call setChildLoaded on its parent when all of its initial\noutput is finalized. For instance, after loading a saved object."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.runtimeId",
|
|
"type": "number",
|
|
"tags": [],
|
|
"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`."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.enhancements",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "enhancements",
|
|
"description": [
|
|
"\nExtra abilities added to Embeddable by `*_enhanced` plugins."
|
|
],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.fatalError",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fatalError",
|
|
"description": [
|
|
"\nIf this embeddable has encountered a fatal error, that error will be stored here"
|
|
],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getIsContainer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIsContainer",
|
|
"description": [
|
|
"\nA functional representation of the isContainer variable, but helpful for typescript to\nknow the shape if this returns true"
|
|
],
|
|
"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"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInput",
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getOutput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOutput",
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<O>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.updateInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateInput",
|
|
"description": [
|
|
"\nUpdates input state with the given changes."
|
|
],
|
|
"signature": [
|
|
"(changes: Partial<I>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.updateInput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getInput$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInput$",
|
|
"description": [
|
|
"\nReturns an observable which will be notified when input state changes."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"Observable",
|
|
"<I>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getOutput$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getOutput$",
|
|
"description": [
|
|
"\nReturns an observable which will be notified when output state changes."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<",
|
|
"Observable",
|
|
"<O>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getTitle",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTitle",
|
|
"description": [
|
|
"\nReturns the title of this embeddable."
|
|
],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRoot",
|
|
"description": [
|
|
"\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent."
|
|
],
|
|
"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"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [
|
|
"\nRenders the embeddable at the given node."
|
|
],
|
|
"signature": [
|
|
"(domNode: Element | HTMLElement) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.render.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "domNode",
|
|
"description": [],
|
|
"signature": [
|
|
"Element | HTMLElement"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.reload",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reload",
|
|
"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)"
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getInspectorAdapters",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getInspectorAdapters",
|
|
"description": [
|
|
"\nAn embeddable can return inspector adapters if it wants the inspector to be\navailable via the context menu of that panel."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [
|
|
"Inspector adapters that will be used to open an inspector for."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.destroy",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "destroy",
|
|
"description": [
|
|
"\nCleans up subscriptions, destroy nodes mounted from calls to render."
|
|
],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.supportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "supportedTriggers",
|
|
"description": [
|
|
"\nList of triggers that this embeddable will execute."
|
|
],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.OutputSpec",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "OutputSpec",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.OutputSpec.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PanelState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<E>"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelState.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelState.explicitInput",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "explicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<E> & { id: string; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PropertySpec",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.displayName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "displayName",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.accessPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "accessPath",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.value",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.RangeSelectContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RangeSelectContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.RangeSelectContext",
|
|
"text": "RangeSelectContext"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.RangeSelectContext.embeddable",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.RangeSelectContext.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
"{ table: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
"; column: number; range: number[]; timeFieldName?: string | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReferenceOrValueEmbeddable",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReferenceOrValueEmbeddable",
|
|
"description": [
|
|
"\nAll embeddables that implement 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)."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReferenceOrValueEmbeddable",
|
|
"text": "ReferenceOrValueEmbeddable"
|
|
},
|
|
"<ValTypeInput, RefTypeInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "inputIsRefType",
|
|
"description": [
|
|
"\ndetermines whether the input is by value or by reference."
|
|
],
|
|
"signature": [
|
|
"(input: ValTypeInput | RefTypeInput) => input is RefTypeInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"ValTypeInput | RefTypeInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReferenceOrValueEmbeddable.getInputAsValueType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsValueType",
|
|
"description": [
|
|
"\nGets the embeddable's current input as its Value type"
|
|
],
|
|
"signature": [
|
|
"() => Promise<ValTypeInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReferenceOrValueEmbeddable.getInputAsRefType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInputAsRefType",
|
|
"description": [
|
|
"\nGets the embeddable's current input as its Reference type"
|
|
],
|
|
"signature": [
|
|
"() => Promise<RefTypeInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SavedObjectEmbeddableInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SavedObjectEmbeddableInput.savedObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ValueClickContext",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ValueClickContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ValueClickContext",
|
|
"text": "ValueClickContext"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ValueClickContext.embeddable",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ValueClickContext.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"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; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ViewMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ViewMode",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ACTION_ADD_PANEL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTION_ADD_PANEL",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ACTION_ADD_PANEL\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ACTION_EDIT_PANEL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ACTION_EDIT_PANEL",
|
|
"description": [],
|
|
"signature": [
|
|
"\"editPanel\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ATTRIBUTE_SERVICE_KEY",
|
|
"type": "string",
|
|
"tags": [],
|
|
"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."
|
|
],
|
|
"signature": [
|
|
"\"attributes\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ChartActionContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ChartActionContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ValueClickContext",
|
|
"text": "ValueClickContext"
|
|
},
|
|
"<T> | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.RangeSelectContext",
|
|
"text": "RangeSelectContext"
|
|
},
|
|
"<T> | ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.RowClickContext",
|
|
"text": "RowClickContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.CONTEXT_MENU_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CONTEXT_MENU_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"CONTEXT_MENU_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactoryDefinition",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableFactoryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, T>, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, T>, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanelHOC",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddablePanelHOC",
|
|
"description": [],
|
|
"signature": [
|
|
"React.FunctionComponent<{ 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; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanelHOC.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P & { children?: React.ReactNode; }"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanelHOC.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRendererProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableRendererProps",
|
|
"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"
|
|
],
|
|
"signature": [
|
|
"EmbeddableRendererPropsWithEmbeddable<I> | EmbeddableRendererWithFactory<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PANEL_BADGE_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PANEL_BADGE_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PANEL_BADGE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PANEL_NOTIFICATION_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PANEL_NOTIFICATION_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PANEL_NOTIFICATION_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SELECT_RANGE_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SELECT_RANGE_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"SELECT_RANGE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.VALUE_CLICK_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VALUE_CLICK_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"VALUE_CLICK_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.contextMenuTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextMenuTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.contextMenuTrigger.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.contextMenuTrigger.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.contextMenuTrigger.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelBadgeTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelBadgeTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelBadgeTrigger.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelBadgeTrigger.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelBadgeTrigger.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelNotificationTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelNotificationTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelNotificationTrigger.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelNotificationTrigger.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelNotificationTrigger.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableSetup",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(id: string, factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
">) => () => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEnhancement",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancement: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEnhancement.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enhancement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setCustomEmbeddableFactoryProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"(customProvider: ",
|
|
"EmbeddableFactoryProvider",
|
|
") => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "customProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"EmbeddableFactoryProvider"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableStart",
|
|
"text": "EmbeddableStart"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", O extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", E extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
"SavedObjectAttributes",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getEmbeddableFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableFactoryId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getEmbeddableFactories",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactories",
|
|
"description": [],
|
|
"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"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
">, ",
|
|
"SavedObjectAttributes",
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.EmbeddablePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "EmbeddablePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"React.FunctionComponent<{ 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; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.EmbeddablePanel.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"P & { children?: React.ReactNode; }"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.EmbeddablePanel.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "node_modules/@types/react/index.d.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getStateTransfer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStateTransfer",
|
|
"description": [],
|
|
"signature": [
|
|
"(storage?: ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
" | undefined) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableStateTransfer",
|
|
"text": "EmbeddableStateTransfer"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getStateTransfer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "storage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getAttributeService",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAttributeService",
|
|
"description": [],
|
|
"signature": [
|
|
"<A extends { title: string; }, V extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { attributes: A; } = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { attributes: A; }, R extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
},
|
|
">(type: string, options: ",
|
|
"AttributeServiceOptions",
|
|
"<A>) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.AttributeService",
|
|
"text": "AttributeService"
|
|
},
|
|
"<A, V, R>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getAttributeService.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getAttributeService.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"AttributeServiceOptions",
|
|
"<A>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<P> extends Partial<",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<P>>"
|
|
],
|
|
"path": "src/plugins/embeddable/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EnhancementRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnhancementRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<P> extends Partial<",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<P>>"
|
|
],
|
|
"path": "src/plugins/embeddable/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EnhancementRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/server/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableSetup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EmbeddableSetup",
|
|
"text": "EmbeddableSetup"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEmbeddableFactory",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEmbeddableFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEnhancement",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancement: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEnhancement.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enhancement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.getAllMigrations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllMigrations",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.MigrateFunctionsObject",
|
|
"text": "MigrateFunctionsObject"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.extractBaseEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extractBaseEmbeddableInput",
|
|
"description": [],
|
|
"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",
|
|
"[]; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.extractBaseEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getExtractFunction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExtractFunction",
|
|
"description": [],
|
|
"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",
|
|
"[]; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/extract.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getExtractFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.CommonEmbeddableStartContract",
|
|
"text": "CommonEmbeddableStartContract"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/extract.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getInjectFunction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInjectFunction",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/inject.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getInjectFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.CommonEmbeddableStartContract",
|
|
"text": "CommonEmbeddableStartContract"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/inject.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getMigrateFunction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getMigrateFunction",
|
|
"description": [],
|
|
"signature": [
|
|
"(embeddables: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.CommonEmbeddableStartContract",
|
|
"text": "CommonEmbeddableStartContract"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.MigrateFunction",
|
|
"text": "MigrateFunction"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getMigrateFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.CommonEmbeddableStartContract",
|
|
"text": "CommonEmbeddableStartContract"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getTelemetryFunction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTelemetryFunction",
|
|
"description": [],
|
|
"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<string, ",
|
|
"PhraseFilterValue",
|
|
">) => Record<string, ",
|
|
"PhraseFilterValue",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/telemetry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.getTelemetryFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.CommonEmbeddableStartContract",
|
|
"text": "CommonEmbeddableStartContract"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/telemetry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.injectBaseEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "injectBaseEmbeddableInput",
|
|
"description": [],
|
|
"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"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.injectBaseEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.injectBaseEmbeddableInput.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "references",
|
|
"description": [],
|
|
"signature": [
|
|
"SavedObjectReference",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.isSavedObjectEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isSavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"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"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.isSavedObjectEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.telemetryBaseEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "telemetryBaseEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
", telemetryData: Record<string, ",
|
|
"PhraseFilterValue",
|
|
">) => Record<string, ",
|
|
"PhraseFilterValue",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.telemetryBaseEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.telemetryBaseEmbeddableInput.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "telemetryData",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"PhraseFilterValue",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CommonEmbeddableStartContract",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
"> & { isContainerType: boolean; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableFactoryId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEnhancement",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancementId: string) => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEnhancement.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "enhancementId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.PanelState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "PanelState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<E>"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.PanelState.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.PanelState.explicitInput",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "explicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<E> & { id: string; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.SavedObjectEmbeddableInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.SavedObjectEmbeddableInput.savedObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.ViewMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ViewMode",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddableInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ",
|
|
"KibanaExecutionContext",
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddablePersistableStateService",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddablePersistableStateService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddableStateWithType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableStateWithType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { type: string; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.MigrateFunction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MigrateFunction",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
", version: string) => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.MigrateFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "server",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-server.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.MigrateFunction.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.baseEmbeddableMigrations",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "baseEmbeddableMigrations",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/lib/migrate_base_input.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |