kibana/api_docs/lens.json
Stacey Gammon 8fba2d93a6
Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823)
* Make sure arrow functions capture parameter comments.

* Update docs
2021-05-28 11:56:31 -04:00

3466 lines
109 KiB
JSON

{
"id": "lens",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig",
"type": "Interface",
"tags": [],
"label": "AxesSettingsConfig",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 83
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig.x",
"type": "boolean",
"tags": [],
"label": "x",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 84
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig.yLeft",
"type": "boolean",
"tags": [],
"label": "yLeft",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 85
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.AxesSettingsConfig.yRight",
"type": "boolean",
"tags": [],
"label": "yRight",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 86
},
"deprecated": 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 ",
"FormattedIndexPatternColumn",
",",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.CardinalityIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"unique_count\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
"lineNumber": 48
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState",
"type": "Interface",
"tags": [],
"label": "DatatableVisualizationState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 42
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"ColumnState",
"[]"
],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 43
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.DatatableVisualizationState.sorting",
"type": "Object",
"tags": [],
"label": "sorting",
"description": [],
"signature": [
"SortingState",
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 45
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 43
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.DateHistogramIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"date_histogram\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.DateHistogramIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ interval: string; timeZone?: string | undefined; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 45
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 73
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.FiltersIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"filters\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 74
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.FiltersIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ filters: ",
"Filter",
"[]; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 75
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn",
"type": "Interface",
"tags": [],
"label": "IncompleteColumn",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 45
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn.operationType",
"type": "CompoundType",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"math\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | \"formula\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 46
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.IncompleteColumn.sourceField",
"type": "string",
"tags": [],
"label": "sourceField",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 47
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.IndexPatternPersistedState",
"type": "Interface",
"tags": [],
"label": "IndexPatternPersistedState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 73
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.IndexPatternPersistedState.layers",
"type": "Object",
"tags": [],
"label": "layers",
"description": [],
"signature": [
"{ [x: string]: Pick<",
"IndexPatternLayer",
", \"columns\" | \"columnOrder\" | \"incompleteColumns\">; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 74
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
"lineNumber": 80
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.LastValueIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"last_value\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
"lineNumber": 81
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LastValueIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ sortField: string; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
"lineNumber": 82
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig",
"type": "Interface",
"tags": [],
"label": "LegendConfig",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 26
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.LegendConfig.position",
"type": "CompoundType",
"tags": [],
"label": "position",
"description": [
"\nPosition of the legend relative to the chart"
],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 34
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.LensPublicStart",
"type": "Interface",
"tags": [],
"label": "LensPublicStart",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 83
},
"deprecated": 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"
},
">"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 92
},
"deprecated": false
},
{
"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: ",
"LensEmbeddableInput",
", openInNewTab?: boolean | undefined) => void"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 101
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "lens",
"id": "def-public.input",
"type": "CompoundType",
"tags": [],
"label": "input",
"description": [],
"signature": [
"LensByValueInput",
" | ",
"LensByReferenceInput"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 101
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.openInNewTab",
"type": "CompoundType",
"tags": [],
"label": "openInNewTab",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 101
},
"deprecated": false
}
]
},
{
"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"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 105
},
"deprecated": false,
"returnComment": [],
"children": []
},
{
"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",
"[]>"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 110
},
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricState",
"type": "Interface",
"tags": [],
"label": "MetricState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.MetricState.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 9
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.MetricState.accessor",
"type": "string",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 10
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata",
"type": "Interface",
"tags": [],
"label": "OperationMetadata",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/types.ts",
"lineNumber": 363
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.dataType",
"type": "CompoundType",
"tags": [],
"label": "dataType",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"histogram\" | \"document\""
],
"source": {
"path": "x-pack/plugins/lens/public/types.ts",
"lineNumber": 365
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.OperationMetadata.isBucketed",
"type": "boolean",
"tags": [],
"label": "isBucketed",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/types.ts",
"lineNumber": 368
},
"deprecated": 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\" | \"ordinal\" | \"ratio\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/types.ts",
"lineNumber": 374
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.PercentileIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"percentile\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
"lineNumber": 25
},
"deprecated": 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; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
"lineNumber": 26
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState",
"type": "Interface",
"tags": [],
"label": "PieVisualizationState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.shape",
"type": "CompoundType",
"tags": [],
"label": "shape",
"description": [],
"signature": [
"\"donut\" | \"pie\" | \"treemap\""
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.layers",
"type": "Array",
"tags": [],
"label": "layers",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PieLayerState",
"text": "PieLayerState"
},
"[]"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieVisualizationState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<unknown> | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 29
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx",
"lineNumber": 36
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.RangeIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"range\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx",
"lineNumber": 37
},
"deprecated": 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; parentFormat?: { id: string; params?: { id?: string | undefined; template?: string | undefined; replaceInfinity?: boolean | undefined; } | undefined; } | undefined; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx",
"lineNumber": 38
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState",
"type": "Interface",
"tags": [],
"label": "SharedPieLayerState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 11
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.groups",
"type": "Array",
"tags": [],
"label": "groups",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.metric",
"type": "string",
"tags": [],
"label": "metric",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 13
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.numberDisplay",
"type": "CompoundType",
"tags": [],
"label": "numberDisplay",
"description": [],
"signature": [
"\"hidden\" | \"value\" | \"percent\""
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 14
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.categoryDisplay",
"type": "CompoundType",
"tags": [],
"label": "categoryDisplay",
"description": [],
"signature": [
"\"default\" | \"hide\" | \"inside\""
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 15
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendDisplay",
"type": "CompoundType",
"tags": [],
"label": "legendDisplay",
"description": [],
"signature": [
"\"default\" | \"hide\" | \"show\""
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.legendPosition",
"type": "CompoundType",
"tags": [],
"label": "legendPosition",
"description": [],
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.nestedLegend",
"type": "CompoundType",
"tags": [],
"label": "nestedLegend",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.SharedPieLayerState.percentDecimals",
"type": "number",
"tags": [],
"label": "percentDecimals",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 19
},
"deprecated": 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"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx",
"lineNumber": 56
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.TermsIndexPatternColumn.operationType",
"type": "string",
"tags": [],
"label": "operationType",
"description": [],
"signature": [
"\"terms\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx",
"lineNumber": 57
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.TermsIndexPatternColumn.params",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ size: number; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx",
"lineNumber": 58
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig",
"type": "Interface",
"tags": [],
"label": "XYLayerConfig",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 424
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.hide",
"type": "CompoundType",
"tags": [],
"label": "hide",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 425
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.layerId",
"type": "string",
"tags": [],
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 426
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.xAccessor",
"type": "string",
"tags": [],
"label": "xAccessor",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 427
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.accessors",
"type": "Array",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 428
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.yConfig",
"type": "Array",
"tags": [],
"label": "yConfig",
"description": [],
"signature": [
"YConfig",
"[] | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 429
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.seriesType",
"type": "CompoundType",
"tags": [],
"label": "seriesType",
"description": [],
"signature": [
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 430
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.splitAccessor",
"type": "string",
"tags": [],
"label": "splitAccessor",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 431
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYLayerConfig.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<unknown> | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 432
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState",
"type": "Interface",
"tags": [],
"label": "XYState",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 474
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-public.XYState.preferredSeriesType",
"type": "CompoundType",
"tags": [],
"label": "preferredSeriesType",
"description": [],
"signature": [
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 475
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.legend",
"type": "Object",
"tags": [],
"label": "legend",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LegendConfig",
"text": "LegendConfig"
}
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 476
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.valueLabels",
"type": "CompoundType",
"tags": [],
"label": "valueLabels",
"description": [],
"signature": [
"\"hide\" | \"inside\" | \"outside\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 477
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.fittingFunction",
"type": "CompoundType",
"tags": [],
"label": "fittingFunction",
"description": [],
"signature": [
"\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 478
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yLeftExtent",
"type": "Object",
"tags": [],
"label": "yLeftExtent",
"description": [],
"signature": [
"AxisExtentConfig",
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 479
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yRightExtent",
"type": "Object",
"tags": [],
"label": "yRightExtent",
"description": [],
"signature": [
"AxisExtentConfig",
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 480
},
"deprecated": 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"
},
"[]"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 481
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.xTitle",
"type": "string",
"tags": [],
"label": "xTitle",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 482
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yTitle",
"type": "string",
"tags": [],
"label": "yTitle",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 483
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.yRightTitle",
"type": "string",
"tags": [],
"label": "yRightTitle",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 484
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 485
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 486
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 487
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.curveType",
"type": "CompoundType",
"tags": [],
"label": "curveType",
"description": [],
"signature": [
"\"LINEAR\" | \"CURVE_MONOTONE_X\" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 488
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.fillOpacity",
"type": "number",
"tags": [],
"label": "fillOpacity",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 489
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.hideEndzones",
"type": "CompoundType",
"tags": [],
"label": "hideEndzones",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 490
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "lens",
"id": "def-public.AvgIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "AvgIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"average\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 132
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CounterRateIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CounterRateIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"counter_rate\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx",
"lineNumber": 35
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CountIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CountIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"count\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx",
"lineNumber": 24
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.CumulativeSumIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "CumulativeSumIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"cumulative_sum\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx",
"lineNumber": 33
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DataType",
"type": "Type",
"tags": [],
"label": "DataType",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"date\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"histogram\" | \"document\""
],
"source": {
"path": "x-pack/plugins/lens/public/types.ts",
"lineNumber": 352
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.DerivativeIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "DerivativeIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"differences\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/differences.tsx",
"lineNumber": 37
},
"deprecated": 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"
],
"source": {
"path": "x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx",
"lineNumber": 46
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.FieldBasedIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "FieldBasedIndexPatternColumn",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeIndexPatternColumn",
"text": "RangeIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TermsIndexPatternColumn",
"text": "TermsIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DateHistogramIndexPatternColumn",
"text": "DateHistogramIndexPatternColumn"
},
" | MetricColumn<\"min\"> | MetricColumn<\"max\"> | MetricColumn<\"average\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
},
" | MetricColumn<\"sum\"> | MetricColumn<\"median\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileIndexPatternColumn",
"text": "PercentileIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CountIndexPatternColumn",
"text": "CountIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LastValueIndexPatternColumn",
"text": "LastValueIndexPatternColumn"
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 79
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.IndexPatternColumn",
"type": "Type",
"tags": [],
"label": "IndexPatternColumn",
"description": [
"\nA union type of all available column types. If a column is of an unknown type somewhere\nwithing the indexpattern data source it should be typed as `IndexPatternColumn` to make\ntypeguards possible that consider all available column types."
],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FiltersIndexPatternColumn",
"text": "FiltersIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeIndexPatternColumn",
"text": "RangeIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TermsIndexPatternColumn",
"text": "TermsIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DateHistogramIndexPatternColumn",
"text": "DateHistogramIndexPatternColumn"
},
" | MetricColumn<\"min\"> | MetricColumn<\"max\"> | MetricColumn<\"average\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
},
" | MetricColumn<\"sum\"> | MetricColumn<\"median\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileIndexPatternColumn",
"text": "PercentileIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CountIndexPatternColumn",
"text": "CountIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LastValueIndexPatternColumn",
"text": "LastValueIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CumulativeSumIndexPatternColumn",
"text": "CumulativeSumIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CounterRateIndexPatternColumn",
"text": "CounterRateIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DerivativeIndexPatternColumn",
"text": "DerivativeIndexPatternColumn"
},
" | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MovingAverageIndexPatternColumn",
"text": "MovingAverageIndexPatternColumn"
},
" | ",
"MathIndexPatternColumn",
" | ",
"FormulaIndexPatternColumn"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 58
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MaxIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MaxIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"max\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 134
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MedianIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MedianIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"median\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 135
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MinIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MinIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"min\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 133
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.MovingAverageIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "MovingAverageIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
"ReferenceBasedIndexPatternColumn",
" & { operationType: \"moving_average\"; params: { window: number; }; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx",
"lineNumber": 47
},
"deprecated": 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": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"average\" | \"percentile\" | \"terms\" | \"median\" | \"cumulative_sum\" | \"moving_average\" | \"math\" | \"counter_rate\" | \"differences\" | \"unique_count\" | \"last_value\" | \"formula\""
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 498
},
"deprecated": 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.IndexPatternColumn",
"text": "IndexPatternColumn"
},
">; columnOrder: string[]; incompleteColumns?: Record<string, ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.IncompleteColumn",
"text": "IncompleteColumn"
},
"> | undefined; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 77
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.PieLayerState",
"type": "Type",
"tags": [],
"label": "PieLayerState",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SharedPieLayerState",
"text": "SharedPieLayerState"
},
" & { layerId: string; }"
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SeriesType",
"type": "Type",
"tags": [],
"label": "SeriesType",
"description": [],
"signature": [
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 402
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.SumIndexPatternColumn",
"type": "Type",
"tags": [],
"label": "SumIndexPatternColumn",
"description": [],
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FieldBasedIndexPatternColumn",
"text": "FieldBasedIndexPatternColumn"
},
" & { operationType: \"sum\"; }"
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 131
},
"deprecated": 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": [
"Pick<",
"LensByValueInput",
", \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"onLoad\" | \"renderMode\" | \"onBrushEnd\" | \"onFilter\" | \"onTableRowClick\"> & { attributes: LensAttributes<\"lnsXY\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYState",
"text": "XYState"
},
"> | LensAttributes<\"lnsPie\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PieVisualizationState",
"text": "PieVisualizationState"
},
"> | LensAttributes<\"lnsDatatable\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DatatableVisualizationState",
"text": "DatatableVisualizationState"
},
"> | LensAttributes<\"lnsMetric\", ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MetricState",
"text": "MetricState"
},
">; }"
],
"source": {
"path": "x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx",
"lineNumber": 38
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.ValueLabelConfig",
"type": "Type",
"tags": [],
"label": "ValueLabelConfig",
"description": [],
"signature": [
"\"hide\" | \"inside\" | \"outside\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 416
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYCurveType",
"type": "Type",
"tags": [],
"label": "XYCurveType",
"description": [],
"signature": [
"\"LINEAR\" | \"CURVE_MONOTONE_X\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 471
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-public.YAxisMode",
"type": "Type",
"tags": [],
"label": "YAxisMode",
"description": [],
"signature": [
"\"left\" | \"right\" | \"auto\""
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 414
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin",
"type": "Class",
"tags": [],
"label": "LensServerPlugin",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.LensServerPlugin",
"text": "LensServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<{}, {}, {}, {}>"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
},
", unknown>, plugins: ",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
},
") => {}"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
},
", unknown>"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
", plugins: ",
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
},
") => {}"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "lens",
"id": "def-server.LensServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 66
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract",
"type": "Interface",
"tags": [],
"label": "PluginSetupContract",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract.usageCollection",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract.taskManager",
"type": "CompoundType",
"tags": [],
"label": "taskManager",
"description": [],
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerSetupContract",
"text": "TaskManagerSetupContract"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 23
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginStartContract",
"type": "Interface",
"tags": [],
"label": "PluginStartContract",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-server.PluginStartContract.taskManager",
"type": "CompoundType",
"tags": [],
"label": "taskManager",
"description": [],
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerStartContract",
"text": "TaskManagerStartContract"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginStartContract.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 28
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "lens",
"id": "def-common.getBasePath",
"type": "Function",
"tags": [],
"label": "getBasePath",
"description": [],
"signature": [
"() => string"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.getEditPath",
"type": "Function",
"tags": [],
"label": "getEditPath",
"description": [],
"signature": [
"(id: string | undefined, timeRange: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => string"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 25
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.getEditPath.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 25
},
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "lens",
"id": "def-common.getEditPath.$2",
"type": "Object",
"tags": [],
"label": "timeRange",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 25
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.getFullPath",
"type": "Function",
"tags": [],
"label": "getFullPath",
"description": [],
"signature": [
"(id: string | undefined) => string"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.getFullPath.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 37
},
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "lens",
"id": "def-common.BucketedAggregation",
"type": "Interface",
"tags": [],
"label": "BucketedAggregation",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType>"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.BucketedAggregation.buckets",
"type": "Array",
"tags": [],
"label": "buckets",
"description": [],
"signature": [
"{ key: KeyType; count: number; }[]"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 9
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.DateRange",
"type": "Interface",
"tags": [],
"label": "DateRange",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.DateRange.fromDate",
"type": "string",
"tags": [],
"label": "fromDate",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.DateRange.toDate",
"type": "string",
"tags": [],
"label": "toDate",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 17
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.ExistingFields",
"type": "Interface",
"tags": [],
"label": "ExistingFields",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.ExistingFields.indexPatternTitle",
"type": "string",
"tags": [],
"label": "indexPatternTitle",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.ExistingFields.existingFieldNames",
"type": "Array",
"tags": [],
"label": "existingFieldNames",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 12
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse",
"type": "Interface",
"tags": [],
"label": "FieldStatsResponse",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.FieldStatsResponse",
"text": "FieldStatsResponse"
},
"<KeyType>"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse.totalDocuments",
"type": "number",
"tags": [],
"label": "totalDocuments",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 28
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse.sampledDocuments",
"type": "number",
"tags": [],
"label": "sampledDocuments",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 30
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse.sampledValues",
"type": "number",
"tags": [],
"label": "sampledValues",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse.histogram",
"type": "Object",
"tags": [],
"label": "histogram",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType> | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.FieldStatsResponse.topValues",
"type": "Object",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType> | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 36
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.NumberStatsResult",
"type": "Interface",
"tags": [],
"label": "NumberStatsResult",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 15
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.NumberStatsResult.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 16
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.NumberStatsResult.histogram",
"type": "Object",
"tags": [],
"label": "histogram",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<number>"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.NumberStatsResult.topValues",
"type": "Object",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<number>"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 18
},
"deprecated": 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": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.Filter",
"text": "Filter"
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.PersistableFilter.meta",
"type": "Object",
"tags": [],
"label": "meta",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.PersistableFilterMeta",
"text": "PersistableFilterMeta"
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 25
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.PersistableFilterMeta",
"type": "Interface",
"tags": [],
"label": "PersistableFilterMeta",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.PersistableFilterMeta",
"text": "PersistableFilterMeta"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.FilterMeta",
"text": "FilterMeta"
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.PersistableFilterMeta.indexRefName",
"type": "string",
"tags": [],
"label": "indexRefName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 21
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.TopValuesResult",
"type": "Interface",
"tags": [],
"label": "TopValuesResult",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 21
},
"deprecated": false,
"children": [
{
"parentPluginId": "lens",
"id": "def-common.TopValuesResult.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 22
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-common.TopValuesResult.topValues",
"type": "Object",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<string>"
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 23
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "lens",
"id": "def-common.APP_ID",
"type": "string",
"tags": [],
"label": "APP_ID",
"description": [],
"signature": [
"\"lens\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.BASE_API_URL",
"type": "string",
"tags": [],
"label": "BASE_API_URL",
"description": [],
"signature": [
"\"/api/lens\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.DOC_TYPE",
"type": "string",
"tags": [],
"label": "DOC_TYPE",
"description": [],
"signature": [
"\"lens\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 14
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.LENS_EDIT_BY_VALUE",
"type": "string",
"tags": [],
"label": "LENS_EDIT_BY_VALUE",
"description": [],
"signature": [
"\"edit_by_value\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.LENS_EMBEDDABLE_TYPE",
"type": "string",
"tags": [],
"label": "LENS_EMBEDDABLE_TYPE",
"description": [],
"signature": [
"\"lens\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 13
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.NOT_INTERNATIONALIZED_PRODUCT_NAME",
"type": "string",
"tags": [],
"label": "NOT_INTERNATIONALIZED_PRODUCT_NAME",
"description": [],
"signature": [
"\"Lens Visualizations\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 15
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "lens",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"lens\""
],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}