kibana/api_docs/expression_gauge.devdocs.json
2022-10-29 00:46:56 -04:00

1294 lines
No EOL
43 KiB
JSON

{
"id": "expressionGauge",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionGauge",
"id": "def-public.getGoalValue",
"type": "Function",
"tags": [],
"label": "getGoalValue",
"description": [],
"signature": [
"(row?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined, accessors?: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined) => any"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-public.getGoalValue.$1",
"type": "Object",
"tags": [],
"label": "row",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getGoalValue.$2",
"type": "Object",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMaxValue",
"type": "Function",
"tags": [],
"label": "getMaxValue",
"description": [],
"signature": [
"(row?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined, accessors?: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined, paletteParams?: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined, isRespectRanges?: boolean | undefined) => number"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMaxValue.$1",
"type": "Object",
"tags": [],
"label": "row",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMaxValue.$2",
"type": "Object",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMaxValue.$3",
"type": "Object",
"tags": [],
"label": "paletteParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMaxValue.$4",
"type": "CompoundType",
"tags": [],
"label": "isRespectRanges",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMinValue",
"type": "Function",
"tags": [],
"label": "getMinValue",
"description": [],
"signature": [
"(row?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined, accessors?: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined, paletteParams?: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined, isRespectRanges?: boolean | undefined) => any"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMinValue.$1",
"type": "Object",
"tags": [],
"label": "row",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMinValue.$2",
"type": "Object",
"tags": [],
"label": "accessors",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.Accessors",
"text": "Accessors"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMinValue.$3",
"type": "Object",
"tags": [],
"label": "paletteParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getMinValue.$4",
"type": "CompoundType",
"tags": [],
"label": "isRespectRanges",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getValueFromAccessor",
"type": "Function",
"tags": [],
"label": "getValueFromAccessor",
"description": [],
"signature": [
"(accessor: string, row?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined) => any"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-public.getValueFromAccessor.$1",
"type": "string",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "expressionGauge",
"id": "def-public.getValueFromAccessor.$2",
"type": "Object",
"tags": [],
"label": "row",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableRow",
"text": "DatatableRow"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.gaugeFunction",
"type": "Function",
"tags": [],
"label": "gaugeFunction",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeExpressionFunctionDefinition",
"text": "GaugeExpressionFunctionDefinition"
}
],
"path": "src/plugins/chart_expressions/expression_gauge/common/expression_functions/gauge_function.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.Accessors",
"type": "Interface",
"tags": [],
"label": "Accessors",
"description": [],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.Accessors.min",
"type": "string",
"tags": [],
"label": "min",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.Accessors.max",
"type": "string",
"tags": [],
"label": "max",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.Accessors.metric",
"type": "string",
"tags": [],
"label": "metric",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.Accessors.goal",
"type": "string",
"tags": [],
"label": "goal",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeExpressionProps",
"type": "Interface",
"tags": [],
"label": "GaugeExpressionProps",
"description": [],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeExpressionProps.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeExpressionProps.args",
"type": "CompoundType",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeState",
"text": "GaugeState"
},
" & { shape: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeShape",
"text": "GaugeShape"
},
"; colorMode: ",
"GaugeColorMode",
"; palette?: ",
{
"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; ariaLabel?: string | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeExpressionProps.canNavigateToLens",
"type": "boolean",
"tags": [],
"label": "canNavigateToLens",
"description": [],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState",
"type": "Interface",
"tags": [],
"label": "GaugeState",
"description": [],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.metric",
"type": "CompoundType",
"tags": [],
"label": "metric",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.min",
"type": "CompoundType",
"tags": [],
"label": "min",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.max",
"type": "CompoundType",
"tags": [],
"label": "max",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.goal",
"type": "CompoundType",
"tags": [],
"label": "goal",
"description": [],
"signature": [
"string | ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.ExpressionValueVisDimension",
"text": "ExpressionValueVisDimension"
},
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.ticksPosition",
"type": "CompoundType",
"tags": [],
"label": "ticksPosition",
"description": [],
"signature": [
"\"auto\" | \"hidden\" | \"bands\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.labelMajorMode",
"type": "CompoundType",
"tags": [],
"label": "labelMajorMode",
"description": [],
"signature": [
"\"none\" | \"auto\" | \"custom\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.labelMajor",
"type": "string",
"tags": [],
"label": "labelMajor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.labelMinor",
"type": "string",
"tags": [],
"label": "labelMinor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.centralMajorMode",
"type": "CompoundType",
"tags": [],
"label": "centralMajorMode",
"description": [],
"signature": [
"GaugeCentralMajorMode",
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.centralMajor",
"type": "string",
"tags": [],
"label": "centralMajor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.colorMode",
"type": "CompoundType",
"tags": [],
"label": "colorMode",
"description": [],
"signature": [
"GaugeColorMode",
" | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.palette",
"type": "Object",
"tags": [],
"label": "palette",
"description": [],
"signature": [
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
"> | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.shape",
"type": "CompoundType",
"tags": [],
"label": "shape",
"description": [],
"signature": [
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.percentageMode",
"type": "CompoundType",
"tags": [
"deprecated"
],
"label": "percentageMode",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "visTypeGauge",
"path": "src/plugins/vis_types/gauge/public/to_ast.ts"
}
]
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.respectRanges",
"type": "CompoundType",
"tags": [],
"label": "respectRanges",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.commonLabel",
"type": "string",
"tags": [],
"label": "commonLabel",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.EXPRESSION_GAUGE_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_GAUGE_NAME",
"description": [],
"signature": [
"\"gauge\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.FormatFactory",
"type": "Type",
"tags": [],
"label": "FormatFactory",
"description": [],
"signature": [
"(mapping?: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<{}, ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined) => ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.FormatFactory.$1",
"type": "Object",
"tags": [],
"label": "mapping",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<{}, ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeArguments",
"type": "Type",
"tags": [],
"label": "GaugeArguments",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeState",
"text": "GaugeState"
},
" & { shape: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeShape",
"text": "GaugeShape"
},
"; colorMode: ",
"GaugeColorMode",
"; palette?: ",
{
"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; ariaLabel?: string | undefined; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeExpressionFunctionDefinition",
"type": "Type",
"tags": [],
"label": "GaugeExpressionFunctionDefinition",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionFunctionDefinition",
"text": "ExpressionFunctionDefinition"
},
"<\"gauge\", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeArguments",
"text": "GaugeArguments"
},
", ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionValueRender",
"text": "ExpressionValueRender"
},
"<",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeExpressionProps",
"text": "GaugeExpressionProps"
},
">, ",
{
"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_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeLabelMajorMode",
"type": "Type",
"tags": [],
"label": "GaugeLabelMajorMode",
"description": [],
"signature": [
"\"none\" | \"auto\" | \"custom\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeRenderProps",
"type": "Type",
"tags": [],
"label": "GaugeRenderProps",
"description": [],
"signature": [
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.GaugeExpressionProps",
"text": "GaugeExpressionProps"
},
" & { formatFactory: ",
{
"pluginId": "expressionGauge",
"scope": "common",
"docId": "kibExpressionGaugePluginApi",
"section": "def-common.FormatFactory",
"text": "FormatFactory"
},
"; chartsThemeService: ",
"Theme",
"; paletteService: ",
{
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteRegistry",
"text": "PaletteRegistry"
},
"; renderComplete: () => void; uiState: ",
{
"pluginId": "visualizations",
"scope": "public",
"docId": "kibVisualizationsPluginApi",
"section": "def-public.PersistedState",
"text": "PersistedState"
},
"; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeShape",
"type": "Type",
"tags": [],
"label": "GaugeShape",
"description": [],
"signature": [
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeTicksPosition",
"type": "Type",
"tags": [],
"label": "GaugeTicksPosition",
"description": [],
"signature": [
"\"auto\" | \"hidden\" | \"bands\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionGauge\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionGauge\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeColorModes",
"type": "Object",
"tags": [],
"label": "GaugeColorModes",
"description": [],
"signature": [
"{ readonly PALETTE: \"palette\"; readonly NONE: \"none\"; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeLabelMajorModes",
"type": "Object",
"tags": [],
"label": "GaugeLabelMajorModes",
"description": [],
"signature": [
"{ readonly AUTO: \"auto\"; readonly CUSTOM: \"custom\"; readonly NONE: \"none\"; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeShapes",
"type": "Object",
"tags": [],
"label": "GaugeShapes",
"description": [],
"signature": [
"{ readonly HORIZONTAL_BULLET: \"horizontalBullet\"; readonly VERTICAL_BULLET: \"verticalBullet\"; readonly ARC: \"arc\"; readonly CIRCLE: \"circle\"; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeTicksPositions",
"type": "Object",
"tags": [],
"label": "GaugeTicksPositions",
"description": [],
"signature": [
"{ readonly HIDDEN: \"hidden\"; readonly AUTO: \"auto\"; readonly BANDS: \"bands\"; }"
],
"path": "src/plugins/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}