github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/expression_gauge.devdocs.json

1399 lines
No EOL
50 KiB
JSON
Raw Permalink Blame History

{
"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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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) => number"
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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"
},
" & { 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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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": [
"\"hidden\" | \"auto\" | \"bands\""
],
"path": "src/platform/plugins/shared/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\" | \"custom\" | \"auto\""
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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": [
"\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\" | \"semiCircle\""
],
"path": "src/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.respectRanges",
"type": "CompoundType",
"tags": [],
"label": "respectRanges",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.centralMajorMode",
"type": "CompoundType",
"tags": [
"deprecated"
],
"label": "centralMajorMode",
"description": [],
"signature": [
"GaugeCentralMajorMode",
" | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": true,
"trackAdoption": false,
"references": []
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.centralMajor",
"type": "string",
"tags": [
"deprecated"
],
"label": "centralMajor",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": true,
"trackAdoption": false,
"references": []
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.GaugeState.percentageMode",
"type": "CompoundType",
"tags": [
"deprecated"
],
"label": "percentageMode",
"description": [
"\nThis field is deprecated and will be removed in a future release"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "visTypeGauge",
"path": "src/platform/plugins/private/vis_types/gauge/public/to_ast.ts"
},
{
"plugin": "visTypeGauge",
"path": "src/platform/plugins/private/vis_types/gauge/public/to_ast.ts"
}
]
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "expressionGauge",
"id": "def-common.AllowedGaugeOverrides",
"type": "Type",
"tags": [],
"label": "AllowedGaugeOverrides",
"description": [],
"signature": [
"{ gauge?: { id: string; target?: number | undefined; subtype: ",
"GoalSubtype",
"; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"GoalDomainRange",
">; actual?: number | undefined; base?: number | undefined; labelMajor?: string | ",
"GoalLabelAccessor",
" | undefined; labelMinor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMajor?: string | ",
"GoalLabelAccessor",
" | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; centralMinor?: string | ",
"GoalLabelAccessor",
" | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; } | undefined; }"
],
"path": "src/platform/plugins/shared/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionGauge",
"id": "def-common.EXPRESSION_GAUGE_NAME",
"type": "string",
"tags": [],
"label": "EXPRESSION_GAUGE_NAME",
"description": [],
"signature": [
"\"gauge\""
],
"path": "src/platform/plugins/shared/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": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined) => ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"path": "src/platform/plugins/shared/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": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/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"
},
" & { 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/platform/plugins/shared/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": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DefaultInspectorAdapters",
"text": "DefaultInspectorAdapters"
},
">>"
],
"path": "src/platform/plugins/shared/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\" | \"custom\" | \"auto\""
],
"path": "src/platform/plugins/shared/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: Omit<",
"ThemeService",
", \"init\">; 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"
},
"; overrides?: (Partial<Record<\"gauge\", { id: string; target?: number | undefined; subtype: ",
"GoalSubtype",
"; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<",
"GoalDomainRange",
">; actual?: number | undefined; base?: number | undefined; labelMajor?: string | ",
"GoalLabelAccessor",
" | undefined; labelMinor?: string | ",
"GoalLabelAccessor",
" | undefined; centralMajor?: string | ",
"GoalLabelAccessor",
" | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; centralMinor?: string | ",
"GoalLabelAccessor",
" | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.MakeOverridesSerializable",
"text": "MakeOverridesSerializable"
},
"<string[] | undefined>; tooltipValueFormatter?: \"ignore\" | undefined; }>> & 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; setChartSize: (d: ",
{
"pluginId": "@kbn/chart-expressions-common",
"scope": "common",
"docId": "kibKbnChartExpressionsCommonPluginApi",
"section": "def-common.ChartSizeSpec",
"text": "ChartSizeSpec"
},
") => void; }"
],
"path": "src/platform/plugins/shared/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": [
"\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\" | \"semiCircle\""
],
"path": "src/platform/plugins/shared/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": [
"\"hidden\" | \"auto\" | \"bands\""
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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/platform/plugins/shared/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 SEMI_CIRCLE: \"semiCircle\"; readonly ARC: \"arc\"; readonly CIRCLE: \"circle\"; }"
],
"path": "src/platform/plugins/shared/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/platform/plugins/shared/chart_expressions/expression_gauge/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink