mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
15919 lines
No EOL
571 KiB
JSON
15919 lines
No EOL
571 KiB
JSON
{
|
|
"id": "embeddable",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"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, MetaInfo>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "toasts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-notifications-browser",
|
|
"scope": "public",
|
|
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
|
|
"section": "def-public.IToasts",
|
|
"text": "IToasts"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"AttributeServiceOptions",
|
|
"<SavedObjectAttributes, MetaInfo>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.Unnamed.$4",
|
|
"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"
|
|
},
|
|
", any>, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.AttributeService.unwrapAttributes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "unwrapAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ValType | RefType) => Promise<",
|
|
"AttributeServiceUnwrapResult",
|
|
"<SavedObjectAttributes, MetaInfo>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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<Omit<ValType | RefType, \"id\">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<TChildInput, TContainerInput, TContainerOutput>,",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.children$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "children$",
|
|
"description": [],
|
|
"signature": [
|
|
"BehaviorSubject",
|
|
"<{ [key: string]: unknown; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O, any>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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.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/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.Unnamed.$5",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settings",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableContainerSettings",
|
|
"text": "EmbeddableContainerSettings"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getPanelCount",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPanelCount",
|
|
"description": [],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.removePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.removePanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addNewPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"<ApiType extends unknown = unknown>(panelPackage: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<object>) => Promise<ApiType | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewPanel.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelPackage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<object>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replacePanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replacePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(idToRemove: string, { panelType, initialState }: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<object>) => Promise<string>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replacePanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "idToRemove",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replacePanel.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ panelType, initialState }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PanelPackage",
|
|
"text": "PanelPackage"
|
|
},
|
|
"<object>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
", any>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO, any>>(type: string, explicitInput: Partial<EEI>, attributes?: unknown) => 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.addNewEmbeddable.$3",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replaceEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replaceEmbeddable",
|
|
"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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<EEI, EEO, any>>(id: string, newExplicitInput: Partial<EEI>, newType?: string | undefined, generateNewId?: boolean | undefined) => Promise<string>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replaceEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replaceEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replaceEmbeddable.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newType",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.replaceEmbeddable.$4",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "generateNewId",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.onRemoveEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onRemoveEmbeddable",
|
|
"description": [
|
|
"\nControl the panels that are pushed to the input stream when an embeddable is\nremoved. This can be used if removing one embeddable has knock-on effects, like\nre-ordering embeddables that come after it."
|
|
],
|
|
"signature": [
|
|
"(embeddableId: string) => { [key: string]: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
" & { id: string; }>; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.onRemoveEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>>(id: string) => E"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getAnyChildOutputChange$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAnyChildOutputChange$",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<string>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"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,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>>(id: string) => Promise<TEmbeddable | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.untilReactEmbeddableLoaded",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untilReactEmbeddableLoaded",
|
|
"description": [],
|
|
"signature": [
|
|
"<ApiType>(id: string) => Promise<ApiType | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.untilReactEmbeddableLoaded.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getExplicitInputIsEqual",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInputIsEqual",
|
|
"description": [],
|
|
"signature": [
|
|
"(lastInput: TContainerInput) => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.getExplicitInputIsEqual.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "lastInput",
|
|
"description": [],
|
|
"signature": [
|
|
"TContainerInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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, any>>(factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<TEmbeddableInput, any, TEmbeddable, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">, partial?: Partial<TEmbeddableInput>, attributes?: unknown) => { newPanel: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<TEmbeddableInput>; otherPanels: TContainerInput[\"panels\"]; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createNewPanelState.$3",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createAndSaveEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createAndSaveEmbeddable",
|
|
"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"
|
|
},
|
|
", TEmbeddable extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", any>>(type: string, panelState: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; version?: string | undefined; }>, otherPanels: TContainerInput[\"panels\"]) => Promise<TEmbeddable | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createAndSaveEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createAndSaveEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.PanelState",
|
|
"text": "PanelState"
|
|
},
|
|
"<{ id: string; version?: string | undefined; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Container.createAndSaveEmbeddable.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "otherPanels",
|
|
"description": [],
|
|
"signature": [
|
|
"TContainerInput[\"panels\"]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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, TNode> implements ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<TEmbeddableInput, TEmbeddableOutput, TNode>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.uuid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.disableTriggers",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "disableTriggers",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.onEdit",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onEdit",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.viewMode",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "viewMode",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
"; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
") => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
") => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
"; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
">; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
">[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
", R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
">; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
"> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
">> | ((value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
") => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
") => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.parentApi",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "parentApi",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
},
|
|
" & Partial<Pick<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesPanelTitle",
|
|
"text": "PublishesPanelTitle"
|
|
},
|
|
", \"hidePanelTitle\"> & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesViewMode",
|
|
"text": "PublishesViewMode"
|
|
},
|
|
">) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.dataViews",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViews",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined) => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>> | ((value: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
"[] | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.query$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined) => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>> | ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.panelTitle",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: string | undefined; error: (err: any) => void; forEach: { (next: (value: string | undefined) => void): Promise<void>; (next: (value: string | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => string | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<string | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<string | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<string | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<string | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, string | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<string | undefined>> | ((value: string | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: string | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<string | undefined>; (PromiseCtor: PromiseConstructor): Promise<string | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.dataLoading",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataLoading",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: boolean | undefined; error: (err: any) => void; forEach: { (next: (value: boolean | undefined) => void): Promise<void>; (next: (value: boolean | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => boolean | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<boolean | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<boolean | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<boolean | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<boolean | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, boolean | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<boolean | undefined>> | ((value: boolean | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: boolean | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<boolean | undefined>; (PromiseCtor: PromiseConstructor): Promise<boolean | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<boolean | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.filters$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "filters$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>> | ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[] | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.phase$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "phase$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined) => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>> | ((value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PhaseEvent",
|
|
"text": "PhaseEvent"
|
|
},
|
|
" | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.linkToLibrary",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "linkToLibrary",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<void>) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.blockingError",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "blockingError",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: Error | undefined; error: (err: any) => void; forEach: { (next: (value: Error | undefined) => void): Promise<void>; (next: (value: Error | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => Error | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<Error | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<Error | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<Error | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<Error | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<Error | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, Error | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<Error | undefined>> | ((value: Error | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: Error | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<Error | undefined>; (PromiseCtor: PromiseConstructor): Promise<Error | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<Error | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setPanelTitle",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setPanelTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"(newTitle: string | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setPanelTitle.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_title.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.timeRange$",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange$",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; error: (err: any) => void; forEach: { (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void): Promise<void>; (next: (value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>> | ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructor): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.hidePanelTitle",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hidePanelTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: boolean | undefined; error: (err: any) => void; forEach: { (next: (value: boolean | undefined) => void): Promise<void>; (next: (value: boolean | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => boolean | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<boolean | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<boolean | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<boolean | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<boolean | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<boolean | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, boolean | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<boolean | undefined>> | ((value: boolean | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: boolean | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<boolean | undefined>; (PromiseCtor: PromiseConstructor): Promise<boolean | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<boolean | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.isEditingEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEditingEnabled",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.canLinkToLibrary",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "canLinkToLibrary",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<boolean>) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.panelDescription",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: string | undefined; error: (err: any) => void; forEach: { (next: (value: string | undefined) => void): Promise<void>; (next: (value: string | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => string | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<string | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<string | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<string | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<string | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, string | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<string | undefined>> | ((value: string | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: string | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<string | undefined>; (PromiseCtor: PromiseConstructor): Promise<string | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.defaultPanelDescription",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultPanelDescription",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<string | undefined> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.disabledActionIds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "disabledActionIds",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: string[] | undefined; error: (err: any) => void; forEach: { (next: (value: string[] | undefined) => void): Promise<void>; (next: (value: string[] | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => string[] | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<string[] | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string[] | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<string[] | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<string[] | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<string[] | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, string[] | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<string[] | undefined>> | ((value: string[] | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: string[] | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<string[] | undefined>; (PromiseCtor: PromiseConstructor): Promise<string[] | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string[] | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.unlinkFromLibrary",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "unlinkFromLibrary",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<void>) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setTimeRange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setTimeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"(timeRange: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setTimeRange.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/presentation/presentation_publishing/interfaces/fetch/publishes_unified_search.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.defaultPanelTitle",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultPanelTitle",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishingSubject",
|
|
"text": "PublishingSubject"
|
|
},
|
|
"<string | undefined> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setHidePanelTitle",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setHidePanelTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"(hide: boolean | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setHidePanelTitle.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hide",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_title.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getTypeDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTypeDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setPanelDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setPanelDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"(newTitle: string | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.setPanelDescription.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newTitle",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_description.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.canUnlinkFromLibrary",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "canUnlinkFromLibrary",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => Promise<boolean>) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.isCompatibleWithUnifiedSearch",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isCompatibleWithUnifiedSearch",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => boolean) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.savedObjectId",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"signature": [
|
|
"{ source: ",
|
|
"Observable",
|
|
"<any> | undefined; readonly value: string | undefined; error: (err: any) => void; forEach: { (next: (value: string | undefined) => void): Promise<void>; (next: (value: string | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; complete: () => void; getValue: () => string | undefined; closed: boolean; pipe: { (): ",
|
|
"Observable",
|
|
"<string | undefined>; <A>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>): ",
|
|
"Observable",
|
|
"<A>; <A, B>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>): ",
|
|
"Observable",
|
|
"<B>; <A, B, C>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>): ",
|
|
"Observable",
|
|
"<C>; <A, B, C, D>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>): ",
|
|
"Observable",
|
|
"<D>; <A, B, C, D, E>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>): ",
|
|
"Observable",
|
|
"<E>; <A, B, C, D, E, F>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>): ",
|
|
"Observable",
|
|
"<F>; <A, B, C, D, E, F, G>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>): ",
|
|
"Observable",
|
|
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>): ",
|
|
"Observable",
|
|
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>): ",
|
|
"Observable",
|
|
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
|
|
"OperatorFunction",
|
|
"<string | undefined, A>, op2: ",
|
|
"OperatorFunction",
|
|
"<A, B>, op3: ",
|
|
"OperatorFunction",
|
|
"<B, C>, op4: ",
|
|
"OperatorFunction",
|
|
"<C, D>, op5: ",
|
|
"OperatorFunction",
|
|
"<D, E>, op6: ",
|
|
"OperatorFunction",
|
|
"<E, F>, op7: ",
|
|
"OperatorFunction",
|
|
"<F, G>, op8: ",
|
|
"OperatorFunction",
|
|
"<G, H>, op9: ",
|
|
"OperatorFunction",
|
|
"<H, I>, ...operations: ",
|
|
"OperatorFunction",
|
|
"<any, any>[]): ",
|
|
"Observable",
|
|
"<unknown>; }; observers: ",
|
|
"Observer",
|
|
"<string | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
|
|
"Operator",
|
|
"<string | undefined, R>) => ",
|
|
"Observable",
|
|
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
|
|
"Observable",
|
|
"<string | undefined>; operator: ",
|
|
"Operator",
|
|
"<any, string | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
|
|
"Observer",
|
|
"<string | undefined>> | ((value: string | undefined) => void) | undefined): ",
|
|
"Subscription",
|
|
"; (next?: ((value: string | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
|
|
"Subscription",
|
|
"; }; toPromise: { (): Promise<string | undefined>; (PromiseCtor: PromiseConstructor): Promise<string | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string | undefined>; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getEditHref",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEditHref",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<string | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getAppContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAppContext",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableAppContext",
|
|
"text": "EmbeddableAppContext"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.reportsEmbeddableLoad",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportsEmbeddableLoad",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.refreshInputFromParent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "refreshInputFromParent",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getExplicitInputIsEqual",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInputIsEqual",
|
|
"description": [],
|
|
"signature": [
|
|
"(lastExplicitInput: Partial<TEmbeddableInput>) => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getExplicitInputIsEqual.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getExplicitInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getPersistableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPersistableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => TEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.getDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any> | ",
|
|
{
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"(el: HTMLElement) => void | TNode"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.untilInitializationFinished",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untilInitializationFinished",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.onFatalError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFatalError",
|
|
"description": [
|
|
"\nCall this **only** when your embeddable has encountered a non-recoverable error; recoverable errors\nshould be handled by the individual embeddable types"
|
|
],
|
|
"signature": [
|
|
"(e: Error) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Embeddable.onFatalError.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "e",
|
|
"description": [
|
|
"The fatal, unrecoverable Error that was thrown"
|
|
],
|
|
"signature": [
|
|
"Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToApp",
|
|
"description": [],
|
|
"signature": [
|
|
"(appId: string, options?: ",
|
|
{
|
|
"pluginId": "@kbn/core-application-browser",
|
|
"scope": "public",
|
|
"docId": "kibKbnCoreApplicationBrowserPluginApi",
|
|
"section": "def-public.NavigateToAppOptions",
|
|
"text": "NavigateToAppOptions"
|
|
},
|
|
" | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "currentAppId$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<string | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appList",
|
|
"description": [],
|
|
"signature": [
|
|
"ReadonlyMap<string, ",
|
|
{
|
|
"pluginId": "@kbn/core-application-browser",
|
|
"scope": "public",
|
|
"docId": "kibKbnCoreApplicationBrowserPluginApi",
|
|
"section": "def-public.PublicAppInfo",
|
|
"text": "PublicAppInfo"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.Unnamed.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "customStorage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getAppNameFromId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAppNameFromId",
|
|
"description": [
|
|
"\nFetches an internationalized app title when given an appId."
|
|
],
|
|
"signature": [
|
|
"(appId: string) => string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getAppNameFromId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The id of the app to fetch the title for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncomingEditorState",
|
|
"description": [
|
|
"\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"
|
|
],
|
|
"signature": [
|
|
"(appId: string, removeAfterFetch?: boolean | undefined) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch incomingEditorState for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEditorState.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeAfterFetch",
|
|
"description": [
|
|
"- Whether to remove the package state after fetch to prevent duplicates."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.clearEditorState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearEditorState",
|
|
"description": [
|
|
"\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"
|
|
],
|
|
"signature": [
|
|
"(appId?: string | undefined) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.clearEditorState.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch incomingEditorState for"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIncomingEmbeddablePackage",
|
|
"description": [
|
|
"\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n"
|
|
],
|
|
"signature": [
|
|
"(appId: string, removeAfterFetch?: boolean | undefined) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [
|
|
"- The app to fetch EmbeddablePackageState for"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "removeAfterFetch",
|
|
"description": [
|
|
"- Whether to remove the package state after fetch to prevent duplicates."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToEditor",
|
|
"description": [
|
|
"\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}"
|
|
],
|
|
"signature": [
|
|
"(appId: string, options?: { path?: string | undefined; openInNewTab?: boolean | undefined; skipAppLeave?: boolean | undefined; state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
},
|
|
"; } | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.openInNewTab",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "openInNewTab",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.skipAppLeave",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "skipAppLeave",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToEditor.$2.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableEditorState",
|
|
"text": "EmbeddableEditorState"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToWithEmbeddablePackage",
|
|
"description": [
|
|
"\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}"
|
|
],
|
|
"signature": [
|
|
"(appId: string, options?: { path?: string | undefined; state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
},
|
|
"; } | undefined) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.$2.state",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddablePackageState",
|
|
"text": "EmbeddablePackageState"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", React.ReactNode>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ErrorEmbeddable.render",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "render",
|
|
"description": [],
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelIncompatibleError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PanelIncompatibleError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.PanelIncompatibleError",
|
|
"text": "PanelIncompatibleError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelIncompatibleError.code",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "code",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelIncompatibleError.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelNotFoundError",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PanelNotFoundError",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.PanelNotFoundError",
|
|
"text": "PanelNotFoundError"
|
|
},
|
|
" extends Error"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/errors.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O, any>, T extends ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "@kbn/core-saved-objects-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
|
|
"section": "def-common.SavedObjectAttributes",
|
|
"text": "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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableInputToSubject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "embeddableInputToSubject",
|
|
"description": [],
|
|
"signature": [
|
|
"<ValueType extends unknown = unknown, LegacyInput 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"
|
|
},
|
|
">(subscription: ",
|
|
"Subscription",
|
|
", embeddable: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<LegacyInput, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", any>, key: keyof LegacyInput, useExplicitInput?: boolean) => ",
|
|
"BehaviorSubject",
|
|
"<ValueType | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableInputToSubject.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "subscription",
|
|
"description": [],
|
|
"signature": [
|
|
"Subscription"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableInputToSubject.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "embeddable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<LegacyInput, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
", any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableInputToSubject.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof LegacyInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableInputToSubject.$4",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableOutputToSubject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "embeddableOutputToSubject",
|
|
"description": [],
|
|
"signature": [
|
|
"<ValueType extends unknown = unknown, LegacyOutput 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"
|
|
},
|
|
">(subscription: ",
|
|
"Subscription",
|
|
", 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"
|
|
},
|
|
", LegacyOutput, any>, key: keyof LegacyOutput) => ",
|
|
"BehaviorSubject",
|
|
"<ValueType | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableOutputToSubject.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "subscription",
|
|
"description": [],
|
|
"signature": [
|
|
"Subscription"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableOutputToSubject.$2",
|
|
"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"
|
|
},
|
|
", LegacyOutput, any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.embeddableOutputToSubject.$3",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof LegacyOutput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/compatibility/embeddable_compatibility_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "EmbeddablePanel",
|
|
"description": [],
|
|
"signature": [
|
|
"(props: ",
|
|
"EmbeddablePanelProps",
|
|
") => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/embeddable_panel/embeddable_panel.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "lens",
|
|
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx"
|
|
},
|
|
{
|
|
"plugin": "lens",
|
|
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx"
|
|
},
|
|
{
|
|
"plugin": "canvas",
|
|
"path": "x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx"
|
|
},
|
|
{
|
|
"plugin": "canvas",
|
|
"path": "x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePanel.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"EmbeddablePanelProps"
|
|
],
|
|
"path": "src/plugins/embeddable/public/embeddable_panel/embeddable_panel.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "EmbeddableRoot",
|
|
"description": [],
|
|
"signature": [
|
|
"({ embeddable, loading, error, input }: React.PropsWithChildren<Props>) => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableRoot.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{ embeddable, loading, error, input }",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<Props>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.genericEmbeddableInputIsEqual",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "genericEmbeddableInputIsEqual",
|
|
"description": [],
|
|
"signature": [
|
|
"(currentInput: Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">, lastInput: Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.genericEmbeddableInputIsEqual.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "currentInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.genericEmbeddableInputIsEqual.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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/is_error_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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/is_error_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isExplicitInputWithAttributes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isExplicitInputWithAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: ",
|
|
"ExplicitInputWithAttributes",
|
|
" | Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">) => value is ",
|
|
"ExplicitInputWithAttributes"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isExplicitInputWithAttributes.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"ExplicitInputWithAttributes",
|
|
" | Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isFilterableEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isFilterableEmbeddable",
|
|
"description": [
|
|
"\nEnsure that embeddable supports filtering/querying"
|
|
],
|
|
"signature": [
|
|
"(incoming: unknown) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isFilterableEmbeddable.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "incoming",
|
|
"description": [
|
|
"Embeddable that is being tested to check if it is a FilterableEmbeddable"
|
|
],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"true if the incoming embeddable is a FilterableEmbeddable, false if it is not"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isMultiValueClickTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isMultiValueClickTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
") => context is ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.MultiValueClickContext",
|
|
"text": "MultiValueClickContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isMultiValueClickTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRangeSelectTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRangeSelectTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
") => context is ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.RangeSelectContext",
|
|
"text": "RangeSelectContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRangeSelectTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRowClickTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isRowClickTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
") => context is ",
|
|
{
|
|
"pluginId": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.RowClickContext",
|
|
"text": "RowClickContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isRowClickTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isValueClickTriggerContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isValueClickTriggerContext",
|
|
"description": [],
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
},
|
|
") => context is ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ValueClickContext",
|
|
"text": "ValueClickContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.isValueClickTriggerContext.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "context",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ChartActionContext",
|
|
"text": "ChartActionContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.omitGenericEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "omitGenericEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"<I extends Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
"> = Partial<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">>(input: I) => Omit<I, keyof ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.omitGenericEmbeddableInput.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"I"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "openAddPanelFlyout",
|
|
"description": [],
|
|
"signature": [
|
|
"({ container, onAddPanel, onClose, }: { container: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
},
|
|
"; onAddPanel?: ((id: string) => void) | undefined; onClose?: (() => void) | undefined; }) => ",
|
|
{
|
|
"pluginId": "@kbn/core-mount-utils-browser",
|
|
"scope": "public",
|
|
"docId": "kibKbnCoreMountUtilsBrowserPluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n container,\n onAddPanel,\n onClose,\n}",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.container",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "container",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.PresentationContainer",
|
|
"text": "PresentationContainer"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.onAddPanel",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onAddPanel",
|
|
"description": [],
|
|
"signature": [
|
|
"((id: string) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.onAddPanel.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.openAddPanelFlyout.$1.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "ReactEmbeddableRenderer",
|
|
"description": [
|
|
"\nRenders a component from the React Embeddable registry into a Presentation Panel.\n\nTODO: Rename this to simply `Embeddable` when the legacy Embeddable system is removed."
|
|
],
|
|
"signature": [
|
|
"<SerializedState extends object = object, RuntimeState extends object = SerializedState, Api extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<SerializedState, RuntimeState> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<SerializedState, RuntimeState>, ParentApi extends ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSerializedChildState",
|
|
"text": "HasSerializedChildState"
|
|
},
|
|
"<SerializedState> = ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSerializedChildState",
|
|
"text": "HasSerializedChildState"
|
|
},
|
|
"<SerializedState>>({ type, maybeId, getParentApi, panelProps, onAnyStateChange, onApiAvailable, hidePanelChrome, }: { type: string; maybeId?: string | undefined; getParentApi: () => ParentApi; onApiAvailable?: ((api: Api) => void) | undefined; panelProps?: Pick<",
|
|
{
|
|
"pluginId": "presentationPanel",
|
|
"scope": "public",
|
|
"docId": "kibPresentationPanelPluginApi",
|
|
"section": "def-public.PresentationPanelProps",
|
|
"text": "PresentationPanelProps"
|
|
},
|
|
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideHeader\" | \"hideInspector\"> | undefined; hidePanelChrome?: boolean | undefined; onAnyStateChange?: ((state: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState>) => void) | undefined; }) => JSX.Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n type,\n maybeId,\n getParentApi,\n panelProps,\n onAnyStateChange,\n onApiAvailable,\n hidePanelChrome,\n}",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.maybeId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "maybeId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.getParentApi",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParentApi",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ParentApi"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onApiAvailable",
|
|
"description": [],
|
|
"signature": [
|
|
"((api: Api) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "api",
|
|
"description": [],
|
|
"signature": [
|
|
"Api"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.panelProps",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelProps",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "presentationPanel",
|
|
"scope": "public",
|
|
"docId": "kibPresentationPanelPluginApi",
|
|
"section": "def-public.PresentationPanelProps",
|
|
"text": "PresentationPanelProps"
|
|
},
|
|
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideHeader\" | \"hideInspector\"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.hidePanelChrome",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hidePanelChrome",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onAnyStateChange",
|
|
"description": [
|
|
"\nThis `onAnyStateChange` callback allows the parent to keep track of the state of the embeddable\nas it changes. This is **not** expected to change over the lifetime of the component."
|
|
],
|
|
"signature": [
|
|
"((state: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState>) => void) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "runEmbeddableFactoryMigrations",
|
|
"description": [
|
|
"\nA helper function that migrates an Embeddable Input to its latest version. Note that this function\nonly runs the embeddable factory's migrations."
|
|
],
|
|
"signature": [
|
|
"<ToType extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
">(initialInput: { version?: string | undefined; }, factory: { migrations?: ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.MigrateFunctionsObject",
|
|
"text": "MigrateFunctionsObject"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.GetMigrationFunctionObjectFn",
|
|
"text": "GetMigrationFunctionObjectFn"
|
|
},
|
|
" | undefined; latestVersion?: string | undefined; }) => { input: ToType; migrationRun: boolean; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations.$1.version",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations.$2.migrations",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "migrations",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.MigrateFunctionsObject",
|
|
"text": "MigrateFunctionsObject"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.GetMigrationFunctionObjectFn",
|
|
"text": "GetMigrationFunctionObjectFn"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.runEmbeddableFactoryMigrations.$2.latestVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "latestVersion",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/factory_migrations/run_factory_migrations.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldFetch$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "shouldFetch$",
|
|
"description": [],
|
|
"signature": [
|
|
"(updated$: ",
|
|
"Observable",
|
|
"<unknown>, getInput: () => TFilterableEmbeddableInput) => ",
|
|
"Observable",
|
|
"<TFilterableEmbeddableInput>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldFetch$.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "updated$",
|
|
"description": [],
|
|
"signature": [
|
|
"Observable",
|
|
"<unknown>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldFetch$.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInput",
|
|
"description": [],
|
|
"signature": [
|
|
"() => TFilterableEmbeddableInput"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
", any> | undefined, boolean, string | undefined]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O, any>, 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.Adapters.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: any",
|
|
"description": [],
|
|
"signature": [
|
|
"[key: string]: any"
|
|
],
|
|
"path": "src/plugins/inspector/common/adapters/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.DefaultEmbeddableApi",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DefaultEmbeddableApi",
|
|
"description": [
|
|
"\nThe default embeddable API that all Embeddables must implement.\n\nBefore adding anything to this interface, please be certain that it belongs in *every* embeddable."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<SerializedState, RuntimeState> extends ",
|
|
"DefaultPresentationPanelApi",
|
|
",",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.HasType",
|
|
"text": "HasType"
|
|
},
|
|
"<string>,",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesPhaseEvents",
|
|
"text": "PublishesPhaseEvents"
|
|
},
|
|
",",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.PublishesUnsavedChanges",
|
|
"text": "PublishesUnsavedChanges"
|
|
},
|
|
",",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSerializableState",
|
|
"text": "HasSerializableState"
|
|
},
|
|
"<SerializedState>,",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSnapshottableState",
|
|
"text": "HasSnapshottableState"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContainerSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableContainerSettings",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContainerSettings.initializeSequentially",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "initializeSequentially",
|
|
"description": [
|
|
"\nIf true, the container will wait for each embeddable to load after creation before loading the next embeddable."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContainerSettings.childIdInitializeOrder",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "childIdInitializeOrder",
|
|
"description": [
|
|
"\nInitialise children in the order specified. If an ID does not match it will be skipped and if a child is not included it will be initialized in the default order after the list of provided IDs."
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableContext",
|
|
"type": "Interface",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"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": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "embeddableEnhanced",
|
|
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "embeddableEnhanced",
|
|
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "embeddableEnhanced",
|
|
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts"
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.valueInput",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "valueInput",
|
|
"description": [],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableEditorState.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.latestVersion",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "latestVersion",
|
|
"description": [
|
|
"\nThe version of this Embeddable factory. This will be used in the client side migration system\nto ensure that input from any source is compatible with the latest version of this embeddable.\nIf the latest version is not defined, all clientside migrations will be skipped. If migrations\nare added to this factory but a latestVersion is not set, an error will be thrown on server start"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.savedObjectMetaData",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectMetaData",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-public.SavedObjectMetaData",
|
|
"text": "SavedObjectMetaData"
|
|
},
|
|
"<TSavedObjectAttributes> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.PresentableGrouping",
|
|
"text": "PresentableGrouping"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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.\n\nCan be used to edit an embeddable by re-requesting explicit input. Initial input can be provided to allow the editor to show the current state.\n\nIf saved object information is needed for creation use-cases, getExplicitInput can also return an unknown typed attributes object which will be passed\ninto the container's addNewEmbeddable function."
|
|
],
|
|
"signature": [
|
|
"(initialInput?: Partial<TEmbeddableInput> | undefined, 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<Partial<TEmbeddableInput> | ",
|
|
"ExplicitInputWithAttributes",
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getExplicitInput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "initialInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<TEmbeddableInput> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.getExplicitInput.$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,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"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<TEmbeddable | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [
|
|
"\nCreates an Embeddable instance, running the inital input through all registered migrations. Resolves to undefined if a new Embeddable\ncannot be directly created and the user will instead be redirected elsewhere."
|
|
],
|
|
"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<TEmbeddable | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | undefined>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableFactory.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.rendered",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rendered",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.error",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ErrorLike",
|
|
"text": "ErrorLike"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.defaultDescription",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.inlineEditable",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "inlineEditable",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableOutput.editableWithExplicitInput",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "editableWithExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddablePackageState",
|
|
"description": [
|
|
"\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.input",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [
|
|
"\nFor react embeddables, this input must be runtime state."
|
|
],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.embeddableId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.size",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [],
|
|
"signature": [
|
|
"{ width?: number | undefined; height?: number | undefined; } | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddablePackageState.searchSessionId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchSessionId",
|
|
"description": [
|
|
"\nPass current search session id when navigating to an editor,\nEditors could use it continue previous search session"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetupDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableSetupDependencies",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetupDependencies.uiActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiActions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly registerTrigger: (trigger: ",
|
|
{
|
|
"pluginId": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.Trigger",
|
|
"text": "Trigger"
|
|
},
|
|
") => void; readonly registerAction: <Context extends object>(definition: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<Context>) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<Context>; readonly unregisterAction: (actionId: string) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<any>) => void; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableStartDependencies",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.uiActions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiActions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly registerTrigger: (trigger: ",
|
|
{
|
|
"pluginId": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.Trigger",
|
|
"text": "Trigger"
|
|
},
|
|
") => void; readonly hasTrigger: (triggerId: string) => boolean; readonly getTrigger: (triggerId: string) => ",
|
|
"TriggerContract",
|
|
"<object>; readonly registerAction: <Context extends object>(definition: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<Context>) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<Context>; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly addTriggerAction: (triggerId: string, action: ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.ActionDefinition",
|
|
"text": "ActionDefinition"
|
|
},
|
|
"<any>) => void; readonly getAction: (id: string) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.Action",
|
|
"text": "Action"
|
|
},
|
|
"<object>; 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 getFrequentlyChangingActionsForTrigger: (triggerId: string, context: object) => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.FrequentCompatibilityChangeAction",
|
|
"text": "FrequentCompatibilityChangeAction"
|
|
},
|
|
"<object>[]; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
|
|
{
|
|
"pluginId": "uiActions",
|
|
"scope": "public",
|
|
"docId": "kibUiActionsPluginApi",
|
|
"section": "def-public.UiActionsService",
|
|
"text": "UiActionsService"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.usageCollection",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "usageCollection",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "usageCollection",
|
|
"scope": "public",
|
|
"docId": "kibUsageCollectionPluginApi",
|
|
"section": "def-public.UsageCollectionStart",
|
|
"text": "UsageCollectionStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.contentManagement",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contentManagement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "contentManagement",
|
|
"scope": "public",
|
|
"docId": "kibContentManagementPluginApi",
|
|
"section": "def-public.ContentManagementPublicStart",
|
|
"text": "ContentManagementPublicStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.savedObjectsManagement",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsManagement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjectsManagement",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsManagementPluginApi",
|
|
"section": "def-public.SavedObjectsManagementPluginStart",
|
|
"text": "SavedObjectsManagementPluginStart"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStartDependencies.savedObjectsTaggingOss",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsTaggingOss",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjectsTaggingOss",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsTaggingOssPluginApi",
|
|
"section": "def-public.SavedObjectTaggingOssPluginStart",
|
|
"text": "SavedObjectTaggingOssPluginStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EnhancementRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnhancementRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EnhancementRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.FilterableEmbeddable",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FilterableEmbeddable",
|
|
"description": [
|
|
"\nAll embeddables that implement this interface should support being filtered\nand/or queried via the top navigation bar."
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.FilterableEmbeddable.getFilters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFilters",
|
|
"description": [
|
|
"\nGets the embeddable's local filters"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Filter",
|
|
"text": "Filter"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.FilterableEmbeddable.getQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getQuery",
|
|
"description": [
|
|
"\nGets the embeddable's local query"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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, any>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any>>(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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
", any>>(id: string) => E"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any> = ",
|
|
{
|
|
"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"
|
|
},
|
|
", any>>(embeddable: E) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<EEI, EEO, any>>(type: string, explicitInput: Partial<EEI>, attributes?: unknown) => 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.addNewEmbeddable.$3",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "attributes",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.replaceEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replaceEmbeddable",
|
|
"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.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<EEI, EEO, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.Embeddable",
|
|
"text": "Embeddable"
|
|
},
|
|
"<EEI, EEO, any>>(id: string, newExplicitInput: Partial<EEI>, newType?: string | undefined, generateNewId?: boolean | undefined) => Promise<string>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.replaceEmbeddable.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.replaceEmbeddable.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newExplicitInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<EEI>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.replaceEmbeddable.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "newType",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IContainer.replaceEmbeddable.$4",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "generateNewId",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/containers/i_container.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"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, N> extends ",
|
|
"LegacyEmbeddableAPI"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.reportsEmbeddableLoad",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportsEmbeddableLoad",
|
|
"description": [
|
|
"\nThis method returns false by default.\nIt should be set to true for any embeddable type that utilizes the `loading` and `rendered`\noutput variables to notify a container of their loading progress. If set to false, a container should assume\nthe embeddable is loaded immediately."
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getExplicitInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInput",
|
|
"description": [
|
|
"\nBecause embeddables can inherit input from their parents, they also need a way to separate their own\ninput from input which is inherited. If the embeddable does not have a parent, getExplicitInput\nand getInput should return the same."
|
|
],
|
|
"signature": [
|
|
"() => Readonly<Partial<I>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getPersistableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getPersistableInput",
|
|
"description": [
|
|
"\nSome embeddables contain input that should not be persisted anywhere beyond their own state. This method\nis a way for containers to separate input to store from input which can be ephemeral. In most cases, this\nwill be the same as getExplicitInput"
|
|
],
|
|
"signature": [
|
|
"() => Readonly<Partial<I>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.updateOutput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateOutput",
|
|
"description": [
|
|
"\nUpdates output state with the given changes."
|
|
],
|
|
"signature": [
|
|
"(changes: Partial<O>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.updateOutput.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "changes",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<O>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDescription",
|
|
"description": [
|
|
"\nReturns the description of this embeddable."
|
|
],
|
|
"signature": [
|
|
"() => string | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", any> | ",
|
|
{
|
|
"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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getAppContext",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAppContext",
|
|
"description": [
|
|
"\nReturns the context of this embeddable's container, or undefined."
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableAppContext",
|
|
"text": "EmbeddableAppContext"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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: HTMLElement | Element) => void | N"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.render.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "domNode",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement | Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A React node to mount or void in the case when rendering is done without React."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.catchError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "catchError",
|
|
"description": [
|
|
"\nRenders a custom embeddable error at the given node."
|
|
],
|
|
"signature": [
|
|
"((error: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ErrorLike",
|
|
"text": "ErrorLike"
|
|
},
|
|
", domNode: HTMLElement | Element) => N | (() => void)) | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.catchError.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ErrorLike",
|
|
"text": "ErrorLike"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.catchError.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "domNode",
|
|
"description": [],
|
|
"signature": [
|
|
"HTMLElement | Element"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"A React node or callback that will be called on error destroy."
|
|
]
|
|
},
|
|
{
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getExplicitInputIsEqual",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getExplicitInputIsEqual",
|
|
"description": [
|
|
"\nUsed to diff explicit embeddable input"
|
|
],
|
|
"signature": [
|
|
"(lastInput: Partial<I>) => Promise<boolean>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.getExplicitInputIsEqual.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "lastInput",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<I>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.refreshInputFromParent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "refreshInputFromParent",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.IEmbeddable.untilInitializationFinished",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "untilInitializationFinished",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<void>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.OutputSpec.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[key: string]: PropertySpec",
|
|
"description": [],
|
|
"signature": [
|
|
"[key: string]: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.PropertySpec",
|
|
"text": "PropertySpec"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PanelState.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.accessPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "accessPath",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PropertySpec.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ReactEmbeddableFactory",
|
|
"description": [
|
|
"\nThe React Embeddable Factory interface is used to register a series of functions that\ncreate and manage an embeddable instance.\n\nEmbeddables are React components that manage their own state, can be serialized and\ndeserialized, and return an API that can be used to interact with them imperatively."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReactEmbeddableFactory",
|
|
"text": "ReactEmbeddableFactory"
|
|
},
|
|
"<SerializedState, RuntimeState, Api>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nA unique key for the type of this embeddable. The React Embeddable Renderer will use this type\nto find this factory."
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.deserializeState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deserializeState",
|
|
"description": [
|
|
"\nA required asynchronous function that transforms serialized state into runtime state.\n\nThis could be used to:\n- Load state from some external store\n- Inject references provided by the parent\n- Migrate the state to a newer version (this must be undone when serializing)"
|
|
],
|
|
"signature": [
|
|
"(panelState: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState>) => ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.MaybePromise",
|
|
"text": "MaybePromise"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.deserializeState.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.SerializedPanelState",
|
|
"text": "SerializedPanelState"
|
|
},
|
|
"<SerializedState>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildEmbeddable",
|
|
"description": [
|
|
"\nA required async function that builds your embeddable component and a linked API instance. The API\nand component will be combined together by the ReactEmbeddableRenderer. Initial state will contain the result of\nthe deserialize function.\n\nThe returned API must extend {@link HasSerializableState} which does the opposite of the deserializeState\nfunction."
|
|
],
|
|
"signature": [
|
|
"(initialState: RuntimeState, buildApi: (apiRegistration: ",
|
|
"BuildReactEmbeddableApiRegistration",
|
|
"<SerializedState, RuntimeState, Api>, comparators: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.StateComparators",
|
|
"text": "StateComparators"
|
|
},
|
|
"<RuntimeState>) => Api & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSnapshottableState",
|
|
"text": "HasSnapshottableState"
|
|
},
|
|
"<RuntimeState>, uuid: string, parentApi: unknown, setApi: (api: ",
|
|
"SetReactEmbeddableApiRegistration",
|
|
"<SerializedState, RuntimeState, Api>) => Api) => Promise<{ Component: React.FC<{}>; api: Api; }>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "initialState",
|
|
"description": [],
|
|
"signature": [
|
|
"RuntimeState"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "buildApi",
|
|
"description": [],
|
|
"signature": [
|
|
"(apiRegistration: ",
|
|
"BuildReactEmbeddableApiRegistration",
|
|
"<SerializedState, RuntimeState, Api>, comparators: ",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.StateComparators",
|
|
"text": "StateComparators"
|
|
},
|
|
"<RuntimeState>) => Api & ",
|
|
{
|
|
"pluginId": "@kbn/presentation-containers",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationContainersPluginApi",
|
|
"section": "def-public.HasSnapshottableState",
|
|
"text": "HasSnapshottableState"
|
|
},
|
|
"<RuntimeState>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uuid",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$4",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "parentApi",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$5",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setApi",
|
|
"description": [],
|
|
"signature": [
|
|
"(api: ",
|
|
"SetReactEmbeddableApiRegistration",
|
|
"<SerializedState, RuntimeState, Api>) => Api"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SelfStyledEmbeddable",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SelfStyledEmbeddable",
|
|
"description": [
|
|
"\nAll embeddables that implement this interface will be able to configure\nthe style of their containing panels"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/self_styled_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SelfStyledEmbeddable.getSelfStyledOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSelfStyledOptions",
|
|
"description": [
|
|
"\nGets the embeddable's style configuration"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"SelfStyledOptions"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/self_styled_embeddable/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ViewMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ViewMode",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"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,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.CELL_VALUE_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CELL_VALUE_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"CELL_VALUE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.CellValueContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CellValueContext",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableApiContext",
|
|
"text": "EmbeddableApiContext"
|
|
},
|
|
"> & { data: { value?: any; eventId?: string | undefined; columnMeta?: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumnMeta",
|
|
"text": "DatatableColumnMeta"
|
|
},
|
|
" | undefined; }[]; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ChartActionContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ChartActionContext",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ValueClickContext",
|
|
"text": "ValueClickContext"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.RangeSelectContext",
|
|
"text": "RangeSelectContext"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.MultiValueClickContext",
|
|
"text": "MultiValueClickContext"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/ui-actions-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnUiActionsBrowserPluginApi",
|
|
"section": "def-common.RowClickContext",
|
|
"text": "RowClickContext"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.CONTEXT_MENU_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "CONTEXT_MENU_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"CONTEXT_MENU_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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\" | \"latestVersion\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, T>, \"telemetry\" | \"inject\" | \"extract\" | \"migrations\" | \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ version?: string | undefined; viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; title?: string | undefined; description?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ",
|
|
{
|
|
"pluginId": "@kbn/core-execution-context-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
|
|
"section": "def-common.KibanaExecutionContext",
|
|
"text": "KibanaExecutionContext"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.MULTI_VALUE_CLICK_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "MULTI_VALUE_CLICK_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"MULTI_VALUE_CLICK_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.MultiValueClickContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "MultiValueClickContext",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableApiContext",
|
|
"text": "EmbeddableApiContext"
|
|
},
|
|
"> & { data: { data: { table: Pick<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
", \"columns\" | \"rows\">; cells: { column: number; row: number; }[]; relation?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.BooleanRelation",
|
|
"text": "BooleanRelation"
|
|
},
|
|
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PANEL_BADGE_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PANEL_BADGE_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PANEL_BADGE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PANEL_HOVER_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PANEL_HOVER_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PANEL_HOVER_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.PANEL_NOTIFICATION_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "PANEL_NOTIFICATION_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"PANEL_NOTIFICATION_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.RangeSelectContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RangeSelectContext",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableApiContext",
|
|
"text": "EmbeddableApiContext"
|
|
},
|
|
"> & { data: { table: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
"; column: number; range: number[]; timeFieldName?: string | undefined; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ReactEmbeddableSavedObject",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReactEmbeddableSavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
"{ onAdd: SOToEmbeddable<TSavedObjectAttributes>; savedObjectMetaData: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-public.SavedObjectMetaData",
|
|
"text": "SavedObjectMetaData"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddable_saved_object_registry/embeddable_saved_object_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.SELECT_RANGE_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "SELECT_RANGE_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"SELECT_RANGE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.VALUE_CLICK_TRIGGER",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VALUE_CLICK_TRIGGER",
|
|
"description": [],
|
|
"signature": [
|
|
"\"VALUE_CLICK_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.ValueClickContext",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ValueClickContext",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "@kbn/presentation-publishing",
|
|
"scope": "public",
|
|
"docId": "kibKbnPresentationPublishingPluginApi",
|
|
"section": "def-public.EmbeddableApiContext",
|
|
"text": "EmbeddableApiContext"
|
|
},
|
|
"> & { data: { data: { table: Pick<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
", \"columns\" | \"rows\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.cellValueTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cellValueTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.cellValueTrigger.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.cellValueTrigger.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.cellValueTrigger.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "COMMON_EMBEDDABLE_GROUPING",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.legacy",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "legacy",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.legacy.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.legacy.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.legacy.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.annotation",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "annotation",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.annotation.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.annotation.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.other",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "other",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.other.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.other.getDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayName",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.other.getIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIconType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.COMMON_EMBEDDABLE_GROUPING.other.order",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "order",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/embeddables/common/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.contextMenuTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "contextMenuTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelHoverTrigger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "panelHoverTrigger",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelHoverTrigger.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelHoverTrigger.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.panelHoverTrigger.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldRefreshFilterCompareOptions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "shouldRefreshFilterCompareOptions",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldRefreshFilterCompareOptions.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.shouldRefreshFilterCompareOptions.state",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [
|
|
"// do not compare $state to avoid refreshing when filter is pinned/unpinned (which does not impact results)"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/should_fetch.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerReactEmbeddableSavedObject",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerReactEmbeddableSavedObject",
|
|
"description": [
|
|
"\nRegister an embeddable API saved object with the Add from library flyout.\n"
|
|
],
|
|
"signature": [
|
|
"<TSavedObjectAttributes extends ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">({ onAdd, embeddableType, savedObjectType, savedObjectName, getIconForSavedObject, getSavedObjectSubType, getTooltipForSavedObject, }: { onAdd: SOToEmbeddable<TSavedObjectAttributes>; embeddableType: string; savedObjectType: string; savedObjectName: string; getIconForSavedObject: (savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => ",
|
|
"IconType",
|
|
"; getSavedObjectSubType?: ((savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => string) | undefined; getTooltipForSavedObject?: ((savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => string) | undefined; }) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerReactEmbeddableSavedObject.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
"{ onAdd: SOToEmbeddable<TSavedObjectAttributes>; embeddableType: string; savedObjectType: string; savedObjectName: string; getIconForSavedObject: (savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => ",
|
|
"IconType",
|
|
"; getSavedObjectSubType?: ((savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => string) | undefined; getTooltipForSavedObject?: ((savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => string) | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/public/lib/embeddable_saved_object_registry/embeddable_saved_object_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerSavedObjectToPanelMethod",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "registerSavedObjectToPanelMethod",
|
|
"description": [],
|
|
"signature": [
|
|
"<TSavedObjectAttributes, TByValueAttributes>(savedObjectType: string, method: SavedObjectToPanelMethod<TSavedObjectAttributes, TByValueAttributes>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "visualizations",
|
|
"path": "src/plugins/visualizations/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "lens",
|
|
"path": "x-pack/plugins/lens/public/plugin.ts"
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerSavedObjectToPanelMethod.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectType",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/registry/saved_object_to_panel_methods.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerSavedObjectToPanelMethod.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "method",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedObject: ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.SavedObjectCommon",
|
|
"text": "SavedObjectCommon"
|
|
},
|
|
"<TSavedObjectAttributes>) => { savedObjectId: string; } | Partial<TByValueAttributes>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/registry/saved_object_to_panel_methods.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerSavedObjectToPanelMethod.$2.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObject",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/content-management-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnContentManagementUtilsPluginApi",
|
|
"section": "def-common.SOWithMetadata",
|
|
"text": "SOWithMetadata"
|
|
},
|
|
"<TSavedObjectAttributes>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/registry/saved_object_to_panel_methods.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerReactEmbeddableFactory",
|
|
"description": [
|
|
"\nRegisters an async {@link ReactEmbeddableFactory} getter."
|
|
],
|
|
"signature": [
|
|
"<SerializedState extends object = object, RuntimeState extends object = SerializedState, Api extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<SerializedState, RuntimeState> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.DefaultEmbeddableApi",
|
|
"text": "DefaultEmbeddableApi"
|
|
},
|
|
"<SerializedState, RuntimeState>>(type: string, getFactory: () => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReactEmbeddableFactory",
|
|
"text": "ReactEmbeddableFactory"
|
|
},
|
|
"<SerializedState, RuntimeState, Api>>) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerReactEmbeddableFactory.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReactEmbeddableFactory",
|
|
"text": "ReactEmbeddableFactory"
|
|
},
|
|
"<SerializedState, RuntimeState, Api>>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_registry.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O, any>>(id: string, factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactoryDefinition",
|
|
"text": "EmbeddableFactoryDefinition"
|
|
},
|
|
"<I, O, E, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">) => () => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "visualizations",
|
|
"path": "src/plugins/visualizations/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "lens",
|
|
"path": "x-pack/plugins/lens/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/plugin.tsx"
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": 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, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEnhancement",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "registerEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancement: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "uiActionsEnhanced",
|
|
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.registerEnhancement.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enhancement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "setCustomEmbeddableFactoryProvider",
|
|
"description": [],
|
|
"signature": [
|
|
"(customProvider: ",
|
|
"EmbeddableFactoryProvider",
|
|
") => void"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "embeddableEnhanced",
|
|
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts"
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableStart",
|
|
"text": "EmbeddableStart"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.reactEmbeddableRegistryHasKey",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reactEmbeddableRegistryHasKey",
|
|
"description": [
|
|
"\nChecks if a {@link ReactEmbeddableFactory} has been registered using {@link registerReactEmbeddableFactory}"
|
|
],
|
|
"signature": [
|
|
"(type: string) => boolean"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.reactEmbeddableRegistryHasKey.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getReactEmbeddableSavedObjects",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getReactEmbeddableSavedObjects",
|
|
"description": [
|
|
"\n"
|
|
],
|
|
"signature": [
|
|
"<TSavedObjectAttributes extends ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">() => IterableIterator<[string, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ReactEmbeddableSavedObject",
|
|
"text": "ReactEmbeddableSavedObject"
|
|
},
|
|
"<TSavedObjectAttributes>]>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [
|
|
"An iterator over all {@link ReactEmbeddableSavedObject }s that have been registered using {@link registerReactEmbeddableSavedObject }."
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"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, any> = ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<I, O, any>>(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableFactory",
|
|
"text": "EmbeddableFactory"
|
|
},
|
|
"<I, O, E, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "lens",
|
|
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/services/embeddable/types.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/services/embeddable/embeddable_service.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_renderer.tsx"
|
|
},
|
|
{
|
|
"plugin": "investigateApp",
|
|
"path": "x-pack/plugins/observability_solution/investigate_app/public/widgets/embeddable_widget/register_embeddable_widget.tsx"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts"
|
|
},
|
|
{
|
|
"plugin": "controls",
|
|
"path": "src/plugins/controls/public/services/embeddable/embeddable.story.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.test.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts"
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getEmbeddableFactories",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"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"
|
|
},
|
|
", any>, ",
|
|
{
|
|
"pluginId": "savedObjectsFinder",
|
|
"scope": "common",
|
|
"docId": "kibSavedObjectsFinderPluginApi",
|
|
"section": "def-common.FinderAttributes",
|
|
"text": "FinderAttributes"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": true,
|
|
"trackAdoption": false,
|
|
"references": [
|
|
{
|
|
"plugin": "canvas",
|
|
"path": "x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx"
|
|
},
|
|
{
|
|
"plugin": "canvas",
|
|
"path": "x-pack/plugins/canvas/public/services/kibana/embeddables.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts"
|
|
},
|
|
{
|
|
"plugin": "dashboard",
|
|
"path": "src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts"
|
|
}
|
|
],
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getStateTransfer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "storage",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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"
|
|
},
|
|
", M extends unknown = unknown>(type: string, options: ",
|
|
"AttributeServiceOptions",
|
|
"<A, M>) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.AttributeService",
|
|
"text": "AttributeService"
|
|
},
|
|
"<A, V, R, M>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-public.EmbeddableStart.getAttributeService.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"AttributeServiceOptions",
|
|
"<A, M>"
|
|
],
|
|
"path": "src/plugins/embeddable/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<P> extends Partial<",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<P>>"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EnhancementRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EnhancementRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EnhancementRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/server/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableSetup",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EmbeddableSetup",
|
|
"text": "EmbeddableSetup"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"(factory: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEmbeddableFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "factory",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEnhancement",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancement: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.registerEnhancement.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "enhancement",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "server",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-server.EnhancementRegistryDefinition",
|
|
"text": "EnhancementRegistryDefinition"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableSetup.getAllMigrations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllMigrations",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.MigrateFunctionsObject",
|
|
"text": "MigrateFunctionsObject"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-server.EmbeddableStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/server/plugin.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.isSavedObjectEmbeddableInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isSavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.isSavedObjectEmbeddableInput.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.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,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"(embeddableFactoryId: string) => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
"> & { isContainerType: boolean; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "embeddableFactoryId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEnhancement",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEnhancement",
|
|
"description": [],
|
|
"signature": [
|
|
"(enhancementId: string) => ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.CommonEmbeddableStartContract.getEnhancement.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "enhancementId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddableRegistryDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableRegistryDefinition",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableRegistryDefinition",
|
|
"text": "EmbeddableRegistryDefinition"
|
|
},
|
|
"<P> extends Partial<",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableState",
|
|
"text": "PersistableState"
|
|
},
|
|
"<P>>"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddableRegistryDefinition.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"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,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.PanelState.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.SavedObjectEmbeddableInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SavedObjectEmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.SavedObjectEmbeddableInput",
|
|
"text": "SavedObjectEmbeddableInput"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.SavedObjectEmbeddableInput.savedObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectId",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.ViewMode",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "ViewMode",
|
|
"description": [],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddableInput",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddableInput",
|
|
"description": [],
|
|
"signature": [
|
|
"{ version?: string | undefined; viewMode?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.ViewMode",
|
|
"text": "ViewMode"
|
|
},
|
|
" | undefined; title?: string | undefined; description?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
|
|
{
|
|
"pluginId": "@kbn/utility-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnUtilityTypesPluginApi",
|
|
"section": "def-common.SerializableRecord",
|
|
"text": "SerializableRecord"
|
|
},
|
|
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ",
|
|
{
|
|
"pluginId": "@kbn/core-execution-context-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
|
|
"section": "def-common.KibanaExecutionContext",
|
|
"text": "KibanaExecutionContext"
|
|
},
|
|
" | undefined; }"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "embeddable",
|
|
"id": "def-common.EmbeddablePersistableStateService",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EmbeddablePersistableStateService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "common",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-common.PersistableStateService",
|
|
"text": "PersistableStateService"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/embeddable/common/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |