{ "id": "visualizations", "client": { "classes": [ { "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" ], "children": [ { "id": "def-public.PersistedState.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Any", "label": "value", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 40 } }, { "type": "CompoundType", "label": "path", "isRequired": false, "signature": [ "string | string[] | undefined" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 40 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 40 } }, { "id": "def-public.PersistedState.get", "type": "Function", "label": "get", "signature": [ "(key?: string | string[] | undefined, defaultValue?: any) => any" ], "description": [], "children": [ { "type": "CompoundType", "label": "key", "isRequired": false, "signature": [ "string | string[] | undefined" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 57 } }, { "type": "Any", "label": "defaultValue", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 57 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 57 } }, { "id": "def-public.PersistedState.set", "type": "Function", "label": "set", "signature": [ "(key: any, value?: any) => this" ], "description": [], "children": [ { "type": "Any", "label": "key", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 66 } }, { "type": "Any", "label": "value", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 66 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 66 } }, { "id": "def-public.PersistedState.setSilent", "type": "Function", "label": "setSilent", "signature": [ "(key: any, value?: any) => this | undefined" ], "description": [], "children": [ { "type": "Any", "label": "key", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 74 } }, { "type": "Any", "label": "value", "isRequired": true, "signature": [ "any" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 74 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 74 } }, { "id": "def-public.PersistedState.clearAllKeys", "type": "Function", "label": "clearAllKeys", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 82 } }, { "id": "def-public.PersistedState.reset", "type": "Function", "label": "reset", "signature": [ "(path: string | string[]) => void" ], "description": [], "children": [ { "type": "CompoundType", "label": "path", "isRequired": true, "signature": [ "string | string[]" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 88 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 88 } }, { "id": "def-public.PersistedState.getChanges", "type": "Function", "label": "getChanges", "signature": [ "() => any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 105 } }, { "id": "def-public.PersistedState.toJSON", "type": "Function", "label": "toJSON", "signature": [ "() => any" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 109 } }, { "id": "def-public.PersistedState.toString", "type": "Function", "label": "toString", "signature": [ "() => string" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 113 } }, { "id": "def-public.PersistedState.fromString", "type": "Function", "label": "fromString", "signature": [ "(input: string) => this" ], "description": [], "children": [ { "type": "string", "label": "input", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 117 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 117 } } ], "source": { "path": "src/plugins/visualizations/public/persisted_state/persisted_state.ts", "lineNumber": 32 }, "initialIsOpen": false }, { "id": "def-public.Vis", "type": "Class", "tags": [], "label": "Vis", "description": [], "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, "" ], "children": [ { "tags": [], "id": "def-public.Vis.type", "type": "Object", "label": "type", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 74 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.BaseVisType", "text": "BaseVisType" }, "" ] }, { "tags": [], "id": "def-public.Vis.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 75 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.Vis.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 76 } }, { "tags": [], "id": "def-public.Vis.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 77 } }, { "tags": [], "id": "def-public.Vis.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 78 }, "signature": [ "TVisParams" ] }, { "id": "def-public.Vis.data", "type": "Object", "tags": [], "children": [], "description": [], "label": "data", "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 79 } }, { "tags": [], "id": "def-public.Vis.uiState", "type": "Object", "label": "uiState", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 81 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.PersistedState", "text": "PersistedState" } ] }, { "id": "def-public.Vis.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "visType", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 83 } }, { "type": "Object", "label": "visState", "isRequired": true, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.SerializedVis", "text": "SerializedVis" }, "" ], "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 83 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 83 } }, { "id": "def-public.Vis.setState", "type": "Function", "label": "setState", "signature": [ "(state: Pick, \"type\" | \"description\" | \"title\" | \"id\" | \"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\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\">) => Promise" ], "description": [], "children": [ { "type": "Object", "label": "state", "isRequired": true, "signature": [ "Pick, \"type\" | \"description\" | \"title\" | \"id\" | \"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\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\">" ], "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 108 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 108 } }, { "id": "def-public.Vis.clone", "type": "Function", "label": "clone", "signature": [ "() => ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, "" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 157 } }, { "id": "def-public.Vis.serialize", "type": "Function", "label": "serialize", "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" }, ">" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 171 } }, { "id": "def-public.Vis.isHierarchical", "type": "Function", "label": "isHierarchical", "signature": [ "() => boolean" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 189 } } ], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 73 }, "initialIsOpen": false } ], "functions": [ { "id": "def-public.getVisSchemas", "type": "Function", "children": [ { "type": "Object", "label": "vis", "isRequired": true, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, "" ], "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 45 } }, { "type": "Object", "label": "{ timeRange, timefilter }", "isRequired": true, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisToExpressionAstParams", "text": "VisToExpressionAstParams" } ], "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 46 } } ], "signature": [ "(vis: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, ", { timeRange, timefilter }: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisToExpressionAstParams", "text": "VisToExpressionAstParams" }, ") => ", "Schemas" ], "description": [], "label": "getVisSchemas", "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 44 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.updateOldState", "type": "Function", "label": "updateOldState", "signature": [ "(oldState: unknown) => ", { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.SavedVisState", "text": "SavedVisState" }, "<", { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.VisParams", "text": "VisParams" }, ">" ], "description": [], "children": [ { "type": "Unknown", "label": "oldState", "isRequired": true, "signature": [ "unknown" ], "description": [], "source": { "path": "src/plugins/visualizations/public/legacy/vis_update_state.d.ts", "lineNumber": 11 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/legacy/vis_update_state.d.ts", "lineNumber": 11 }, "initialIsOpen": false }, { "id": "def-public.VisualizationContainer", "type": "Function", "children": [ { "type": "Object", "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n}", "isRequired": true, "signature": [ "VisualizationContainerProps" ], "description": [], "source": { "path": "src/plugins/visualizations/public/components/visualization_container.tsx", "lineNumber": 23 } } ], "signature": [ "({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, }: VisualizationContainerProps) => JSX.Element" ], "description": [], "label": "VisualizationContainer", "source": { "path": "src/plugins/visualizations/public/components/visualization_container.tsx", "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.ISavedVis", "type": "Interface", "label": "ISavedVis", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ISavedVis.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 31 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.ISavedVis.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 32 } }, { "tags": [], "id": "def-public.ISavedVis.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 33 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.ISavedVis.visState", "type": "Object", "label": "visState", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 34 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.SavedVisState", "text": "SavedVisState" } ] }, { "tags": [], "id": "def-public.ISavedVis.searchSourceFields", "type": "Object", "label": "searchSourceFields", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 35 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" }, " | undefined" ] }, { "tags": [], "id": "def-public.ISavedVis.uiStateJSON", "type": "string", "label": "uiStateJSON", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 36 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.ISavedVis.savedSearchRefName", "type": "string", "label": "savedSearchRefName", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 37 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.ISavedVis.savedSearchId", "type": "string", "label": "savedSearchId", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 38 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 30 }, "initialIsOpen": false }, { "id": "def-public.ISchemas", "type": "Interface", "label": "ISchemas", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ISchemas.[AggGroupNames.Buckets]", "type": "Array", "label": "[AggGroupNames.Buckets]", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 30 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Schema", "text": "Schema" }, "[]" ] }, { "tags": [], "id": "def-public.ISchemas.[AggGroupNames.Metrics]", "type": "Array", "label": "[AggGroupNames.Metrics]", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 31 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Schema", "text": "Schema" }, "[]" ] }, { "tags": [], "id": "def-public.ISchemas.all", "type": "Array", "label": "all", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 32 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Schema", "text": "Schema" }, "[]" ] } ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 29 }, "initialIsOpen": false }, { "id": "def-public.SavedVisState", "type": "Interface", "label": "SavedVisState", "signature": [ { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.SavedVisState", "text": "SavedVisState" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SavedVisState.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-public.SavedVisState.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-public.SavedVisState.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 19 }, "signature": [ "TVisParams" ] }, { "tags": [], "id": "def-public.SavedVisState.aggs", "type": "Array", "label": "aggs", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 20 }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ] } ], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 16 }, "initialIsOpen": false }, { "id": "def-public.Schema", "type": "Interface", "label": "Schema", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.Schema.aggFilter", "type": "Array", "label": "aggFilter", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 36 }, "signature": [ "string[]" ] }, { "tags": [], "id": "def-public.Schema.group", "type": "CompoundType", "label": "group", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 37 }, "signature": [ "node_modules/utility-types/dist/utility-types", "$Values>" ] }, { "tags": [], "id": "def-public.Schema.max", "type": "number", "label": "max", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 38 } }, { "tags": [], "id": "def-public.Schema.min", "type": "number", "label": "min", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 39 } }, { "tags": [], "id": "def-public.Schema.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 40 } }, { "tags": [], "id": "def-public.Schema.params", "type": "Array", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 41 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggParam", "text": "AggParam" }, "[]" ] }, { "tags": [], "id": "def-public.Schema.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 42 } }, { "tags": [], "id": "def-public.Schema.defaults", "type": "Unknown", "label": "defaults", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 43 }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-public.Schema.hideCustomLabel", "type": "CompoundType", "label": "hideCustomLabel", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 44 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.Schema.mustBeFirst", "type": "CompoundType", "label": "mustBeFirst", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 45 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.Schema.aggSettings", "type": "Any", "label": "aggSettings", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 46 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.Schema.disabled", "type": "CompoundType", "label": "disabled", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 47 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.Schema.tooltip", "type": "CompoundType", "label": "tooltip", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 48 }, "signature": [ "React.ReactNode" ] } ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 35 }, "initialIsOpen": false }, { "id": "def-public.SchemaConfig", "type": "Interface", "label": "SchemaConfig", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SchemaConfig.accessor", "type": "number", "label": "accessor", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 22 } }, { "tags": [], "id": "def-public.SchemaConfig.label", "type": "string", "label": "label", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 23 } }, { "tags": [], "id": "def-public.SchemaConfig.format", "type": "Object", "label": "format", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 24 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedFieldFormat", "text": "SerializedFieldFormat" }, ">" ] }, { "tags": [], "id": "def-public.SchemaConfig.params", "type": "Object", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 25 }, "signature": [ "SchemaConfigParams" ] }, { "tags": [], "id": "def-public.SchemaConfig.aggType", "type": "string", "label": "aggType", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 26 } } ], "source": { "path": "src/plugins/visualizations/public/vis_schemas.ts", "lineNumber": 21 }, "initialIsOpen": false }, { "id": "def-public.SerializedVis", "type": "Interface", "label": "SerializedVis", "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.SerializedVis", "text": "SerializedVis" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SerializedVis.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 43 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SerializedVis.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 44 } }, { "tags": [], "id": "def-public.SerializedVis.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 45 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SerializedVis.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 46 } }, { "tags": [], "id": "def-public.SerializedVis.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 47 }, "signature": [ "T" ] }, { "tags": [], "id": "def-public.SerializedVis.uiState", "type": "Any", "label": "uiState", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 48 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.SerializedVis.data", "type": "Object", "label": "data", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 49 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.SerializedVisData", "text": "SerializedVisData" } ] } ], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 42 }, "initialIsOpen": false }, { "id": "def-public.SerializedVisData", "type": "Interface", "label": "SerializedVisData", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.SerializedVisData.expression", "type": "string", "label": "expression", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 36 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.SerializedVisData.aggs", "type": "Array", "label": "aggs", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 37 }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ] }, { "tags": [], "id": "def-public.SerializedVisData.searchSource", "type": "Object", "label": "searchSource", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 38 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.SearchSourceFields", "text": "SearchSourceFields" } ] }, { "tags": [], "id": "def-public.SerializedVisData.savedSearchId", "type": "string", "label": "savedSearchId", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 39 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 35 }, "initialIsOpen": false }, { "id": "def-public.VisData", "type": "Interface", "label": "VisData", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisData.ast", "type": "string", "label": "ast", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 53 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisData.aggs", "type": "Object", "label": "aggs", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 54 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" }, " | undefined" ] }, { "tags": [], "id": "def-public.VisData.indexPattern", "type": "Object", "label": "indexPattern", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 55 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, " | undefined" ] }, { "tags": [], "id": "def-public.VisData.searchSource", "type": "Object", "label": "searchSource", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 56 }, "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" ] }, { "tags": [], "id": "def-public.VisData.savedSearchId", "type": "string", "label": "savedSearchId", "description": [], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 57 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/vis.ts", "lineNumber": 52 }, "initialIsOpen": false }, { "id": "def-public.VisEditorOptionsProps", "type": "Interface", "label": "VisEditorOptionsProps", "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisEditorOptionsProps", "text": "VisEditorOptionsProps" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisEditorOptionsProps.aggs", "type": "Object", "label": "aggs", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 55 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.AggConfigs", "text": "AggConfigs" } ] }, { "tags": [], "id": "def-public.VisEditorOptionsProps.hasHistogramAgg", "type": "boolean", "label": "hasHistogramAgg", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 56 } }, { "tags": [], "id": "def-public.VisEditorOptionsProps.isTabSelected", "type": "boolean", "label": "isTabSelected", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 57 } }, { "tags": [], "id": "def-public.VisEditorOptionsProps.stateParams", "type": "Uncategorized", "label": "stateParams", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 58 }, "signature": [ "VisParamType" ] }, { "tags": [], "id": "def-public.VisEditorOptionsProps.vis", "type": "Object", "label": "vis", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 59 }, "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" }, ">" ] }, { "tags": [], "id": "def-public.VisEditorOptionsProps.uiState", "type": "Object", "label": "uiState", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 60 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.PersistedState", "text": "PersistedState" } ] }, { "id": "def-public.VisEditorOptionsProps.setValue", "type": "Function", "label": "setValue", "signature": [ "(paramName: T, value: VisParamType[T]) => void" ], "description": [], "children": [ { "type": "Uncategorized", "label": "paramName", "isRequired": true, "signature": [ "T" ], "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 61 } }, { "type": "Uncategorized", "label": "value", "isRequired": true, "signature": [ "VisParamType[T]" ], "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 61 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 61 } }, { "id": "def-public.VisEditorOptionsProps.setValidity", "type": "Function", "label": "setValidity", "signature": [ "(isValid: boolean) => void" ], "description": [], "children": [ { "type": "boolean", "label": "isValid", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 62 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 62 } }, { "id": "def-public.VisEditorOptionsProps.setTouched", "type": "Function", "label": "setTouched", "signature": [ "(isTouched: boolean) => void" ], "description": [], "children": [ { "type": "boolean", "label": "isTouched", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 63 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 63 } } ], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 54 }, "initialIsOpen": false }, { "id": "def-public.VisParams", "type": "Interface", "label": "VisParams", "description": [], "tags": [], "children": [ { "id": "def-public.VisParams.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 13 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 12 }, "initialIsOpen": false }, { "id": "def-public.VisSavedObject", "type": "Interface", "label": "VisSavedObject", "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" } ], "description": [], "tags": [], "children": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 41 }, "initialIsOpen": false }, { "id": "def-public.VisToExpressionAstParams", "type": "Interface", "label": "VisToExpressionAstParams", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisToExpressionAstParams.timefilter", "type": "Object", "label": "timefilter", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 44 }, "signature": [ "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.Timefilter", "text": "Timefilter" }, ", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">" ] }, { "tags": [], "id": "def-public.VisToExpressionAstParams.timeRange", "type": "Any", "label": "timeRange", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 45 }, "signature": [ "any" ] }, { "tags": [], "id": "def-public.VisToExpressionAstParams.abortSignal", "type": "Object", "label": "abortSignal", "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 46 }, "signature": [ "AbortSignal | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 43 }, "initialIsOpen": false }, { "id": "def-public.VisTypeAlias", "type": "Interface", "label": "VisTypeAlias", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisTypeAlias.aliasPath", "type": "string", "label": "aliasPath", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 35 } }, { "tags": [], "id": "def-public.VisTypeAlias.aliasApp", "type": "string", "label": "aliasApp", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 36 } }, { "tags": [], "id": "def-public.VisTypeAlias.name", "type": "string", "label": "name", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 37 } }, { "tags": [], "id": "def-public.VisTypeAlias.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 38 } }, { "tags": [], "id": "def-public.VisTypeAlias.icon", "type": "string", "label": "icon", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 39 } }, { "tags": [], "id": "def-public.VisTypeAlias.promotion", "type": "CompoundType", "label": "promotion", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 40 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.VisTypeAlias.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 41 } }, { "tags": [], "id": "def-public.VisTypeAlias.note", "type": "string", "label": "note", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 42 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisTypeAlias.getSupportedTriggers", "type": "Function", "label": "getSupportedTriggers", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 43 }, "signature": [ "(() => string[]) | undefined" ] }, { "tags": [], "id": "def-public.VisTypeAlias.stage", "type": "CompoundType", "label": "stage", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 44 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisualizationStage", "text": "VisualizationStage" } ] }, { "tags": [], "id": "def-public.VisTypeAlias.appExtensions", "type": "Object", "label": "appExtensions", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 46 }, "signature": [ "{ [appName: string]: unknown; visualizations: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisualizationsAppExtension", "text": "VisualizationsAppExtension" }, "; } | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 34 }, "initialIsOpen": false }, { "id": "def-public.VisTypeDefinition", "type": "Interface", "label": "VisTypeDefinition", "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisTypeDefinition", "text": "VisTypeDefinition" }, "" ], "description": [ "\nA visualization type definition representing a spec of one specific type of \"classical\"\nvisualizations (i.e. not Lens visualizations)." ], "tags": [], "children": [ { "tags": [], "id": "def-public.VisTypeDefinition.name", "type": "string", "label": "name", "description": [ "\nVisualization unique name" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 83 } }, { "tags": [], "id": "def-public.VisTypeDefinition.title", "type": "string", "label": "title", "description": [ "\nIt is the displayed text on the wizard and the vis listing" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 87 } }, { "tags": [], "id": "def-public.VisTypeDefinition.description", "type": "string", "label": "description", "description": [ "\nIf given, it will be diplayed on the wizard vis card as the main description." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 91 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.note", "type": "string", "label": "note", "description": [ "\nIf given, it will be diplayed on the wizard vis card as a note in italic." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 95 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.getSupportedTriggers", "type": "Function", "label": "getSupportedTriggers", "description": [ "\nIf given, it will return the supported triggers for this vis." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 99 }, "signature": [ "(() => string[]) | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.getUsedIndexPattern", "type": "Function", "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" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 105 }, "signature": [ "((visParams: ", { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.VisParams", "text": "VisParams" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, "[] | Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" }, "[]>) | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.isAccessible", "type": "CompoundType", "label": "isAccessible", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 107 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.icon", "type": "CompoundType", "label": "icon", "description": [ "\nIt is the visualization icon, displayed on the wizard." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 111 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.image", "type": "string", "label": "image", "description": [ "\nExcept from an icon, an image can be passed" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 115 }, "signature": [ "string | undefined" ] }, { "tags": [ "default" ], "id": "def-public.VisTypeDefinition.stage", "type": "CompoundType", "label": "stage", "description": [ "\nDescribes the visualization stage" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 120 }, "signature": [ "\"experimental\" | \"beta\" | \"production\" | undefined" ] }, { "tags": [ "default" ], "id": "def-public.VisTypeDefinition.group", "type": "CompoundType", "label": "group", "description": [ "\nDescribes the experience group that the visualization belongs.\nIt can be on tools, aggregation based or promoted group." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 126 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisGroups", "text": "VisGroups" }, " | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.titleInWizard", "type": "string", "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" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 132 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.requiresSearch", "type": "CompoundType", "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." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 138 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.hierarchicalData", "type": "CompoundType", "label": "hierarchicalData", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 139 }, "signature": [ "boolean | ((vis: { params: TVisParams; }) => boolean) | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.inspectorAdapters", "type": "CompoundType", "label": "inspectorAdapters", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 140 }, "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" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.getInfoMessage", "type": "Function", "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." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 147 }, "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" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.toExpressionAst", "type": "Function", "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." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 153 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisToExpressionAst", "text": "VisToExpressionAst" }, "" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.setup", "type": "Function", "label": "setup", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 155 }, "signature": [ "((vis: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, ") => Promise<", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, ">) | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.hidden", "type": "CompoundType", "label": "hidden", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 156 }, "signature": [ "boolean | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.options", "type": "Object", "label": "options", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 158 }, "signature": [ "Partial<", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisTypeOptions", "text": "VisTypeOptions" }, "> | undefined" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.editorConfig", "type": "CompoundType", "label": "editorConfig", "description": [ "\nConfig for the default editor.\nCustom editor can be specified." ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 164 }, "signature": [ "DefaultEditorConfig | CustomEditorConfig" ] }, { "tags": [], "id": "def-public.VisTypeDefinition.visConfig", "type": "Object", "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" ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 170 }, "signature": [ "Record" ] } ], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 79 }, "initialIsOpen": false }, { "id": "def-public.VisualizationListItem", "type": "Interface", "label": "VisualizationListItem", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisualizationListItem.editUrl", "type": "string", "label": "editUrl", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 14 } }, { "tags": [], "id": "def-public.VisualizationListItem.editApp", "type": "string", "label": "editApp", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 15 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisualizationListItem.error", "type": "string", "label": "error", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 16 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisualizationListItem.icon", "type": "string", "label": "icon", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-public.VisualizationListItem.id", "type": "string", "label": "id", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-public.VisualizationListItem.stage", "type": "CompoundType", "label": "stage", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 19 }, "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisualizationStage", "text": "VisualizationStage" } ] }, { "tags": [], "id": "def-public.VisualizationListItem.savedObjectType", "type": "string", "label": "savedObjectType", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 20 } }, { "tags": [], "id": "def-public.VisualizationListItem.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 21 } }, { "tags": [], "id": "def-public.VisualizationListItem.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 22 }, "signature": [ "string | undefined" ] }, { "tags": [], "id": "def-public.VisualizationListItem.getSupportedTriggers", "type": "Function", "label": "getSupportedTriggers", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 23 }, "signature": [ "(() => string[]) | undefined" ] }, { "tags": [], "id": "def-public.VisualizationListItem.typeTitle", "type": "string", "label": "typeTitle", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-public.VisualizationListItem.image", "type": "string", "label": "image", "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 25 }, "signature": [ "string | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 13 }, "initialIsOpen": false }, { "id": "def-public.VisualizeInput", "type": "Interface", "label": "VisualizeInput", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisualizeInput.vis", "type": "Object", "label": "vis", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 58 }, "signature": [ "{ colors?: { [key: string]: string; } | undefined; } | undefined" ] }, { "tags": [], "id": "def-public.VisualizeInput.savedVis", "type": "Object", "label": "savedVis", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 61 }, "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" ] }, { "tags": [], "id": "def-public.VisualizeInput.table", "type": "Unknown", "label": "table", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 62 }, "signature": [ "unknown" ] }, { "tags": [], "id": "def-public.VisualizeInput.query", "type": "Object", "label": "query", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 63 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ] }, { "tags": [], "id": "def-public.VisualizeInput.filters", "type": "Array", "label": "filters", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 64 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ] }, { "tags": [], "id": "def-public.VisualizeInput.timeRange", "type": "Object", "label": "timeRange", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 65 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ] } ], "source": { "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "lineNumber": 57 }, "initialIsOpen": false } ], "enums": [ { "id": "def-public.VisGroups", "type": "Enum", "label": "VisGroups", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/types.ts", "lineNumber": 23 }, "initialIsOpen": false } ], "misc": [ { "id": "def-public.ExpressionValueVisDimension", "type": "Type", "label": "ExpressionValueVisDimension", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/expression_functions/vis_dimension.ts", "lineNumber": 23 }, "signature": [ "{ type: \"vis_dimension\"; } & { accessor: number | DatatableColumn; format: { id?: string; params: Record;}; }" ], "initialIsOpen": false }, { "id": "def-public.VisToExpressionAst", "type": "Type", "label": "VisToExpressionAst", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/types.ts", "lineNumber": 49 }, "signature": [ "(vis: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.Vis", "text": "Vis" }, ", 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" }, ">" ], "initialIsOpen": false }, { "id": "def-public.VisualizationStage", "type": "Type", "label": "VisualizationStage", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", "lineNumber": 11 }, "signature": [ "\"experimental\" | \"beta\" | \"production\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.VISUALIZE_EMBEDDABLE_TYPE", "type": "string", "label": "VISUALIZE_EMBEDDABLE_TYPE", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/constants.ts", "lineNumber": 9 }, "signature": [ "\"visualization\"" ], "initialIsOpen": false }, { "tags": [], "id": "def-public.VISUALIZE_ENABLE_LABS_SETTING", "type": "string", "label": "VISUALIZE_ENABLE_LABS_SETTING", "description": [], "source": { "path": "src/plugins/visualizations/common/constants.ts", "lineNumber": 9 }, "signature": [ "\"visualize:enableLabs\"" ], "initialIsOpen": false }, { "id": "def-public.VisualizeEmbeddableContract", "type": "Type", "label": "VisualizeEmbeddableContract", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/index.ts", "lineNumber": 31 }, "signature": [ "{ readonly type: \"visualization\"; readonly id: 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; getDescription: () => string; 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" } ], "initialIsOpen": false }, { "id": "def-public.VisualizeEmbeddableFactoryContract", "type": "Type", "label": "VisualizeEmbeddableFactoryContract", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/public/index.ts", "lineNumber": 30 }, "signature": [ "{ readonly type: \"visualization\"; 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" } ], "initialIsOpen": false } ], "objects": [ { "id": "def-public.VIS_EVENT_TO_TRIGGER", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.VIS_EVENT_TO_TRIGGER.applyFilter", "type": "string", "label": "applyFilter", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/events.ts", "lineNumber": 21 }, "signature": [ "\"FILTER_TRIGGER\"" ] }, { "tags": [], "id": "def-public.VIS_EVENT_TO_TRIGGER.brush", "type": "string", "label": "brush", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/events.ts", "lineNumber": 22 }, "signature": [ "\"SELECT_RANGE_TRIGGER\"" ] }, { "tags": [], "id": "def-public.VIS_EVENT_TO_TRIGGER.filter", "type": "string", "label": "filter", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/events.ts", "lineNumber": 23 }, "signature": [ "\"VALUE_CLICK_TRIGGER\"" ] }, { "tags": [], "id": "def-public.VIS_EVENT_TO_TRIGGER.tableRowContextMenuClick", "type": "string", "label": "tableRowContextMenuClick", "description": [], "source": { "path": "src/plugins/visualizations/public/embeddable/events.ts", "lineNumber": 24 }, "signature": [ "\"ROW_CLICK_TRIGGER\"" ] } ], "description": [], "label": "VIS_EVENT_TO_TRIGGER", "source": { "path": "src/plugins/visualizations/public/embeddable/events.ts", "lineNumber": 20 }, "initialIsOpen": false } ], "setup": { "id": "def-public.VisualizationsSetup", "type": "Type", "label": "VisualizationsSetup", "tags": [ "public" ], "description": [ "\nInterface for this plugin's returned setup/start contracts.\n" ], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 74 }, "signature": [ "{ createBaseVisualization: (config: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisTypeDefinition", "text": "VisTypeDefinition" }, ") => void; registerAlias: (newVisTypeAlias: ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisTypeAlias", "text": "VisTypeAlias" }, ") => void; hideTypes: (typeNames: string[]) => void; }" ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-public.VisualizationsStart", "type": "Interface", "label": "VisualizationsStart", "signature": [ { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.VisualizationsStart", "text": "VisualizationsStart" }, " extends { get: (visualization: string) => ", "BaseVisType", " | undefined; all: () => ", "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" } ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.VisualizationsStart.savedVisualizationsLoader", "type": "CompoundType", "label": "savedVisualizationsLoader", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 77 }, "signature": [ { "pluginId": "savedObjects", "scope": "public", "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObjectLoader", "text": "SavedObjectLoader" }, " & { findListItems: (search: string, sizeOrOptions?: number | ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.FindListItemsOptions", "text": "FindListItemsOptions" }, " | undefined) => any; }" ] }, { "tags": [], "id": "def-public.VisualizationsStart.createVis", "type": "Function", "label": "createVis", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 78 }, "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" }, ">>" ] }, { "tags": [], "id": "def-public.VisualizationsStart.convertToSerializedVis", "type": "Function", "label": "convertToSerializedVis", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 79 }, "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" }, ">" ] }, { "tags": [], "id": "def-public.VisualizationsStart.convertFromSerializedVis", "type": "Function", "label": "convertFromSerializedVis", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 80 }, "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" } ] }, { "tags": [], "id": "def-public.VisualizationsStart.showNewVisModal", "type": "Function", "label": "showNewVisModal", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 81 }, "signature": [ "typeof ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.showNewVisModal", "text": "showNewVisModal" } ] }, { "tags": [], "id": "def-public.VisualizationsStart.__LEGACY", "type": "Object", "label": "__LEGACY", "description": [], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 82 }, "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 | ", { "pluginId": "visualizations", "scope": "public", "docId": "kibVisualizationsPluginApi", "section": "def-public.FindListItemsOptions", "text": "FindListItemsOptions" } ] } ], "source": { "path": "src/plugins/visualizations/public/plugin.ts", "lineNumber": 76 }, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [ { "id": "def-common.SavedVisState", "type": "Interface", "label": "SavedVisState", "signature": [ { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.SavedVisState", "text": "SavedVisState" }, "" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.SavedVisState.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 17 } }, { "tags": [], "id": "def-common.SavedVisState.type", "type": "string", "label": "type", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 18 } }, { "tags": [], "id": "def-common.SavedVisState.params", "type": "Uncategorized", "label": "params", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 19 }, "signature": [ "TVisParams" ] }, { "tags": [], "id": "def-common.SavedVisState.aggs", "type": "Array", "label": "aggs", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 20 }, "signature": [ "Pick & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, \"type\"> & Pick<{ type: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.IAggType", "text": "IAggType" }, "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" ] } ], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 16 }, "initialIsOpen": false }, { "id": "def-common.VisParams", "type": "Interface", "label": "VisParams", "description": [], "tags": [], "children": [ { "id": "def-common.VisParams.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 13 }, "signature": [ "any" ] } ], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 12 }, "initialIsOpen": false }, { "id": "def-common.VisualizationSavedObjectAttributes", "type": "Interface", "label": "VisualizationSavedObjectAttributes", "signature": [ { "pluginId": "visualizations", "scope": "common", "docId": "kibVisualizationsPluginApi", "section": "def-common.VisualizationSavedObjectAttributes", "text": "VisualizationSavedObjectAttributes" }, " extends ", "SavedObjectAttributes" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.description", "type": "string", "label": "description", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 24 } }, { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.kibanaSavedObjectMeta", "type": "Object", "label": "kibanaSavedObjectMeta", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 25 }, "signature": [ "{ searchSourceJSON: string; }" ] }, { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.title", "type": "string", "label": "title", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 28 } }, { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.version", "type": "number", "label": "version", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 29 } }, { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.visState", "type": "string", "label": "visState", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 30 } }, { "tags": [], "id": "def-common.VisualizationSavedObjectAttributes.uiStateJSON", "type": "string", "label": "uiStateJSON", "description": [], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 31 } } ], "source": { "path": "src/plugins/visualizations/common/types.ts", "lineNumber": 23 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [] } }