kibana/api_docs/expression_metric_vis.devdocs.json

1352 lines
No EOL
50 KiB
JSON

{
"id": "expressionMetricVis",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette",
"type": "Function",
"tags": [],
"label": "getDataBoundsForPalette",
"description": [],
"signature": [
"(accessors: { metric: string; max?: string | undefined; breakdownBy?: string | undefined; }, data?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
" | undefined, rowNumber?: number | undefined) => { min: number; max: any; }"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$1",
"type": "Object",
"tags": [],
"label": "accessors",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$1.metric",
"type": "string",
"tags": [],
"label": "metric",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$1.max",
"type": "string",
"tags": [],
"label": "max",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$1.breakdownBy",
"type": "string",
"tags": [],
"label": "breakdownBy",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$2",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.getDataBoundsForPalette.$3",
"type": "number",
"tags": [],
"label": "rowNumber",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.EXPRESSION_METRIC_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_METRIC_NAME",
"description": [],
"signature": [
"\"metricVis\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-public.EXPRESSION_METRIC_TRENDLINE_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_METRIC_TRENDLINE_NAME",
"description": [],
"signature": [
"\"metricTrendline\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.metricVisFunction",
"type": "Function",
"tags": [],
"label": "metricVisFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.MetricVisExpressionFunctionDefinition",
"text": "MetricVisExpressionFunctionDefinition"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam",
"type": "Interface",
"tags": [],
"label": "DimensionsVisParam",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.metric",
"type": "CompoundType",
"tags": [],
"label": "metric",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.secondaryMetric",
"type": "CompoundType",
"tags": [],
"label": "secondaryMetric",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.max",
"type": "CompoundType",
"tags": [],
"label": "max",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.breakdownBy",
"type": "CompoundType",
"tags": [],
"label": "breakdownBy",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments",
"type": "Interface",
"tags": [],
"label": "MetricArguments",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.metric",
"type": "CompoundType",
"tags": [],
"label": "metric",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.secondaryMetric",
"type": "CompoundType",
"tags": [],
"label": "secondaryMetric",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.max",
"type": "CompoundType",
"tags": [],
"label": "max",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.breakdownBy",
"type": "CompoundType",
"tags": [],
"label": "breakdownBy",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.trendline",
"type": "Object",
"tags": [],
"label": "trendline",
"description": [],
"signature": [
"TrendlineResult",
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.subtitle",
"type": "string",
"tags": [],
"label": "subtitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.secondaryPrefix",
"type": "string",
"tags": [],
"label": "secondaryPrefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.progressDirection",
"type": "CompoundType",
"tags": [],
"label": "progressDirection",
"description": [],
"signature": [
"LayoutDirection",
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.titlesTextAlign",
"type": "CompoundType",
"tags": [],
"label": "titlesTextAlign",
"description": [],
"signature": [
"\"right\" | \"center\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.valuesTextAlign",
"type": "CompoundType",
"tags": [],
"label": "valuesTextAlign",
"description": [],
"signature": [
"\"right\" | \"center\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.iconAlign",
"type": "CompoundType",
"tags": [],
"label": "iconAlign",
"description": [],
"signature": [
"\"right\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.valueFontSize",
"type": "CompoundType",
"tags": [],
"label": "valueFontSize",
"description": [],
"signature": [
"number | \"default\" | \"fit\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.CustomPaletteState",
"text": "CustomPaletteState"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.maxCols",
"type": "number",
"tags": [],
"label": "maxCols",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.minTiles",
"type": "number",
"tags": [],
"label": "minTiles",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.inspectorTableId",
"type": "string",
"tags": [],
"label": "inspectorTableId",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions",
"type": "Interface",
"tags": [],
"label": "MetricOptions",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.bgColor",
"type": "string",
"tags": [],
"label": "bgColor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.lightText",
"type": "boolean",
"tags": [],
"label": "lightText",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.colIndex",
"type": "number",
"tags": [],
"label": "colIndex",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.rowIndex",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam",
"type": "Interface",
"tags": [],
"label": "MetricVisParam",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.subtitle",
"type": "string",
"tags": [],
"label": "subtitle",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.secondaryPrefix",
"type": "string",
"tags": [],
"label": "secondaryPrefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.CustomPaletteState",
"text": "CustomPaletteState"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.progressDirection",
"type": "CompoundType",
"tags": [],
"label": "progressDirection",
"description": [],
"signature": [
"LayoutDirection",
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.titlesTextAlign",
"type": "CompoundType",
"tags": [],
"label": "titlesTextAlign",
"description": [],
"signature": [
"\"right\" | \"center\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.valuesTextAlign",
"type": "CompoundType",
"tags": [],
"label": "valuesTextAlign",
"description": [],
"signature": [
"\"right\" | \"center\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.iconAlign",
"type": "CompoundType",
"tags": [],
"label": "iconAlign",
"description": [],
"signature": [
"\"right\" | \"left\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.valueFontSize",
"type": "CompoundType",
"tags": [],
"label": "valueFontSize",
"description": [],
"signature": [
"number | \"default\" | \"fit\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.maxCols",
"type": "number",
"tags": [],
"label": "maxCols",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.minTiles",
"type": "number",
"tags": [],
"label": "minTiles",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.trends",
"type": "Object",
"tags": [],
"label": "trends",
"description": [],
"signature": [
"Record<string, { x: number; y: number; }[]> | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig",
"type": "Interface",
"tags": [],
"label": "MetricVisRenderConfig",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.visType",
"type": "string",
"tags": [],
"label": "visType",
"description": [],
"signature": [
"\"metric\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.visData",
"type": "Object",
"tags": [],
"label": "visData",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.visConfig",
"type": "Object",
"tags": [],
"label": "visConfig",
"description": [],
"signature": [
"{ metric: ",
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.MetricVisParam",
"text": "MetricVisParam"
},
"; dimensions: ",
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.DimensionsVisParam",
"text": "DimensionsVisParam"
},
"; }"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.overrides",
"type": "CompoundType",
"tags": [],
"label": "overrides",
"description": [],
"signature": [
"(Partial<Record<\"settings\", { onResize?: \"ignore\" | undefined; theme?: ",
"MakeOverridesSerializable",
"<",
"RecursivePartial",
"<",
"Theme",
"> | ",
"RecursivePartial",
"<",
"Theme",
">[] | undefined>; rendering?: ",
"Rendering",
" | undefined; showLegend?: boolean | undefined; legendPosition?: ",
"Position",
" | ",
"LegendPositionConfig",
" | undefined; rotation?: ",
"Rotation",
" | undefined; animateData?: boolean | undefined; externalPointerEvents?: ",
"MakeOverridesSerializable",
"<",
"ExternalPointerEventsSettings",
" | undefined>; debug?: boolean | undefined; pointBuffer?: ",
"MarkBuffer",
" | undefined; pointerUpdateTrigger?: ",
"PointerUpdateTrigger",
" | undefined; brushAxis?: ",
"BrushAxis",
" | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; locale?: string | undefined; dow?: number | undefined; legendValues?: ",
"MakeOverridesSerializable",
"<",
"LegendValue",
"[] | undefined>; legendMaxDepth?: number | undefined; legendSize?: number | undefined; flatLegend?: boolean | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onWillRender?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; xDomain?: ",
"MakeOverridesSerializable",
"<",
"CustomXDomain",
" | undefined>; onAnnotationClick?: \"ignore\" | undefined; resizeDebounce?: number | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; renderingSort?: \"ignore\" | undefined; noResults?: React.ComponentType<{}> | React.ReactChild | undefined; ariaLabel?: string | undefined; ariaLabelledBy?: string | undefined; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaTableCaption?: string | undefined; legendStrategy?: ",
"LegendStrategy",
" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemClick?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; legendAction?: \"ignore\" | undefined; legendSort?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; legendTitle?: string | undefined; }>> & Partial<Record<\"chart\", { title?: string | undefined; description?: string | undefined; }>>) | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams",
"type": "Interface",
"tags": [],
"label": "VisParams",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.addTooltip",
"type": "boolean",
"tags": [],
"label": "addTooltip",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.addLegend",
"type": "boolean",
"tags": [],
"label": "addLegend",
"description": [],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.dimensions",
"type": "Object",
"tags": [],
"label": "dimensions",
"description": [],
"signature": [
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.DimensionsVisParam",
"text": "DimensionsVisParam"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.metric",
"type": "Object",
"tags": [],
"label": "metric",
"description": [],
"signature": [
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.MetricVisParam",
"text": "MetricVisParam"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"metric\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.AvailableMetricIcon",
"type": "Type",
"tags": [],
"label": "AvailableMetricIcon",
"description": [],
"signature": [
"\"alert\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\" | \"temperature\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.EXPRESSION_METRIC_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_METRIC_NAME",
"description": [],
"signature": [
"\"metricVis\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.EXPRESSION_METRIC_TRENDLINE_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_METRIC_TRENDLINE_NAME",
"description": [],
"signature": [
"\"metricTrendline\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricInput",
"type": "Type",
"tags": [],
"label": "MetricInput",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisExpressionFunctionDefinition",
"type": "Type",
"tags": [],
"label": "MetricVisExpressionFunctionDefinition",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"metricVis\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", ",
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.MetricArguments",
"text": "MetricArguments"
},
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueRender",
"text": "ExpressionValueRender"
},
"<",
{
"pluginId": "expressionMetricVis",
"scope": "common",
"docId": "kibExpressionMetricVisPluginApi",
"section": "def-common.MetricVisRenderConfig",
"text": "MetricVisRenderConfig"
},
">, ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DefaultInspectorAdapters",
"text": "DefaultInspectorAdapters"
},
">>"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionMetricVis\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionMetricVis\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.TrendlineExpressionFunctionDefinition",
"type": "Type",
"tags": [],
"label": "TrendlineExpressionFunctionDefinition",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"metricTrendline\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", ",
"TrendlineArguments",
", ",
"TrendlineResult",
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExecutionContext",
"text": "ExecutionContext"
},
"<",
{
"pluginId": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
">>"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}