kibana/api_docs/expression_metric_vis.json
Stacey Gammon e92a945ab1
Add packages to our API documentation (#113564) (#114513)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
# Conflicts:
#	api_docs/alerting.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/custom_integrations.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/event_log.mdx
#	api_docs/fleet.mdx
#	api_docs/home.json
#	api_docs/index_management.json
#	api_docs/interactive_setup.mdx
#	api_docs/kibana_legacy.json
#	api_docs/kibana_legacy.mdx
#	api_docs/observability.mdx
#	api_docs/plugin_directory.mdx
#	api_docs/security_oss.mdx
2021-10-11 13:58:18 -04:00

837 lines
29 KiB
JSON

{
"id": "expressionMetricVis",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"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/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam",
"type": "Interface",
"tags": [],
"label": "DimensionsVisParam",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.metrics",
"type": "Array",
"tags": [],
"label": "metrics",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"vis_dimension\", { accessor: number | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"; format: { id?: string | undefined; params: Record<string, any>; }; }>[]"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.DimensionsVisParam.bucket",
"type": "CompoundType",
"tags": [],
"label": "bucket",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"vis_dimension\", { accessor: number | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"; format: { id?: string | undefined; params: Record<string, any>; }; }> | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments",
"type": "Interface",
"tags": [],
"label": "MetricArguments",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.percentageMode",
"type": "boolean",
"tags": [],
"label": "percentageMode",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.colorSchema",
"type": "Enum",
"tags": [],
"label": "colorSchema",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.ColorSchemas",
"text": "ColorSchemas"
}
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.colorMode",
"type": "CompoundType",
"tags": [],
"label": "colorMode",
"description": [],
"signature": [
"\"Background\" | \"Labels\" | \"None\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.useRanges",
"type": "boolean",
"tags": [],
"label": "useRanges",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.invertColors",
"type": "boolean",
"tags": [],
"label": "invertColors",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.showLabels",
"type": "boolean",
"tags": [],
"label": "showLabels",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.bgFill",
"type": "string",
"tags": [],
"label": "bgFill",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.subText",
"type": "string",
"tags": [],
"label": "subText",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.colorRange",
"type": "Array",
"tags": [],
"label": "colorRange",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Range",
"text": "Range"
},
"[]"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.font",
"type": "Object",
"tags": [],
"label": "font",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionTypeStyle",
"text": "ExpressionTypeStyle"
}
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.metric",
"type": "Array",
"tags": [],
"label": "metric",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"vis_dimension\", { accessor: number | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"; format: { id?: string | undefined; params: Record<string, any>; }; }>[]"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricArguments.bucket",
"type": "CompoundType",
"tags": [],
"label": "bucket",
"description": [],
"signature": [
"{ type: \"vis_dimension\"; } & { accessor: number | ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"; format: { id?: string | undefined; params: Record<string, any>; }; }"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions",
"type": "Interface",
"tags": [],
"label": "MetricOptions",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.bgColor",
"type": "string",
"tags": [],
"label": "bgColor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.lightText",
"type": "boolean",
"tags": [],
"label": "lightText",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricOptions.rowIndex",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam",
"type": "Interface",
"tags": [],
"label": "MetricVisParam",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.percentageMode",
"type": "boolean",
"tags": [],
"label": "percentageMode",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.percentageFormatPattern",
"type": "string",
"tags": [],
"label": "percentageFormatPattern",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.useRanges",
"type": "boolean",
"tags": [],
"label": "useRanges",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.colorSchema",
"type": "Enum",
"tags": [],
"label": "colorSchema",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.ColorSchemas",
"text": "ColorSchemas"
}
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.metricColorMode",
"type": "CompoundType",
"tags": [],
"label": "metricColorMode",
"description": [],
"signature": [
"\"Background\" | \"Labels\" | \"None\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.colorsRange",
"type": "Array",
"tags": [],
"label": "colorsRange",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Range",
"text": "Range"
},
"[]"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.labels",
"type": "Object",
"tags": [],
"label": "labels",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.Labels",
"text": "Labels"
}
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.invertColors",
"type": "boolean",
"tags": [],
"label": "invertColors",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisParam.style",
"type": "Object",
"tags": [],
"label": "style",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "common",
"docId": "kibChartsPluginApi",
"section": "def-common.Style",
"text": "Style"
}
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig",
"type": "Interface",
"tags": [],
"label": "MetricVisRenderConfig",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.MetricVisRenderConfig.visType",
"type": "string",
"tags": [],
"label": "visType",
"description": [],
"signature": [
"\"metric\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": 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/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": 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/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams",
"type": "Interface",
"tags": [],
"label": "VisParams",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.addTooltip",
"type": "boolean",
"tags": [],
"label": "addTooltip",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.addLegend",
"type": "boolean",
"tags": [],
"label": "addLegend",
"description": [],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": 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/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": 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/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.VisParams.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"metric\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.EXPRESSION_METRIC_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_METRIC_NAME",
"description": [],
"signature": [
"\"metricVis\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/constants.ts",
"deprecated": 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/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": 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.ExpressionValueBoxed",
"text": "ExpressionValueBoxed"
},
"<\"render\", { as: string; value: ",
{
"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": "inspector",
"scope": "common",
"docId": "kibInspectorPluginApi",
"section": "def-common.Adapters",
"text": "Adapters"
},
", ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>"
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionMetricVis\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionMetricVis",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionMetricVis\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}