github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/lens.devdocs.json

11156 lines
No EOL
393 KiB
JSON
Raw Permalink Blame History

{
"id": "lens",
"client": {
"classes": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable",
"type": "Class",
"tags": [],
"label": "Embeddable",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Embeddable",
"text": "Embeddable"
},
" extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.Embeddable",
"text": "Embeddable"
},
"<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
", ",
"LensEmbeddableOutput",
", any> implements ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ReferenceOrValueEmbeddable",
"text": "ReferenceOrValueEmbeddable"
},
"<",
"LensByValueInput",
", ",
"LensByReferenceInput",
">,",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.SelfStyledEmbeddable",
"text": "SelfStyledEmbeddable"
},
",",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.FilterableEmbeddable",
"text": "FilterableEmbeddable"
}
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.deferEmbeddableLoad",
"type": "boolean",
"tags": [],
"label": "deferEmbeddableLoad",
"description": [],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"LensEmbeddableDeps"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.Unnamed.$2",
"type": "CompoundType",
"tags": [],
"label": "initialInput",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
}
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.Unnamed.$3",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"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"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getUserMessages",
"type": "Function",
"tags": [],
"label": "getUserMessages",
"description": [],
"signature": [
"(locationId: \"banner\" | \"toolbar\" | \"embeddableBadge\" | \"visualization\" | \"visualizationOnEmbeddable\" | \"visualizationInEditor\" | \"textBasedLanguagesQueryInput\" | \"dimensionButton\" | (\"banner\" | \"toolbar\" | \"embeddableBadge\" | \"visualization\" | \"visualizationOnEmbeddable\" | \"visualizationInEditor\" | \"textBasedLanguagesQueryInput\" | \"dimensionButton\")[] | undefined, filters: ",
"UserMessageFilters",
" | undefined) => ",
"UserMessage",
"[]"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getUserMessages.$1",
"type": "CompoundType",
"tags": [],
"label": "locationId",
"description": [],
"signature": [
"\"banner\" | \"toolbar\" | \"embeddableBadge\" | \"visualization\" | \"visualizationOnEmbeddable\" | \"visualizationInEditor\" | \"textBasedLanguagesQueryInput\" | \"dimensionButton\" | (\"banner\" | \"toolbar\" | \"embeddableBadge\" | \"visualization\" | \"visualizationOnEmbeddable\" | \"visualizationInEditor\" | \"textBasedLanguagesQueryInput\" | \"dimensionButton\")[] | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getUserMessages.$2",
"type": "Object",
"tags": [],
"label": "filters",
"description": [],
"signature": [
"UserMessageFilters",
" | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.reportsEmbeddableLoad",
"type": "Function",
"tags": [],
"label": "reportsEmbeddableLoad",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.supportedTriggers",
"type": "Function",
"tags": [],
"label": "supportedTriggers",
"description": [],
"signature": [
"() => string[]"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getInspectorAdapters",
"type": "Function",
"tags": [],
"label": "getInspectorAdapters",
"description": [],
"signature": [
"() => ",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
}
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getFullAttributes",
"type": "Function",
"tags": [],
"label": "getFullAttributes",
"description": [],
"signature": [
"() => ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensSavedObjectAttributes",
"text": "LensSavedObjectAttributes"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.isTextBasedLanguage",
"type": "Function",
"tags": [],
"label": "isTextBasedLanguage",
"description": [],
"signature": [
"() => boolean | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getTextBasedLanguage",
"type": "Function",
"tags": [],
"label": "getTextBasedLanguage",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.updateVisualization",
"type": "Function",
"tags": [],
"label": "updateVisualization",
"description": [],
"signature": [
"(datasourceState: unknown, visualizationState: unknown) => Promise<void>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.updateVisualization.$1",
"type": "Unknown",
"tags": [],
"label": "datasourceState",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.updateVisualization.$2",
"type": "Unknown",
"tags": [],
"label": "visualizationState",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.openConfingPanel",
"type": "Function",
"tags": [],
"label": "openConfingPanel",
"description": [],
"signature": [
"(startDependencies: ",
"LensPluginStartDependencies",
") => Promise<JSX.Element | null>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.openConfingPanel.$1",
"type": "Object",
"tags": [],
"label": "startDependencies",
"description": [],
"signature": [
"LensPluginStartDependencies"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.initializeSavedVis",
"type": "Function",
"tags": [],
"label": "initializeSavedVis",
"description": [],
"signature": [
"(input: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
") => Promise<void>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.initializeSavedVis.$1",
"type": "CompoundType",
"tags": [],
"label": "input",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
}
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getExecutionContext",
"type": "Function",
"tags": [],
"label": "getExecutionContext",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [
"\n"
],
"signature": [
"(domNode: Element | HTMLElement) => void"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.render.$1",
"type": "CompoundType",
"tags": [],
"label": "domNode",
"description": [],
"signature": [
"Element | HTMLElement"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.badgeDomNode",
"type": "Object",
"tags": [],
"label": "badgeDomNode",
"description": [],
"signature": [
"HTMLDivElement | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.handleEvent",
"type": "Function",
"tags": [],
"label": "handleEvent",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "expressions",
"scope": "public",
"docId": "kibExpressionsPluginApi",
"section": "def-public.ExpressionRendererEvent",
"text": "ExpressionRendererEvent"
},
") => Promise<void>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.handleEvent.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "public",
"docId": "kibExpressionsPluginApi",
"section": "def-public.ExpressionRendererEvent",
"text": "ExpressionRendererEvent"
}
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.reload",
"type": "Function",
"tags": [],
"label": "reload",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getViewUnderlyingDataArgs",
"type": "Function",
"tags": [],
"label": "getViewUnderlyingDataArgs",
"description": [
"\nReturns the necessary arguments to view the underlying data in discover.\n\nOnly makes sense to call this after canViewUnderlyingData has been checked"
],
"signature": [
"() => ",
"ViewUnderlyingDataArgs",
" | undefined"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.canViewUnderlyingData",
"type": "Function",
"tags": [],
"label": "canViewUnderlyingData",
"description": [],
"signature": [
"() => Promise<boolean>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.initializeOutput",
"type": "Function",
"tags": [],
"label": "initializeOutput",
"description": [],
"signature": [
"() => Promise<void>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.inputIsRefType",
"type": "Function",
"tags": [],
"label": "inputIsRefType",
"description": [],
"signature": [
"(input: ",
"LensByValueInput",
" | ",
"LensByReferenceInput",
") => input is ",
"LensByReferenceInput"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.inputIsRefType.$1",
"type": "CompoundType",
"tags": [],
"label": "input",
"description": [],
"signature": [
"LensByValueInput",
" | ",
"LensByReferenceInput"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getInputAsRefType",
"type": "Function",
"tags": [],
"label": "getInputAsRefType",
"description": [],
"signature": [
"() => Promise<",
"LensByReferenceInput",
">"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getInputAsValueType",
"type": "Function",
"tags": [],
"label": "getInputAsValueType",
"description": [],
"signature": [
"() => Promise<",
"LensByValueInput",
">"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getFilters",
"type": "Function",
"tags": [],
"label": "getFilters",
"description": [
"\nGets the Lens embeddable's local filters"
],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [
"Local/panel-level array of filters for Lens embeddable"
]
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getQuery",
"type": "Function",
"tags": [],
"label": "getQuery",
"description": [
"\nGets the Lens embeddable's local query"
],
"signature": [
"() => Promise<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [
"Local/panel-level query for Lens embeddable"
]
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getSavedVis",
"type": "Function",
"tags": [],
"label": "getSavedVis",
"description": [],
"signature": [
"() => Readonly<",
"Document",
" | undefined>"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.destroy",
"type": "Function",
"tags": [],
"label": "destroy",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Embeddable.getSelfStyledOptions",
"type": "Function",
"tags": [],
"label": "getSelfStyledOptions",
"description": [],
"signature": [
"() => { hideTitle: boolean | undefined; }"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig",
"type": "Interface",
"tags": [],
"label": "AxesSettingsConfig",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig.yLeft",
"type": "boolean",
"tags": [],
"label": "yLeft",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig.yRight",
"type": "boolean",
"tags": [],
"label": "yRight",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig",
"type": "Interface",
"tags": [],
"label": "AxisConfig",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.hide",
"type": "CompoundType",
"tags": [],
"label": "hide",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.position",
"type": "CompoundType",
"tags": [],
"label": "position",
"description": [],
"signature": [
"Position",
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.labelColor",
"type": "string",
"tags": [],
"label": "labelColor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.showOverlappingLabels",
"type": "CompoundType",
"tags": [],
"label": "showOverlappingLabels",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.showDuplicates",
"type": "CompoundType",
"tags": [],
"label": "showDuplicates",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.labelsOrientation",
"type": "number",
"tags": [],
"label": "labelsOrientation",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.truncate",
"type": "number",
"tags": [],
"label": "truncate",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.showLabels",
"type": "CompoundType",
"tags": [],
"label": "showLabels",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.showTitle",
"type": "CompoundType",
"tags": [],
"label": "showTitle",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.showGridLines",
"type": "CompoundType",
"tags": [],
"label": "showGridLines",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisConfig.extent",
"type": "CompoundType",
"tags": [],
"label": "extent",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.AxisExtentConfigResult",
"text": "AxisExtentConfigResult"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig",
"type": "Interface",
"tags": [],
"label": "AxisExtentConfig",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig.mode",
"type": "CompoundType",
"tags": [],
"label": "mode",
"description": [],
"signature": [
"\"full\" | \"custom\" | \"dataBounds\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig.lowerBound",
"type": "number",
"tags": [],
"label": "lowerBound",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig.upperBound",
"type": "number",
"tags": [],
"label": "upperBound",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig.enforce",
"type": "CompoundType",
"tags": [],
"label": "enforce",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfig.niceValues",
"type": "CompoundType",
"tags": [],
"label": "niceValues",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CardinalityIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "CardinalityIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/cardinality.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.CardinalityIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"unique_count\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/cardinality.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.CardinalityIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/cardinality.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ChartInfo",
"type": "Interface",
"tags": [],
"label": "ChartInfo",
"description": [],
"path": "x-pack/plugins/lens/public/chart_info_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.ChartInfo.layers",
"type": "Array",
"tags": [],
"label": "layers",
"description": [],
"signature": [
"ChartLayerDescriptor",
"[]"
],
"path": "x-pack/plugins/lens/public/chart_info_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ChartInfo.visualizationType",
"type": "string",
"tags": [],
"label": "visualizationType",
"description": [],
"path": "x-pack/plugins/lens/public/chart_info_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ChartInfo.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]"
],
"path": "x-pack/plugins/lens/public/chart_info_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ChartInfo.query",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
"{ query: string | { [key: string]: any; }; language: string; }"
],
"path": "x-pack/plugins/lens/public/chart_info_api.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs",
"type": "Interface",
"tags": [],
"label": "DataLayerArgs",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.accessors",
"type": "Array",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
"(string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
")[]"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.seriesType",
"type": "CompoundType",
"tags": [],
"label": "seriesType",
"description": [],
"signature": [
"\"bar\" | \"line\" | \"area\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.xAccessor",
"type": "CompoundType",
"tags": [],
"label": "xAccessor",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.simpleView",
"type": "CompoundType",
"tags": [],
"label": "simpleView",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.splitAccessors",
"type": "Array",
"tags": [],
"label": "splitAccessors",
"description": [],
"signature": [
"(string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
")[] | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.markSizeAccessor",
"type": "CompoundType",
"tags": [],
"label": "markSizeAccessor",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.lineWidth",
"type": "number",
"tags": [],
"label": "lineWidth",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.showPoints",
"type": "CompoundType",
"tags": [],
"label": "showPoints",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.showLines",
"type": "CompoundType",
"tags": [],
"label": "showLines",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.pointsRadius",
"type": "number",
"tags": [],
"label": "pointsRadius",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.columnToLabel",
"type": "string",
"tags": [],
"label": "columnToLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.xScaleType",
"type": "CompoundType",
"tags": [],
"label": "xScaleType",
"description": [],
"signature": [
"\"time\" | \"linear\" | \"ordinal\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.isHistogram",
"type": "boolean",
"tags": [],
"label": "isHistogram",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.isPercentage",
"type": "boolean",
"tags": [],
"label": "isPercentage",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.isStacked",
"type": "boolean",
"tags": [],
"label": "isStacked",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.isHorizontal",
"type": "boolean",
"tags": [],
"label": "isHorizontal",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.decorations",
"type": "Array",
"tags": [],
"label": "decorations",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.DataDecorationConfigResult",
"text": "DataDecorationConfigResult"
},
"[] | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerArgs.curveType",
"type": "CompoundType",
"tags": [],
"label": "curveType",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XYCurveType",
"text": "XYCurveType"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI",
"type": "Interface",
"tags": [],
"label": "DatasourcePublicAPI",
"description": [
"\nThis is an API provided to visualizations by the frame, which calls the publicAPI on the datasource"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.datasourceId",
"type": "string",
"tags": [],
"label": "datasourceId",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.datasourceAliasIds",
"type": "Array",
"tags": [],
"label": "datasourceAliasIds",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getTableSpec",
"type": "Function",
"tags": [],
"label": "getTableSpec",
"description": [],
"signature": [
"() => { columnId: string; fields: string[]; }[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getOperationForColumnId",
"type": "Function",
"tags": [],
"label": "getOperationForColumnId",
"description": [],
"signature": [
"(columnId: string) => ",
"OperationDescriptor",
" | null"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getOperationForColumnId.$1",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getVisualDefaults",
"type": "Function",
"tags": [],
"label": "getVisualDefaults",
"description": [
"\nCollect all default visual values given the current state"
],
"signature": [
"() => Record<string, Record<string, unknown>>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getSourceId",
"type": "Function",
"tags": [],
"label": "getSourceId",
"description": [
"\nRetrieve the specific source id for the current state"
],
"signature": [
"() => string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.isTextBasedLanguage",
"type": "Function",
"tags": [],
"label": "isTextBasedLanguage",
"description": [
"\nReturns true if this is a text based language datasource"
],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getFilters",
"type": "Function",
"tags": [],
"label": "getFilters",
"description": [
"\nCollect all defined filters from all the operations in the layer. If it returns undefined, this means that filters can't be constructed for the current layer"
],
"signature": [
"(activeData?: Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"> | undefined, timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => { error: string; } | Record<\"enabled\" | \"disabled\", { kuery: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"[][]; lucene: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"[][]; }>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getFilters.$1",
"type": "Object",
"tags": [],
"label": "activeData",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getFilters.$2",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getMaxPossibleNumValues",
"type": "Function",
"tags": [],
"label": "getMaxPossibleNumValues",
"description": [
"\nReturns the maximum possible number of values for this column when it can be known, otherwise null\n(e.g. with a top 5 values operation, we can be sure that there will never be more than 5 values returned\n or 6 if the \"Other\" bucket is enabled)"
],
"signature": [
"(columnId: string) => number | null"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.getMaxPossibleNumValues.$1",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.DatasourcePublicAPI.hasDefaultTimeField",
"type": "Function",
"tags": [],
"label": "hasDefaultTimeField",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState",
"type": "Interface",
"tags": [],
"label": "DatatableVisualizationState",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"ColumnState",
"[]"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.sorting",
"type": "Object",
"tags": [],
"label": "sorting",
"description": [],
"signature": [
"SortingState",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.rowHeight",
"type": "CompoundType",
"tags": [],
"label": "rowHeight",
"description": [],
"signature": [
"\"custom\" | \"auto\" | \"single\" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.headerRowHeight",
"type": "CompoundType",
"tags": [],
"label": "headerRowHeight",
"description": [],
"signature": [
"\"custom\" | \"auto\" | \"single\" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.rowHeightLines",
"type": "number",
"tags": [],
"label": "rowHeightLines",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.headerRowHeightLines",
"type": "number",
"tags": [],
"label": "headerRowHeightLines",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.paging",
"type": "Object",
"tags": [],
"label": "paging",
"description": [],
"signature": [
"PagingState",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/datatable/visualization.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DateHistogramIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "DateHistogramIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DateHistogramIndexPatternColumn",
"text": "DateHistogramIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/date_histogram.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DateHistogramIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"date_histogram\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/date_histogram.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.DateHistogramIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ interval: string; ignoreTimeRange?: boolean | undefined; includeEmptyRows?: boolean | undefined; dropPartials?: boolean | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/date_histogram.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FieldBasedIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "FieldBasedIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" extends ",
"BaseIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FieldBasedIndexPatternColumn.sourceField",
"type": "string",
"tags": [],
"label": "sourceField",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FiltersIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "FiltersIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FiltersIndexPatternColumn",
"text": "FiltersIndexPatternColumn"
},
" extends ",
"BaseIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/filters/filters.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FiltersIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"filters\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/filters/filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FiltersIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ filters: ",
"Filter",
"[]; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/filters/filters.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer",
"type": "Interface",
"tags": [],
"label": "FormBasedLayer",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.columnOrder",
"type": "Array",
"tags": [],
"label": "columnOrder",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.columns",
"type": "Object",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.GenericIndexPatternColumn",
"text": "GenericIndexPatternColumn"
},
"; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.indexPatternId",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.linkToLayers",
"type": "Array",
"tags": [],
"label": "linkToLayers",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.incompleteColumns",
"type": "Object",
"tags": [],
"label": "incompleteColumns",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.IncompleteColumn",
"text": "IncompleteColumn"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.sampling",
"type": "number",
"tags": [],
"label": "sampling",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedLayer.ignoreGlobalFilters",
"type": "CompoundType",
"tags": [],
"label": "ignoreGlobalFilters",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormBasedPersistedState",
"type": "Interface",
"tags": [],
"label": "FormBasedPersistedState",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormBasedPersistedState.layers",
"type": "Object",
"tags": [],
"label": "layers",
"description": [],
"signature": [
"{ [x: string]: Omit<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormBasedLayer",
"text": "FormBasedLayer"
},
", \"indexPatternId\">; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "FormulaIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormulaIndexPatternColumn",
"text": "FormulaIndexPatternColumn"
},
" extends ",
"ReferenceBasedIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormulaIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"formula\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ formula?: string | undefined; isFormulaBroken?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi",
"type": "Interface",
"tags": [],
"label": "FormulaPublicApi",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn",
"type": "Function",
"tags": [],
"label": "insertOrReplaceFormulaColumn",
"description": [
"\nMethod which Lens consumer can import and given a formula string,\nreturn a parsed result as list of columns to use as Embeddable attributes.\n"
],
"signature": [
"(id: string, column: { formula: string; label?: string | undefined; filter?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; reducedTimeRange?: string | undefined; timeScale?: ",
"TimeScaleUnit",
" | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }, layer: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PersistedIndexPatternLayer",
"text": "PersistedIndexPatternLayer"
},
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", dateRange?: ",
"DateRange",
" | undefined) => ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PersistedIndexPatternLayer",
"text": "PersistedIndexPatternLayer"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- Formula column id"
],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2",
"type": "Object",
"tags": [],
"label": "column",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.formula",
"type": "string",
"tags": [],
"label": "formula",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.filter",
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.reducedTimeRange",
"type": "string",
"tags": [],
"label": "reducedTimeRange",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.timeScale",
"type": "CompoundType",
"tags": [],
"label": "timeScale",
"description": [],
"signature": [
"TimeScaleUnit",
" | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$2.format",
"type": "Object",
"tags": [],
"label": "format",
"description": [],
"signature": [
"{ id: string; params?: { decimals: number; } | undefined; } | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$3",
"type": "Object",
"tags": [],
"label": "layer",
"description": [
"- The layer to which the formula columns will be added"
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PersistedIndexPatternLayer",
"text": "PersistedIndexPatternLayer"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$4",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [
"- The dataView instance\n\nSee `x-pack/examples/embedded_lens_example` for exemplary usage."
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.FormulaPublicApi.insertOrReplaceFormulaColumn.$5",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"DateRange",
" | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/formula_public_api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn",
"type": "Interface",
"tags": [],
"label": "IncompleteColumn",
"description": [],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn.sourceField",
"type": "string",
"tags": [],
"label": "sourceField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LastValueIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "LastValueIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LastValueIndexPatternColumn",
"text": "LastValueIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/last_value.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LastValueIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"last_value\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/last_value.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LastValueIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ sortField: string; showArrayValues: boolean; format?: ",
"ValueFormatConfig",
" | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/last_value.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState",
"type": "Interface",
"tags": [],
"label": "LegacyMetricState",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.autoScaleMetricAlignment",
"type": "CompoundType",
"tags": [],
"label": "autoScaleMetricAlignment",
"description": [],
"signature": [
"\"left\" | \"right\" | \"center\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.accessor",
"type": "string",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.colorMode",
"type": "CompoundType",
"tags": [],
"label": "colorMode",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.ColorMode",
"text": "ColorMode"
},
" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.titlePosition",
"type": "CompoundType",
"tags": [],
"label": "titlePosition",
"description": [],
"signature": [
"\"top\" | \"bottom\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.size",
"type": "string",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegacyMetricState.textAlign",
"type": "CompoundType",
"tags": [],
"label": "textAlign",
"description": [],
"signature": [
"\"left\" | \"right\" | \"center\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig",
"type": "Interface",
"tags": [],
"label": "LegendConfig",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.isVisible",
"type": "boolean",
"tags": [],
"label": "isVisible",
"description": [
"\nFlag whether the legend should be shown. If there is just a single series, it will be hidden"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.position",
"type": "CompoundType",
"tags": [],
"label": "position",
"description": [
"\nPosition of the legend relative to the chart"
],
"signature": [
"\"top\" | \"left\" | \"right\" | \"bottom\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.showSingleSeries",
"type": "CompoundType",
"tags": [],
"label": "showSingleSeries",
"description": [
"\nFlag whether the legend should be shown even with just a single series"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.isInside",
"type": "CompoundType",
"tags": [],
"label": "isInside",
"description": [
"\nFlag whether the legend is inside the chart"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.horizontalAlignment",
"type": "CompoundType",
"tags": [],
"label": "horizontalAlignment",
"description": [
"\nHorizontal Alignment of the legend when it is set inside chart"
],
"signature": [
"\"left\" | \"right\" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.verticalAlignment",
"type": "CompoundType",
"tags": [],
"label": "verticalAlignment",
"description": [
"\nVertical Alignment of the legend when it is set inside chart"
],
"signature": [
"\"top\" | \"bottom\" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.floatingColumns",
"type": "number",
"tags": [],
"label": "floatingColumns",
"description": [
"\nNumber of columns when legend is set inside chart"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.maxLines",
"type": "number",
"tags": [],
"label": "maxLines",
"description": [
"\nMaximum number of lines per legend item"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.shouldTruncate",
"type": "CompoundType",
"tags": [],
"label": "shouldTruncate",
"description": [
"\nFlag whether the legend items are truncated or not"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.legendSize",
"type": "CompoundType",
"tags": [],
"label": "legendSize",
"description": [
"\nExact legend width (vertical) or height (horizontal)\nLimited to max of 70% of the chart container dimension Vertical legends limited to min of 30% of computed width"
],
"signature": [
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.LegendSize",
"text": "LegendSize"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicSetup",
"type": "Interface",
"tags": [],
"label": "LensPublicSetup",
"description": [],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicSetup.registerVisualization",
"type": "Function",
"tags": [
"experimental"
],
"label": "registerVisualization",
"description": [
"\nRegister 3rd party visualization type\nSee `x-pack/examples/3rd_party_lens_vis` for exemplary usage.\n\nIn case the visualization is a function returning a promise, it will only be called once Lens is actually requiring it.\nThis can be used to lazy-load parts of the code to keep the initial bundle as small as possible.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"<T>(visualization: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Visualization",
"text": "Visualization"
},
"<T, T, unknown> | (() => Promise<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Visualization",
"text": "Visualization"
},
"<T, T, unknown>>)) => void"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicSetup.registerVisualization.$1",
"type": "CompoundType",
"tags": [],
"label": "visualization",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Visualization",
"text": "Visualization"
},
"<T, T, unknown> | (() => Promise<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Visualization",
"text": "Visualization"
},
"<T, T, unknown>>)"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicSetup.registerTopNavMenuEntryGenerator",
"type": "Function",
"tags": [
"experimental"
],
"label": "registerTopNavMenuEntryGenerator",
"description": [
"\nRegister a generic menu entry shown in the top nav\nSee `x-pack/examples/3rd_party_lens_navigation_prompt` for exemplary usage.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"(navigationPromptGenerator: ",
"LensTopNavMenuEntryGenerator",
") => void"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicSetup.registerTopNavMenuEntryGenerator.$1",
"type": "Function",
"tags": [],
"label": "navigationPromptGenerator",
"description": [],
"signature": [
"LensTopNavMenuEntryGenerator"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart",
"type": "Interface",
"tags": [],
"label": "LensPublicStart",
"description": [],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.EmbeddableComponent",
"type": "CompoundType",
"tags": [
"experimental"
],
"label": "EmbeddableComponent",
"description": [
"\nReact component which can be used to embed a Lens visualization into another application.\nSee `x-pack/examples/embedded_lens_example` for exemplary usage.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"React.ComponentClass<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.EmbeddableComponentProps",
"text": "EmbeddableComponentProps"
},
", any> | React.FunctionComponent<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.EmbeddableComponentProps",
"text": "EmbeddableComponentProps"
},
">"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.SaveModalComponent",
"type": "CompoundType",
"tags": [
"experimental"
],
"label": "SaveModalComponent",
"description": [
"\nReact component which can be used to embed a Lens Visualization Save Modal Component.\nSee `x-pack/examples/embedded_lens_example` for exemplary usage.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"React.ComponentClass<Omit<",
"SaveModalContainerProps",
", \"lensServices\">, any> | React.FunctionComponent<Omit<",
"SaveModalContainerProps",
", \"lensServices\">>"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.EditLensConfigPanelApi",
"type": "Function",
"tags": [
"experimental"
],
"label": "EditLensConfigPanelApi",
"description": [
"\nReact component which can be used to embed a Lens Visualization Config Panel Component.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"() => Promise<",
"EditLensConfigPanelComponent",
">"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor",
"type": "Function",
"tags": [
"experimental"
],
"label": "navigateToPrefilledEditor",
"description": [
"\nMethod which navigates to the Lens editor, loading the state specified by the `input` parameter.\nSee `x-pack/examples/embedded_lens_example` for exemplary usage.\n\nThis API might undergo breaking changes even in minor versions.\n"
],
"signature": [
"(input: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
" | undefined, options?: { openInNewTab?: boolean | undefined; originatingApp?: string | undefined; originatingPath?: string | undefined; skipAppLeave?: boolean | undefined; } | undefined) => void"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$1",
"type": "CompoundType",
"tags": [],
"label": "input",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.openInNewTab",
"type": "CompoundType",
"tags": [],
"label": "openInNewTab",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.originatingPath",
"type": "string",
"tags": [],
"label": "originatingPath",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2.skipAppLeave",
"type": "CompoundType",
"tags": [],
"label": "skipAppLeave",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.canUseEditor",
"type": "Function",
"tags": [],
"label": "canUseEditor",
"description": [
"\nMethod which returns true if the user has permission to use Lens as defined by application capabilities."
],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.getXyVisTypes",
"type": "Function",
"tags": [],
"label": "getXyVisTypes",
"description": [
"\nMethod which returns xy VisualizationTypes array keeping this async as to not impact page load bundle"
],
"signature": [
"() => Promise<",
"VisualizationType",
"[]>"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart.stateHelperApi",
"type": "Function",
"tags": [],
"label": "stateHelperApi",
"description": [
"\nAPI which returns state helpers keeping this async as to not impact page load bundle"
],
"signature": [
"() => Promise<{ formula: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FormulaPublicApi",
"text": "FormulaPublicApi"
},
"; chartInfo: ",
"ChartInfoApi",
"; suggestions: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensSuggestionsApi",
"text": "LensSuggestionsApi"
},
"; }>"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MathIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "MathIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MathIndexPatternColumn",
"text": "MathIndexPatternColumn"
},
" extends ",
"ReferenceBasedIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/math.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.MathIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"math\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/math.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MathIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ tinymathAst: string | ",
"TinymathAST",
"; format?: ",
"ValueFormatConfig",
" | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/formula/math.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState",
"type": "Interface",
"tags": [],
"label": "MetricVisualizationState",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.metricAccessor",
"type": "string",
"tags": [],
"label": "metricAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.secondaryMetricAccessor",
"type": "string",
"tags": [],
"label": "secondaryMetricAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.maxAccessor",
"type": "string",
"tags": [],
"label": "maxAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.breakdownByAccessor",
"type": "string",
"tags": [],
"label": "breakdownByAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.collapseFn",
"type": "CompoundType",
"tags": [],
"label": "collapseFn",
"description": [],
"signature": [
"\"min\" | \"max\" | \"sum\" | \"avg\" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.subtitle",
"type": "string",
"tags": [],
"label": "subtitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.secondaryPrefix",
"type": "string",
"tags": [],
"label": "secondaryPrefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.progressDirection",
"type": "CompoundType",
"tags": [],
"label": "progressDirection",
"description": [],
"signature": [
"LayoutDirection",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.showBar",
"type": "CompoundType",
"tags": [],
"label": "showBar",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.maxCols",
"type": "number",
"tags": [],
"label": "maxCols",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineLayerId",
"type": "string",
"tags": [],
"label": "trendlineLayerId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineLayerType",
"type": "CompoundType",
"tags": [],
"label": "trendlineLayerType",
"description": [],
"signature": [
"LayerType",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineTimeAccessor",
"type": "string",
"tags": [],
"label": "trendlineTimeAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineMetricAccessor",
"type": "string",
"tags": [],
"label": "trendlineMetricAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineSecondaryMetricAccessor",
"type": "string",
"tags": [],
"label": "trendlineSecondaryMetricAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricVisualizationState.trendlineBreakdownByAccessor",
"type": "string",
"tags": [],
"label": "trendlineBreakdownByAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/metric/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata",
"type": "Interface",
"tags": [],
"label": "OperationMetadata",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.dataType",
"type": "CompoundType",
"tags": [],
"label": "dataType",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"date\" | ",
"FieldOnlyDataType"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.isBucketed",
"type": "boolean",
"tags": [],
"label": "isBucketed",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.scale",
"type": "CompoundType",
"tags": [],
"label": "scale",
"description": [
"\nordinal: Each name is a unique value, but the names are in sorted order, like \"Top values\"\ninterval: Histogram data, like date or number histograms\nratio: Most number data is rendered as a ratio that includes 0"
],
"signature": [
"\"interval\" | \"ratio\" | \"ordinal\" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.isStaticValue",
"type": "CompoundType",
"tags": [],
"label": "isStaticValue",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PercentileIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "PercentileIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileIndexPatternColumn",
"text": "PercentileIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.PercentileIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"percentile\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.PercentileIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ percentile: number; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PercentileRanksIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "PercentileRanksIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileRanksIndexPatternColumn",
"text": "PercentileRanksIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile_ranks.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.PercentileRanksIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"percentile_rank\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile_ranks.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.PercentileRanksIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ value: number; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/percentile_ranks.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState",
"type": "Interface",
"tags": [],
"label": "PieVisualizationState",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.shape",
"type": "CompoundType",
"tags": [],
"label": "shape",
"description": [],
"signature": [
"\"treemap\" | \"mosaic\" | \"waffle\" | \"pie\" | \"donut\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.layers",
"type": "Array",
"tags": [],
"label": "layers",
"description": [],
"signature": [
"PieLayerState",
"[]"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.RangeIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "RangeIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeIndexPatternColumn",
"text": "RangeIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/ranges/ranges.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.RangeIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"range\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/ranges/ranges.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.RangeIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ type: ",
"MODES_TYPES",
"; maxBars: number | \"auto\"; ranges: ",
"RangeTypeLens",
"[]; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; includeEmptyRows?: boolean | undefined; parentFormat?: { id: string; params?: { id?: string | undefined; template?: string | undefined; replaceInfinity?: boolean | undefined; } | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/ranges/ranges.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs",
"type": "Interface",
"tags": [],
"label": "ReferenceLineLayerArgs",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs.accessors",
"type": "Array",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs.columnToLabel",
"type": "string",
"tags": [],
"label": "columnToLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs.decorations",
"type": "Array",
"tags": [],
"label": "decorations",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.ReferenceLineDecorationConfigResult",
"text": "ReferenceLineDecorationConfigResult"
},
"[] | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerArgs.table",
"type": "Object",
"tags": [],
"label": "table",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState",
"type": "Interface",
"tags": [],
"label": "SharedPieLayerState",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.metrics",
"type": "Array",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.primaryGroups",
"type": "Array",
"tags": [],
"label": "primaryGroups",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.secondaryGroups",
"type": "Array",
"tags": [],
"label": "secondaryGroups",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.allowMultipleMetrics",
"type": "CompoundType",
"tags": [],
"label": "allowMultipleMetrics",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.colorsByDimension",
"type": "Object",
"tags": [],
"label": "colorsByDimension",
"description": [],
"signature": [
"Record<string, string> | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.collapseFns",
"type": "Object",
"tags": [],
"label": "collapseFns",
"description": [],
"signature": [
"Record<string, ",
"CollapseFunction",
"> | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.numberDisplay",
"type": "CompoundType",
"tags": [],
"label": "numberDisplay",
"description": [],
"signature": [
"\"value\" | \"hidden\" | \"percent\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.categoryDisplay",
"type": "CompoundType",
"tags": [],
"label": "categoryDisplay",
"description": [],
"signature": [
"\"default\" | \"hide\" | \"inside\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendDisplay",
"type": "CompoundType",
"tags": [],
"label": "legendDisplay",
"description": [],
"signature": [
"\"default\" | \"hide\" | \"show\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendPosition",
"type": "CompoundType",
"tags": [],
"label": "legendPosition",
"description": [],
"signature": [
"Position",
" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.showValuesInLegend",
"type": "CompoundType",
"tags": [],
"label": "showValuesInLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.nestedLegend",
"type": "CompoundType",
"tags": [],
"label": "nestedLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.percentDecimals",
"type": "number",
"tags": [],
"label": "percentDecimals",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.emptySizeRatio",
"type": "number",
"tags": [],
"label": "emptySizeRatio",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendMaxLines",
"type": "number",
"tags": [],
"label": "legendMaxLines",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendSize",
"type": "CompoundType",
"tags": [],
"label": "legendSize",
"description": [],
"signature": [
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.LegendSize",
"text": "LegendSize"
},
" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.truncateLegend",
"type": "CompoundType",
"tags": [],
"label": "truncateLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.StaticValueIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "StaticValueIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.StaticValueIndexPatternColumn",
"text": "StaticValueIndexPatternColumn"
},
" extends ",
"ReferenceBasedIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/static_value.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.StaticValueIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"static_value\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/static_value.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.StaticValueIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ value?: string | undefined; format?: ",
"ValueFormatConfig",
" | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/static_value.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion",
"type": "Interface",
"tags": [],
"label": "Suggestion",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Suggestion",
"text": "Suggestion"
},
"<T, V>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.visualizationId",
"type": "string",
"tags": [],
"label": "visualizationId",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.datasourceState",
"type": "Uncategorized",
"tags": [],
"label": "datasourceState",
"description": [],
"signature": [
"V | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.datasourceId",
"type": "string",
"tags": [],
"label": "datasourceId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.columns",
"type": "number",
"tags": [],
"label": "columns",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.score",
"type": "number",
"tags": [],
"label": "score",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.visualizationState",
"type": "Uncategorized",
"tags": [],
"label": "visualizationState",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.previewExpression",
"type": "CompoundType",
"tags": [],
"label": "previewExpression",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/interpreter",
"scope": "common",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-common.Ast",
"text": "Ast"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.previewIcon",
"type": "CompoundType",
"tags": [],
"label": "previewIcon",
"description": [],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.hide",
"type": "CompoundType",
"tags": [],
"label": "hide",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.incomplete",
"type": "CompoundType",
"tags": [],
"label": "incomplete",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.changeType",
"type": "CompoundType",
"tags": [],
"label": "changeType",
"description": [],
"signature": [
"\"layers\" | \"initial\" | \"unchanged\" | \"reduced\" | \"extended\" | \"reorder\""
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Suggestion.keptLayerIds",
"type": "Array",
"tags": [],
"label": "keptLayerIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest",
"type": "Interface",
"tags": [],
"label": "SuggestionRequest",
"description": [
"\nObject passed to `getSuggestions` of a visualization.\nIt contains a possible table the current datasource could\nprovide and the state of the visualization if it is currently active.\n\nIf the current datasource suggests multiple tables, `getSuggestions`\nis called multiple times with separate `SuggestionRequest` objects."
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SuggestionRequest",
"text": "SuggestionRequest"
},
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.table",
"type": "Object",
"tags": [],
"label": "table",
"description": [
"\nA table configuration the datasource could provide."
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TableSuggestion",
"text": "TableSuggestion"
}
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.state",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [
"\nState is only passed if the visualization is active."
],
"signature": [
"T | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.mainPalette",
"type": "Object",
"tags": [],
"label": "mainPalette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.isFromContext",
"type": "CompoundType",
"tags": [],
"label": "isFromContext",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.keptLayerIds",
"type": "Array",
"tags": [],
"label": "keptLayerIds",
"description": [
"\nThe visualization needs to know which table is being suggested"
],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.subVisualizationId",
"type": "string",
"tags": [],
"label": "subVisualizationId",
"description": [
"\nDifferent suggestions can be generated for each subtype of the visualization"
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.activeData",
"type": "Object",
"tags": [],
"label": "activeData",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.SuggestionRequest.allowMixed",
"type": "CompoundType",
"tags": [],
"label": "allowMixed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion",
"type": "Interface",
"tags": [],
"label": "TableSuggestion",
"description": [
"\nA possible table a datasource can create. This object is passed to the visualization\nwhich tries to build a meaningful visualization given the shape of the table. If this\nis possible, the visualization returns a `VisualizationSuggestion` object"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion.isMultiRow",
"type": "boolean",
"tags": [],
"label": "isMultiRow",
"description": [
"\nFlag indicating whether the table will include more than one column.\nThis is not the case for example for a single metric aggregation"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nThe columns of the table. Each column has to be mapped to a dimension in a chart. If a visualization\ncan't use all columns of a suggestion, it should not return a `VisualizationSuggestion` based on it\nbecause there would be unreferenced columns"
],
"signature": [
"TableSuggestionColumn",
"[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [
"\nThe layer this table will replace. This is only relevant if the visualization this suggestion is passed\nis currently active and has multiple layers configured. If this suggestion is applied, the table of this\nlayer will be replaced by the columns specified in this suggestion"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion.label",
"type": "string",
"tags": [],
"label": "label",
"description": [
"\nA label describing the table. This can be used to provide a title for the `VisualizationSuggestion`,\nbut the visualization can also decide to overwrite it."
],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.TableSuggestion.changeType",
"type": "CompoundType",
"tags": [],
"label": "changeType",
"description": [
"\nThe change type indicates what was changed in this table compared to the currently active table of this layer."
],
"signature": [
"\"layers\" | \"initial\" | \"unchanged\" | \"reduced\" | \"extended\" | \"reorder\""
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.TermsIndexPatternColumn",
"type": "Interface",
"tags": [],
"label": "TermsIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TermsIndexPatternColumn",
"text": "TermsIndexPatternColumn"
},
" extends ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/terms/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.TermsIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"terms\""
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/terms/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.TermsIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ size: number; accuracyMode?: boolean | undefined; include?: string[] | number[] | undefined; exclude?: string[] | number[] | undefined; includeIsRegex?: boolean | undefined; excludeIsRegex?: boolean | undefined; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"rare\"; maxDocCount: number; } | { type: \"significant\"; } | { type: \"column\"; columnId: string; } | { type: \"custom\"; }; orderAgg?: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" | undefined; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; secondaryFields?: string[] | undefined; format?: ",
"ValueFormatConfig",
" | undefined; parentFormat?: { id: string; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/terms/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization",
"type": "Interface",
"tags": [],
"label": "Visualization",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Visualization",
"text": "Visualization"
},
"<T, P, ExtraAppendLayerArg>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Plugin ID, such as \"lnsXY\""
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.alias",
"type": "Array",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.initialize",
"type": "Function",
"tags": [],
"label": "initialize",
"description": [
"\nInitialize is allowed to modify the state stored in memory. The initialize function\nis called with a previous state in two cases:\n- Loading from a saved visualization\n- When using suggestions, the suggested state is passed in"
],
"signature": [
"{ (addNewLayer: () => string, nonPersistedState?: T | undefined, mainPalette?: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined): T; (addNewLayer: () => string, persistedState: P, mainPalette?: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined, annotationGroups?: ",
"AnnotationGroups",
" | undefined, references?: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined): T; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUsedDataView",
"type": "Function",
"tags": [],
"label": "getUsedDataView",
"description": [],
"signature": [
"((state: T, layerId: string) => string | undefined) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUsedDataView.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUsedDataView.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUsedDataViews",
"type": "Function",
"tags": [],
"label": "getUsedDataViews",
"description": [
"\nRetrieve the used DataViews in the visualization"
],
"signature": [
"((state?: T | undefined) => string[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUsedDataViews.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getMainPalette",
"type": "Function",
"tags": [],
"label": "getMainPalette",
"description": [],
"signature": [
"((state: T) => ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getMainPalette.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.triggers",
"type": "Array",
"tags": [],
"label": "triggers",
"description": [
"\nSupported triggers of this visualization type when embedded somewhere"
],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.visualizationTypes",
"type": "Array",
"tags": [],
"label": "visualizationTypes",
"description": [
"\nVisualizations must provide at least one type for the chart switcher,\nbut can register multiple subtypes"
],
"signature": [
"VisualizationType",
"[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getVisualizationTypeId",
"type": "Function",
"tags": [],
"label": "getVisualizationTypeId",
"description": [
"\nReturn the ID of the current visualization. Used to highlight\nthe active subtype of the visualization."
],
"signature": [
"(state: T) => string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getVisualizationTypeId.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.switchVisualizationType",
"type": "Function",
"tags": [],
"label": "switchVisualizationType",
"description": [
"\nIf the visualization has subtypes, update the subtype in state."
],
"signature": [
"((visualizationTypeId: string, state: T) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.switchVisualizationType.$1",
"type": "string",
"tags": [],
"label": "visualizationTypeId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.switchVisualizationType.$2",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getDescription",
"type": "Function",
"tags": [],
"label": "getDescription",
"description": [
"Description is displayed as the clickable text in the chart switcher"
],
"signature": [
"(state: T) => { icon?: ",
"IconType",
" | undefined; label: string; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getDescription.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getPersistableState",
"type": "Function",
"tags": [],
"label": "getPersistableState",
"description": [
"Visualizations can have references as well"
],
"signature": [
"((state: T) => { state: P; savedObjectReferences: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getPersistableState.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayerIds",
"type": "Function",
"tags": [],
"label": "getLayerIds",
"description": [
"Frame needs to know which layers the visualization is currently using"
],
"signature": [
"(state: T) => string[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayerIds.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.clearLayer",
"type": "Function",
"tags": [],
"label": "clearLayer",
"description": [
"Reset button on each layer triggers this"
],
"signature": [
"(state: T, layerId: string, indexPatternId: string) => T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.clearLayer.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.clearLayer.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.clearLayer.$3",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.cloneLayer",
"type": "Function",
"tags": [],
"label": "cloneLayer",
"description": [
"Reset button on each layer triggers this"
],
"signature": [
"((state: T, layerId: string, newLayerId: string, clonedIDsMap: Map<string, string>) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.cloneLayer.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.cloneLayer.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.cloneLayer.$3",
"type": "string",
"tags": [],
"label": "newLayerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.cloneLayer.$4",
"type": "Object",
"tags": [],
"label": "clonedIDsMap",
"description": [],
"signature": [
"Map<string, string>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.removeLayer",
"type": "Function",
"tags": [],
"label": "removeLayer",
"description": [
"Optional, if the visualization supports multiple layers"
],
"signature": [
"((state: T, layerId: string) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.removeLayer.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.removeLayer.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer",
"type": "Function",
"tags": [],
"label": "appendLayer",
"description": [
"Track added layers in internal state"
],
"signature": [
"((state: T, layerId: string, type: ",
"LayerType",
", indexPatternId: string, extraArg?: ExtraAppendLayerArg | undefined) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer.$3",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"LayerType"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer.$4",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.appendLayer.$5",
"type": "Uncategorized",
"tags": [],
"label": "extraArg",
"description": [],
"signature": [
"ExtraAppendLayerArg | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedLayers",
"type": "Function",
"tags": [],
"label": "getSupportedLayers",
"description": [
"Retrieve a list of supported layer types with initialization data"
],
"signature": [
"(state?: T | undefined, frame?: Pick<",
"FramePublicAPI",
", \"activeData\" | \"datasourceLayers\"> | undefined) => ",
"VisualizationLayerDescription",
"[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedLayers.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedLayers.$2",
"type": "Object",
"tags": [],
"label": "frame",
"description": [],
"signature": [
"Pick<",
"FramePublicAPI",
", \"activeData\" | \"datasourceLayers\"> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer",
"type": "Function",
"tags": [],
"label": "getSupportedActionsForLayer",
"description": [
"\nreturns a list of custom actions supported by the visualization layer.\nDefault actions like delete/clear are not included in this list and are managed by the editor frame"
],
"signature": [
"((layerId: string, state: T, setState: ",
"StateSetter",
"<T, unknown>, registerLibraryAnnotationGroup: ",
"RegisterLibraryAnnotationGroupFunction",
", isSaveable?: boolean | undefined) => ",
"LayerAction",
"[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer.$1",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer.$2",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer.$3",
"type": "Function",
"tags": [],
"label": "setState",
"description": [],
"signature": [
"StateSetter",
"<T, unknown>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer.$4",
"type": "Function",
"tags": [],
"label": "registerLibraryAnnotationGroup",
"description": [],
"signature": [
"RegisterLibraryAnnotationGroupFunction"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSupportedActionsForLayer.$5",
"type": "CompoundType",
"tags": [],
"label": "isSaveable",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getCustomRemoveLayerText",
"type": "Function",
"tags": [],
"label": "getCustomRemoveLayerText",
"description": [
"\nThis method is a clunky solution to the problem, but I'm banking on the confirm modal being removed\nwith undo/redo anyways"
],
"signature": [
"((layerId: string, state: T) => { title?: string | undefined; description?: string | undefined; } | undefined) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getCustomRemoveLayerText.$1",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getCustomRemoveLayerText.$2",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayerType",
"type": "Function",
"tags": [],
"label": "getLayerType",
"description": [
"returns the type string of the given layer"
],
"signature": [
"(layerId: string, state?: T | undefined) => ",
"LayerType",
" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayerType.$1",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayerType.$2",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayersToLinkTo",
"type": "Function",
"tags": [],
"label": "getLayersToLinkTo",
"description": [
"\nGet the layers this one should be linked to (currently that means just keeping the data view in sync)"
],
"signature": [
"((state: T, newLayerId: string) => string[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayersToLinkTo.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayersToLinkTo.$2",
"type": "string",
"tags": [],
"label": "newLayerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLinkedDimensions",
"type": "Function",
"tags": [],
"label": "getLinkedDimensions",
"description": [
"\nReturns a set of dimensions that should be kept in sync"
],
"signature": [
"((state: T) => DimensionLink[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLinkedDimensions.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getRemoveOperation",
"type": "Function",
"tags": [],
"label": "getRemoveOperation",
"description": [],
"signature": [
"((state: T, layerId: string) => \"remove\" | \"clear\") | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getRemoveOperation.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getRemoveOperation.$2",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getConfiguration",
"type": "Function",
"tags": [],
"label": "getConfiguration",
"description": [
"\nFor consistency across different visualizations, the dimension configuration UI is standardized"
],
"signature": [
"(props: ",
"VisualizationConfigProps",
"<T>) => { hidden?: boolean | undefined; groups: ",
"VisualizationDimensionGroupConfig",
"[]; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getConfiguration.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationConfigProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerHeaderComponent",
"type": "Function",
"tags": [],
"label": "LayerHeaderComponent",
"description": [
"\nHeader rendered as layer title. This can be used for both static and dynamic content like\nfor extra configurability, such as for switch chart type"
],
"signature": [
"((props: ",
"VisualizationLayerWidgetProps",
"<T>) => React.ReactElement<",
"VisualizationLayerWidgetProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerHeaderComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationLayerWidgetProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerPanelComponent",
"type": "Function",
"tags": [],
"label": "LayerPanelComponent",
"description": [
"\nLayer panel content rendered. This can be used to render a custom content below the title,\nlike a custom dataview switch"
],
"signature": [
"((props: ",
"VisualizationLayerWidgetProps",
"<T>) => React.ReactElement<",
"VisualizationLayerWidgetProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerPanelComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationLayerWidgetProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.ToolbarComponent",
"type": "Function",
"tags": [],
"label": "ToolbarComponent",
"description": [
"\nToolbar rendered above the visualization. This is meant to be used to provide chart-level\nsettings for the visualization."
],
"signature": [
"((props: ",
"VisualizationToolbarProps",
"<T>) => React.ReactElement<",
"VisualizationToolbarProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.ToolbarComponent.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationToolbarProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.setDimension",
"type": "Function",
"tags": [],
"label": "setDimension",
"description": [
"\nThe frame is telling the visualization to update or set a dimension based on user interaction\ngroupId is coming from the groupId provided in getConfiguration"
],
"signature": [
"(props: ",
"VisualizationDimensionChangeProps",
"<T> & { groupId: string; previousColumn?: string | undefined; }) => T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.setDimension.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationDimensionChangeProps",
"<T> & { groupId: string; previousColumn?: string | undefined; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.removeDimension",
"type": "Function",
"tags": [],
"label": "removeDimension",
"description": [
"\nThe frame is telling the visualization to remove a dimension. The visualization needs to\nlook at its internal state to determine which dimension is being affected."
],
"signature": [
"(props: ",
"VisualizationDimensionChangeProps",
"<T>) => T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.removeDimension.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationDimensionChangeProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop",
"type": "Function",
"tags": [],
"label": "onDrop",
"description": [
"\nAllow defining custom behavior for the visualization when the drop action occurs."
],
"signature": [
"((props: { prevState: T; target: ",
"DragDropOperation",
"; source: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragDropIdentifier",
"text": "DragDropIdentifier"
},
"; frame: ",
"FramePublicAPI",
"; dropType: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
"; group?: ",
"VisualizationDimensionGroupConfig",
" | undefined; }) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.prevState",
"type": "Uncategorized",
"tags": [],
"label": "prevState",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.target",
"type": "Object",
"tags": [],
"label": "target",
"description": [],
"signature": [
"DragDropOperation"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.source",
"type": "CompoundType",
"tags": [],
"label": "source",
"description": [],
"signature": [
"Record<string, unknown> & { id: string; humanData: ",
"HumanData",
"; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.frame",
"type": "Object",
"tags": [],
"label": "frame",
"description": [],
"signature": [
"FramePublicAPI"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.dropType",
"type": "CompoundType",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
"\"reorder\" | \"field_add\" | \"field_replace\" | \"move_compatible\" | \"replace_compatible\" | \"move_incompatible\" | \"replace_incompatible\" | \"replace_duplicate_compatible\" | \"duplicate_compatible\" | \"swap_compatible\" | \"replace_duplicate_incompatible\" | \"duplicate_incompatible\" | \"swap_incompatible\" | \"field_combine\" | \"combine_compatible\" | \"combine_incompatible\""
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onDrop.$1.group",
"type": "CompoundType",
"tags": [],
"label": "group",
"description": [],
"signature": [
"VisualizationDimensionGroupConfig",
" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getDropProps",
"type": "Function",
"tags": [],
"label": "getDropProps",
"description": [],
"signature": [
"((dropProps: ",
"GetDropPropsArgs",
"<unknown>) => { dropTypes: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
"[]; nextLabel?: string | undefined; } | undefined) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getDropProps.$1",
"type": "Object",
"tags": [],
"label": "dropProps",
"description": [],
"signature": [
"GetDropPropsArgs",
"<unknown>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.hasLayerSettings",
"type": "Function",
"tags": [],
"label": "hasLayerSettings",
"description": [
"\nAllows the visualization to announce whether or not it has any settings to show"
],
"signature": [
"((props: ",
"VisualizationConfigProps",
"<T>) => Record<\"data\" | \"appearance\", boolean>) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.hasLayerSettings.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationConfigProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerSettingsComponent",
"type": "Function",
"tags": [],
"label": "LayerSettingsComponent",
"description": [],
"signature": [
"((props: ",
"VisualizationConfigProps",
"<T> & { setState(newState: T | ((currState: T) => T)): void; panelRef: React.MutableRefObject<HTMLDivElement | null>; } & { section: \"data\" | \"appearance\"; }) => React.ReactElement<",
"VisualizationLayerSettingsProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.LayerSettingsComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationConfigProps",
"<T> & { setState(newState: T | ((currState: T) => T)): void; panelRef: React.MutableRefObject<HTMLDivElement | null>; } & { section: \"data\" | \"appearance\"; }"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorComponent",
"type": "Function",
"tags": [],
"label": "DimensionEditorComponent",
"description": [
"\nAdditional editor that gets rendered inside the dimension popover in the \"appearance\" section.\nThis can be used to configure dimension-specific options"
],
"signature": [
"((props: ",
"VisualizationDimensionEditorProps",
"<T>) => React.ReactElement<",
"VisualizationDimensionEditorProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationDimensionEditorProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorAdditionalSectionComponent",
"type": "Function",
"tags": [],
"label": "DimensionEditorAdditionalSectionComponent",
"description": [
"\nAdditional editor that gets rendered inside the dimension popover in an additional section below \"appearance\".\nThis can be used to configure dimension-specific options"
],
"signature": [
"((props: ",
"VisualizationDimensionEditorProps",
"<T>) => React.ReactElement<",
"VisualizationDimensionEditorProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorAdditionalSectionComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationDimensionEditorProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorDataExtraComponent",
"type": "Function",
"tags": [],
"label": "DimensionEditorDataExtraComponent",
"description": [
"\nAdditional editor that gets rendered inside the data section.\nThis can be used to configure dimension-specific options"
],
"signature": [
"((props: ",
"VisualizationDimensionEditorProps",
"<T>) => React.ReactElement<",
"VisualizationDimensionEditorProps",
"<T>, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionEditorDataExtraComponent.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationDimensionEditorProps",
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionTriggerComponent",
"type": "Function",
"tags": [],
"label": "DimensionTriggerComponent",
"description": [
"\nRenders dimension trigger. Used only for noDatasource layers"
],
"signature": [
"((props: { columnId: string; label: string; hideTooltip?: boolean | undefined; }) => React.ReactElement<{ columnId: string; label: string; hideTooltip?: boolean | undefined; }, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionTriggerComponent.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionTriggerComponent.$1.columnId",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionTriggerComponent.$1.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.DimensionTriggerComponent.$1.hideTooltip",
"type": "CompoundType",
"tags": [],
"label": "hideTooltip",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getAddLayerButtonComponent",
"type": "Function",
"tags": [],
"label": "getAddLayerButtonComponent",
"description": [],
"signature": [
"((props: AddLayerButtonProps) => React.ReactElement<AddLayerButtonProps, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getAddLayerButtonComponent.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AddLayerButtonProps"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUniqueLabels",
"type": "Function",
"tags": [],
"label": "getUniqueLabels",
"description": [
"\nCreates map of columns ids and unique lables. Used only for noDatasource layers"
],
"signature": [
"((state: T) => Record<string, string>) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUniqueLabels.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSuggestions",
"type": "Function",
"tags": [],
"label": "getSuggestions",
"description": [
"\nThe frame will call this function on all visualizations at different times. The\nmain use cases where visualization suggestions are requested are:\n- When dragging a field\n- When opening the chart switcher\nIf the state is provided when requesting suggestions, the visualization is active.\nMost visualizations will apply stricter filtering to suggestions when they are active,\nbecause suggestions have the potential to remove the users's work in progress."
],
"signature": [
"(context: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SuggestionRequest",
"text": "SuggestionRequest"
},
"<T>) => ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.VisualizationSuggestion",
"text": "VisualizationSuggestion"
},
"<T>[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSuggestions.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SuggestionRequest",
"text": "SuggestionRequest"
},
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toExpression",
"type": "Function",
"tags": [],
"label": "toExpression",
"description": [],
"signature": [
"(state: T, datasourceLayers: Partial<Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatasourcePublicAPI",
"text": "DatasourcePublicAPI"
},
">>, attributes?: Partial<{ title: string; description: string; }> | undefined, datasourceExpressionsByLayers?: Record<string, ",
{
"pluginId": "@kbn/interpreter",
"scope": "common",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-common.Ast",
"text": "Ast"
},
"> | undefined) => string | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
" | null"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toExpression.$2",
"type": "Object",
"tags": [],
"label": "datasourceLayers",
"description": [],
"signature": [
"Partial<Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatasourcePublicAPI",
"text": "DatasourcePublicAPI"
},
">>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toExpression.$3",
"type": "Object",
"tags": [],
"label": "attributes",
"description": [],
"signature": [
"Partial<{ title: string; description: string; }> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toExpression.$4",
"type": "Object",
"tags": [],
"label": "datasourceExpressionsByLayers",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "@kbn/interpreter",
"scope": "common",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-common.Ast",
"text": "Ast"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toPreviewExpression",
"type": "Function",
"tags": [],
"label": "toPreviewExpression",
"description": [
"\nExpression to render a preview version of the chart in very constrained space.\nIf there is no expression provided, the preview icon is used."
],
"signature": [
"((state: T, datasourceLayers: Partial<Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatasourcePublicAPI",
"text": "DatasourcePublicAPI"
},
">>, datasourceExpressionsByLayers?: Record<string, ",
{
"pluginId": "@kbn/interpreter",
"scope": "common",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-common.Ast",
"text": "Ast"
},
"> | undefined) => string | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
" | null) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toPreviewExpression.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toPreviewExpression.$2",
"type": "Object",
"tags": [],
"label": "datasourceLayers",
"description": [],
"signature": [
"Partial<Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatasourcePublicAPI",
"text": "DatasourcePublicAPI"
},
">>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.toPreviewExpression.$3",
"type": "Object",
"tags": [],
"label": "datasourceExpressionsByLayers",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "@kbn/interpreter",
"scope": "common",
"docId": "kibKbnInterpreterPluginApi",
"section": "def-common.Ast",
"text": "Ast"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUserMessages",
"type": "Function",
"tags": [],
"label": "getUserMessages",
"description": [
"\nThe frame will call this function on all visualizations at few stages (pre-build/build error) in order\nto provide more context to the error and show it to the user"
],
"signature": [
"((state: T, deps: { frame: ",
"FramePublicAPI",
"; }) => ",
"UserMessage",
"[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUserMessages.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUserMessages.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getUserMessages.$2.frame",
"type": "Object",
"tags": [],
"label": "frame",
"description": [],
"signature": [
"FramePublicAPI"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onEditAction",
"type": "Function",
"tags": [],
"label": "onEditAction",
"description": [
"\nOn Edit events the frame will call this to know what's going to be the next visualization state"
],
"signature": [
"((state: T, event: ",
"LensEditEvent",
"<keyof ",
"LensEditContextMapping",
">) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onEditAction.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onEditAction.$2",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"LensEditEvent",
"<keyof ",
"LensEditContextMapping",
">"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternChange",
"type": "Function",
"tags": [],
"label": "onIndexPatternChange",
"description": [
"\nSome visualization track indexPattern changes (i.e. annotations)\nThis method makes it aware of the change and produces a new updated state"
],
"signature": [
"((state: T, indexPatternId: string, layerId?: string | undefined) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternChange.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternChange.$2",
"type": "string",
"tags": [],
"label": "indexPatternId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternChange.$3",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternRename",
"type": "Function",
"tags": [],
"label": "onIndexPatternRename",
"description": [],
"signature": [
"((state: T, oldIndexPatternId: string, newIndexPatternId: string) => T) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternRename.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternRename.$2",
"type": "string",
"tags": [],
"label": "oldIndexPatternId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.onIndexPatternRename.$3",
"type": "string",
"tags": [],
"label": "newIndexPatternId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayersToRemoveOnIndexPatternChange",
"type": "Function",
"tags": [],
"label": "getLayersToRemoveOnIndexPatternChange",
"description": [],
"signature": [
"((state: T) => string[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getLayersToRemoveOnIndexPatternChange.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getDisplayOptions",
"type": "Function",
"tags": [],
"label": "getDisplayOptions",
"description": [
"\nGets custom display options for showing the visualization."
],
"signature": [
"(() => ",
"VisualizationDisplayOptions",
") | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getRenderEventCounters",
"type": "Function",
"tags": [],
"label": "getRenderEventCounters",
"description": [
"\nGet RenderEventCounters events for telemetry"
],
"signature": [
"((state: T) => string[]) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getRenderEventCounters.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSuggestionFromConvertToLensContext",
"type": "Function",
"tags": [],
"label": "getSuggestionFromConvertToLensContext",
"description": [],
"signature": [
"((props: VisualizationStateFromContextChangeProps) => ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Suggestion",
"text": "Suggestion"
},
"<T, unknown> | undefined) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getSuggestionFromConvertToLensContext.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"VisualizationStateFromContextChangeProps"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual",
"type": "Function",
"tags": [],
"label": "isEqual",
"description": [],
"signature": [
"((state1: P, references1: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[], state2: P, references2: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[], annotationGroups: ",
"AnnotationGroups",
") => boolean) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual.$1",
"type": "Uncategorized",
"tags": [],
"label": "state1",
"description": [],
"signature": [
"P"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual.$2",
"type": "Array",
"tags": [],
"label": "references1",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual.$3",
"type": "Uncategorized",
"tags": [],
"label": "state2",
"description": [],
"signature": [
"P"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual.$4",
"type": "Array",
"tags": [],
"label": "references2",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.isEqual.$5",
"type": "Object",
"tags": [],
"label": "annotationGroups",
"description": [],
"signature": [
"AnnotationGroups"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getVisualizationInfo",
"type": "Function",
"tags": [],
"label": "getVisualizationInfo",
"description": [],
"signature": [
"((state: T, frame?: ",
"FramePublicAPI",
" | undefined) => ",
"VisualizationInfo",
") | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getVisualizationInfo.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getVisualizationInfo.$2",
"type": "Object",
"tags": [],
"label": "frame",
"description": [],
"signature": [
"FramePublicAPI",
" | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getReportingLayout",
"type": "Function",
"tags": [],
"label": "getReportingLayout",
"description": [
"\nA visualization can return custom dimensions for the reporting tool"
],
"signature": [
"((state: T) => { height: number; width: number; }) | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.Visualization.getReportingLayout.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion",
"type": "Interface",
"tags": [],
"label": "VisualizationSuggestion",
"description": [
"\nA possible configuration of a given visualization. It is based on a `TableSuggestion`.\nSuggestion might be shown in the UI to be chosen by the user directly, but they are\nalso applied directly under some circumstances (dragging in the first field from the data\npanel or switching to another visualization in the chart switcher)."
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.VisualizationSuggestion",
"text": "VisualizationSuggestion"
},
"<T>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.score",
"type": "number",
"tags": [],
"label": "score",
"description": [
"\nThe score of a suggestion should indicate how valuable the suggestion is. It is used\nto rank multiple suggestions of multiple visualizations. The number should be between 0 and 1"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.hide",
"type": "CompoundType",
"tags": [],
"label": "hide",
"description": [
"\nFlag indicating whether this suggestion should not be advertised to the user. It is still\nconsidered in scenarios where the available suggestion with the highest suggestion is applied\ndirectly."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.incomplete",
"type": "CompoundType",
"tags": [],
"label": "incomplete",
"description": [
"\nFlag indicating whether this suggestion is incomplete"
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.title",
"type": "string",
"tags": [],
"label": "title",
"description": [
"\nDescriptive title of the suggestion. Should be as short as possible. This title is shown if\nthe suggestion is advertised to the user and will also show either the `previewExpression` or\nthe `previewIcon`"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.state",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [
"\nThe new state of the visualization if this suggestion is applied."
],
"signature": [
"T"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.VisualizationSuggestion.previewIcon",
"type": "CompoundType",
"tags": [],
"label": "previewIcon",
"description": [
"\nAn EUI icon type shown instead of the preview expression."
],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs",
"type": "Interface",
"tags": [],
"label": "XYArgs",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XYArgs",
"text": "XYArgs"
},
" extends ",
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.DataLayerArgs",
"text": "DataLayerArgs"
}
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.legend",
"type": "CompoundType",
"tags": [],
"label": "legend",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.LegendConfig",
"text": "LegendConfig"
},
" & { type: \"legendConfig\"; }"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.endValue",
"type": "CompoundType",
"tags": [],
"label": "endValue",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.EndValue",
"text": "EndValue"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.emphasizeFitting",
"type": "CompoundType",
"tags": [],
"label": "emphasizeFitting",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.valueLabels",
"type": "CompoundType",
"tags": [],
"label": "valueLabels",
"description": [],
"signature": [
"\"hide\" | \"show\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.referenceLines",
"type": "Array",
"tags": [],
"label": "referenceLines",
"description": [],
"signature": [
"ReferenceLineConfigResult",
"[]"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.fittingFunction",
"type": "CompoundType",
"tags": [],
"label": "fittingFunction",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.FittingFunction",
"text": "FittingFunction"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.fillOpacity",
"type": "number",
"tags": [],
"label": "fillOpacity",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.hideEndzones",
"type": "CompoundType",
"tags": [],
"label": "hideEndzones",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.valuesInLegend",
"type": "CompoundType",
"tags": [],
"label": "valuesInLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.ariaLabel",
"type": "string",
"tags": [],
"label": "ariaLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.yAxisConfigs",
"type": "Array",
"tags": [],
"label": "yAxisConfigs",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.YAxisConfigResult",
"text": "YAxisConfigResult"
},
"[] | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.xAxisConfig",
"type": "CompoundType",
"tags": [],
"label": "xAxisConfig",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XAxisConfigResult",
"text": "XAxisConfigResult"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.addTimeMarker",
"type": "CompoundType",
"tags": [],
"label": "addTimeMarker",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.markSizeRatio",
"type": "number",
"tags": [],
"label": "markSizeRatio",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.minTimeBarInterval",
"type": "string",
"tags": [],
"label": "minTimeBarInterval",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.splitRowAccessor",
"type": "CompoundType",
"tags": [],
"label": "splitRowAccessor",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.splitColumnAccessor",
"type": "CompoundType",
"tags": [],
"label": "splitColumnAccessor",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.detailedTooltip",
"type": "CompoundType",
"tags": [],
"label": "detailedTooltip",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.orderBucketsBySum",
"type": "CompoundType",
"tags": [],
"label": "orderBucketsBySum",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYArgs.showTooltip",
"type": "boolean",
"tags": [],
"label": "showTooltip",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps",
"type": "Interface",
"tags": [],
"label": "XYChartProps",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.args",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"XYProps"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.syncTooltips",
"type": "boolean",
"tags": [],
"label": "syncTooltips",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.syncCursor",
"type": "boolean",
"tags": [],
"label": "syncCursor",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.syncColors",
"type": "boolean",
"tags": [],
"label": "syncColors",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.canNavigateToLens",
"type": "CompoundType",
"tags": [],
"label": "canNavigateToLens",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYChartProps.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"(Partial<Record<\"axisX\" | \"axisLeft\" | \"axisRight\", { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; title?: string | undefined; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; position?: ",
"Position",
" | undefined; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial<Record<\"chart\", { description?: string | undefined; title?: string | undefined; }>>) | undefined"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig",
"type": "Interface",
"tags": [],
"label": "XYDataLayerConfig",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.accessors",
"type": "Array",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.layerType",
"type": "string",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.seriesType",
"type": "CompoundType",
"tags": [],
"label": "seriesType",
"description": [],
"signature": [
"\"bar\" | \"line\" | \"area\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.xAccessor",
"type": "string",
"tags": [],
"label": "xAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.simpleView",
"type": "CompoundType",
"tags": [],
"label": "simpleView",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.yConfig",
"type": "Array",
"tags": [],
"label": "yConfig",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.YConfig",
"text": "YConfig"
},
"[] | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.splitAccessor",
"type": "string",
"tags": [],
"label": "splitAccessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }> | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.collapseFn",
"type": "CompoundType",
"tags": [],
"label": "collapseFn",
"description": [],
"signature": [
"CollapseFunction",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.xScaleType",
"type": "CompoundType",
"tags": [],
"label": "xScaleType",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XScaleType",
"text": "XScaleType"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.isHistogram",
"type": "CompoundType",
"tags": [],
"label": "isHistogram",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYDataLayerConfig.columnToLabel",
"type": "string",
"tags": [],
"label": "columnToLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYReferenceLineLayerConfig",
"type": "Interface",
"tags": [],
"label": "XYReferenceLineLayerConfig",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYReferenceLineLayerConfig.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYReferenceLineLayerConfig.accessors",
"type": "Array",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYReferenceLineLayerConfig.yConfig",
"type": "Array",
"tags": [],
"label": "yConfig",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.YConfig",
"text": "YConfig"
},
"[] | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYReferenceLineLayerConfig.layerType",
"type": "string",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"referenceLine\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYRender",
"type": "Interface",
"tags": [],
"label": "XYRender",
"description": [],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYRender.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"render\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYRender.as",
"type": "string",
"tags": [],
"label": "as",
"description": [],
"signature": [
"\"xyVis\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYRender.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XYChartProps",
"text": "XYChartProps"
}
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState",
"type": "Interface",
"tags": [],
"label": "XYState",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYState.preferredSeriesType",
"type": "CompoundType",
"tags": [],
"label": "preferredSeriesType",
"description": [],
"signature": [
"\"bar\" | \"line\" | \"area\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.legend",
"type": "Object",
"tags": [],
"label": "legend",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.LegendConfig",
"text": "LegendConfig"
}
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.valueLabels",
"type": "CompoundType",
"tags": [],
"label": "valueLabels",
"description": [],
"signature": [
"ValueLabelConfig",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.fittingFunction",
"type": "CompoundType",
"tags": [],
"label": "fittingFunction",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.FittingFunction",
"text": "FittingFunction"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.emphasizeFitting",
"type": "CompoundType",
"tags": [],
"label": "emphasizeFitting",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.endValue",
"type": "CompoundType",
"tags": [],
"label": "endValue",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.EndValue",
"text": "EndValue"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.xExtent",
"type": "Object",
"tags": [],
"label": "xExtent",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.AxisExtentConfig",
"text": "AxisExtentConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yLeftExtent",
"type": "Object",
"tags": [],
"label": "yLeftExtent",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.AxisExtentConfig",
"text": "AxisExtentConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yRightExtent",
"type": "Object",
"tags": [],
"label": "yRightExtent",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.AxisExtentConfig",
"text": "AxisExtentConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.layers",
"type": "Array",
"tags": [],
"label": "layers",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYLayerConfig",
"text": "XYLayerConfig"
},
"[]"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.xTitle",
"type": "string",
"tags": [],
"label": "xTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yTitle",
"type": "string",
"tags": [],
"label": "yTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yRightTitle",
"type": "string",
"tags": [],
"label": "yRightTitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yLeftScale",
"type": "CompoundType",
"tags": [],
"label": "yLeftScale",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.YScaleType",
"text": "YScaleType"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yRightScale",
"type": "CompoundType",
"tags": [],
"label": "yRightScale",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.YScaleType",
"text": "YScaleType"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.axisTitlesVisibilitySettings",
"type": "Object",
"tags": [],
"label": "axisTitlesVisibilitySettings",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.AxesSettingsConfig",
"text": "AxesSettingsConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.tickLabelsVisibilitySettings",
"type": "Object",
"tags": [],
"label": "tickLabelsVisibilitySettings",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.AxesSettingsConfig",
"text": "AxesSettingsConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.gridlinesVisibilitySettings",
"type": "Object",
"tags": [],
"label": "gridlinesVisibilitySettings",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.AxesSettingsConfig",
"text": "AxesSettingsConfig"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.labelsOrientation",
"type": "Object",
"tags": [],
"label": "labelsOrientation",
"description": [],
"signature": [
"LabelsOrientationConfig",
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.curveType",
"type": "CompoundType",
"tags": [],
"label": "curveType",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.XYCurveType",
"text": "XYCurveType"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.fillOpacity",
"type": "number",
"tags": [],
"label": "fillOpacity",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.hideEndzones",
"type": "CompoundType",
"tags": [],
"label": "hideEndzones",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.showCurrentTimeMarker",
"type": "CompoundType",
"tags": [],
"label": "showCurrentTimeMarker",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.valuesInLegend",
"type": "CompoundType",
"tags": [],
"label": "valuesInLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig",
"type": "Interface",
"tags": [],
"label": "YConfig",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.YConfig.forAccessor",
"type": "string",
"tags": [],
"label": "forAccessor",
"description": [],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.lineWidth",
"type": "number",
"tags": [],
"label": "lineWidth",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.lineStyle",
"type": "CompoundType",
"tags": [],
"label": "lineStyle",
"description": [],
"signature": [
"\"solid\" | \"dashed\" | \"dotted\" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.fill",
"type": "CompoundType",
"tags": [],
"label": "fill",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.FillStyle",
"text": "FillStyle"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.iconPosition",
"type": "CompoundType",
"tags": [],
"label": "iconPosition",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.IconPosition",
"text": "IconPosition"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.textVisibility",
"type": "CompoundType",
"tags": [],
"label": "textVisibility",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.YConfig.axisMode",
"type": "CompoundType",
"tags": [],
"label": "axisMode",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.YAxisMode",
"text": "YAxisMode"
},
" | undefined"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "lens",
"id": "def-public.AvgIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "AvgIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"average\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentConfigResult",
"type": "Type",
"tags": [],
"label": "AxisExtentConfigResult",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.AxisExtentConfig",
"text": "AxisExtentConfig"
},
" & { type: \"axisExtentConfig\"; }"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxisExtentMode",
"type": "Type",
"tags": [],
"label": "AxisExtentMode",
"description": [],
"signature": [
"\"full\" | \"custom\" | \"dataBounds\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CounterRateIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CounterRateIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"counter_rate\"; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/counter_rate.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CountIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CountIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"count\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/count.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CumulativeSumIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CumulativeSumIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"cumulative_sum\"; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/cumulative_sum.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataLayerConfig",
"type": "Type",
"tags": [],
"label": "DataLayerConfig",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.DataLayerArgs",
"text": "DataLayerArgs"
},
", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>; table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; } & ",
"WithLayerId"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataType",
"type": "Type",
"tags": [],
"label": "DataType",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"date\" | ",
"FieldOnlyDataType"
],
"path": "x-pack/plugins/lens/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DerivativeIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "DerivativeIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"differences\"; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/differences.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.EmbeddableComponentProps",
"type": "Type",
"tags": [],
"label": "EmbeddableComponentProps",
"description": [],
"signature": [
"(",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TypedLensByValueInput",
"text": "TypedLensByValueInput"
},
" | ",
"LensByReferenceInput",
") & { withDefaultActions?: boolean | undefined; extraActions?: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[] | undefined; showInspector?: boolean | undefined; }"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FillStyle",
"type": "Type",
"tags": [],
"label": "FillStyle",
"description": [],
"signature": [
"\"none\" | \"above\" | \"below\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FittingFunction",
"type": "Type",
"tags": [],
"label": "FittingFunction",
"description": [],
"signature": [
"\"None\" | \"Average\" | \"Zero\" | \"Nearest\" | \"Linear\" | \"Carry\" | \"Lookahead\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.GaugeVisualizationState",
"type": "Type",
"tags": [],
"label": "GaugeVisualizationState",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeState",
"text": "GaugeState"
},
", \"min\" | \"max\" | \"metric\" | \"goal\"> & { metricAccessor?: string | undefined; minAccessor?: string | undefined; maxAccessor?: string | undefined; goalAccessor?: string | undefined; } & { layerId: string; layerType: ",
"LayerType",
"; }"
],
"path": "x-pack/plugins/lens/public/visualizations/gauge/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.GenericIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "GenericIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" | ",
"BaseIndexPatternColumn",
" | ",
"ReferenceBasedIndexPatternColumn"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.HeatmapVisualizationState",
"type": "Type",
"tags": [],
"label": "HeatmapVisualizationState",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "expressionHeatmap",
"scope": "common",
"docId": "kibExpressionHeatmapPluginApi",
"section": "def-common.HeatmapArguments",
"text": "HeatmapArguments"
},
", \"palette\"> & { layerId: string; layerType: ",
"LayerType",
"; valueAccessor?: string | undefined; xAccessor?: string | undefined; yAccessor?: string | undefined; shape: \"heatmap\"; } & { palette?: ",
"Palette",
" | undefined; }"
],
"path": "x-pack/plugins/lens/public/visualizations/heatmap/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.IconPosition",
"type": "Type",
"tags": [],
"label": "IconPosition",
"description": [],
"signature": [
"\"left\" | \"right\" | \"above\" | \"below\" | \"auto\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LayerType",
"type": "Type",
"tags": [],
"label": "LayerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfigResult",
"type": "Type",
"tags": [],
"label": "LegendConfigResult",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.LegendConfig",
"text": "LegendConfig"
},
" & { type: \"legendConfig\"; }"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LENS_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "LENS_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"lens\""
],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensEmbeddableInput",
"type": "Type",
"tags": [],
"label": "LensEmbeddableInput",
"description": [],
"signature": [
"LensByValueInput",
" | ",
"LensByReferenceInput"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensSavedObjectAttributes",
"type": "Type",
"tags": [],
"label": "LensSavedObjectAttributes",
"description": [],
"signature": [
"{ description?: string | undefined; title: string; state: { datasourceStates: Record<string, unknown>; visualization: unknown; query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; adHocDataViews?: Record<string, ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
"> | undefined; internalReferences?: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined; }; references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; visualizationType: string | null; }"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensSuggestionsApi",
"type": "Type",
"tags": [],
"label": "LensSuggestionsApi",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.VisualizeFieldContext",
"text": "VisualizeFieldContext"
},
" | ",
"VisualizeEditorContext",
"<",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.Configuration",
"text": "Configuration"
},
">, dataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
", excludedVisualizations?: string[] | undefined) => ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Suggestion",
"text": "Suggestion"
},
"<unknown, unknown>[] | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LensSuggestionsApi.$1",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.VisualizeFieldContext",
"text": "VisualizeFieldContext"
},
" | ",
"VisualizeEditorContext",
"<",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.Configuration",
"text": "Configuration"
},
">"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensSuggestionsApi.$2",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensSuggestionsApi.$3",
"type": "Array",
"tags": [],
"label": "excludedVisualizations",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/lens/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LineStyle",
"type": "Type",
"tags": [],
"label": "LineStyle",
"description": [],
"signature": [
"\"solid\" | \"dashed\" | \"dotted\" | \"dot-dashed\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MaxIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MaxIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"max\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MedianIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MedianIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"median\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MinIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MinIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"min\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MovingAverageIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MovingAverageIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"moving_average\"; params: { window: number; }; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/moving_average.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationType",
"type": "Type",
"tags": [],
"label": "OperationType",
"description": [
"\nA union type of all available operation types. The operation type is a unique id of an operation.\nEach column is assigned to exactly one operation type."
],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.OverallSumIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "OverallSumIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"overall_sum\"; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/overall_metric.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PersistedIndexPatternLayer",
"type": "Type",
"tags": [],
"label": "PersistedIndexPatternLayer",
"description": [],
"signature": [
"{ columns: Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.GenericIndexPatternColumn",
"text": "GenericIndexPatternColumn"
},
">; ignoreGlobalFilters?: boolean | undefined; columnOrder: string[]; linkToLayers?: string[] | undefined; incompleteColumns?: Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.IncompleteColumn",
"text": "IncompleteColumn"
},
"> | undefined; sampling?: number | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieLayerState",
"type": "Type",
"tags": [],
"label": "PieLayerState",
"description": [],
"signature": [
"SharedPieLayerState",
" & { layerId: string; layerType: ",
"LayerType",
"; }"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ReferenceLineLayerConfig",
"type": "Type",
"tags": [],
"label": "ReferenceLineLayerConfig",
"description": [],
"signature": [
{
"pluginId": "expressionXY",
"scope": "common",
"docId": "kibExpressionXYPluginApi",
"section": "def-common.ReferenceLineLayerArgs",
"text": "ReferenceLineLayerArgs"
},
" & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; } & ",
"WithLayerId"
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SeriesType",
"type": "Type",
"tags": [],
"label": "SeriesType",
"description": [],
"signature": [
"\"bar\" | \"line\" | \"area\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.StandardDeviationIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "StandardDeviationIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"standard_deviation\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SumIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "SumIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"sum\"; params?: { emptyAsNull?: boolean | undefined; format?: ",
"ValueFormatConfig",
" | undefined; } | undefined; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/metrics.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.TimeScaleIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "TimeScaleIndexPatternColumn",
"description": [],
"signature": [
"FormattedIndexPatternColumn",
" & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"normalize_by_unit\"; params: { unit?: string | undefined; }; }"
],
"path": "x-pack/plugins/lens/public/datasources/form_based/operations/definitions/calculations/time_scale.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.TypedLensByValueInput",
"type": "Type",
"tags": [],
"label": "TypedLensByValueInput",
"description": [
"\nType-safe variant of by value embeddable input for Lens.\nThis can be used to hardcode certain Lens chart configurations within another app."
],
"signature": [
"Omit<",
"LensByValueInput",
", \"attributes\" | \"overrides\"> & { attributes: LensAttributes<\"lnsXY\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYState",
"text": "XYState"
},
"> | LensAttributes<\"lnsPie\", ",
"PieVisualizationState",
"> | LensAttributes<\"lnsHeatmap\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.HeatmapVisualizationState",
"text": "HeatmapVisualizationState"
},
"> | LensAttributes<\"lnsGauge\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.GaugeVisualizationState",
"text": "GaugeVisualizationState"
},
"> | LensAttributes<\"lnsDatatable\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatatableVisualizationState",
"text": "DatatableVisualizationState"
},
"> | LensAttributes<\"lnsLegacyMetric\", ",
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.LegacyMetricState",
"text": "LegacyMetricState"
},
"> | LensAttributes<\"lnsMetric\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MetricVisualizationState",
"text": "MetricVisualizationState"
},
"> | LensAttributes<string, unknown>; overrides?: Partial<Record<\"settings\", { debug?: boolean | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ",
"Rendering",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; pointBuffer?: ",
"MarkBuffer",
" | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | Partial<Record<\"gauge\", { id: string; subtype: ",
"GoalSubtype",
"; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"GoalDomainRange",
">; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ",
"GoalLabelAccessor",
" | undefined; labelMinor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMajor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMinor?: string | ",
"GoalLabelAccessor",
" | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; }>> | Partial<Record<\"partition\", { animation?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<{ duration: number; } | undefined>; valueGetter?: ",
"ValueGetter",
" | undefined; fillOutside?: boolean | undefined; radiusOutside?: number | undefined; fillRectangleWidth?: number | undefined; fillRectangleHeight?: number | undefined; topGroove?: number | undefined; percentFormatter?: \"ignore\" | undefined; clockwiseSectors?: boolean | undefined; maxRowCount?: number | undefined; specialFirstInnermostSector?: boolean | undefined; smallMultiples?: string | undefined; drilldown?: boolean | undefined; }>> | Partial<Record<\"axisX\" | \"axisLeft\" | \"axisRight\", { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; style?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"RecursivePartial",
"<Omit<",
"AxisStyle",
", \"gridLine\">> | undefined>; title?: string | undefined; gridLine?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<Partial<",
"GridLineStyle",
"> | undefined>; position?: ",
"Position",
" | undefined; ticks?: number | undefined; domain?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"YDomainRange",
" | undefined>; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> | undefined; }"
],
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ValidLayer",
"type": "Type",
"tags": [],
"label": "ValidLayer",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYReferenceLineLayerConfig",
"text": "XYReferenceLineLayerConfig"
},
" | ",
"ValidXYDataLayerConfig"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ValueLabelConfig",
"type": "Type",
"tags": [],
"label": "ValueLabelConfig",
"description": [],
"signature": [
"\"hide\" | \"show\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ValueLabelMode",
"type": "Type",
"tags": [],
"label": "ValueLabelMode",
"description": [],
"signature": [
"\"hide\" | \"show\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XScaleType",
"type": "Type",
"tags": [],
"label": "XScaleType",
"description": [],
"signature": [
"\"time\" | \"linear\" | \"ordinal\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYAnnotationLayerConfig",
"type": "Type",
"tags": [],
"label": "XYAnnotationLayerConfig",
"description": [],
"signature": [
"XYByValueAnnotationLayerConfig",
" | ",
"XYByReferenceAnnotationLayerConfig"
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYCurveType",
"type": "Type",
"tags": [],
"label": "XYCurveType",
"description": [],
"signature": [
"\"LINEAR\" | \"CURVE_MONOTONE_X\" | \"CURVE_STEP_AFTER\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig",
"type": "Type",
"tags": [],
"label": "XYLayerConfig",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYDataLayerConfig",
"text": "XYDataLayerConfig"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYReferenceLineLayerConfig",
"text": "XYReferenceLineLayerConfig"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYAnnotationLayerConfig",
"text": "XYAnnotationLayerConfig"
}
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.YAxisMode",
"type": "Type",
"tags": [],
"label": "YAxisMode",
"description": [],
"signature": [
"\"left\" | \"right\" | \"bottom\" | \"auto\""
],
"path": "x-pack/plugins/lens/public/visualizations/xy/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.YScaleType",
"type": "Type",
"tags": [],
"label": "YScaleType",
"description": [],
"signature": [
"\"log\" | \"time\" | \"linear\" | \"sqrt\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "lens",
"id": "def-public.layerTypes",
"type": "Object",
"tags": [],
"label": "layerTypes",
"description": [],
"signature": [
"{ readonly DATA: \"data\"; readonly REFERENCELINE: \"referenceLine\"; readonly ANNOTATIONS: \"annotations\"; readonly METRIC_TRENDLINE: \"metricTrendline\"; }"
],
"path": "x-pack/plugins/lens/common/layer_types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715",
"type": "Interface",
"tags": [],
"label": "LensDocShape715",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensDocShape715",
"text": "LensDocShape715"
},
"<VisualizationState>"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.visualizationType",
"type": "CompoundType",
"tags": [],
"label": "visualizationType",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-server.LensDocShape715.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record<string, { columnOrder: string[]; columns: Record<string, Record<string, unknown>>; }>; }; }; visualization: VisualizationState; query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"; filters: ",
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.PersistableFilter",
"text": "PersistableFilter"
},
"[]; }"
],
"path": "x-pack/plugins/lens/server/migrations/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup",
"type": "Interface",
"tags": [],
"label": "LensServerPluginSetup",
"description": [],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup.lensEmbeddableFactory",
"type": "Function",
"tags": [],
"label": "lensEmbeddableFactory",
"description": [
"\nServer side embeddable definition which provides migrations to run if Lens state is embedded into another saved object somewhere"
],
"signature": [
"() => ",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableRegistryDefinition",
"text": "EmbeddableRegistryDefinition"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
">"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup.registerVisualizationMigration",
"type": "Function",
"tags": [],
"label": "registerVisualizationMigration",
"description": [
"\nRegister custom migration functions for custom third party Lens visualizations"
],
"signature": [
"(id: string, migrationsGetter: () => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
},
") => void"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup.registerVisualizationMigration.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPluginSetup.registerVisualizationMigration.$2",
"type": "Function",
"tags": [],
"label": "migrationsGetter",
"description": [],
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
}
],
"path": "x-pack/plugins/lens/server/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState",
"type": "Interface",
"tags": [],
"label": "LegacyMetricState",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.autoScaleMetricAlignment",
"type": "CompoundType",
"tags": [],
"label": "autoScaleMetricAlignment",
"description": [],
"signature": [
"\"left\" | \"right\" | \"center\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.accessor",
"type": "string",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.layerType",
"type": "CompoundType",
"tags": [],
"label": "layerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\""
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.colorMode",
"type": "CompoundType",
"tags": [],
"label": "colorMode",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.ColorMode",
"text": "ColorMode"
},
" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
"> | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.titlePosition",
"type": "CompoundType",
"tags": [],
"label": "titlePosition",
"description": [],
"signature": [
"\"top\" | \"bottom\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.size",
"type": "string",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "lens",
"id": "def-common.LegacyMetricState.textAlign",
"type": "CompoundType",
"tags": [],
"label": "textAlign",
"description": [],
"signature": [
"\"left\" | \"right\" | \"center\" | undefined"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.PersistableFilter",
"type": "Interface",
"tags": [],
"label": "PersistableFilter",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.PersistableFilter",
"text": "PersistableFilter"
},
" extends ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.PersistableFilter.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
"PersistableFilterMeta"
],
"path": "x-pack/plugins/lens/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "lens",
"id": "def-common.DOCUMENT_FIELD_NAME",
"type": "string",
"tags": [],
"label": "DOCUMENT_FIELD_NAME",
"description": [],
"signature": [
"\"___records___\""
],
"path": "x-pack/plugins/lens/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink