66f69d6a13
* Improve API docs for task manager * Update docs
5524 lines
No EOL
186 KiB
JSON
5524 lines
No EOL
186 KiB
JSON
{
|
|
"id": "visualizations",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "BaseVisType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.note",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "note",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.getSupportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSupportedTriggers",
|
|
"description": [],
|
|
"signature": [
|
|
"((params?: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
" | undefined) => string[]) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.icon",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [],
|
|
"signature": [
|
|
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.image",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "image",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.stage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "stage",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"production\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.group",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisGroups",
|
|
"text": "VisGroups"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.titleInWizard",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "titleInWizard",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"VisTypeOptions"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.visConfig",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "visConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.editorConfig",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "editorConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.hidden",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hidden",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.requiresSearch",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "requiresSearch",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.hierarchicalData",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hierarchicalData",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | ((vis: { params: TVisParams; }) => boolean)"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"((vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>) => Promise<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>>) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.getUsedIndexPattern",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUsedIndexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
"((visParams: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[] | Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[]>) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.inspectorAdapters",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "inspectorAdapters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
" | (() => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
") | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.toExpressionAst",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toExpressionAst",
|
|
"description": [],
|
|
"signature": [
|
|
"(vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>, params: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
" | Promise<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.toExpressionAst.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.toExpressionAst.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.getInfoMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoMessage",
|
|
"description": [],
|
|
"signature": [
|
|
"((vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">) => React.ReactNode) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.schemas",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "schemas",
|
|
"description": [],
|
|
"signature": [
|
|
"Schemas"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.BaseVisType.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "opts",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisTypeDefinition",
|
|
"text": "VisTypeDefinition"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PersistedState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.PersistedState",
|
|
"text": "PersistedState"
|
|
},
|
|
" extends EventEmitter"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.Unnamed.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.Unnamed.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[] | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [],
|
|
"signature": [
|
|
"(key?: string | string[] | undefined, defaultValue?: any) => any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.get.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[] | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.get.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "defaultValue",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.set",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "set",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: any, value?: any) => this"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.set.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.set.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.setSilent",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setSilent",
|
|
"description": [],
|
|
"signature": [
|
|
"(key: any, value?: any) => this | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.setSilent.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.setSilent.$2",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.clearAllKeys",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clearAllKeys",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.reset",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reset",
|
|
"description": [],
|
|
"signature": [
|
|
"(path: string | string[]) => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.reset.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.getChanges",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getChanges",
|
|
"description": [],
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.toJSON",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"() => any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.toString",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toString",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.fromString",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fromString",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: string) => this"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.PersistedState.fromString.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "Vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.type",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"TVisParams"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.uiState",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.PersistedState",
|
|
"text": "PersistedState"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.Unnamed.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "visType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.setState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setState",
|
|
"description": [],
|
|
"signature": [
|
|
"(state: Pick<Pick<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">, \"type\" | \"id\" | \"title\" | \"description\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVisData",
|
|
"text": "SerializedVisData"
|
|
},
|
|
">; }, \"data\"> & Pick<{ data: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVisData",
|
|
"text": "SerializedVisData"
|
|
},
|
|
">; }, never>, \"type\" | \"data\" | \"id\" | \"title\" | \"description\" | \"params\" | \"uiState\">) => Promise<void>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.setState.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "state",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<Pick<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">, \"type\" | \"id\" | \"title\" | \"description\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVisData",
|
|
"text": "SerializedVisData"
|
|
},
|
|
">; }, \"data\"> & Pick<{ data: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVisData",
|
|
"text": "SerializedVisData"
|
|
},
|
|
">; }, never>, \"type\" | \"data\" | \"id\" | \"title\" | \"description\" | \"params\" | \"uiState\">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.clone",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "clone",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.serialize",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "serialize",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Vis.isHierarchical",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isHierarchical",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.getVisSchemas",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getVisSchemas",
|
|
"description": [],
|
|
"signature": [
|
|
"<TVisParams>(vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>, { timeRange, timefilter }: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
},
|
|
") => ",
|
|
"Schemas"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.getVisSchemas.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.getVisSchemas.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ timeRange, timefilter }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.prepareLogTable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prepareLogTable",
|
|
"description": [],
|
|
"signature": [
|
|
"(datatable: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
", dimensions: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.Dimension",
|
|
"text": "Dimension"
|
|
},
|
|
"[]) => { columns: { meta: { dimensionName: string | undefined; type: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumnType",
|
|
"text": "DatatableColumnType"
|
|
},
|
|
"; field?: string | undefined; index?: string | undefined; params?: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>> | undefined; source?: string | undefined; sourceParams?: ",
|
|
"SerializableRecord",
|
|
" | undefined; }; id: string; name: string; }[]; type: \"datatable\"; rows: Record<string, any>[]; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.prepareLogTable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "datatable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.prepareLogTable.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "dimensions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.Dimension",
|
|
"text": "Dimension"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.updateOldState",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "updateOldState",
|
|
"description": [],
|
|
"signature": [
|
|
"(oldState: unknown) => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.SavedVisState",
|
|
"text": "SavedVisState"
|
|
},
|
|
"<",
|
|
"SerializableRecord",
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/legacy/vis_update_state.d.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.updateOldState.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "oldState",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/visualizations/public/legacy/vis_update_state.d.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationContainer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "VisualizationContainer",
|
|
"description": [],
|
|
"signature": [
|
|
"({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, error, }: ",
|
|
"VisualizationContainerProps",
|
|
") => JSX.Element"
|
|
],
|
|
"path": "src/plugins/visualizations/public/components/visualization_container.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationContainer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n error,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"VisualizationContainerProps"
|
|
],
|
|
"path": "src/plugins/visualizations/public/components/visualization_container.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DateHistogramParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.date",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "date",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.interval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.intervalESValue",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "intervalESValue",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.intervalESUnit",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "intervalESUnit",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.DateHistogramParams.bounds",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "bounds",
|
|
"description": [],
|
|
"signature": [
|
|
"{ min: React.ReactText; max: React.ReactText; } | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.FakeParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FakeParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.FakeParams.defaultValue",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultValue",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.HistogramParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HistogramParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.HistogramParams.interval",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "interval",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISavedVis",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.visState",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SavedVisState",
|
|
"text": "SavedVisState"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.searchSourceFields",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSourceFields",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.uiStateJSON",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uiStateJSON",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.savedSearchRefName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedSearchRefName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISavedVis.savedSearchId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedSearchId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISchemas",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISchemas",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISchemas.AggGroupNames.Buckets",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[AggGroupNames.Buckets]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Schema",
|
|
"text": "Schema"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISchemas.AggGroupNames.Metrics",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "[AggGroupNames.Metrics]",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Schema",
|
|
"text": "Schema"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ISchemas.all",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "all",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Schema",
|
|
"text": "Schema"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Schema",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.aggFilter",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aggFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.group",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [],
|
|
"signature": [
|
|
"\"none\" | \"buckets\" | \"metrics\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.max",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "max",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.min",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "min",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.params",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggParam",
|
|
"text": "AggParam"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.defaults",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "defaults",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.hideCustomLabel",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hideCustomLabel",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.mustBeFirst",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mustBeFirst",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.aggSettings",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "aggSettings",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.disabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "disabled",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Schema.tooltip",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "tooltip",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SchemaConfig",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig.accessor",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "accessor",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig.label",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "label",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig.format",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"SchemaConfigParams"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SchemaConfig.aggType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aggType",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_schemas.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SerializedVis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<T>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.uiState",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "uiState",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVis.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVisData",
|
|
"text": "SerializedVisData"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVisData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SerializedVisData",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVisData.expression",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "expression",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVisData.aggs",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableRecord",
|
|
" | undefined; schema?: string | undefined; }[]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVisData.searchSource",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSourceFields",
|
|
"text": "SearchSourceFields"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SerializedVisData.savedSearchId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedSearchId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisData",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData.ast",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ast",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData.aggs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData.indexPattern",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData.searchSource",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "searchSource",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.SearchSource",
|
|
"text": "SearchSource"
|
|
},
|
|
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisData.savedSearchId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedSearchId",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisEditorOptionsProps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisEditorOptionsProps",
|
|
"text": "VisEditorOptionsProps"
|
|
},
|
|
"<VisParamType>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.aggs",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "aggs",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-common.AggConfigs",
|
|
"text": "AggConfigs"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.hasHistogramAgg",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hasHistogramAgg",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.isTabSelected",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isTabSelected",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.stateParams",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "stateParams",
|
|
"description": [],
|
|
"signature": [
|
|
"VisParamType"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.vis",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.uiState",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.PersistedState",
|
|
"text": "PersistedState"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setValue",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setValue",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends keyof VisParamType>(paramName: T, value: VisParamType[T]) => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setValue.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "paramName",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setValue.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"VisParamType[T]"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setValidity",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setValidity",
|
|
"description": [],
|
|
"signature": [
|
|
"(isValid: boolean) => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setValidity.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isValid",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setTouched",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setTouched",
|
|
"description": [],
|
|
"signature": [
|
|
"(isTouched: boolean) => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisEditorOptionsProps.setTouched.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isTouched",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisParams.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisSavedObject",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisSavedObject",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisSavedObject",
|
|
"text": "VisSavedObject"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObject",
|
|
"text": "SavedObject"
|
|
},
|
|
",",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.ISavedVis",
|
|
"text": "ISavedVis"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAstParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisToExpressionAstParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAstParams.timefilter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timefilter",
|
|
"description": [],
|
|
"signature": [
|
|
"{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ",
|
|
"Observable",
|
|
"<boolean>; getTimeUpdate$: () => ",
|
|
"Observable",
|
|
"<unknown>; getRefreshIntervalUpdate$: () => ",
|
|
"Observable",
|
|
"<unknown>; getAutoRefreshFetch$: () => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-public.AutoRefreshDoneFn",
|
|
"text": "AutoRefreshDoneFn"
|
|
},
|
|
">; getFetch$: () => ",
|
|
"Observable",
|
|
"<unknown>; getTime: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; getAbsoluteTime: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; setTime: (time: ",
|
|
"InputTimeRange",
|
|
") => void; getRefreshInterval: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
"; setRefreshInterval: (refreshInterval: Partial<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
">) => void; createFilter: (indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
},
|
|
", timeRange?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => ",
|
|
"RangeFilter",
|
|
" | ",
|
|
"ScriptedRangeFilter",
|
|
" | ",
|
|
"MatchAllRangeFilter",
|
|
" | undefined; createRelativeFilter: (indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
},
|
|
", timeRange?: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => ",
|
|
"RangeFilter",
|
|
" | ",
|
|
"ScriptedRangeFilter",
|
|
" | ",
|
|
"MatchAllRangeFilter",
|
|
" | undefined; getBounds: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
"; calculateBounds: (timeRange: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
"; getActiveBounds: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRangeBounds",
|
|
"text": "TimeRangeBounds"
|
|
},
|
|
" | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
"; getRefreshIntervalDefaults: () => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.RefreshInterval",
|
|
"text": "RefreshInterval"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAstParams.timeRange",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAstParams.abortSignal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "abortSignal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisTypeAlias",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.aliasPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aliasPath",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.aliasApp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "aliasApp",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.icon",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.promotion",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "promotion",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.note",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "note",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.getSupportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSupportedTriggers",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => string[]) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.stage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "stage",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"production\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeAlias.appExtensions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "appExtensions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [appName: string]: unknown; visualizations: ",
|
|
"VisualizationsAppExtension",
|
|
"; } | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisTypeDefinition",
|
|
"description": [
|
|
"\nA visualization type definition representing a spec of one specific type of \"classical\"\nvisualizations (i.e. not Lens visualizations)."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisTypeDefinition",
|
|
"text": "VisTypeDefinition"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nVisualization unique name"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nIt is the displayed text on the wizard and the vis listing"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nIf given, it will be diplayed on the wizard vis card as the main description."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.note",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "note",
|
|
"description": [
|
|
"\nIf given, it will be diplayed on the wizard vis card as a note in italic."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getSupportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSupportedTriggers",
|
|
"description": [
|
|
"\nIf given, it will return the supported triggers for this vis."
|
|
],
|
|
"signature": [
|
|
"((params?: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
" | undefined) => string[]) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getSupportedTriggers.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getUsedIndexPattern",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUsedIndexPattern",
|
|
"description": [
|
|
"\nSome visualizations are created without SearchSource and may change the used indexes during the visualization configuration.\nUsing this method we can rewrite the standard mechanism for getting used indexes"
|
|
],
|
|
"signature": [
|
|
"((visParams: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[] | Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataDataViewsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"[]>) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getUsedIndexPattern.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.isAccessible",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isAccessible",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.icon",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [
|
|
"\nIt is the visualization icon, displayed on the wizard."
|
|
],
|
|
"signature": [
|
|
"string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.image",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "image",
|
|
"description": [
|
|
"\nExcept from an icon, an image can be passed"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.stage",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"default"
|
|
],
|
|
"label": "stage",
|
|
"description": [
|
|
"\nDescribes the visualization stage"
|
|
],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"production\" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.group",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"default"
|
|
],
|
|
"label": "group",
|
|
"description": [
|
|
"\nDescribes the experience group that the visualization belongs.\nIt can be on tools, aggregation based or promoted group."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisGroups",
|
|
"text": "VisGroups"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.titleInWizard",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "titleInWizard",
|
|
"description": [
|
|
"\nIf given, it will be displayed on the wizard instead of the title.\nWe use it because we want to differentiate the vis title from the\nway it is presented on the wizard"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.requiresSearch",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requiresSearch",
|
|
"description": [
|
|
"\nThe flag is necessary for aggregation based visualizations.\nWhen \"true\", an additional step on the vis creation wizard will be provided\nwith the selection of a search source - an index pattern or a saved search."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.hierarchicalData",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hierarchicalData",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | ((vis: { params: TVisParams; }) => boolean) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.inspectorAdapters",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "inspectorAdapters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
" | (() => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
") | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getInfoMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInfoMessage",
|
|
"description": [
|
|
"\nWhen specified this visualization is deprecated. This function\nshould return a ReactElement that will render a deprecation warning.\nIt will be shown in the editor when editing/creating visualizations\nof this type."
|
|
],
|
|
"signature": [
|
|
"((vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">) => React.ReactNode) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.getInfoMessage.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.toExpressionAst",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "toExpressionAst",
|
|
"description": [
|
|
"\nShould be provided to expand base visualization expression with\ncustom exprsesion chain, including render expression.\nExplicit renderer should be registered in expressions plugin to render your visualization."
|
|
],
|
|
"signature": [
|
|
"(vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>, params: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
" | Promise<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.toExpressionAst.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.toExpressionAst.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"((vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>) => Promise<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>>) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.hidden",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "hidden",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<",
|
|
"VisTypeOptions",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.editorConfig",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "editorConfig",
|
|
"description": [
|
|
"\nConfig for the default editor.\nCustom editor can be specified."
|
|
],
|
|
"signature": [
|
|
"DefaultEditorConfig<TVisParams> | CustomEditorConfig"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisTypeDefinition.visConfig",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visConfig",
|
|
"description": [
|
|
"\nHave the \"defaults\" prop with default params for a visualization.\nTODO: ideally should have next type: { defaults: TVisParams } , but currently\nhave incosistencies in legacy visLib visualizations"
|
|
],
|
|
"signature": [
|
|
"{ [x: string]: any; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizationListItem",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.editUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "editUrl",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.editApp",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "editApp",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.error",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.icon",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.stage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "stage",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"production\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.savedObjectType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "savedObjectType",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.getSupportedTriggers",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSupportedTriggers",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => string[]) | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.typeTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "typeTitle",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.image",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "image",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationListItem.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizeInput",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.vis",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
"{ colors?: { [key: string]: string; } | undefined; } | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.savedVis",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedVis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.table",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "table",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"Query",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.filters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "filters",
|
|
"description": [],
|
|
"signature": [
|
|
"Filter",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeInput.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisGroups",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "VisGroups",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_groups_enum.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.Dimension",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Dimension",
|
|
"description": [],
|
|
"signature": [
|
|
"[(",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionValueBoxed",
|
|
"text": "ExpressionValueBoxed"
|
|
},
|
|
"<\"vis_dimension\", { accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: { id?: string | undefined; params: Record<string, any>; }; }> | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionValueBoxed",
|
|
"text": "ExpressionValueBoxed"
|
|
},
|
|
"<\"xy_dimension\", { label: string; aggType: string; params: {} | ",
|
|
"DateHistogramParams",
|
|
" | ",
|
|
"HistogramParams",
|
|
" | ",
|
|
"FakeParams",
|
|
"; accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>; }>)[] | undefined, string]"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ExpressionValueVisDimension",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExpressionValueVisDimension",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"vis_dimension\"; } & { accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: { id?: string | undefined; params: Record<string, any>; }; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.ExpressionValueXYDimension",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExpressionValueXYDimension",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"xy_dimension\"; } & { label: string; aggType: string; params: {} | ",
|
|
"DateHistogramParams",
|
|
" | ",
|
|
"HistogramParams",
|
|
" | ",
|
|
"FakeParams",
|
|
"; accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/xy_dimension.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.SavedVisState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedVisState",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title: string; type: string; params: TVisParams; aggs: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableRecord",
|
|
" | undefined; schema?: string | undefined; }[]; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAst",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VisToExpressionAst",
|
|
"description": [],
|
|
"signature": [
|
|
"(vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>, params: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
" | Promise<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionAstExpression",
|
|
"text": "ExpressionAstExpression"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAst.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<TVisParams>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisToExpressionAst.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisToExpressionAstParams",
|
|
"text": "VisToExpressionAstParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationStage",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VisualizationStage",
|
|
"description": [],
|
|
"signature": [
|
|
"\"experimental\" | \"beta\" | \"production\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VISUALIZE_EMBEDDABLE_TYPE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VISUALIZE_EMBEDDABLE_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"visualization\""
|
|
],
|
|
"path": "src/plugins/visualizations/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VISUALIZE_ENABLE_LABS_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VISUALIZE_ENABLE_LABS_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"visualize:enableLabs\""
|
|
],
|
|
"path": "src/plugins/visualizations/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeEmbeddableContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VisualizeEmbeddableContract",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly type: \"visualization\"; readonly id: string; getDescription: () => string; destroy: () => void; readonly parent?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined; render: (domNode: HTMLElement) => Promise<void>; getInspectorAdapters: () => ",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
" | undefined; openInspector: () => ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.OverlayRef",
|
|
"text": "OverlayRef"
|
|
},
|
|
" | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerRender: () => void; onContainerError: (error: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "public",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-public.ExpressionRenderError",
|
|
"text": "ExpressionRenderError"
|
|
},
|
|
") => void; reload: () => Promise<void>; supportedTriggers: () => string[]; inputIsRefType: (input: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
") => input is ",
|
|
"VisualizeByReferenceInput",
|
|
"; getInputAsValueType: () => Promise<",
|
|
"VisualizeByValueInput",
|
|
">; getInputAsRefType: () => Promise<",
|
|
"VisualizeByReferenceInput",
|
|
">; readonly runtimeId: number; readonly isContainer: boolean; readonly deferEmbeddableLoad: boolean; fatalError?: Error | undefined; getIsContainer: () => this is ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
">; getUpdated$: () => Readonly<",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
" | ",
|
|
"VisualizeOutput",
|
|
">>; getInput$: () => Readonly<",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
">>; getOutput$: () => Readonly<",
|
|
"Observable",
|
|
"<",
|
|
"VisualizeOutput",
|
|
">>; getOutput: () => Readonly<",
|
|
"VisualizeOutput",
|
|
">; getInput: () => Readonly<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
">; getTitle: () => string; getRoot: () => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IEmbeddable",
|
|
"text": "IEmbeddable"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableInput",
|
|
"text": "EmbeddableInput"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.EmbeddableOutput",
|
|
"text": "EmbeddableOutput"
|
|
},
|
|
"> | ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
">; updateInput: (changes: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
">) => void; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizeEmbeddableFactoryContract",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VisualizeEmbeddableFactoryContract",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly type: \"visualization\"; inject: (_state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
", references: ",
|
|
"SavedObjectReference",
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
"; extract: (_state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
") => { state: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "common",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-common.EmbeddableStateWithType",
|
|
"text": "EmbeddableStateWithType"
|
|
},
|
|
"; references: ",
|
|
"SavedObjectReference",
|
|
"[]; }; create: (input: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
" & { savedVis?: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
"> | undefined; }, parent?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | ",
|
|
"VisualizeEmbeddable",
|
|
" | ",
|
|
"DisabledLabEmbeddable",
|
|
" | undefined>; isEditable: () => Promise<boolean>; getDisplayName: () => string; createFromSavedObject: (savedObjectId: string, input: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
"> & { id: string; }, parent?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | ",
|
|
"VisualizeEmbeddable",
|
|
" | ",
|
|
"DisabledLabEmbeddable",
|
|
">; readonly savedObjectMetaData: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectMetaData",
|
|
"text": "SavedObjectMetaData"
|
|
},
|
|
"<VisualizationAttributes>; getCurrentAppId: () => Promise<string | undefined>; checkTitle: (props: ",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.OnSaveProps",
|
|
"text": "OnSaveProps"
|
|
},
|
|
") => Promise<true>; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VIS_EVENT_TO_TRIGGER",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "VIS_EVENT_TO_TRIGGER",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/public/embeddable/events.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VIS_EVENT_TO_TRIGGER.applyFilter",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "applyFilter",
|
|
"description": [],
|
|
"signature": [
|
|
"\"FILTER_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/events.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VIS_EVENT_TO_TRIGGER.brush",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "brush",
|
|
"description": [],
|
|
"signature": [
|
|
"\"SELECT_RANGE_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/events.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VIS_EVENT_TO_TRIGGER.filter",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "filter",
|
|
"description": [],
|
|
"signature": [
|
|
"\"VALUE_CLICK_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/events.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VIS_EVENT_TO_TRIGGER.tableRowContextMenuClick",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "tableRowContextMenuClick",
|
|
"description": [],
|
|
"signature": [
|
|
"\"ROW_CLICK_TRIGGER\""
|
|
],
|
|
"path": "src/plugins/visualizations/public/embeddable/events.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"setup": {
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "VisualizationsSetup",
|
|
"description": [
|
|
"\nInterface for this plugin's returned setup/start contracts.\n"
|
|
],
|
|
"signature": [
|
|
"{ createBaseVisualization: <TVisParams>(config: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisTypeDefinition",
|
|
"text": "VisTypeDefinition"
|
|
},
|
|
"<TVisParams>) => void; registerAlias: (newVisTypeAlias: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisTypeAlias",
|
|
"text": "VisTypeAlias"
|
|
},
|
|
") => void; hideTypes: (typeNames: string[]) => void; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizationsStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizationsStart",
|
|
"text": "VisualizationsStart"
|
|
},
|
|
" extends { get: <TVisParams>(visualization: string) => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<TVisParams> | undefined; all: () => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">[]; getAliases: () => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisTypeAlias",
|
|
"text": "VisTypeAlias"
|
|
},
|
|
"[]; unRegisterAlias: (visTypeAliasName: string) => void; getByGroup: (group: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisGroups",
|
|
"text": "VisGroups"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.BaseVisType",
|
|
"text": "BaseVisType"
|
|
},
|
|
"<any>[]; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.savedVisualizationsLoader",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "savedVisualizationsLoader",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoader",
|
|
"text": "SavedObjectLoader"
|
|
},
|
|
" & { findListItems: (search: string, sizeOrOptions?: number | ",
|
|
"FindListItemsOptions",
|
|
" | undefined) => any; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.createVis",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createVis",
|
|
"description": [],
|
|
"signature": [
|
|
"(visType: string, visState: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">) => Promise<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">>"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.createVis.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "visType",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.createVis.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "visState",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.convertToSerializedVis",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "convertToSerializedVis",
|
|
"description": [],
|
|
"signature": [
|
|
"(savedVis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.ISavedVis",
|
|
"text": "ISavedVis"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.convertToSerializedVis.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedVis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.ISavedVis",
|
|
"text": "ISavedVis"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.convertFromSerializedVis",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "convertFromSerializedVis",
|
|
"description": [],
|
|
"signature": [
|
|
"(vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">) => ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.ISavedVis",
|
|
"text": "ISavedVis"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.convertFromSerializedVis.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "vis",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.SerializedVis",
|
|
"text": "SerializedVis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.showNewVisModal",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "showNewVisModal",
|
|
"description": [],
|
|
"signature": [
|
|
"({ editorParams, onClose, originatingApp, outsideVisualizeApp, showAggsSelection, selectedVisType, }?: ",
|
|
"ShowNewVisModalParams",
|
|
") => () => void"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.showNewVisModal.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__0",
|
|
"description": [],
|
|
"signature": [
|
|
"ShowNewVisModalParams"
|
|
],
|
|
"path": "src/plugins/visualizations/public/wizard/show_new_vis.tsx",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-public.VisualizationsStart.__LEGACY",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__LEGACY",
|
|
"description": [],
|
|
"signature": [
|
|
"{ createVisEmbeddableFromObject: (vis: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.Vis",
|
|
"text": "Vis"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisParams",
|
|
"text": "VisParams"
|
|
},
|
|
">, input: Partial<",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "public",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-public.VisualizeInput",
|
|
"text": "VisualizeInput"
|
|
},
|
|
"> & { id: string; }, savedVisualizationsLoader?: (",
|
|
{
|
|
"pluginId": "savedObjects",
|
|
"scope": "public",
|
|
"docId": "kibSavedObjectsPluginApi",
|
|
"section": "def-public.SavedObjectLoader",
|
|
"text": "SavedObjectLoader"
|
|
},
|
|
" & { findListItems: (search: string, sizeOrOptions?: number | ",
|
|
"FindListItemsOptions",
|
|
" | undefined) => any; }) | undefined, attributeService?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.AttributeService",
|
|
"text": "AttributeService"
|
|
},
|
|
"<",
|
|
"VisualizeSavedObjectAttributes",
|
|
", ",
|
|
"VisualizeByValueInput",
|
|
", ",
|
|
"VisualizeByReferenceInput",
|
|
"> | undefined, parent?: ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.IContainer",
|
|
"text": "IContainer"
|
|
},
|
|
"<{}, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerInput",
|
|
"text": "ContainerInput"
|
|
},
|
|
"<{}>, ",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ContainerOutput",
|
|
"text": "ContainerOutput"
|
|
},
|
|
"> | undefined) => Promise<",
|
|
{
|
|
"pluginId": "embeddable",
|
|
"scope": "public",
|
|
"docId": "kibEmbeddablePluginApi",
|
|
"section": "def-public.ErrorEmbeddable",
|
|
"text": "ErrorEmbeddable"
|
|
},
|
|
" | ",
|
|
"VisualizeEmbeddable",
|
|
" | ",
|
|
"DisabledLabEmbeddable",
|
|
">; }"
|
|
],
|
|
"path": "src/plugins/visualizations/public/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-server.VISUALIZE_ENABLE_LABS_SETTING",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "VISUALIZE_ENABLE_LABS_SETTING",
|
|
"description": [],
|
|
"signature": [
|
|
"\"visualize:enableLabs\""
|
|
],
|
|
"path": "src/plugins/visualizations/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-server.VisualizationsPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizationsPluginSetup",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-server.VisualizationsPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizationsPluginStart",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.prepareLogTable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prepareLogTable",
|
|
"description": [],
|
|
"signature": [
|
|
"(datatable: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
", dimensions: ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.Dimension",
|
|
"text": "Dimension"
|
|
},
|
|
"[]) => { columns: { meta: { dimensionName: string | undefined; type: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumnType",
|
|
"text": "DatatableColumnType"
|
|
},
|
|
"; field?: string | undefined; index?: string | undefined; params?: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>> | undefined; source?: string | undefined; sourceParams?: ",
|
|
"SerializableRecord",
|
|
" | undefined; }; id: string; name: string; }[]; type: \"datatable\"; rows: Record<string, any>[]; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.prepareLogTable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "datatable",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
}
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.prepareLogTable.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "dimensions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.Dimension",
|
|
"text": "Dimension"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.range",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "range",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionFunctionDefinition",
|
|
"text": "ExpressionFunctionDefinition"
|
|
},
|
|
"<\"range\", ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
" | null, Arguments, ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Range",
|
|
"text": "Range"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExecutionContext",
|
|
"text": "ExecutionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
", ",
|
|
"SerializableRecord",
|
|
">>"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/range.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.visDimension",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "visDimension",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionFunctionDefinition",
|
|
"text": "ExpressionFunctionDefinition"
|
|
},
|
|
"<\"visdimension\", ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.Datatable",
|
|
"text": "Datatable"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.Arguments",
|
|
"text": "Arguments"
|
|
},
|
|
", ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionValueBoxed",
|
|
"text": "ExpressionValueBoxed"
|
|
},
|
|
"<\"vis_dimension\", { accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: { id?: string | undefined; params: Record<string, any>; }; }>, ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExecutionContext",
|
|
"text": "ExecutionContext"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "inspector",
|
|
"scope": "common",
|
|
"docId": "kibInspectorPluginApi",
|
|
"section": "def-common.Adapters",
|
|
"text": "Adapters"
|
|
},
|
|
", ",
|
|
"SerializableRecord",
|
|
">>"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.Arguments",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Arguments",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.Arguments.accessor",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "accessor",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.Arguments.format",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "format",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.Arguments.formatParams",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "formatParams",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisParams",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisParams.Unnamed",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "Unnamed",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "VisualizationSavedObjectAttributes",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "visualizations",
|
|
"scope": "common",
|
|
"docId": "kibVisualizationsPluginApi",
|
|
"section": "def-common.VisualizationSavedObjectAttributes",
|
|
"text": "VisualizationSavedObjectAttributes"
|
|
},
|
|
" extends ",
|
|
"SavedObjectAttributes"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.kibanaSavedObjectMeta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "kibanaSavedObjectMeta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ searchSourceJSON: string; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.version",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "version",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.visState",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "visState",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.VisualizationSavedObjectAttributes.uiStateJSON",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uiStateJSON",
|
|
"description": [],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.Dimension",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Dimension",
|
|
"description": [],
|
|
"signature": [
|
|
"[(",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionValueBoxed",
|
|
"text": "ExpressionValueBoxed"
|
|
},
|
|
"<\"vis_dimension\", { accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: { id?: string | undefined; params: Record<string, any>; }; }> | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.ExpressionValueBoxed",
|
|
"text": "ExpressionValueBoxed"
|
|
},
|
|
"<\"xy_dimension\", { label: string; aggType: string; params: {} | ",
|
|
"DateHistogramParams",
|
|
" | ",
|
|
"HistogramParams",
|
|
" | ",
|
|
"FakeParams",
|
|
"; accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<Record<string, any>>; }>)[] | undefined, string]"
|
|
],
|
|
"path": "src/plugins/visualizations/common/prepare_log_table.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.ExpressionValueVisDimension",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ExpressionValueVisDimension",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: \"vis_dimension\"; } & { accessor: number | ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"; format: { id?: string | undefined; params: Record<string, any>; }; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/expression_functions/vis_dimension.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "visualizations",
|
|
"id": "def-common.SavedVisState",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SavedVisState",
|
|
"description": [],
|
|
"signature": [
|
|
"{ title: string; type: string; params: TVisParams; aggs: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",
|
|
"SerializableRecord",
|
|
" | undefined; schema?: string | undefined; }[]; }"
|
|
],
|
|
"path": "src/plugins/visualizations/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |