maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/presentation_util.json
Stacey Gammon 4bfb35b43a
Update api docs (#116495) 
* update api docs

* update api docs
2021-11-01 19:16:16 +00:00

4592 lines
169 KiB
JSON
Raw Blame History

{
"id": "presentationUtil",
"client": {
"classes": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer",
"type": "Class",
"tags": [],
"label": "ControlGroupContainer",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupContainer",
"text": "ControlGroupContainer"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.Container",
"text": "Container"
},
"<",
"ControlInput",
", ",
"ControlGroupInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupOutput",
"text": "ControlGroupOutput"
},
">"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"control_group\""
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.untilReady",
"type": "Function",
"tags": [],
"label": "untilReady",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initialInput",
"description": [],
"signature": [
"ControlGroupInput"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.Container",
"text": "Container"
},
"<{}, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerInput",
"text": "ContainerInput"
},
"<{}>, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.createNewPanelState",
"type": "Function",
"tags": [],
"label": "createNewPanelState",
"description": [],
"signature": [
"<TEmbeddableInput extends ",
"ControlInput",
" = ",
"ControlInput",
">(factory: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
">, ",
"SavedObjectAttributes",
">, partial?: Partial<TEmbeddableInput>) => ",
"ControlPanelState",
"<TEmbeddableInput>"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.createNewPanelState.$1",
"type": "Object",
"tags": [],
"label": "factory",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
">, ",
"SavedObjectAttributes",
">"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.createNewPanelState.$2",
"type": "Object",
"tags": [],
"label": "partial",
"description": [],
"signature": [
"Partial<TEmbeddableInput>"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.getInheritedInput",
"type": "Function",
"tags": [],
"label": "getInheritedInput",
"description": [],
"signature": [
"(id: string) => ",
"ControlInput"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.getInheritedInput.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"(dom: HTMLElement) => void"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainer.render.$1",
"type": "Object",
"tags": [],
"label": "dom",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory",
"type": "Class",
"tags": [],
"label": "ControlGroupContainerFactory",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupContainerFactory",
"text": "ControlGroupContainerFactory"
},
" implements ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableFactoryDefinition",
"text": "EmbeddableFactoryDefinition"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
">, ",
"SavedObjectAttributes",
">"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.isContainerType",
"type": "boolean",
"tags": [],
"label": "isContainerType",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"control_group\""
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "persistableStateService",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddablePersistableStateService",
"text": "EmbeddablePersistableStateService"
}
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.isEditable",
"type": "Function",
"tags": [],
"label": "isEditable",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [],
"signature": [
"() => string"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.getDefaultInput",
"type": "Function",
"tags": [],
"label": "getDefaultInput",
"description": [],
"signature": [
"() => Partial<",
"ControlGroupInput",
">"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(initialInput: ",
"ControlGroupInput",
", parent?: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.Container",
"text": "Container"
},
"<{}, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerInput",
"text": "ContainerInput"
},
"<{}>, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined) => Promise<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlGroupContainer",
"text": "ControlGroupContainer"
},
">"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.create.$1",
"type": "Object",
"tags": [],
"label": "initialInput",
"description": [],
"signature": [
"ControlGroupInput"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.create.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.Container",
"text": "Container"
},
"<{}, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerInput",
"text": "ContainerInput"
},
"<{}>, ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
"> | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.inject",
"type": "Function",
"tags": [],
"label": "inject",
"description": [],
"signature": [
"(state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
", references: ",
"SavedObjectReference",
"[]) => ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
}
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.inject.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"P"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.inject.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"SavedObjectReference",
"[]"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.extract",
"type": "Function",
"tags": [],
"label": "extract",
"description": [],
"signature": [
"(state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
") => { state: ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
"; references: ",
"SavedObjectReference",
"[]; }"
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupContainerFactory.extract.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"P"
],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider",
"type": "Class",
"tags": [],
"label": "PluginServiceProvider",
"description": [
"\nAn object which uses a given factory to start, stop or provide a service.\n\nThe `Service` generic determines the shape of the API being produced.\nThe `StartParameters` generic determines what parameters are expected to\nstart the service."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceProvider",
"text": "PluginServiceProvider"
},
"<Service, StartParameters>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.Provider",
"type": "Function",
"tags": [],
"label": "Provider",
"description": [],
"signature": [
"({ children }: { children?: React.ReactNode; }) => JSX.Element"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.Provider.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"signature": [
"{ children?: React.ReactNode; }"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.Unnamed.$1",
"type": "Function",
"tags": [],
"label": "factory",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceFactory",
"text": "PluginServiceFactory"
},
"<Service, StartParameters>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.getService",
"type": "Function",
"tags": [],
"label": "getService",
"description": [
"\nGetter that will enforce proper setup throughout the class."
],
"signature": [
"() => Service"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [
"\nStart the service.\n"
],
"signature": [
"(params: StartParameters) => void"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.start.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"Parameters used to start the service."
],
"signature": [
"StartParameters"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.getServiceReactHook",
"type": "Function",
"tags": [],
"label": "getServiceReactHook",
"description": [
"\nReturns a function for providing a Context hook for the service."
],
"signature": [
"() => () => Service"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [
"\nStop the service."
],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry",
"type": "Class",
"tags": [],
"label": "PluginServiceRegistry",
"description": [
"\nA `PluginServiceRegistry` maintains a set of service providers which can be collectively\nstarted, stopped or retreived.\n\nThe `Services` generic determines the shape of all service APIs being produced.\nThe `StartParameters` generic determines what parameters are expected to\nstart the service."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceRegistry",
"text": "PluginServiceRegistry"
},
"<Services, StartParameters>"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "providers",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceProviders",
"text": "PluginServiceProviders"
},
"<Services, StartParameters>"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.isStarted",
"type": "Function",
"tags": [],
"label": "isStarted",
"description": [
"\nReturns true if the registry has been started, false otherwise."
],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.getServiceProviders",
"type": "Function",
"tags": [],
"label": "getServiceProviders",
"description": [
"\nReturns a map of `PluginServiceProvider` objects."
],
"signature": [
"() => ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceProviders",
"text": "PluginServiceProviders"
},
"<Services, StartParameters>"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.getContextProvider",
"type": "Function",
"tags": [],
"label": "getContextProvider",
"description": [
"\nReturns a React Context Provider for use in consuming applications."
],
"signature": [
"() => React.FC<{}>"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [
"\nStart the registry.\n"
],
"signature": [
"(params: StartParameters) => this"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.start.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"Parameters used to start the registry."
],
"signature": [
"StartParameters"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceRegistry.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [
"\nStop the registry."
],
"signature": [
"() => this"
],
"path": "src/plugins/presentation_util/public/services/create/registry.tsx",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices",
"type": "Class",
"tags": [],
"label": "PluginServices",
"description": [
"\n`PluginServices` is a top-level class for specifying and accessing services within a plugin.\n\nA `PluginServices` object can be provided with a `PluginServiceRegistry` at any time, which will\nthen be used to provide services to any component that accesses it.\n\nThe `Services` generic determines the shape of all service APIs being produced."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServices",
"text": "PluginServices"
},
"<Services>"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.setRegistry",
"type": "Function",
"tags": [],
"label": "setRegistry",
"description": [
"\nSupply a `PluginServiceRegistry` for the class to use to provide services and context.\n"
],
"signature": [
"(registry: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceRegistry",
"text": "PluginServiceRegistry"
},
"<Services, any> | null) => void"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.setRegistry.$1",
"type": "CompoundType",
"tags": [],
"label": "registry",
"description": [
"A setup and started `PluginServiceRegistry`."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceRegistry",
"text": "PluginServiceRegistry"
},
"<Services, any> | null"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.hasRegistry",
"type": "Function",
"tags": [],
"label": "hasRegistry",
"description": [
"\nReturns true if a registry has been provided, false otherwise."
],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.getContextProvider",
"type": "Function",
"tags": [],
"label": "getContextProvider",
"description": [
"\nReturn the React Context Provider that will supply services."
],
"signature": [
"() => React.FC<{}>"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.getHooks",
"type": "Function",
"tags": [],
"label": "getHooks",
"description": [
"\nReturn a map of React Hooks that can be used in React components."
],
"signature": [
"() => ServiceHooks<Services>"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServices.getServices",
"type": "Function",
"tags": [],
"label": "getServices",
"description": [],
"signature": [
"() => Services"
],
"path": "src/plugins/presentation_util/public/services/create/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.AddFromLibraryButton",
"type": "Function",
"tags": [],
"label": "AddFromLibraryButton",
"description": [],
"signature": [
"({ onClick, ...rest }: Pick<",
"Props",
", \"onClick\" | \"className\" | \"primary\" | \"iconSide\" | \"isDarkModeEnabled\">) => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.AddFromLibraryButton.$1",
"type": "Object",
"tags": [],
"label": "{ onClick, ...rest }",
"description": [],
"signature": [
"Pick<",
"Props",
", \"onClick\" | \"className\" | \"primary\" | \"iconSide\" | \"isDarkModeEnabled\">"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.encode",
"type": "Function",
"tags": [],
"label": "encode",
"description": [],
"signature": [
"(data: any, type: string) => Promise<string>"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.encode.$1",
"type": "Any",
"tags": [],
"label": "data",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.encode.$2",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.functionWrapper",
"type": "Function",
"tags": [],
"label": "functionWrapper",
"description": [],
"signature": [
"(fnSpec: FnType) => (input: any, args: Record<string, any>, context: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">) => any"
],
"path": "src/plugins/presentation_util/common/lib/test_helpers/function_wrapper.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.functionWrapper.$1",
"type": "Function",
"tags": [],
"label": "fnSpec",
"description": [],
"signature": [
"FnType"
],
"path": "src/plugins/presentation_util/common/lib/test_helpers/function_wrapper.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.getElasticLogo",
"type": "Function",
"tags": [],
"label": "getElasticLogo",
"description": [],
"signature": [
"() => Promise<typeof ",
"src/plugins/presentation_util/common/lib/utils/elastic_logo",
">"
],
"path": "src/plugins/presentation_util/common/lib/utils/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.getElasticOutline",
"type": "Function",
"tags": [],
"label": "getElasticOutline",
"description": [],
"signature": [
"() => Promise<typeof ",
"src/plugins/presentation_util/common/lib/utils/elastic_outline",
">"
],
"path": "src/plugins/presentation_util/common/lib/utils/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.getStubPluginServices",
"type": "Function",
"tags": [],
"label": "getStubPluginServices",
"description": [],
"signature": [
"() => ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationUtilPluginStart",
"text": "PresentationUtilPluginStart"
}
],
"path": "src/plugins/presentation_util/public/services/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidDataUrl",
"type": "Function",
"tags": [],
"label": "isValidDataUrl",
"description": [],
"signature": [
"(str: string | undefined) => boolean"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidDataUrl.$1",
"type": "string",
"tags": [],
"label": "str",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidHttpUrl",
"type": "Function",
"tags": [],
"label": "isValidHttpUrl",
"description": [],
"signature": [
"(str: string) => boolean"
],
"path": "src/plugins/presentation_util/common/lib/utils/httpurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidHttpUrl.$1",
"type": "string",
"tags": [],
"label": "str",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/common/lib/utils/httpurl.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidUrl",
"type": "Function",
"tags": [],
"label": "isValidUrl",
"description": [],
"signature": [
"(url: string) => boolean"
],
"path": "src/plugins/presentation_util/common/lib/utils/url.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.isValidUrl.$1",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/common/lib/utils/url.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDashboardPicker",
"type": "Function",
"tags": [],
"label": "LazyDashboardPicker",
"description": [],
"signature": [
"React.ExoticComponent<",
"DashboardPickerProps",
"> & { readonly _result: (props: ",
"DashboardPickerProps",
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDashboardPicker.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsBeakerButton",
"type": "Function",
"tags": [],
"label": "LazyLabsBeakerButton",
"description": [],
"signature": [
"React.ExoticComponent<",
"Props",
"> & { readonly _result: ({ solutions, ...props }: ",
"Props",
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsBeakerButton.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsFlyout",
"type": "Function",
"tags": [],
"label": "LazyLabsFlyout",
"description": [],
"signature": [
"React.ExoticComponent<",
"Props",
"> & { readonly _result: (props: ",
"Props",
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsFlyout.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazySavedObjectSaveModalDashboard",
"type": "Function",
"tags": [],
"label": "LazySavedObjectSaveModalDashboard",
"description": [],
"signature": [
"React.ExoticComponent<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.SaveModalDashboardProps",
"text": "SaveModalDashboardProps"
},
"> & { readonly _result: (props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.SaveModalDashboardProps",
"text": "SaveModalDashboardProps"
},
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazySavedObjectSaveModalDashboard.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.parseDataUrl",
"type": "Function",
"tags": [],
"label": "parseDataUrl",
"description": [],
"signature": [
"(str: string, withData: boolean) => { mimetype: string; encoding: string; charset: string; data: string | null; isImage: boolean; extension: any; } | null"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.parseDataUrl.$1",
"type": "string",
"tags": [],
"label": "str",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.parseDataUrl.$2",
"type": "boolean",
"tags": [],
"label": "withData",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionButton",
"type": "Function",
"tags": [],
"label": "PrimaryActionButton",
"description": [],
"signature": [
"({ isDarkModeEnabled, ...props }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_button.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionButton.$1",
"type": "Object",
"tags": [],
"label": "{ isDarkModeEnabled, ...props }",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_button.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionPopover",
"type": "Function",
"tags": [],
"label": "PrimaryActionPopover",
"description": [],
"signature": [
"(props: Pick<",
"Props",
", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"label\" | \"onKeyDown\" | \"id\" | \"title\" | \"security\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"panelRef\" | \"data-test-subj\" | \"display\" | \"offset\" | \"iconType\" | \"iconSide\" | \"buttonRef\" | \"hasArrow\" | \"isDarkModeEnabled\" | \"anchorClassName\" | \"attachToAnchor\" | \"container\" | \"focusTrapProps\" | \"initialFocus\" | \"insert\" | \"ownFocus\" | \"panelClassName\" | \"panelPaddingSize\" | \"panelStyle\" | \"panelProps\" | \"popoverRef\" | \"repositionOnScroll\" | \"zIndex\" | \"onTrapDeactivation\" | \"buffer\" | \"arrowChildren\">) => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionPopover.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Pick<",
"Props",
", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"label\" | \"onKeyDown\" | \"id\" | \"title\" | \"security\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"panelRef\" | \"data-test-subj\" | \"display\" | \"offset\" | \"iconType\" | \"iconSide\" | \"buttonRef\" | \"hasArrow\" | \"isDarkModeEnabled\" | \"anchorClassName\" | \"attachToAnchor\" | \"container\" | \"focusTrapProps\" | \"initialFocus\" | \"insert\" | \"ownFocus\" | \"panelClassName\" | \"panelPaddingSize\" | \"panelStyle\" | \"panelProps\" | \"popoverRef\" | \"repositionOnScroll\" | \"zIndex\" | \"onTrapDeactivation\" | \"buffer\" | \"arrowChildren\">"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.QuickButtonGroup",
"type": "Function",
"tags": [],
"label": "QuickButtonGroup",
"description": [],
"signature": [
"({ buttons }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.QuickButtonGroup.$1",
"type": "Object",
"tags": [],
"label": "{ buttons }",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveFromArgs",
"type": "Function",
"tags": [],
"label": "resolveFromArgs",
"description": [],
"signature": [
"(args: any, defaultDataurl?: string | null) => string"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveFromArgs.$1",
"type": "Any",
"tags": [],
"label": "args",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveFromArgs.$2",
"type": "CompoundType",
"tags": [],
"label": "defaultDataurl",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveWithMissingImage",
"type": "Function",
"tags": [],
"label": "resolveWithMissingImage",
"description": [],
"signature": [
"(img: string | null, alt?: string | null) => string | null"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveWithMissingImage.$1",
"type": "CompoundType",
"tags": [],
"label": "img",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.resolveWithMissingImage.$2",
"type": "CompoundType",
"tags": [],
"label": "alt",
"description": [],
"signature": [
"string | null"
],
"path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbar",
"type": "Function",
"tags": [],
"label": "SolutionToolbar",
"description": [],
"signature": [
"({ isDarkModeEnabled, children }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/solution_toolbar.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbar.$1",
"type": "Object",
"tags": [],
"label": "{ isDarkModeEnabled, children }",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/solution_toolbar.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbarButton",
"type": "Function",
"tags": [],
"label": "SolutionToolbarButton",
"description": [],
"signature": [
"({ label, primary, className, ...rest }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/button.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbarButton.$1",
"type": "Object",
"tags": [],
"label": "{ label, primary, className, ...rest }",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/button.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbarPopover",
"type": "Function",
"tags": [],
"label": "SolutionToolbarPopover",
"description": [],
"signature": [
"({ label, iconType, primary, iconSide, children, ...popover }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/popover.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.SolutionToolbarPopover.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n label,\n iconType,\n primary,\n iconSide,\n children,\n ...popover\n}",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/popover.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.useLabs",
"type": "Function",
"tags": [],
"label": "useLabs",
"description": [],
"signature": [
"() => ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationLabsService",
"text": "PresentationLabsService"
}
],
"path": "src/plugins/presentation_util/public/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.withSuspense",
"type": "Function",
"tags": [],
"label": "withSuspense",
"description": [
"\nA HOC which supplies React.Suspense with a fallback component, and a `EuiErrorBoundary` to contain errors."
],
"signature": [
"<P extends {}, R = {}>(Component: React.ComponentType<P>, fallback?: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) => React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.withSuspense.$1",
"type": "CompoundType",
"tags": [],
"label": "Component",
"description": [
"A component deferred by `React.lazy`"
],
"signature": [
"React.ComponentType<P>"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.withSuspense.$2",
"type": "CompoundType",
"tags": [],
"label": "fallback",
"description": [
"A fallback component to render while things load; default is `EuiLoadingSpinner`"
],
"signature": [
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.CommonControlOutput",
"type": "Interface",
"tags": [],
"label": "CommonControlOutput",
"description": [],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.CommonControlOutput.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.CommonControlOutput.dataViews",
"type": "Array",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[] | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps",
"type": "Interface",
"tags": [],
"label": "ControlEditorProps",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEditorProps",
"text": "ControlEditorProps"
},
"<T>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.initialInput",
"type": "Object",
"tags": [],
"label": "initialInput",
"description": [],
"signature": [
"Partial<T> | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"(partial: Partial<T>) => void"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.onChange.$1",
"type": "Object",
"tags": [],
"label": "partial",
"description": [],
"signature": [
"Partial<T>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.setValidState",
"type": "Function",
"tags": [],
"label": "setValidState",
"description": [],
"signature": [
"(valid: boolean) => void"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.setValidState.$1",
"type": "boolean",
"tags": [],
"label": "valid",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.setDefaultTitle",
"type": "Function",
"tags": [],
"label": "setDefaultTitle",
"description": [],
"signature": [
"(defaultTitle: string) => void"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEditorProps.setDefaultTitle.$1",
"type": "string",
"tags": [],
"label": "defaultTitle",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupInput",
"type": "Interface",
"tags": [],
"label": "ControlGroupInput",
"description": [],
"signature": [
"ControlGroupInput",
" extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
",",
"ControlInput"
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupInput.defaultControlWidth",
"type": "CompoundType",
"tags": [],
"label": "defaultControlWidth",
"description": [],
"signature": [
"\"auto\" | \"small\" | \"medium\" | \"large\" | undefined"
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupInput.controlStyle",
"type": "CompoundType",
"tags": [],
"label": "controlStyle",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupInput.panels",
"type": "Object",
"tags": [],
"label": "panels",
"description": [],
"signature": [
"ControlsPanels"
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlPanelState",
"type": "Interface",
"tags": [],
"label": "ControlPanelState",
"description": [],
"signature": [
"ControlPanelState",
"<TEmbeddableInput> extends ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.PanelState",
"text": "PanelState"
},
"<TEmbeddableInput>"
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlPanelState.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlPanelState.width",
"type": "CompoundType",
"tags": [],
"label": "width",
"description": [],
"signature": [
"\"auto\" | \"small\" | \"medium\" | \"large\""
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlsPanels",
"type": "Interface",
"tags": [],
"label": "ControlsPanels",
"description": [],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlsPanels.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory",
"type": "Interface",
"tags": [],
"label": "IEditableControlFactory",
"description": [
"\nControl embeddable editor types"
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.IEditableControlFactory",
"text": "IEditableControlFactory"
},
"<T>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory.controlEditorComponent",
"type": "Function",
"tags": [],
"label": "controlEditorComponent",
"description": [],
"signature": [
"((props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEditorProps",
"text": "ControlEditorProps"
},
"<T>) => JSX.Element) | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory.controlEditorComponent.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEditorProps",
"text": "ControlEditorProps"
},
"<T>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory.presaveTransformFunction",
"type": "Function",
"tags": [],
"label": "presaveTransformFunction",
"description": [],
"signature": [
"((newState: Partial<T>, embeddable?: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<T, ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
"> | undefined) => Partial<T>) | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory.presaveTransformFunction.$1",
"type": "Object",
"tags": [],
"label": "newState",
"description": [],
"signature": [
"Partial<T>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.IEditableControlFactory.presaveTransformFunction.$2",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<T, ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
"> | undefined"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams",
"type": "Interface",
"tags": [],
"label": "KibanaPluginServiceParams",
"description": [
"\nParameters necessary to create a Kibana-based service, (e.g. during Plugin\nstartup or setup).\n\nThe `Start` generic refers to the specific Plugin `TPluginsStart`."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.KibanaPluginServiceParams",
"text": "KibanaPluginServiceParams"
},
"<Start>"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.coreStart",
"type": "Object",
"tags": [],
"label": "coreStart",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.startPlugins",
"type": "Uncategorized",
"tags": [],
"label": "startPlugins",
"description": [],
"signature": [
"Start"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.appUpdater",
"type": "Object",
"tags": [],
"label": "appUpdater",
"description": [],
"signature": [
"BehaviorSubject",
"<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.AppUpdater",
"text": "AppUpdater"
},
"> | undefined"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.initContext",
"type": "Object",
"tags": [],
"label": "initContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object> | undefined"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput",
"type": "Interface",
"tags": [],
"label": "OptionsListEmbeddableInput",
"description": [],
"signature": [
"OptionsListEmbeddableInput",
" extends ",
"ControlInput"
],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput.dataViewId",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput.selectedOptions",
"type": "Array",
"tags": [],
"label": "selectedOptions",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput.singleSelect",
"type": "CompoundType",
"tags": [],
"label": "singleSelect",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OptionsListEmbeddableInput.loading",
"type": "CompoundType",
"tags": [],
"label": "loading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ParentIgnoreSettings",
"type": "Interface",
"tags": [],
"label": "ParentIgnoreSettings",
"description": [],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ParentIgnoreSettings.ignoreFilters",
"type": "CompoundType",
"tags": [],
"label": "ignoreFilters",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ParentIgnoreSettings.ignoreQuery",
"type": "CompoundType",
"tags": [],
"label": "ignoreQuery",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ParentIgnoreSettings.ignoreTimerange",
"type": "CompoundType",
"tags": [],
"label": "ignoreTimerange",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationCapabilitiesService",
"type": "Interface",
"tags": [],
"label": "PresentationCapabilitiesService",
"description": [],
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationCapabilitiesService.canAccessDashboards",
"type": "Function",
"tags": [],
"label": "canAccessDashboards",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationCapabilitiesService.canCreateNewDashboards",
"type": "Function",
"tags": [],
"label": "canCreateNewDashboards",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationCapabilitiesService.canSaveVisualizations",
"type": "Function",
"tags": [],
"label": "canSaveVisualizations",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationCapabilitiesService.canSetAdvancedSettings",
"type": "Function",
"tags": [],
"label": "canSetAdvancedSettings",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService",
"type": "Interface",
"tags": [],
"label": "PresentationDashboardsService",
"description": [],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboards",
"type": "Function",
"tags": [],
"label": "findDashboards",
"description": [],
"signature": [
"(query: string, fields: string[]) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
"PartialDashboardAttributes",
">[]>"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboards.$1",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboards.$2",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboardsByTitle",
"type": "Function",
"tags": [],
"label": "findDashboardsByTitle",
"description": [],
"signature": [
"(title: string) => Promise<",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
"PartialDashboardAttributes",
">[]>"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboardsByTitle.$1",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService",
"type": "Interface",
"tags": [],
"label": "PresentationLabsService",
"description": [],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.isProjectEnabled",
"type": "Function",
"tags": [],
"label": "isProjectEnabled",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\") => boolean"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.isProjectEnabled.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProjectIDs",
"type": "Function",
"tags": [],
"label": "getProjectIDs",
"description": [],
"signature": [
"() => readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\"]"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProject",
"type": "Function",
"tags": [],
"label": "getProject",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\") => ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
}
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProject.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProjects",
"type": "Function",
"tags": [],
"label": "getProjects",
"description": [],
"signature": [
"(solutions?: (\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined) => Record<\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\", ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
},
">"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProjects.$1",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"(\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.setProjectStatus",
"type": "Function",
"tags": [],
"label": "setProjectStatus",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\", env: \"kibana\" | \"browser\" | \"session\", status: boolean) => void"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.setProjectStatus.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.setProjectStatus.$2",
"type": "CompoundType",
"tags": [],
"label": "env",
"description": [],
"signature": [
"\"kibana\" | \"browser\" | \"session\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.setProjectStatus.$3",
"type": "boolean",
"tags": [],
"label": "status",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.reset",
"type": "Function",
"tags": [],
"label": "reset",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.QuickButtonProps",
"type": "Interface",
"tags": [],
"label": "QuickButtonProps",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.QuickButtonProps",
"text": "QuickButtonProps"
},
" extends Pick<",
"EuiButtonGroupOptionProps",
", \"iconType\">"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.QuickButtonProps.createType",
"type": "string",
"tags": [],
"label": "createType",
"description": [],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.QuickButtonProps.onClick",
"type": "Function",
"tags": [],
"label": "onClick",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps",
"type": "Interface",
"tags": [],
"label": "SaveModalDashboardProps",
"description": [],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.documentInfo",
"type": "Object",
"tags": [],
"label": "documentInfo",
"description": [],
"signature": [
"SaveModalDocumentInfo"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.canSaveByReference",
"type": "boolean",
"tags": [],
"label": "canSaveByReference",
"description": [],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.objectType",
"type": "string",
"tags": [],
"label": "objectType",
"description": [],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
" & { dashboardId: string | null; addToLibrary: boolean; }) => void"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.onSave.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
" & { dashboardId: string | null; addToLibrary: boolean; }"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.tagOptions",
"type": "CompoundType",
"tags": [],
"label": "tagOptions",
"description": [],
"signature": [
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | ((state: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SaveModalState",
"text": "SaveModalState"
},
") => React.ReactNode) | null | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.CONTROL_GROUP_TYPE",
"type": "string",
"tags": [],
"label": "CONTROL_GROUP_TYPE",
"description": [],
"signature": [
"\"control_group\""
],
"path": "src/plugins/presentation_util/common/controls/control_group/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlEmbeddable",
"type": "Type",
"tags": [],
"label": "ControlEmbeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<TControlEmbeddableInput, TControlEmbeddableOutput>"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlFactory",
"type": "Type",
"tags": [],
"label": "ControlFactory",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<",
"ControlInput",
", ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ControlOutput",
"text": "ControlOutput"
},
">, ",
"SavedObjectAttributes",
">"
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlGroupOutput",
"type": "Type",
"tags": [],
"label": "ControlGroupOutput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ContainerOutput",
"text": "ContainerOutput"
},
" & ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.CommonControlOutput",
"text": "CommonControlOutput"
}
],
"path": "src/plugins/presentation_util/public/components/controls/control_group/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlInput",
"type": "Type",
"tags": [],
"label": "ControlInput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
" & { query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; timeRange?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; controlStyle?: \"twoLine\" | \"oneLine\" | undefined; ignoreParentSettings?: ",
"ParentIgnoreSettings",
" | undefined; }"
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlOutput",
"type": "Type",
"tags": [],
"label": "ControlOutput",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
" & ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.CommonControlOutput",
"text": "CommonControlOutput"
}
],
"path": "src/plugins/presentation_util/public/components/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlStyle",
"type": "Type",
"tags": [],
"label": "ControlStyle",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ControlWidth",
"type": "Type",
"tags": [],
"label": "ControlWidth",
"description": [],
"signature": [
"\"auto\" | \"small\" | \"medium\" | \"large\""
],
"path": "src/plugins/presentation_util/common/controls/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.imageTypes",
"type": "Array",
"tags": [],
"label": "imageTypes",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/presentation_util/common/lib/utils/dataurl.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceFactory",
"type": "Type",
"tags": [],
"label": "KibanaPluginServiceFactory",
"description": [
"\nA factory function for creating a Kibana-based service.\n\nThe `Service` generic determines the shape of the API being produced.\nThe `Setup` generic refers to the specific Plugin `TPluginsSetup`.\nThe `Start` generic refers to the specific Plugin `TPluginsStart`."
],
"signature": [
"(params: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.KibanaPluginServiceParams",
"text": "KibanaPluginServiceParams"
},
"<Start>) => Service"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceFactory.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.KibanaPluginServiceParams",
"text": "KibanaPluginServiceParams"
},
"<Start>"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OPTIONS_LIST_CONTROL",
"type": "string",
"tags": [],
"label": "OPTIONS_LIST_CONTROL",
"description": [],
"signature": [
"\"optionsListControl\""
],
"path": "src/plugins/presentation_util/common/controls/control_types/options_list/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceFactory",
"type": "Type",
"tags": [],
"label": "PluginServiceFactory",
"description": [
"\nA factory function for creating a service.\n\nThe `Service` generic determines the shape of the API being produced.\nThe `StartParameters` generic determines what parameters are expected to\ncreate the service."
],
"signature": [
"(params: Parameters) => Service"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceFactory.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Parameters"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProviders",
"type": "Type",
"tags": [],
"label": "PluginServiceProviders",
"description": [
"\nA collection of `PluginServiceProvider` objects, keyed by the `Services` API generic.\n\nThe `Services` generic determines the shape of all service APIs being produced.\nThe `StartParameters` generic determines what parameters are expected to\nstart the service."
],
"signature": [
"{ [K in keyof Services]: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PluginServiceProvider",
"text": "PluginServiceProvider"
},
"<Services[K], StartParameters>; }"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.Project",
"type": "Type",
"tags": [],
"label": "Project",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.ProjectConfig",
"text": "ProjectConfig"
},
" & { status: ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.ProjectStatus",
"text": "ProjectStatus"
},
"; }"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ProjectID",
"type": "Type",
"tags": [],
"label": "ProjectID",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle",
"type": "Object",
"tags": [],
"label": "fontStyle",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec",
"type": "Object",
"tags": [],
"label": "spec",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.fontFamily",
"type": "string",
"tags": [],
"label": "fontFamily",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.fontWeight",
"type": "string",
"tags": [],
"label": "fontWeight",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.fontStyle",
"type": "string",
"tags": [],
"label": "fontStyle",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.textDecoration",
"type": "string",
"tags": [],
"label": "textDecoration",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.textAlign",
"type": "string",
"tags": [],
"label": "textAlign",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.fontSize",
"type": "string",
"tags": [],
"label": "fontSize",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.spec.lineHeight",
"type": "string",
"tags": [],
"label": "lineHeight",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.fontStyle.css",
"type": "string",
"tags": [],
"label": "css",
"description": [],
"path": "src/plugins/presentation_util/common/lib/test_helpers/test_styles.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.projectIDs",
"type": "Object",
"tags": [],
"label": "projectIDs",
"description": [],
"signature": [
"readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginSetup",
"type": "Interface",
"tags": [],
"label": "PresentationUtilPluginSetup",
"description": [],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart",
"type": "Interface",
"tags": [],
"label": "PresentationUtilPluginStart",
"description": [],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.ContextProvider",
"type": "Function",
"tags": [],
"label": "ContextProvider",
"description": [],
"signature": [
"React.FunctionComponent<{}>"
],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.ContextProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.ContextProvider.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.labsService",
"type": "Object",
"tags": [],
"label": "labsService",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.PresentationLabsService",
"text": "PresentationLabsService"
}
],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.controlsService",
"type": "Object",
"tags": [],
"label": "controlsService",
"description": [],
"signature": [
"PresentationControlsService"
],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-server.SETTING_CATEGORY",
"type": "string",
"tags": [],
"label": "SETTING_CATEGORY",
"description": [],
"signature": [
"\"Presentation Labs\""
],
"path": "src/plugins/presentation_util/server/ui_settings.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.getProjectIDs",
"type": "Function",
"tags": [],
"label": "getProjectIDs",
"description": [],
"signature": [
"() => readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.isProjectEnabledByStatus",
"type": "Function",
"tags": [],
"label": "isProjectEnabledByStatus",
"description": [],
"signature": [
"(active: boolean, status: ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.EnvironmentStatus",
"text": "EnvironmentStatus"
},
") => boolean"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.isProjectEnabledByStatus.$1",
"type": "boolean",
"tags": [],
"label": "active",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.isProjectEnabledByStatus.$2",
"type": "Object",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.EnvironmentStatus",
"text": "EnvironmentStatus"
}
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig",
"type": "Interface",
"tags": [],
"label": "ProjectConfig",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.environments",
"type": "Array",
"tags": [],
"label": "environments",
"description": [],
"signature": [
"(\"kibana\" | \"browser\" | \"session\")[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.solutions",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"(\"dashboard\" | \"canvas\" | \"presentation\")[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.DASHBOARD_CONTROLS",
"type": "string",
"tags": [],
"label": "DASHBOARD_CONTROLS",
"description": [],
"signature": [
"\"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.DEFER_BELOW_FOLD",
"type": "string",
"tags": [],
"label": "DEFER_BELOW_FOLD",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.EnvironmentName",
"type": "Type",
"tags": [],
"label": "EnvironmentName",
"description": [],
"signature": [
"\"kibana\" | \"browser\" | \"session\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.EnvironmentStatus",
"type": "Type",
"tags": [],
"label": "EnvironmentStatus",
"description": [],
"signature": [
"{ kibana?: boolean | undefined; browser?: boolean | undefined; session?: boolean | undefined; }"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.LABS_PROJECT_PREFIX",
"type": "string",
"tags": [],
"label": "LABS_PROJECT_PREFIX",
"description": [],
"signature": [
"\"labs:\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"presentationUtil\""
],
"path": "src/plugins/presentation_util/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"presentationUtil\""
],
"path": "src/plugins/presentation_util/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.Project",
"type": "Type",
"tags": [],
"label": "Project",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.ProjectConfig",
"text": "ProjectConfig"
},
" & { status: ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.ProjectStatus",
"text": "ProjectStatus"
},
"; }"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectID",
"type": "Type",
"tags": [],
"label": "ProjectID",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectStatus",
"type": "Type",
"tags": [],
"label": "ProjectStatus",
"description": [],
"signature": [
"{ defaultValue: boolean; isEnabled: boolean; isOverride: boolean; } & ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.EnvironmentStatus",
"text": "EnvironmentStatus"
}
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.SolutionName",
"type": "Type",
"tags": [],
"label": "SolutionName",
"description": [],
"signature": [
"\"dashboard\" | \"canvas\" | \"presentation\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.environmentNames",
"type": "Object",
"tags": [],
"label": "environmentNames",
"description": [],
"signature": [
"readonly [\"kibana\", \"browser\", \"session\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projectIDs",
"type": "Object",
"tags": [],
"label": "projectIDs",
"description": [],
"signature": [
"readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects",
"type": "Object",
"tags": [],
"label": "projects",
"description": [
"\nThis is a list of active Labs Projects for the Presentation Team. It is the \"source of truth\" for all projects\nprovided to users of our solutions in Kibana."
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD",
"type": "Object",
"tags": [],
"label": "[DEFER_BELOW_FOLD]",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"signature": [
"false"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.environments",
"type": "Array",
"tags": [],
"label": "environments",
"description": [],
"signature": [
"(\"kibana\" | \"browser\" | \"session\")[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.solutions",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"\"dashboard\"[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS",
"type": "Object",
"tags": [],
"label": "[DASHBOARD_CONTROLS]",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:dashboardControls\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"signature": [
"false"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.environments",
"type": "Array",
"tags": [],
"label": "environments",
"description": [],
"signature": [
"(\"kibana\" | \"browser\" | \"session\")[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.solutions",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"\"dashboard\"[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.solutionNames",
"type": "Object",
"tags": [],
"label": "solutionNames",
"description": [],
"signature": [
"readonly [\"canvas\", \"dashboard\", \"presentation\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink