kibana/api_docs/presentation_util.devdocs.json

1807 lines
No EOL
63 KiB
JSON

{
"id": "presentationUtil",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.DashboardDrilldownOptionsComponent",
"type": "Function",
"tags": [],
"label": "DashboardDrilldownOptionsComponent",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DashboardDrilldownOptionsProps",
" & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.DashboardDrilldownOptionsComponent.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDashboardPicker",
"type": "Function",
"tags": [],
"label": "LazyDashboardPicker",
"description": [],
"signature": [
"React.LazyExoticComponent<({ isDisabled, onChange, idsToOmit }: ",
"DashboardPickerProps",
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyDataViewPicker",
"type": "Function",
"tags": [],
"label": "LazyDataViewPicker",
"description": [],
"signature": [
"React.LazyExoticComponent<({ dataViews, selectedDataViewId, onChangeDataViewId, trigger, selectableProps, ...other }: { dataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]; selectedDataViewId?: string | undefined; trigger: ",
"DataViewTriggerProps",
"; onChangeDataViewId: (newId: string) => void; selectableProps?: Partial<",
"EuiSelectableProps",
"<{}>> | undefined; }) => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/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.LazyExoticComponent<(props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.ExpressionInputProps",
"text": "ExpressionInputProps"
},
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyFieldPicker",
"type": "Function",
"tags": [],
"label": "LazyFieldPicker",
"description": [],
"signature": [
"React.LazyExoticComponent<({ dataView, onSelectField, filterPredicate, selectedFieldName, selectableProps, ...other }: ",
"FieldPickerProps",
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsBeakerButton",
"type": "Function",
"tags": [],
"label": "LazyLabsBeakerButton",
"description": [],
"signature": [
"React.LazyExoticComponent<({ solutions, ...props }: ",
"Props",
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazyLabsFlyout",
"type": "Function",
"tags": [],
"label": "LazyLabsFlyout",
"description": [],
"signature": [
"React.LazyExoticComponent<(props: ",
"Props",
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.LazySavedObjectSaveModalDashboard",
"type": "Function",
"tags": [],
"label": "LazySavedObjectSaveModalDashboard",
"description": [],
"signature": [
"React.LazyExoticComponent<(props: ",
{
"pluginId": "presentationUtil",
"scope": "public",
"docId": "kibPresentationUtilPluginApi",
"section": "def-public.SaveModalDashboardProps",
"text": "SaveModalDashboardProps"
},
") => React.JSX.Element>"
],
"path": "src/platform/plugins/shared/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/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService",
"type": "Interface",
"tags": [],
"label": "PresentationLabsService",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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:canvas:byValueEmbeddable\") => boolean"
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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:canvas:byValueEmbeddable\""
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProject",
"type": "Function",
"tags": [],
"label": "getProject",
"description": [],
"signature": [
"(id: \"labs:dashboard:deferBelowFold\" | \"labs:canvas:byValueEmbeddable\") => ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
}
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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:canvas:byValueEmbeddable\""
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProjects",
"type": "Function",
"tags": [],
"label": "getProjects",
"description": [],
"signature": [
"(solutions?: (\"canvas\" | \"presentation\" | \"dashboard\")[] | undefined) => Record<\"labs:dashboard:deferBelowFold\" | \"labs:canvas:byValueEmbeddable\", ",
{
"pluginId": "presentationUtil",
"scope": "common",
"docId": "kibPresentationUtilPluginApi",
"section": "def-common.Project",
"text": "Project"
},
">"
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationLabsService.getProjects.$1",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"(\"canvas\" | \"presentation\" | \"dashboard\")[] | undefined"
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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:canvas:byValueEmbeddable\", env: \"kibana\" | \"browser\" | \"session\", status: boolean) => void"
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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:canvas:byValueEmbeddable\""
],
"path": "src/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.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/platform/plugins/shared/presentation_util/public/services/presentation_labs_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps",
"type": "Interface",
"tags": [],
"label": "SaveModalDashboardProps",
"description": [],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.SaveModalDashboardProps.mustCopyOnSaveMessage",
"type": "string",
"tags": [],
"label": "mustCopyOnSaveMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.DashboardDrilldownOptions",
"type": "Type",
"tags": [],
"label": "DashboardDrilldownOptions",
"description": [],
"signature": [
"{ useCurrentFilters: boolean; useCurrentDateRange: boolean; openInNewTab: boolean; }"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/dashboard_drilldown_options/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"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/platform/plugins/shared/presentation_util/public/components/types.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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/public/components/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS",
"type": "Object",
"tags": [],
"label": "DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/public/components/dashboard_drilldown_options/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "presentationUtil",
"id": "def-public.DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS.openInNewTab",
"type": "boolean",
"tags": [],
"label": "openInNewTab",
"description": [],
"signature": [
"false"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/dashboard_drilldown_options/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS.useCurrentDateRange",
"type": "boolean",
"tags": [],
"label": "useCurrentDateRange",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/dashboard_drilldown_options/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-public.DEFAULT_DASHBOARD_DRILLDOWN_OPTIONS.useCurrentFilters",
"type": "boolean",
"tags": [],
"label": "useCurrentFilters",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/shared/presentation_util/public/components/dashboard_drilldown_options/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"setup": {
"parentPluginId": "presentationUtil",
"id": "def-public.PresentationUtilPluginSetup",
"type": "Interface",
"tags": [],
"label": "PresentationUtilPluginSetup",
"description": [],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/presentation_util/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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:canvas:byValueEmbeddable\"]"
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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:canvas:byValueEmbeddable\""
],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isActive",
"type": "boolean",
"tags": [],
"label": "isActive",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.isDisplayed",
"type": "boolean",
"tags": [],
"label": "isDisplayed",
"description": [],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.ProjectConfig.solutions",
"type": "Array",
"tags": [],
"label": "solutions",
"description": [],
"signature": [
"(\"canvas\" | \"presentation\" | \"dashboard\")[]"
],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "presentationUtil",
"id": "def-common.EnvironmentName",
"type": "Type",
"tags": [],
"label": "EnvironmentName",
"description": [],
"signature": [
"\"kibana\" | \"browser\" | \"session\""
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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:canvas:byValueEmbeddable\""
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.SolutionName",
"type": "Type",
"tags": [],
"label": "SolutionName",
"description": [],
"signature": [
"\"canvas\" | \"presentation\" | \"dashboard\""
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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:canvas:byValueEmbeddable\"]"
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.DEFER_BELOW_FOLD.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "presentationUtil",
"id": "def-common.projects.BY_VALUE_EMBEDDABLE.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/presentation_util/common/labs.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
}
}