github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/presentation_util.devdocs.json
Kibana Machine e82e0a150f
[api-docs] Daily api_docs build (#144203)
2022-10-29 00:46:56 -04:00

4507 lines
No EOL
156 KiB
JSON
Raw Blame History

{
"id": "presentationUtil",
"client": {
"classes": [
{
"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, Services, RequiredServices>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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, ",
"PluginServiceRequiredServices",
"<RequiredServices, Services>>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.Unnamed.$2",
"type": "Uncategorized",
"tags": [],
"label": "requiredServices",
"description": [],
"signature": [
"RequiredServices | undefined"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"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,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [
"\nStart the service.\n"
],
"signature": [
"(params: StartParameters, requiredServices: ",
"PluginServiceRequiredServices",
"<RequiredServices, Services>) => void"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.start.$2",
"type": "Object",
"tags": [],
"label": "requiredServices",
"description": [],
"signature": [
"PluginServiceRequiredServices",
"<RequiredServices, Services>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceProvider.requiredServices",
"type": "CompoundType",
"tags": [],
"label": "requiredServices",
"description": [],
"signature": [
"never[] | NonNullable<RequiredServices>"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.AddFromLibraryButton",
"type": "Function",
"tags": [],
"label": "AddFromLibraryButton",
"description": [],
"signature": [
"({ onClick, ...rest }: ",
"Props",
") => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.AddFromLibraryButton.$1",
"type": "Object",
"tags": [],
"label": "{ onClick, ...rest }",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/add_from_library.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDataViewPicker",
"type": "Function",
"tags": [],
"label": "LazyDataViewPicker",
"description": [],
"signature": [
"React.ExoticComponent<{ dataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]; selectedDataViewId?: string | undefined; trigger: ",
"DataViewTriggerProps",
"; onChangeDataViewId: (newId: string) => void; selectableProps?: ",
"EuiSelectableProps",
"<{}> | undefined; }> & { readonly _result: ({ dataViews, selectedDataViewId, onChangeDataViewId, trigger, selectableProps, }: { dataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]; selectedDataViewId?: string | undefined; trigger: ",
"DataViewTriggerProps",
"; onChangeDataViewId: (newId: string) => void; selectableProps?: ",
"EuiSelectableProps",
"<{}> | undefined; }) => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDataViewPicker.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyExpressionInput",
"type": "Function",
"tags": [],
"label": "LazyExpressionInput",
"description": [
"\nA lazily-loaded ExpressionInput component."
],
"signature": [
"React.ExoticComponent<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ExpressionInputProps",
"text": "ExpressionInputProps"
},
"> & { readonly _result: (props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ExpressionInputProps",
"text": "ExpressionInputProps"
},
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyExpressionInput.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyFieldPicker",
"type": "Function",
"tags": [],
"label": "LazyFieldPicker",
"description": [],
"signature": [
"React.ExoticComponent<",
"FieldPickerProps",
"> & { readonly _result: ({ dataView, onSelectField, filterPredicate, selectedFieldName, }: ",
"FieldPickerProps",
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyFieldPicker.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsBeakerButton",
"type": "Function",
"tags": [],
"label": "LazyLabsBeakerButton",
"description": [],
"signature": [
"React.ExoticComponent<",
"EuiButtonProps",
" & Pick<",
"Props",
", \"solutions\">> & { readonly _result: ({ solutions, ...props }: ",
"Props",
") => JSX.Element; }"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.lazyLoadReduxEmbeddablePackage",
"type": "Function",
"tags": [],
"label": "lazyLoadReduxEmbeddablePackage",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddablePackage",
"text": "ReduxEmbeddablePackage"
},
">"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionPopover",
"type": "Function",
"tags": [],
"label": "PrimaryActionPopover",
"description": [],
"signature": [
"(props: Omit<",
"Props",
", \"primary\">) => JSX.Element"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PrimaryActionPopover.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Omit<",
"Props",
", \"primary\">"
],
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/primary_popover.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.registerExpressionsLanguage",
"type": "Function",
"tags": [],
"label": "registerExpressionsLanguage",
"description": [
"\nRegister a set of Expression Functions with the Presentation Utility ExpressionInput. This allows\nthe Monaco Editor to understand the functions and their arguments.\n\nThis function is async in order to move the logic to an async chunk.\n"
],
"signature": [
"(expressionFunctions: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunction",
"text": "ExpressionFunction"
},
"[]) => Promise<void>"
],
"path": "src/plugins/presentation_util/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.registerExpressionsLanguage.$1",
"type": "Array",
"tags": [],
"label": "expressionFunctions",
"description": [
"A set of Expression Functions to use in the ExpressionInput."
],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunction",
"text": "ExpressionFunction"
},
"[]"
],
"path": "src/plugins/presentation_util/public/index.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.useReduxContainerContext",
"type": "Function",
"tags": [],
"label": "useReduxContainerContext",
"description": [
"\nA typed use context hook for embeddable containers. it @returns an\nReduxContainerContextServices object typed to the generic inputTypes and ReducerTypes you pass in.\nNote that the reducer type is optional, but will be required to correctly infer the keys and payload\ntypes of your reducers. use `typeof MyReducers` here to retain them. It also includes a containerActions\nkey which contains most of the commonly used container operations"
],
"signature": [
"<ReduxEmbeddableStateType extends ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown> = ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown>, ReducerType extends ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType> = ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType>>() => ",
"ReduxContainerContext",
"<ReduxEmbeddableStateType, ReducerType>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/use_redux_embeddable_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.useReduxEmbeddableContext",
"type": "Function",
"tags": [],
"label": "useReduxEmbeddableContext",
"description": [
"\nA typed use context hook for embeddables that are not containers. it @returns an\nReduxEmbeddableContextServices object typed to the generic inputTypes and ReducerTypes you pass in.\nNote that the reducer type is optional, but will be required to correctly infer the keys and payload\ntypes of your reducers. use `typeof MyReducers` here to retain them."
],
"signature": [
"<ReduxEmbeddableStateType extends ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown> = ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown>, ReducerType extends ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType> = ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType>>() => ",
"ReduxEmbeddableContext",
"<ReduxEmbeddableStateType, ReducerType>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/use_redux_embeddable_context.ts",
"deprecated": false,
"trackAdoption": 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 | React.JSXElementConstructor<any>> | null) => React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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 | React.JSXElementConstructor<any>> | null"
],
"path": "src/plugins/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps",
"type": "Interface",
"tags": [],
"label": "ExpressionInputProps",
"description": [
"\nReact Props for the ExpressionInput component."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ExpressionInputProps",
"text": "ExpressionInputProps"
},
" extends Pick<React.HTMLAttributes<HTMLDivElement>, \"className\" | \"style\">"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.expressionFunctions",
"type": "Array",
"tags": [],
"label": "expressionFunctions",
"description": [
"A collection of ExpressionFunctions to use in the autocomplete"
],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunction",
"text": "ExpressionFunction"
},
"[]"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.expression",
"type": "string",
"tags": [],
"label": "expression",
"description": [
"Value of expression"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [
"Function invoked when expression value is changed"
],
"signature": [
"(value?: string | undefined) => void"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.onChange.$1",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.isCompact",
"type": "CompoundType",
"tags": [],
"label": "isCompact",
"description": [
"In full screen mode or not"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.height",
"type": "CompoundType",
"tags": [],
"label": "height",
"description": [
"\nThe CodeEditor requires a set height, either on itself, or set to 100% with the parent\ncontainer controlling the height. This prop is required so consumers understand this\nlimitation and are intentional in using the component."
],
"signature": [
"Property",
".Height<string | number> | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.editorRef",
"type": "Object",
"tags": [],
"label": "editorRef",
"description": [
"\nAn optional ref in order to access the Monaco editor instance from consuming components,\n(e.g. to determine if the editor is focused, etc)."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ExpressionInputEditorRef",
"text": "ExpressionInputEditorRef"
},
" | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputProps.onEditorDidMount",
"type": "Function",
"tags": [],
"label": "onEditorDidMount",
"description": [],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.OnExpressionInputEditorDidMount",
"text": "OnExpressionInputEditorDidMount"
},
" | undefined"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.coreStart",
"type": "Object",
"tags": [],
"label": "coreStart",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.appUpdater",
"type": "Object",
"tags": [],
"label": "appUpdater",
"description": [],
"signature": [
"BehaviorSubject",
"<",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppUpdater",
"text": "AppUpdater"
},
"> | undefined"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceParams.initContext",
"type": "Object",
"tags": [],
"label": "initContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object> | undefined"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboards",
"type": "Function",
"tags": [],
"label": "findDashboards",
"description": [],
"signature": [
"(query: string, fields: string[]) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
"PartialDashboardAttributes",
">[]>"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationDashboardsService.findDashboardsByTitle",
"type": "Function",
"tags": [],
"label": "findDashboardsByTitle",
"description": [],
"signature": [
"(title: string) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-browser",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi",
"section": "def-common.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<",
"PartialDashboardAttributes",
">[]>"
],
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.isProjectEnabled",
"type": "Function",
"tags": [],
"label": "isProjectEnabled",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\") => boolean"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.isProjectEnabled.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": 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\", \"labs:canvas:byValueEmbeddable\"]"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProject",
"type": "Function",
"tags": [],
"label": "getProject",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\") => ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
}
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProject.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": 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\" | \"labs:canvas:byValueEmbeddable\", ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
},
">"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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\" | \"labs:canvas:byValueEmbeddable\", env: \"kibana\" | \"browser\" | \"session\", status: boolean) => void"
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.setProjectStatus.$1",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/public/services/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddablePackage",
"type": "Interface",
"tags": [],
"label": "ReduxEmbeddablePackage",
"description": [
"\nThe package type is lazily exported from presentation_util and should contain all methods needed to use the redux embeddable tools."
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddablePackage.createTools",
"type": "Function",
"tags": [],
"label": "createTools",
"description": [],
"signature": [
"<ReduxEmbeddableStateType extends ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown> = ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown>, ReducerType extends ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType> = ",
"EmbeddableReducers",
"<ReduxEmbeddableStateType>>({ reducers, embeddable, syncSettings, initialComponentState, }: { embeddable: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<ReduxEmbeddableStateType[\"explicitInput\"], ReduxEmbeddableStateType[\"output\"], any>; initialComponentState?: ReduxEmbeddableStateType[\"componentState\"] | undefined; syncSettings?: ",
"ReduxEmbeddableSyncSettings",
"<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown>> | undefined; reducers: ReducerType; }) => ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableTools",
"text": "ReduxEmbeddableTools"
},
"<ReduxEmbeddableStateType, ReducerType>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddablePackage.createTools.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ embeddable: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<ReduxEmbeddableStateType[\"explicitInput\"], ReduxEmbeddableStateType[\"output\"], any>; initialComponentState?: ReduxEmbeddableStateType[\"componentState\"] | undefined; syncSettings?: ",
"ReduxEmbeddableSyncSettings",
"<",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", unknown>> | undefined; reducers: ReducerType; }"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/create_redux_embeddable_tools.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableState",
"type": "Interface",
"tags": [],
"label": "ReduxEmbeddableState",
"description": [
"\nThe Embeddable Redux store should contain Input, Output and State. Input is serialized and used to create the embeddable,\nOutput is used as a communication layer for state that the Embeddable creates, and State is used to store ephemeral state which needs\nto be communicated between an embeddable and its inner React components."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableState",
"text": "ReduxEmbeddableState"
},
"<InputType, OutputType, StateType>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableState.explicitInput",
"type": "Uncategorized",
"tags": [],
"label": "explicitInput",
"description": [],
"signature": [
"InputType"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableState.output",
"type": "Uncategorized",
"tags": [],
"label": "output",
"description": [],
"signature": [
"OutputType"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableState.componentState",
"type": "Uncategorized",
"tags": [],
"label": "componentState",
"description": [],
"signature": [
"StateType"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools",
"type": "Interface",
"tags": [],
"label": "ReduxEmbeddableTools",
"description": [
"\nThe return type from setupReduxEmbeddable. Contains a wrapper which comes with the store provider and provides the context to react components,\nbut also returns the context object to allow the embeddable class to interact with the redux store."
],
"signature": [
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ReduxEmbeddableTools",
"text": "ReduxEmbeddableTools"
},
"<ReduxEmbeddableStateType, ReducerType>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.cleanup",
"type": "Function",
"tags": [],
"label": "cleanup",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.Wrapper",
"type": "Function",
"tags": [],
"label": "Wrapper",
"description": [],
"signature": [
"React.FunctionComponent<{ children?: React.ReactNode; }>"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.Wrapper.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.Wrapper.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.dispatch",
"type": "Function",
"tags": [],
"label": "dispatch",
"description": [],
"signature": [
"Dispatch",
"<",
"AnyAction",
">"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.dispatch.$1",
"type": "Uncategorized",
"tags": [],
"label": "action",
"description": [],
"signature": [
"T"
],
"path": "node_modules/redux/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.getState",
"type": "Function",
"tags": [],
"label": "getState",
"description": [],
"signature": [
"() => ReduxEmbeddableStateType"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ReduxEmbeddableTools.actions",
"type": "CompoundType",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"{ [Property in keyof ReducerType]: ",
"ActionCreatorWithPayload",
"<Parameters<ReducerType[Property]>[1][\"payload\"], string>; } & { updateEmbeddableReduxInput: ",
"ActionCreatorWithPayload",
"<Partial<ReduxEmbeddableStateType[\"explicitInput\"]>, string>; updateEmbeddableReduxOutput: ",
"ActionCreatorWithPayload",
"<Partial<ReduxEmbeddableStateType[\"output\"]>, string>; }"
],
"path": "src/plugins/presentation_util/public/redux_embeddables/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.tagOptions",
"type": "CompoundType",
"tags": [],
"label": "tagOptions",
"description": [],
"signature": [
"React.ReactNode | ((state: ",
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SaveModalState",
"text": "SaveModalState"
},
") => React.ReactNode)"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.ExpressionInputEditorRef",
"type": "Type",
"tags": [],
"label": "ExpressionInputEditorRef",
"description": [
"\nA type for any React Ref that can be used to store a reference to the Monaco editor within the\nExpressionInput."
],
"signature": [
"React.MutableRefObject<",
"editor",
".IStandaloneCodeEditor | null>"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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>, requiredServices: RequiredServices) => Service"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.KibanaPluginServiceFactory.$2",
"type": "Uncategorized",
"tags": [],
"label": "requiredServices",
"description": [],
"signature": [
"RequiredServices"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.OnExpressionInputEditorDidMount",
"type": "Type",
"tags": [],
"label": "OnExpressionInputEditorDidMount",
"description": [],
"signature": [
"(editor: ",
"editor",
".IStandaloneCodeEditor | null) => void"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.OnExpressionInputEditorDidMount.$1",
"type": "CompoundType",
"tags": [],
"label": "editor",
"description": [],
"signature": [
"editor",
".IStandaloneCodeEditor | null"
],
"path": "src/plugins/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": 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, requiredServices: RequiredServices) => Service"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PluginServiceFactory.$2",
"type": "Uncategorized",
"tags": [],
"label": "requiredServices",
"description": [],
"signature": [
"RequiredServices"
],
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
"deprecated": false,
"trackAdoption": 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, Services, (keyof Services)[]>; }"
],
"path": "src/plugins/presentation_util/public/services/create/provider.tsx",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.ProjectID",
"type": "Type",
"tags": [],
"label": "ProjectID",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.defaultTheme$",
"type": "Object",
"tags": [],
"label": "defaultTheme$",
"description": [],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">"
],
"path": "src/plugins/presentation_util/common/lib/utils/default_theme.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.projectIDs",
"type": "Object",
"tags": [],
"label": "projectIDs",
"description": [],
"signature": [
"readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\", \"labs:canvas:byValueEmbeddable\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.registerExpressionsLanguage",
"type": "Function",
"tags": [],
"label": "registerExpressionsLanguage",
"description": [],
"signature": [
"(expressionFunctions: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunction",
"text": "ExpressionFunction"
},
"[]) => Promise<void>"
],
"path": "src/plugins/presentation_util/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginStart.registerExpressionsLanguage.$1",
"type": "Array",
"tags": [],
"label": "expressionFunctions",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunction",
"text": "ExpressionFunction"
},
"[]"
],
"path": "src/plugins/presentation_util/public/index.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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\", \"labs:canvas:byValueEmbeddable\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.BY_VALUE_EMBEDDABLE",
"type": "string",
"tags": [],
"label": "BY_VALUE_EMBEDDABLE",
"description": [],
"signature": [
"\"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.EXPRESSIONS_LANGUAGE_ID",
"type": "string",
"tags": [],
"label": "EXPRESSIONS_LANGUAGE_ID",
"description": [
"\nThe unique identifier for the Expressions Language for use in the ExpressionInput\nand CodeEditor components."
],
"signature": [
"\"kibana-expressions\""
],
"path": "src/plugins/presentation_util/common/index.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectID",
"type": "Type",
"tags": [],
"label": "ProjectID",
"description": [],
"signature": [
"\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projectIDs",
"type": "Object",
"tags": [],
"label": "projectIDs",
"description": [],
"signature": [
"readonly [\"labs:dashboard:deferBelowFold\", \"labs:dashboard:dashboardControls\", \"labs:canvas:byValueEmbeddable\"]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.name",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.description",
"type": "Any",
"tags": [],
"label": "description",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": 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,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.name",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DASHBOARD_CONTROLS.description",
"type": "Any",
"tags": [],
"label": "description",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false
}
]
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE",
"type": "Object",
"tags": [],
"label": "[BY_VALUE_EMBEDDABLE]",
"description": [],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"labs:canvas:byValueEmbeddable\""
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.environments",
"type": "Array",
"tags": [],
"label": "environments",
"description": [],
"signature": [
"(\"kibana\" | \"browser\" | \"session\")[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.name",
"type": "Any",
"tags": [],
"label": "name",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.description",
"type": "Any",
"tags": [],
"label": "description",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.solutions",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"\"canvas\"[]"
],
"path": "src/plugins/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": 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,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink