{ "id": "expressionMetric", "client": { "classes": [], "functions": [ { "parentPluginId": "expressionMetric", "id": "def-public.metricRenderer", "type": "Function", "tags": [], "label": "metricRenderer", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "<", { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.MetricRendererConfig", "text": "MetricRendererConfig" }, ">" ], "path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [ { "parentPluginId": "expressionMetric", "id": "def-public.renderers", "type": "Array", "tags": [], "label": "renderers", "description": [], "signature": [ "(() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "<", { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.MetricRendererConfig", "text": "MetricRendererConfig" }, ">)[]" ], "path": "src/plugins/expression_metric/public/expression_renderers/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [], "start": { "parentPluginId": "expressionMetric", "id": "def-public.ExpressionMetricPluginStart", "type": "Type", "tags": [], "label": "ExpressionMetricPluginStart", "description": [], "signature": [ "void" ], "path": "src/plugins/expression_metric/public/plugin.ts", "deprecated": false, "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [], "start": { "parentPluginId": "expressionMetric", "id": "def-server.ExpressionMetricPluginStart", "type": "Type", "tags": [], "label": "ExpressionMetricPluginStart", "description": [], "signature": [ "void" ], "path": "src/plugins/expression_metric/server/plugin.ts", "deprecated": false, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "parentPluginId": "expressionMetric", "id": "def-common.metricFunction", "type": "Function", "tags": [], "label": "metricFunction", "description": [], "signature": [ "() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"string\" | \"null\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: string | number | null, { label, labelFont, metricFont, metricFormat }: ", { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.Arguments", "text": "Arguments" }, ") => { type: \"render\"; as: string; value: { metric: React.ReactText; label: string; labelFont: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, "; metricFont: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, "; metricFormat: string; }; }; }" ], "path": "src/plugins/expression_metric/common/expression_functions/metric_function.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "expressionMetric", "id": "def-common.Arguments", "type": "Interface", "tags": [], "label": "Arguments", "description": [], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false, "children": [ { "parentPluginId": "expressionMetric", "id": "def-common.Arguments.label", "type": "string", "tags": [], "label": "label", "description": [], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.Arguments.metricFont", "type": "Object", "tags": [], "label": "metricFont", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.Arguments.metricFormat", "type": "string", "tags": [], "label": "metricFormat", "description": [], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.Arguments.labelFont", "type": "Object", "tags": [], "label": "labelFont", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig", "type": "Interface", "tags": [], "label": "MetricRendererConfig", "description": [], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false, "children": [ { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig.label", "type": "string", "tags": [], "label": "label", "description": [ "The text to display under the metric" ], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig.labelFont", "type": "Object", "tags": [], "label": "labelFont", "description": [ "Font settings for the label" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig.metric", "type": "CompoundType", "tags": [], "label": "metric", "description": [ "Value of the metric to display" ], "signature": [ "string | number | null" ], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig.metricFont", "type": "Object", "tags": [], "label": "metricFont", "description": [ "Font settings for the metric" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.MetricRendererConfig.metricFormat", "type": "string", "tags": [], "label": "metricFormat", "description": [ "NumeralJS format string" ], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.NodeDimensions", "type": "Interface", "tags": [], "label": "NodeDimensions", "description": [], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false, "children": [ { "parentPluginId": "expressionMetric", "id": "def-common.NodeDimensions.width", "type": "number", "tags": [], "label": "width", "description": [], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false }, { "parentPluginId": "expressionMetric", "id": "def-common.NodeDimensions.height", "type": "number", "tags": [], "label": "height", "description": [], "path": "src/plugins/expression_metric/common/types/expression_renderers.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "expressionMetric", "id": "def-common.CSS", "type": "string", "tags": [], "label": "CSS", "description": [], "signature": [ "\"CSS\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.ExpressionMetricFunction", "type": "Type", "tags": [], "label": "ExpressionMetricFunction", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"metric\", string | number | null, ", { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.Arguments", "text": "Arguments" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "<\"render\", { as: string; value: ", { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.Arguments", "text": "Arguments" }, "; }>, ", { "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/expression_metric/common/types/expression_functions.ts", "deprecated": false, "returnComment": [], "children": [], "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.FONT_FAMILY", "type": "string", "tags": [], "label": "FONT_FAMILY", "description": [], "signature": [ "\"`font-family`\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.FONT_WEIGHT", "type": "string", "tags": [], "label": "FONT_WEIGHT", "description": [], "signature": [ "\"`font-weight`\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.functions", "type": "Array", "tags": [], "label": "functions", "description": [], "signature": [ { "pluginId": "expressionMetric", "scope": "common", "docId": "kibExpressionMetricPluginApi", "section": "def-common.ExpressionMetricFunction", "text": "ExpressionMetricFunction" }, "[]" ], "path": "src/plugins/expression_metric/common/expression_functions/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.Input", "type": "Type", "tags": [], "label": "Input", "description": [], "signature": [ "string | number | null" ], "path": "src/plugins/expression_metric/common/types/expression_functions.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.NUMERALJS", "type": "string", "tags": [], "label": "NUMERALJS", "description": [], "signature": [ "\"Numeral pattern\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.PLUGIN_ID", "type": "string", "tags": [], "label": "PLUGIN_ID", "description": [], "signature": [ "\"expressionMetric\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "expressionMetric", "id": "def-common.PLUGIN_NAME", "type": "string", "tags": [], "label": "PLUGIN_NAME", "description": [], "signature": [ "\"expressionMetric\"" ], "path": "src/plugins/expression_metric/common/constants.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [] } }