maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/lens.json
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929) 
* update api_docs from gitignore

* api doc files

* Update api_welcome.mdx

* Pretty print json

* Add new lines and extra frontmatter to warn github viewers

* update api_docs with new lines and frontmatter

* Remove all apis tagged @internal and add tests

* Update docs with all internal APIs removed

* fix typescript error in test fixtures

* Update core.json

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-02 22:02:17 -05:00

2799 lines
102 KiB
JSON
Raw Blame History

{
"id": "lens",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.XYState",
"type": "Interface",
"label": "XYState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.XYState.preferredSeriesType",
"type": "CompoundType",
"label": "preferredSeriesType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 420,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L420"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SeriesType",
"text": "SeriesType"
}
]
},
{
"tags": [],
"id": "def-public.XYState.legend",
"type": "Object",
"label": "legend",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 421,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L421"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LegendConfig",
"text": "LegendConfig"
}
]
},
{
"tags": [],
"id": "def-public.XYState.valueLabels",
"type": "CompoundType",
"label": "valueLabels",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 422,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L422"
},
"signature": [
"\"hide\" | \"inside\" | \"outside\" | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.fittingFunction",
"type": "CompoundType",
"label": "fittingFunction",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 423,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L423"
},
"signature": [
"\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.layers",
"type": "Array",
"label": "layers",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 424,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L424"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.XYLayerConfig",
"text": "XYLayerConfig"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.XYState.xTitle",
"type": "string",
"label": "xTitle",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 425,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L425"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.yTitle",
"type": "string",
"label": "yTitle",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 426,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L426"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.yRightTitle",
"type": "string",
"label": "yRightTitle",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 427,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L427"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.axisTitlesVisibilitySettings",
"type": "Object",
"label": "axisTitlesVisibilitySettings",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 428,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L428"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.AxesSettingsConfig",
"text": "AxesSettingsConfig"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.tickLabelsVisibilitySettings",
"type": "Object",
"label": "tickLabelsVisibilitySettings",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 429,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L429"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.AxesSettingsConfig",
"text": "AxesSettingsConfig"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-public.XYState.gridlinesVisibilitySettings",
"type": "Object",
"label": "gridlinesVisibilitySettings",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 430,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L430"
},
"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": 419,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L419"
},
"initialIsOpen": false
},
{
"id": "def-public.AxesSettingsConfig",
"type": "Interface",
"label": "AxesSettingsConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AxesSettingsConfig.x",
"type": "boolean",
"label": "x",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 84,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L84"
}
},
{
"tags": [],
"id": "def-public.AxesSettingsConfig.yLeft",
"type": "boolean",
"label": "yLeft",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 85,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L85"
}
},
{
"tags": [],
"id": "def-public.AxesSettingsConfig.yRight",
"type": "boolean",
"label": "yRight",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 86,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L86"
}
}
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 83,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L83"
},
"initialIsOpen": false
},
{
"id": "def-public.XYLayerConfig",
"type": "Interface",
"label": "XYLayerConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.XYLayerConfig.hide",
"type": "CompoundType",
"label": "hide",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 377,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L377"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.layerId",
"type": "string",
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 378,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L378"
}
},
{
"tags": [],
"id": "def-public.XYLayerConfig.xAccessor",
"type": "string",
"label": "xAccessor",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 379,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L379"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.accessors",
"type": "Array",
"label": "accessors",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 380,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L380"
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.yConfig",
"type": "Array",
"label": "yConfig",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 381,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L381"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.YConfig",
"text": "YConfig"
},
"[] | undefined"
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.seriesType",
"type": "CompoundType",
"label": "seriesType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 382,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L382"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SeriesType",
"text": "SeriesType"
}
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.splitAccessor",
"type": "string",
"label": "splitAccessor",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 383,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L383"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.XYLayerConfig.palette",
"type": "Object",
"label": "palette",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 384,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L384"
},
"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": 376,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L376"
},
"initialIsOpen": false
},
{
"id": "def-public.LegendConfig",
"type": "Interface",
"label": "LegendConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.LegendConfig.isVisible",
"type": "boolean",
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L30"
}
},
{
"tags": [],
"id": "def-public.LegendConfig.position",
"type": "CompoundType",
"label": "position",
"description": [
"\nPosition of the legend relative to the chart"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L34"
},
"signature": [
"node_modules/utility-types/dist/utility-types",
"$Values<Readonly<{ Top: \"top\"; Bottom: \"bottom\"; Left: \"left\"; Right: \"right\"; }>>"
]
},
{
"tags": [],
"id": "def-public.LegendConfig.showSingleSeries",
"type": "CompoundType",
"label": "showSingleSeries",
"description": [
"\nFlag whether the legend should be shown even with just a single series"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L38"
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-public.PieVisualizationState",
"type": "Interface",
"label": "PieVisualizationState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PieVisualizationState.shape",
"type": "CompoundType",
"label": "shape",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L27"
},
"signature": [
"\"donut\" | \"pie\" | \"treemap\""
]
},
{
"tags": [],
"id": "def-public.PieVisualizationState.layers",
"type": "Array",
"label": "layers",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L28"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PieLayerState",
"text": "PieLayerState"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.PieVisualizationState.palette",
"type": "Object",
"label": "palette",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 29,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L29"
},
"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": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-public.SharedPieLayerState",
"type": "Interface",
"label": "SharedPieLayerState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SharedPieLayerState.groups",
"type": "Array",
"label": "groups",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L12"
},
"signature": [
"string[]"
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.metric",
"type": "string",
"label": "metric",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L13"
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.numberDisplay",
"type": "CompoundType",
"label": "numberDisplay",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L14"
},
"signature": [
"\"hidden\" | \"value\" | \"percent\""
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.categoryDisplay",
"type": "CompoundType",
"label": "categoryDisplay",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L15"
},
"signature": [
"\"default\" | \"hide\" | \"inside\""
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.legendDisplay",
"type": "CompoundType",
"label": "legendDisplay",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L16"
},
"signature": [
"\"default\" | \"hide\" | \"show\""
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.legendPosition",
"type": "CompoundType",
"label": "legendPosition",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L17"
},
"signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\" | undefined"
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.nestedLegend",
"type": "CompoundType",
"label": "nestedLegend",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L18"
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-public.SharedPieLayerState.percentDecimals",
"type": "number",
"label": "percentDecimals",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 19,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L19"
},
"signature": [
"number | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L11"
},
"initialIsOpen": false
},
{
"id": "def-public.DatatableVisualizationState",
"type": "Interface",
"label": "DatatableVisualizationState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DatatableVisualizationState.columns",
"type": "Array",
"label": "columns",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/datatable_visualization/visualization.tsx#L35"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.ColumnState",
"text": "ColumnState"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.DatatableVisualizationState.layerId",
"type": "string",
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/datatable_visualization/visualization.tsx#L36"
}
},
{
"tags": [],
"id": "def-public.DatatableVisualizationState.sorting",
"type": "Object",
"label": "sorting",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/datatable_visualization/visualization.tsx#L37"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.SortingState",
"text": "SortingState"
},
" | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/datatable_visualization/visualization.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/datatable_visualization/visualization.tsx#L34"
},
"initialIsOpen": false
},
{
"id": "def-public.MetricState",
"type": "Interface",
"label": "MetricState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.MetricState.layerId",
"type": "string",
"label": "layerId",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/metric_visualization/types.ts#L9"
}
},
{
"tags": [],
"id": "def-public.MetricState.accessor",
"type": "string",
"label": "accessor",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/metric_visualization/types.ts#L10"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/metric_visualization/types.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/metric_visualization/types.ts#L8"
},
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternPersistedState",
"type": "Interface",
"label": "IndexPatternPersistedState",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IndexPatternPersistedState.layers",
"type": "Object",
"label": "layers",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/types.ts#L72"
},
"signature": [
"Record<string, Pick<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.IndexPatternLayer",
"text": "IndexPatternLayer"
},
", \"columns\" | \"columnOrder\" | \"incompleteColumns\">>"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 71,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/types.ts#L71"
},
"initialIsOpen": false
},
{
"id": "def-public.IncompleteColumn",
"type": "Interface",
"label": "IncompleteColumn",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.IncompleteColumn.operationType",
"type": "CompoundType",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts#L44"
},
"signature": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"terms\" | \"avg\" | \"median\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"counter_rate\" | \"cardinality\" | \"percentile\" | \"last_value\" | undefined"
]
},
{
"tags": [],
"id": "def-public.IncompleteColumn.sourceField",
"type": "string",
"label": "sourceField",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts#L45"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/column_types.ts#L43"
},
"initialIsOpen": false
},
{
"id": "def-public.FiltersIndexPatternColumn",
"type": "Interface",
"label": "FiltersIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.FiltersIndexPatternColumn",
"text": "FiltersIndexPatternColumn"
},
" extends ",
"BaseIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FiltersIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 73,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx#L73"
},
"signature": [
"\"filters\""
]
},
{
"tags": [],
"id": "def-public.FiltersIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 74,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx#L74"
},
"signature": [
"{ filters: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.Filter",
"text": "Filter"
},
"[]; }"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx",
"lineNumber": 72,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/filters/filters.tsx#L72"
},
"initialIsOpen": false
},
{
"id": "def-public.RangeIndexPatternColumn",
"type": "Interface",
"label": "RangeIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeIndexPatternColumn",
"text": "RangeIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.RangeIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx",
"lineNumber": 37,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#L37"
},
"signature": [
"\"range\""
]
},
{
"tags": [],
"id": "def-public.RangeIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#L38"
},
"signature": [
"{ type: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.MODES_TYPES",
"text": "MODES_TYPES"
},
"; maxBars: number | \"auto\"; ranges: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.RangeTypeLens",
"text": "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": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#L36"
},
"initialIsOpen": false
},
{
"id": "def-public.TermsIndexPatternColumn",
"type": "Interface",
"label": "TermsIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TermsIndexPatternColumn",
"text": "TermsIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.TermsIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L59"
},
"signature": [
"\"terms\""
]
},
{
"tags": [],
"id": "def-public.TermsIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx",
"lineNumber": 60,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L60"
},
"signature": [
"{ size: number; orderBy: { type: \"alphabetical\"; } | { 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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/terms/index.tsx#L58"
},
"initialIsOpen": false
},
{
"id": "def-public.DateHistogramIndexPatternColumn",
"type": "Interface",
"label": "DateHistogramIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.DateHistogramIndexPatternColumn",
"text": "DateHistogramIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.DateHistogramIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 44,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx#L44"
},
"signature": [
"\"date_histogram\""
]
},
{
"tags": [],
"id": "def-public.DateHistogramIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 45,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx#L45"
},
"signature": [
"{ interval: string; timeZone?: string | undefined; }"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx",
"lineNumber": 43,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx#L43"
},
"initialIsOpen": false
},
{
"id": "def-public.CardinalityIndexPatternColumn",
"type": "Interface",
"label": "CardinalityIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
},
" extends ",
"FormattedIndexPatternColumn",
",",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.CardinalityIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx#L34"
},
"signature": [
"\"cardinality\""
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx#L31"
},
"initialIsOpen": false
},
{
"id": "def-public.PercentileIndexPatternColumn",
"type": "Interface",
"label": "PercentileIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.PercentileIndexPatternColumn",
"text": "PercentileIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.PercentileIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx#L23"
},
"signature": [
"\"percentile\""
]
},
{
"tags": [],
"id": "def-public.PercentileIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx#L24"
},
"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": 22,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/percentile.tsx#L22"
},
"initialIsOpen": false
},
{
"id": "def-public.LastValueIndexPatternColumn",
"type": "Interface",
"label": "LastValueIndexPatternColumn",
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LastValueIndexPatternColumn",
"text": "LastValueIndexPatternColumn"
},
" extends ",
"FieldBasedIndexPatternColumn"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.LastValueIndexPatternColumn.operationType",
"type": "string",
"label": "operationType",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
"lineNumber": 76,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx#L76"
},
"signature": [
"\"last_value\""
]
},
{
"tags": [],
"id": "def-public.LastValueIndexPatternColumn.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx",
"lineNumber": 77,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx#L77"
},
"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": 75,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/last_value.tsx#L75"
},
"initialIsOpen": false
},
{
"id": "def-public.LensPublicStart",
"type": "Interface",
"label": "LensPublicStart",
"description": [],
"tags": [],
"children": [
{
"tags": [
"experimental"
],
"id": "def-public.LensPublicStart.EmbeddableComponent",
"type": "CompoundType",
"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"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 88,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/plugin.ts#L88"
},
"signature": [
"React.ComponentType<",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.EmbeddableComponentProps",
"text": "EmbeddableComponentProps"
},
">"
]
},
{
"tags": [
"experimental"
],
"id": "def-public.LensPublicStart.navigateToPrefilledEditor",
"type": "Function",
"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"
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 97,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/plugin.ts#L97"
},
"signature": [
"(input: ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.LensEmbeddableInput",
"text": "LensEmbeddableInput"
},
") => void"
]
},
{
"tags": [],
"id": "def-public.LensPublicStart.canUseEditor",
"type": "Function",
"label": "canUseEditor",
"description": [
"\nMethod which returns true if the user has permission to use Lens as defined by application capabilities."
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 101,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/plugin.ts#L101"
},
"signature": [
"() => boolean"
]
}
],
"source": {
"path": "x-pack/plugins/lens/public/plugin.ts",
"lineNumber": 79,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/plugin.ts#L79"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.EmbeddableComponentProps",
"type": "Type",
"label": "EmbeddableComponentProps",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx",
"lineNumber": 46,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx#L46"
},
"signature": [
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.TypedLensByValueInput",
"text": "TypedLensByValueInput"
},
" | ",
"LensByReferenceInput"
],
"initialIsOpen": false
},
{
"id": "def-public.TypedLensByValueInput",
"type": "Type",
"label": "TypedLensByValueInput",
"tags": [],
"description": [
"\nType-safe variant of by value embeddable input for Lens.\nThis can be used to hardcode certain Lens chart configurations within another app."
],
"source": {
"path": "x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx",
"lineNumber": 38,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable_component.tsx#L38"
},
"signature": [
"Pick<LensByValueInput, \"palette\" | \"id\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"renderMode\"> & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }"
],
"initialIsOpen": false
},
{
"id": "def-public.SeriesType",
"type": "Type",
"label": "SeriesType",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 354,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L354"
},
"signature": [
"\"area\" | \"line\" | \"bar\" | \"bar_horizontal\" | \"bar_stacked\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"bar_horizontal_percentage_stacked\" | \"area_stacked\" | \"area_percentage_stacked\""
],
"initialIsOpen": false
},
{
"id": "def-public.ValueLabelConfig",
"type": "Type",
"label": "ValueLabelConfig",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 368,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L368"
},
"signature": [
"\"hide\" | \"inside\" | \"outside\""
],
"initialIsOpen": false
},
{
"id": "def-public.YAxisMode",
"type": "Type",
"label": "YAxisMode",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 366,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/xy_visualization/types.ts#L366"
},
"signature": [
"\"left\" | \"right\" | \"auto\""
],
"initialIsOpen": false
},
{
"id": "def-public.PieLayerState",
"type": "Type",
"label": "PieLayerState",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/pie_visualization/types.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/pie_visualization/types.ts#L22"
},
"signature": [
"SharedPieLayerState & { layerId: string; }"
],
"initialIsOpen": false
},
{
"id": "def-public.PersistedIndexPatternLayer",
"type": "Type",
"label": "PersistedIndexPatternLayer",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts",
"lineNumber": 75,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/types.ts#L75"
},
"signature": [
"{ columns: Record<string, IndexPatternColumn>; columnOrder: string[]; incompleteColumns?: Record<string, IncompleteColumn> | undefined; }"
],
"initialIsOpen": false
},
{
"id": "def-public.IndexPatternColumn",
"type": "Type",
"label": "IndexPatternColumn",
"tags": [],
"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."
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 52,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts#L52"
},
"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<\"avg\"> | ",
{
"pluginId": "lens",
"scope": "public",
"docId": "kibLensPluginApi",
"section": "def-public.CardinalityIndexPatternColumn",
"text": "CardinalityIndexPatternColumn"
}
],
"initialIsOpen": false
},
{
"id": "def-public.OperationType",
"type": "Type",
"label": "OperationType",
"tags": [],
"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."
],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 405,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts#L405"
},
"signature": [
"\"range\" | \"filters\" | \"count\" | \"max\" | \"min\" | \"date_histogram\" | \"sum\" | \"terms\" | \"avg\" | \"median\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"counter_rate\" | \"cardinality\" | \"percentile\" | \"last_value\""
],
"initialIsOpen": false
},
{
"id": "def-public.MinIndexPatternColumn",
"type": "Type",
"label": "MinIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 129,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx#L129"
},
"signature": [
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"min\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.MaxIndexPatternColumn",
"type": "Type",
"label": "MaxIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 130,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx#L130"
},
"signature": [
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"max\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.AvgIndexPatternColumn",
"type": "Type",
"label": "AvgIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 128,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx#L128"
},
"signature": [
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"avg\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.SumIndexPatternColumn",
"type": "Type",
"label": "SumIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 127,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx#L127"
},
"signature": [
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"sum\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.MedianIndexPatternColumn",
"type": "Type",
"label": "MedianIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx",
"lineNumber": 131,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/metrics.tsx#L131"
},
"signature": [
"BaseIndexPatternColumn & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: \"median\"; }"
],
"initialIsOpen": false
},
{
"id": "def-public.CountIndexPatternColumn",
"type": "Type",
"label": "CountIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/count.tsx#L24"
},
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & FieldBasedIndexPatternColumn & { operationType: 'count'; }"
],
"initialIsOpen": false
},
{
"id": "def-public.CumulativeSumIndexPatternColumn",
"type": "Type",
"label": "CumulativeSumIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx",
"lineNumber": 32,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/cumulative_sum.tsx#L32"
},
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'cumulative_sum'; }"
],
"initialIsOpen": false
},
{
"id": "def-public.CounterRateIndexPatternColumn",
"type": "Type",
"label": "CounterRateIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/counter_rate.tsx#L34"
},
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'counter_rate'; }"
],
"initialIsOpen": false
},
{
"id": "def-public.DerivativeIndexPatternColumn",
"type": "Type",
"label": "DerivativeIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/derivative.tsx",
"lineNumber": 34,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/derivative.tsx#L34"
},
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'derivative'; }"
],
"initialIsOpen": false
},
{
"id": "def-public.MovingAverageIndexPatternColumn",
"type": "Type",
"label": "MovingAverageIndexPatternColumn",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx",
"lineNumber": 40,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx#L40"
},
"signature": [
"BaseIndexPatternColumn",
" & { params?: { format?: { id: string; params?: { decimals: number; } | undefined; } | undefined; } | undefined; } & ReferenceBasedIndexPatternColumn & { operationType: 'moving_average'; params: { window: number;}; }"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [
{
"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"
},
"<{}, {}, {}, {}>"
],
"children": [
{
"id": "def-server.LensServerPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L35"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L35"
}
},
{
"id": "def-server.LensServerPlugin.setup",
"type": "Function",
"label": "setup",
"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"
},
") => {}"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"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>"
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L39"
}
},
{
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginSetupContract",
"text": "PluginSetupContract"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L39"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L39"
}
},
{
"id": "def-server.LensServerPlugin.start",
"type": "Function",
"label": "start",
"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"
},
") => {}"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L59"
}
},
{
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
{
"pluginId": "lens",
"scope": "server",
"docId": "kibLensPluginApi",
"section": "def-server.PluginStartContract",
"text": "PluginStartContract"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L59"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L59"
}
},
{
"id": "def-server.LensServerPlugin.stop",
"type": "Function",
"label": "stop",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 66,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L66"
}
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 31,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L31"
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-server.PluginSetupContract",
"type": "Interface",
"label": "PluginSetupContract",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.PluginSetupContract.usageCollection",
"type": "Object",
"label": "usageCollection",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L22"
},
"signature": [
"Pick<",
{
"pluginId": "usageCollection",
"scope": "server",
"docId": "kibUsageCollectionPluginApi",
"section": "def-server.CollectorSet",
"text": "CollectorSet"
},
", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"
]
},
{
"tags": [],
"id": "def-server.PluginSetupContract.taskManager",
"type": "CompoundType",
"label": "taskManager",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L23"
},
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerSetupContract",
"text": "TaskManagerSetupContract"
},
" | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L21"
},
"initialIsOpen": false
},
{
"id": "def-server.PluginStartContract",
"type": "Interface",
"label": "PluginStartContract",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.PluginStartContract.taskManager",
"type": "CompoundType",
"label": "taskManager",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 27,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L27"
},
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerStartContract",
"text": "TaskManagerStartContract"
},
" | undefined"
]
},
{
"tags": [],
"id": "def-server.PluginStartContract.data",
"type": "Object",
"label": "data",
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L28"
},
"signature": [
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataPluginApi",
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
}
]
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/server/plugin.tsx#L26"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"id": "def-common.getBasePath",
"type": "Function",
"label": "getBasePath",
"signature": [
"() => string"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L16"
},
"initialIsOpen": false
},
{
"id": "def-common.getEditPath",
"type": "Function",
"label": "getEditPath",
"signature": [
"(id: string | undefined) => string"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L20"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L20"
},
"initialIsOpen": false
},
{
"id": "def-common.getFullPath",
"type": "Function",
"label": "getFullPath",
"signature": [
"(id: string | undefined) => string"
],
"description": [],
"children": [
{
"type": "string",
"label": "id",
"isRequired": false,
"signature": [
"string | undefined"
],
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L24"
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L24"
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.BucketedAggregation",
"type": "Interface",
"label": "BucketedAggregation",
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BucketedAggregation.buckets",
"type": "Array",
"label": "buckets",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L9"
},
"signature": [
"{ key: KeyType; count: number; }[]"
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L8"
},
"initialIsOpen": false
},
{
"id": "def-common.NumberStatsResult",
"type": "Interface",
"label": "NumberStatsResult",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.NumberStatsResult.count",
"type": "number",
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L16"
}
},
{
"tags": [],
"id": "def-common.NumberStatsResult.histogram",
"type": "Object",
"label": "histogram",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L17"
},
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<number>"
]
},
{
"tags": [],
"id": "def-common.NumberStatsResult.topValues",
"type": "Object",
"label": "topValues",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 18,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L18"
},
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<number>"
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L15"
},
"initialIsOpen": false
},
{
"id": "def-common.TopValuesResult",
"type": "Interface",
"label": "TopValuesResult",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.TopValuesResult.count",
"type": "number",
"label": "count",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 22,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L22"
}
},
{
"tags": [],
"id": "def-common.TopValuesResult.topValues",
"type": "Object",
"label": "topValues",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 23,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L23"
},
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<string>"
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L21"
},
"initialIsOpen": false
},
{
"id": "def-common.FieldStatsResponse",
"type": "Interface",
"label": "FieldStatsResponse",
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.FieldStatsResponse",
"text": "FieldStatsResponse"
},
"<KeyType>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FieldStatsResponse.totalDocuments",
"type": "number",
"label": "totalDocuments",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L28"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FieldStatsResponse.sampledDocuments",
"type": "number",
"label": "sampledDocuments",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 30,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L30"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FieldStatsResponse.sampledValues",
"type": "number",
"label": "sampledValues",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 33,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L33"
},
"signature": [
"number | undefined"
]
},
{
"tags": [],
"id": "def-common.FieldStatsResponse.histogram",
"type": "Object",
"label": "histogram",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 35,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L35"
},
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType> | undefined"
]
},
{
"tags": [],
"id": "def-common.FieldStatsResponse.topValues",
"type": "Object",
"label": "topValues",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/api.ts",
"lineNumber": 36,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L36"
},
"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": 26,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/api.ts#L26"
},
"initialIsOpen": false
},
{
"id": "def-common.ExistingFields",
"type": "Interface",
"label": "ExistingFields",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.ExistingFields.indexPatternTitle",
"type": "string",
"label": "indexPatternTitle",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L11"
}
},
{
"tags": [],
"id": "def-common.ExistingFields.existingFieldNames",
"type": "Array",
"label": "existingFieldNames",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L12"
},
"signature": [
"string[]"
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L10"
},
"initialIsOpen": false
},
{
"id": "def-common.DateRange",
"type": "Interface",
"label": "DateRange",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DateRange.fromDate",
"type": "string",
"label": "fromDate",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L16"
}
},
{
"tags": [],
"id": "def-common.DateRange.toDate",
"type": "string",
"label": "toDate",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 17,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L17"
}
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L15"
},
"initialIsOpen": false
},
{
"id": "def-common.PersistableFilterMeta",
"type": "Interface",
"label": "PersistableFilterMeta",
"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"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PersistableFilterMeta.indexRefName",
"type": "string",
"label": "indexRefName",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 21,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L21"
},
"signature": [
"string | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 20,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L20"
},
"initialIsOpen": false
},
{
"id": "def-common.PersistableFilter",
"type": "Interface",
"label": "PersistableFilter",
"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"
}
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.PersistableFilter.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 25,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L25"
},
"signature": [
{
"pluginId": "lens",
"scope": "common",
"docId": "kibLensPluginApi",
"section": "def-common.PersistableFilterMeta",
"text": "PersistableFilterMeta"
}
]
}
],
"source": {
"path": "x-pack/plugins/lens/common/types.ts",
"lineNumber": 24,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/types.ts#L24"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.PLUGIN_ID",
"type": "string",
"label": "PLUGIN_ID",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 8,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L8"
},
"signature": [
"\"lens\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.APP_ID",
"type": "string",
"label": "APP_ID",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 9,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L9"
},
"signature": [
"\"lens\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.LENS_EMBEDDABLE_TYPE",
"type": "string",
"label": "LENS_EMBEDDABLE_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 10,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L10"
},
"signature": [
"\"lens\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DOC_TYPE",
"type": "string",
"label": "DOC_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 11,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L11"
},
"signature": [
"\"lens\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.NOT_INTERNATIONALIZED_PRODUCT_NAME",
"type": "string",
"label": "NOT_INTERNATIONALIZED_PRODUCT_NAME",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 12,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L12"
},
"signature": [
"\"Lens Visualizations\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.BASE_API_URL",
"type": "string",
"label": "BASE_API_URL",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 13,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L13"
},
"signature": [
"\"/api/lens\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.LENS_EDIT_BY_VALUE",
"type": "string",
"label": "LENS_EDIT_BY_VALUE",
"description": [],
"source": {
"path": "x-pack/plugins/lens/common/constants.ts",
"lineNumber": 14,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/lens/common/constants.ts#L14"
},
"signature": [
"\"edit_by_value\""
],
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink