{ "id": "expressions", "client": { "classes": [ { "parentPluginId": "expressions", "id": "def-public.Execution", "type": "Class", "tags": [], "label": "Execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.state", "type": "Object", "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, {}>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.input", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.context", "type": "Object", "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.result", "type": "Object", "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.contract", "type": "Object", "tags": [], "label": "contract", "description": [ "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Execution.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.Unnamed.$1", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionParams", "text": "ExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.Unnamed.$2", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nStop execution of expression." ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.start", "type": "Function", "tags": [], "label": "start", "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "(input?: Input, isSubExpression?: boolean | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.start.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.start.$2", "type": "CompoundType", "tags": [], "label": "isSubExpression", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain", "type": "Function", "tags": [], "label": "invokeChain", "description": [], "signature": [ "([head, ...tail]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[], input: unknown) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | ChainOutput>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain.$1", "type": "Array", "tags": [], "label": "[head, ...tail]", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.invokeChain.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction", "type": "Function", "tags": [], "label": "invokeFunction", "description": [], "signature": [ "(fn: Fn, input: unknown, args: Record) => ", "Observable", ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$1", "type": "Uncategorized", "tags": [], "label": "fn", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.invokeFunction.$3", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.cast", "type": "Function", "tags": [], "label": "cast", "description": [], "signature": [ "(value: unknown, toTypeNames?: string[] | undefined) => Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.cast.$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.cast.$2", "type": "Array", "tags": [], "label": "toTypeNames", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(value: Type, argDef: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, ") => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.validate.$1", "type": "Uncategorized", "tags": [], "label": "value", "description": [], "signature": [ "Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.validate.$2", "type": "Object", "tags": [], "label": "argDef", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs", "type": "Function", "tags": [], "label": "resolveArgs", "description": [], "signature": [ "(fnDef: Fn, input: unknown, argAsts: Record) => ", "Observable", " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$1", "type": "Uncategorized", "tags": [], "label": "fnDef", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.resolveArgs.$3", "type": "Object", "tags": [], "label": "argAsts", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Execution.interpret", "type": "Function", "tags": [], "label": "interpret", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, ", input: T) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Execution.interpret.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Execution.interpret.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract", "type": "Class", "tags": [], "label": "ExecutionContract", "description": [ "\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.isPending", "type": "boolean", "tags": [], "label": "isPending", "description": [], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.execution", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.Unnamed.$1", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution." ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getData", "type": "Function", "tags": [], "label": "getData", "description": [ "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." ], "signature": [ "() => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getExpression", "type": "Function", "tags": [], "label": "getExpression", "description": [ "\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST." ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.getAst", "type": "Function", "tags": [], "label": "getAst", "description": [ "\nGet AST used to execute the expression." ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContract.inspect", "type": "Function", "tags": [], "label": "inspect", "description": [ "\nGet Inspector adapters provided to all functions of expression through\nexecution context." ], "signature": [ "() => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" } ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.Executor", "type": "Class", "tags": [], "label": "Executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.createWithDefaults", "type": "Function", "tags": [], "label": "createWithDefaults", "description": [], "signature": [ " = Record>(logger?: ", { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.createWithDefaults.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.Executor.createWithDefaults.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.container", "type": "Object", "tags": [], "label": "container", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Executor.functions", "type": "Object", "tags": [ "deprecated" ], "label": "functions", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.types", "type": "Object", "tags": [ "deprecated" ], "label": "types", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.Executor.Unnamed.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Executor.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.context", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Executor.run", "type": "Function", "tags": [], "label": "run", "description": [ "\nExecute expression and return result.\n" ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression AST or a string representing expression." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Initial input to the first expression function." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.createExecution", "type": "Function", "tags": [], "label": "createExecution", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.createExecution.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.createExecution.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.inject.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.extract.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.telemetry.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.Executor.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.Executor.migrateToLatest", "type": "Function", "tags": [], "label": "migrateToLatest", "description": [], "signature": [ "(state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Executor.migrateToLatest.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction", "type": "Class", "tags": [], "label": "ExpressionFunction", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.name", "type": "string", "tags": [], "label": "name", "description": [ "\nName of function" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.type", "type": "string", "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], "signature": [ "(input: any, params: Record, handlers: object) => any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.fn.$1", "type": "Any", "tags": [], "label": "input", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.fn.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.fn.$3", "type": "Uncategorized", "tags": [], "label": "handlers", "description": [], "signature": [ "object" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of expression function parameters." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.disabled", "type": "boolean", "tags": [], "label": "disabled", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [ "\nDeprecation flag." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(state: Record, telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.telemetry.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: Record) => { state: Record; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.extract.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: Record, references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inject.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.migrations", "type": "CompoundType", "tags": [], "label": "migrations", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" }, " | ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.GetMigrationFunctionObjectFn", "text": "GetMigrationFunctionObjectFn" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.Unnamed.$1", "type": "Object", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.required", "type": "boolean", "tags": [], "label": "required", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.types", "type": "CompoundType", "tags": [], "label": "types", "description": [], "signature": [ "(string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, ")[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ArrayTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedArrayTypeToArgumentString)[]) | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.default", "type": "CompoundType", "tags": [], "label": "default", "description": [], "signature": [ "string | T | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.resolve", "type": "boolean", "tags": [], "label": "resolve", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.strict", "type": "CompoundType", "tags": [ "deprecated" ], "label": "strict", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "T[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "arg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader", "type": "Class", "tags": [], "label": "ExpressionLoader", "description": [], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.data$", "type": "Object", "tags": [], "label": "data$", "description": [], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.update$", "type": "Object", "tags": [], "label": "update$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.render$", "type": "Object", "tags": [], "label": "render$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.events$", "type": "Object", "tags": [], "label": "events$", "description": [], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererEvent", "text": "ExpressionRendererEvent" }, ">" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.loading$", "type": "Object", "tags": [], "label": "loading$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.Unnamed.$1", "type": "Object", "tags": [], "label": "element", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "expression", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.Unnamed.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.destroy", "type": "Function", "tags": [], "label": "destroy", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.getExpression", "type": "Function", "tags": [], "label": "getExpression", "description": [], "signature": [ "() => string | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.getAst", "type": "Function", "tags": [], "label": "getAst", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.getElement", "type": "Function", "tags": [], "label": "getElement", "description": [], "signature": [ "() => HTMLElement" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.inspect", "type": "Function", "tags": [], "label": "inspect", "description": [], "signature": [ "() => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(expression?: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined, params?: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" }, " | undefined) => void" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.update.$1", "type": "CompoundType", "tags": [], "label": "expression", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionLoader.update.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer", "type": "Class", "tags": [], "label": "ExpressionRenderer", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.displayName", "type": "string", "tags": [], "label": "displayName", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "() => void | Error" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderer.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry", "type": "Class", "tags": [], "label": "ExpressionRendererRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, ">" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "[]" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler", "type": "Class", "tags": [], "label": "ExpressionRenderHandler", "description": [], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render$", "type": "Object", "tags": [], "label": "render$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.update$", "type": "Object", "tags": [], "label": "update$", "description": [], "signature": [ "Observable", "" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.events$", "type": "Object", "tags": [], "label": "events$", "description": [], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererEvent", "text": "ExpressionRendererEvent" }, ">" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed.$1", "type": "Object", "tags": [], "label": "element", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.Unnamed.$2", "type": "Object", "tags": [], "label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n syncCursor,\n interactive,\n hasCompatibleActions = async () => false,\n executionContext,\n }", "description": [], "signature": [ "ExpressionRenderHandlerParams" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(value: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, ", uiState?: unknown) => Promise" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render.$1", "type": "Object", "tags": [], "label": "value", "description": [], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" } ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.render.$2", "type": "Unknown", "tags": [], "label": "uiState", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.destroy", "type": "Function", "tags": [], "label": "destroy", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.getElement", "type": "Function", "tags": [], "label": "getElement", "description": [], "signature": [ "() => HTMLElement" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.handleRenderError", "type": "Function", "tags": [], "label": "handleRenderError", "description": [], "signature": [ "(error: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderError", "text": "ExpressionRenderError" }, ") => void" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderHandler.handleRenderError.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderError", "text": "ExpressionRenderError" } ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin", "type": "Class", "tags": [], "label": "ExpressionsPublicPlugin", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionsPublicPlugin", "text": "ExpressionsPublicPlugin" }, " implements ", { "pluginId": "@kbn/core-plugins-browser", "scope": "common", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-common.Plugin", "text": "Plugin" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" }, ", ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionsStart", "text": "ExpressionsStart" }, ", object, object>" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.Unnamed.$1", "type": "Object", "tags": [], "label": "initializerContext", "description": [], "signature": [ { "pluginId": "@kbn/core-plugins-browser", "scope": "common", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-common.PluginInitializerContext", "text": "PluginInitializerContext" }, "" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "(core: ", { "pluginId": "@kbn/core-lifecycle-browser", "scope": "common", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-common.CoreSetup", "text": "CoreSetup" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" } ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.setup.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-browser", "scope": "common", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-common.CoreSetup", "text": "CoreSetup" }, "" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(core: ", { "pluginId": "@kbn/core-lifecycle-browser", "scope": "common", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-common.CoreStart", "text": "CoreStart" }, ") => ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionsStart", "text": "ExpressionsStart" } ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.start.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-browser", "scope": "common", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-common.CoreStart", "text": "CoreStart" } ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsPublicPlugin.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService", "type": "Class", "tags": [], "label": "ExpressionsService", "description": [ "\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ">,", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" }, ",", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.renderers", "type": "Object", "tags": [], "label": "renderers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.Unnamed.$1", "type": "Object", "tags": [], "label": "{\n logger,\n executor = Executor.createWithDefaults(logger),\n renderers = new ExpressionRendererRegistry(),\n }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionServiceParams", "text": "ExpressionServiceParams" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(name: string, namespace: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(namespace: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getRenderer", "type": "Function", "tags": [], "label": "getRenderer", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getRenderers", "type": "Function", "tags": [], "label": "getRenderers", "description": [], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerRenderer", "type": "Function", "tags": [], "label": "registerRenderer", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.registerRenderer.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.fork", "type": "Function", "tags": [], "label": "fork", "description": [], "signature": [ "(name: string) => ", "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.fork.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.execute.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run", "type": "Function", "tags": [], "label": "run", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [ "\nExtracts telemetry from expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData?: Record) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to extract references from" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.extract", "type": "Function", "tags": [], "label": "extract", "description": [ "\nExtracts saved object references from expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.extract.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to extract references from" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "new expression AST with references removed and array of references" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.inject", "type": "Function", "tags": [], "label": "inject", "description": [ "\nInjects saved object references into expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.inject.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to update" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [ "array of saved object references" ], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "new expression AST with references injected" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [ "\ngets an object with semver mapped to a migration function" ], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.migrateToLatest", "type": "Function", "tags": [], "label": "migrateToLatest", "description": [ "\nmigrates an old expression to latest version" ], "signature": [ "(state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.migrateToLatest.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.setup", "type": "Function", "tags": [], "label": "setup", "description": [ "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." ], "signature": [ "(...args: unknown[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.setup.$1", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "unknown[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.start", "type": "Function", "tags": [], "label": "start", "description": [ "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." ], "signature": [ "(...args: unknown[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.start.$1", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "unknown[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsService.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], "signature": [ "(type: unknown) => void | Error" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.create", "type": "Unknown", "tags": [], "label": "create", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], "signature": [ "((value: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") => unknown) | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((serialized: unknown[]) => ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.Unnamed.$1", "type": "Object", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" } ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.getToFn", "type": "Function", "tags": [], "label": "getToFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.getToFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.getFromFn", "type": "Function", "tags": [], "label": "getFromFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.getFromFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsTo", "type": "Function", "tags": [], "label": "castsTo", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsTo.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsFrom", "type": "Function", "tags": [], "label": "castsFrom", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.castsFrom.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.to", "type": "Function", "tags": [], "label": "to", "description": [], "signature": [ "(value: any, toTypeName: string, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$2", "type": "string", "tags": [], "label": "toTypeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.to.$3", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.from", "type": "Function", "tags": [], "label": "from", "description": [], "signature": [ "(value: any, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionType.from.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionType.from.$2", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry", "type": "Class", "tags": [], "label": "FunctionsRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.FunctionsRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TablesAdapter", "type": "Class", "tags": [], "label": "TablesAdapter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, " extends EventEmitter" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable", "type": "Function", "tags": [], "label": "logDatatable", "description": [], "signature": [ "(name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => void" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.logDatatable.$2", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.reset", "type": "Function", "tags": [], "label": "reset", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TablesAdapter.tables", "type": "Object", "tags": [], "label": "tables", "description": [], "signature": [ "{ [key: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, "; }" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TypesRegistry", "type": "Class", "tags": [], "label": "TypesRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.TypesRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "expressions", "id": "def-public.buildExpression", "type": "Function", "tags": [ "return" ], "label": "buildExpression", "description": [ "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" ], "signature": [ "(initialState: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.buildExpression.$1", "type": "CompoundType", "tags": [], "label": "initialState", "description": [ "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction", "type": "Function", "tags": [ "return" ], "label": "buildExpressionFunction", "description": [ "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "String representing the name of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.buildExpressionFunction.$2", "type": "Object", "tags": [], "label": "initialArgs", "description": [ "Object containing the arguments to this function." ], "signature": [ "{ [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.createDefaultInspectorAdapters", "type": "Function", "tags": [], "label": "createDefaultInspectorAdapters", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DefaultInspectorAdapters", "text": "DefaultInspectorAdapters" } ], "path": "src/plugins/expressions/common/util/create_default_inspector_adapters.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.formatExpression", "type": "Function", "tags": [], "label": "formatExpression", "description": [ "\nGiven expression pipeline AST, returns formatted string.\n" ], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => string" ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.formatExpression.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression pipeline AST." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.isExpressionAstBuilder", "type": "Function", "tags": [ "return" ], "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], "signature": [ "(val: unknown) => boolean" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.isExpressionAstBuilder.$1", "type": "Unknown", "tags": [], "label": "val", "description": [ "Value you want to check." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "boolean" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.parseExpression", "type": "Function", "tags": [], "label": "parseExpression", "description": [ "\nGiven expression pipeline string, returns parsed AST.\n" ], "signature": [ "(expression: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.parseExpression.$1", "type": "string", "tags": [], "label": "expression", "description": [ "Expression pipeline string." ], "signature": [ "string" ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.useExpressionRenderer", "type": "Function", "tags": [], "label": "useExpressionRenderer", "description": [], "signature": [ "(nodeRef: React.RefObject, {\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererParams", "text": "ExpressionRendererParams" }, ") => ExpressionRendererState" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.useExpressionRenderer.$1", "type": "Object", "tags": [], "label": "nodeRef", "description": [], "signature": [ "React.RefObject" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.useExpressionRenderer.$2", "type": "Object", "tags": [], "label": "{\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererParams", "text": "ExpressionRendererParams" } ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "expressions", "id": "def-public.Datatable", "type": "Interface", "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Datatable.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Datatable.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Datatable.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ "DatatableMeta", " | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Datatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.DatatableColumn", "type": "Interface", "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.DatatableColumn.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.DatatableColumn.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.DatatableColumn.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext", "type": "Interface", "tags": [], "label": "ExecutionContext", "description": [ "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getSearchContext", "type": "Function", "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], "signature": [ "() => ExecutionContextSearch" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.variables", "type": "Object", "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.types", "type": "Object", "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.abortSignal", "type": "Object", "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], "signature": [ "AbortSignal" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getSearchSessionId", "type": "Function", "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], "signature": [ "() => string | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getKibanaRequest", "type": "Function", "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], "signature": [ "(() => ", { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [ "\nReturns the state (true|false) of the sync cursor across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [ "\nReturns the state (true|false) of the sync tooltips across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [ "\nContains the meta-data about the source of the expression." ], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.logDatatable", "type": "Function", "tags": [], "label": "logDatatable", "description": [ "\nLogs datatable." ], "signature": [ "((name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => void) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.logDatatable.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.logDatatable.$2", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionParams", "type": "Interface", "tags": [], "label": "ExecutionParams", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionParams.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionParams.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionParams.expression", "type": "string", "tags": [], "label": "expression", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionParams.params", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionState", "type": "Interface", "tags": [], "label": "ExecutionState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutionState.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionState.state", "type": "CompoundType", "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], "signature": [ "\"error\" | \"not-started\" | \"pending\" | \"result\"" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionState.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], "signature": [ "Output | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionState.error", "type": "Object", "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], "signature": [ "Error | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutorState", "type": "Interface", "tags": [], "label": "ExecutorState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExecutorState.functions", "type": "Object", "tags": [], "label": "functions", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutorState.types", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutorState.context", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "Context" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], "signature": [ "\"expression_builder\"" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.functions", "type": "Array", "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.findFunction", "type": "Function", "tags": [ "return" ], "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]) => [] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "Name of the function to search for." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilder[]`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstExpression`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpressionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstFunctionBuilder", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], "signature": [ "\"expression_function_builder\"" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nName of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.arguments", "type": "Object", "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], "signature": [ "FunctionBuilderArguments" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.addArgument", "type": "Function", "tags": [ "return" ], "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], "signature": [ ">(name: A, value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to add." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", "description": [ "The value of the argument to add." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.getArgument", "type": "Function", "tags": [ "return" ], "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], "signature": [ ">(name: A) => (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to retrieve." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument", "type": "Function", "tags": [ "return" ], "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], "signature": [ ">(name: A, value: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to replace." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", "description": [ "The value of the argument. Must always be an array." ], "signature": [ "(", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.removeArgument", "type": "Function", "tags": [ "return" ], "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], "signature": [ ">>(name: A) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to remove." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstFunction`" ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunctionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionExecutor", "type": "Interface", "tags": [ "deprecated" ], "label": "ExpressionExecutor", "description": [], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": true, "trackAdoption": false, "references": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionExecutor.interpreter", "type": "Object", "tags": [], "label": "interpreter", "description": [], "signature": [ "ExpressionInterpreter" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinition", "description": [ "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, " extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">>" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.deprecated", "type": "CompoundType", "tags": [], "label": "deprecated", "description": [ "\nThe flag to mark the function as deprecated." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.disabled", "type": "CompoundType", "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.type", "type": "CompoundType", "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited> | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypeToString", "text": "TypeToString" }, "[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], "signature": [ "{ [key in keyof Arguments]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "; }" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.aliases", "type": "Array", "tags": [ "todo" ], "label": "aliases", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nThe actual implementation of the function.\n" ], "signature": [ "(input: Input, args: Arguments, context: Context) => Output" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Output of the previous function, or initial input." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", "tags": [], "label": "args", "description": [ "Parameters set for this function in expression." ], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", "tags": [], "label": "context", "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], "signature": [ "Context" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.context", "type": "Object", "tags": [ "deprecated" ], "label": "context", "description": [], "signature": [ "{ types: any[] | undefined; } | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.clog", "type": "Object", "tags": [], "label": "clog", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"clog\", unknown, {}, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.font", "type": "Object", "tags": [], "label": "font", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"font\", null, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, ", ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.var_set", "type": "Object", "tags": [], "label": "var_set", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var_set\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.var", "type": "Object", "tags": [], "label": "var", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.theme", "type": "Object", "tags": [], "label": "theme", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"theme\", null, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", "tags": [], "label": "cumulative_sum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"cumulative_sum\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.overall_metric", "type": "Object", "tags": [], "label": "overall_metric", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"overall_metric\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.derivative", "type": "Object", "tags": [], "label": "derivative", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"derivative\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinitions.moving_average", "type": "Object", "tags": [], "label": "moving_average", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"moving_average\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionImage", "type": "Interface", "tags": [], "label": "ExpressionImage", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionImage.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"image\"" ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionImage.mode", "type": "string", "tags": [], "label": "mode", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionImage.dataurl", "type": "string", "tags": [], "label": "dataurl", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition", "type": "Interface", "tags": [], "label": "ExpressionRenderDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.name", "type": "string", "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.displayName", "type": "string", "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], "signature": [ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.render", "type": "Function", "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams", "type": "Interface", "tags": [], "label": "ExpressionRendererParams", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererParams", "text": "ExpressionRendererParams" }, " extends ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" } ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.debounce", "type": "number", "tags": [], "label": "debounce", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.expression", "type": "CompoundType", "tags": [], "label": "expression", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.hasCustomErrorRenderer", "type": "CompoundType", "tags": [], "label": "hasCustomErrorRenderer", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onData$", "type": "Function", "tags": [], "label": "onData$", "description": [], "signature": [ "((data: TData, adapters?: TInspectorAdapters | undefined, partial?: boolean | undefined) => void) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onData$.$1", "type": "Uncategorized", "tags": [], "label": "data", "description": [], "signature": [ "TData" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onData$.$2", "type": "Uncategorized", "tags": [], "label": "adapters", "description": [], "signature": [ "TInspectorAdapters | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onData$.$3", "type": "CompoundType", "tags": [], "label": "partial", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onEvent", "type": "Function", "tags": [], "label": "onEvent", "description": [], "signature": [ "((event: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererEvent", "text": "ExpressionRendererEvent" }, ") => void) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onEvent.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererEvent", "text": "ExpressionRendererEvent" } ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onRender$", "type": "Function", "tags": [], "label": "onRender$", "description": [], "signature": [ "((item: number) => void) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.onRender$.$1", "type": "number", "tags": [], "label": "item", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererParams.reload$", "type": "Object", "tags": [], "label": "reload$", "description": [ "\nAn observable which can be used to re-run the expression without destroying the component" ], "signature": [ "Observable", " | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError", "type": "Interface", "tags": [], "label": "ExpressionRenderError", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderError", "text": "ExpressionRenderError" }, " extends Error" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError.original", "type": "Object", "tags": [], "label": "original", "description": [], "signature": [ "Error | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart", "type": "Interface", "tags": [], "label": "ExpressionsServiceStart", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getRenderer", "type": "Function", "tags": [], "label": "getRenderer", "description": [ "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getRenderers", "type": "Function", "tags": [], "label": "getRenderers", "description": [ "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." ], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getType", "type": "Function", "tags": [], "label": "getType", "description": [ "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [ "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." ], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.run", "type": "Function", "tags": [], "label": "run", "description": [ "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.execute", "type": "Function", "tags": [], "label": "execute", "description": [ "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.execute.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.extract.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.inject.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.telemetry.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceStart.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition", "type": "Interface", "tags": [], "label": "ExpressionTypeDefinition", "description": [ "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "((type: unknown) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.serialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.deserialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "SerializedType" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.from", "type": "Object", "tags": [], "label": "from", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.to", "type": "Object", "tags": [], "label": "to", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeDefinition.help", "type": "string", "tags": [], "label": "help", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle", "type": "Interface", "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"style\"" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.spec", "type": "Object", "tags": [], "label": "spec", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CSSStyle", "text": "CSSStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionTypeStyle.css", "type": "string", "tags": [], "label": "css", "description": [], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.Font", "type": "Interface", "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Font.label", "type": "CompoundType", "tags": [], "label": "label", "description": [], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Font.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams", "type": "Interface", "tags": [], "label": "IExpressionLoaderParams", "description": [], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.searchContext", "type": "Object", "tags": [], "label": "searchContext", "description": [], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.context", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.variables", "type": "Object", "tags": [], "label": "variables", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.disableCaching", "type": "CompoundType", "tags": [], "label": "disableCaching", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.customFunctions", "type": "Object", "tags": [], "label": "customFunctions", "description": [], "signature": [ "[] | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.customRenderers", "type": "Object", "tags": [], "label": "customRenderers", "description": [], "signature": [ "[] | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.uiState", "type": "Unknown", "tags": [], "label": "uiState", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.inspectorAdapters", "type": "Object", "tags": [], "label": "inspectorAdapters", "description": [], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.interactive", "type": "CompoundType", "tags": [], "label": "interactive", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.onRenderError", "type": "Function", "tags": [], "label": "onRenderError", "description": [], "signature": [ "RenderErrorHandlerFnType", " | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.renderMode", "type": "CompoundType", "tags": [], "label": "renderMode", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.RenderMode", "text": "RenderMode" }, " | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.syncColors", "type": "CompoundType", "tags": [], "label": "syncColors", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.syncCursor", "type": "CompoundType", "tags": [], "label": "syncCursor", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.syncTooltips", "type": "CompoundType", "tags": [], "label": "syncTooltips", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.hasCompatibleActions", "type": "Function", "tags": [], "label": "hasCompatibleActions", "description": [], "signature": [ "((event: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererEvent", "text": "ExpressionRendererEvent" }, ") => Promise) | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.executionContext", "type": "Object", "tags": [], "label": "executionContext", "description": [], "signature": [ { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.partial", "type": "CompoundType", "tags": [], "label": "partial", "description": [ "\nThe flag to toggle on emitting partial results.\nBy default, the partial results are disabled." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.throttle", "type": "number", "tags": [], "label": "throttle", "description": [ "\nThrottling of partial results in milliseconds. 0 is disabling the throttling.\nBy default, it equals 1000." ], "signature": [ "number | undefined" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers", "type": "Interface", "tags": [], "label": "IInterpreterRenderHandlers", "description": [], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.done", "type": "Function", "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.onDestroy", "type": "Function", "tags": [], "label": "onDestroy", "description": [], "signature": [ "(fn: () => void) => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.reload", "type": "Function", "tags": [], "label": "reload", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.update.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.event", "type": "Function", "tags": [], "label": "event", "description": [], "signature": [ "(event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.event.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", "tags": [], "label": "hasCompatibleActions", "description": [], "signature": [ "((event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => Promise) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.getRenderMode", "type": "Function", "tags": [], "label": "getRenderMode", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.RenderMode", "text": "RenderMode" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.isInteractive", "type": "Function", "tags": [], "label": "isInteractive", "description": [ "\nThe chart is rendered in a non-interactive environment and should not provide any affordances for interaction like brushing." ], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.uiState", "type": "Unknown", "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.IRegistry", "type": "Interface", "tags": [], "label": "IRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => T | null" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.IRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.IRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => T[]" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn", "type": "Interface", "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"string\" | \"number\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.role", "type": "CompoundType", "tags": [], "label": "role", "description": [], "signature": [ "\"measure\" | \"dimension\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumn.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.Range", "type": "Interface", "tags": [], "label": "Range", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.Range.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Range.from", "type": "number", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Range.to", "type": "number", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.Range.label", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps", "type": "Interface", "tags": [], "label": "ReactExpressionRendererProps", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, " extends Omit<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRendererParams", "text": "ExpressionRendererParams" }, ", \"hasCustomErrorRenderer\">" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.className", "type": "string", "tags": [], "label": "className", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.dataAttrs", "type": "Array", "tags": [], "label": "dataAttrs", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.renderError", "type": "Function", "tags": [], "label": "renderError", "description": [], "signature": [ "((message?: string | null | undefined, error?: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderError", "text": "ExpressionRenderError" }, " | null | undefined) => React.ReactElement> | React.ReactElement>[]) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.renderError.$1", "type": "CompoundType", "tags": [], "label": "message", "description": [], "signature": [ "string | null | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.renderError.$2", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderError", "text": "ExpressionRenderError" }, " | null | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererProps.padding", "type": "CompoundType", "tags": [], "label": "padding", "description": [], "signature": [ "\"m\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.SerializedDatatable", "type": "Interface", "tags": [], "label": "SerializedDatatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.SerializedDatatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ "string[][]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "expressions", "id": "def-public.FontStyle", "type": "Enum", "tags": [], "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.FontWeight", "type": "Enum", "tags": [], "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.Overflow", "type": "Enum", "tags": [], "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TextAlignment", "type": "Enum", "tags": [], "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TextDecoration", "type": "Enum", "tags": [], "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "expressions", "id": "def-public.AnyExpressionFunctionDefinition", "type": "Type", "tags": [], "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, ", any, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.AnyExpressionTypeDefinition", "type": "Type", "tags": [], "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ArgumentType", "type": "Type", "tags": [], "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], "signature": [ "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" ], "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.DatatableColumnType", "type": "Type", "tags": [], "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.DatatableRow", "type": "Type", "tags": [], "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContainer", "type": "Type", "tags": [], "label": "ExecutionContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, ", {}>" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExecutorContainer", "type": "Type", "tags": [], "label": "ExecutorContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstArgument", "type": "Type", "tags": [], "label": "ExpressionAstArgument", "description": [], "signature": [ "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstExpression", "type": "Type", "tags": [], "label": "ExpressionAstExpression", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstFunction", "type": "Type", "tags": [], "label": "ExpressionAstFunction", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.AstFunction", "text": "AstFunction" }, ", \"arguments\"> & { arguments: Record; debug?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionDebug", "text": "ExpressionAstFunctionDebug" }, " | undefined; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionAstNode", "type": "Type", "tags": [], "label": "ExpressionAstNode", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererComponent", "type": "Type", "tags": [], "label": "ExpressionRendererComponent", "description": [], "signature": [ "React.FunctionComponent<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, ">" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererComponent.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "P & { children?: React.ReactNode; }" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererComponent.$2", "type": "Any", "tags": [], "label": "context", "description": [], "signature": [ "any" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRendererEvent", "type": "Type", "tags": [], "label": "ExpressionRendererEvent", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValue", "type": "Type", "tags": [], "label": "ExpressionValue", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueBoxed", "type": "Type", "tags": [], "label": "ExpressionValueBoxed", "description": [], "signature": [ "{ type: Type; } & Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueConverter", "type": "Type", "tags": [], "label": "ExpressionValueConverter", "description": [], "signature": [ "(input: I, availableTypes: Record) => O" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionValueConverter.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "I" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueConverter.$2", "type": "Object", "tags": [], "label": "availableTypes", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueError", "type": "Type", "tags": [], "label": "ExpressionValueError", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueFilter", "type": "Type", "tags": [], "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], "signature": [ "{ type: \"filter\"; } & { filterType?: string | undefined; filterGroup?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueFilter", "text": "ExpressionValueFilter" }, "[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueNum", "type": "Type", "tags": [], "label": "ExpressionValueNum", "description": [], "signature": [ "{ type: \"num\"; } & { value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueRender", "type": "Type", "tags": [], "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueRender", "type": "Type", "tags": [], "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionValueUnboxed", "type": "Type", "tags": [], "label": "ExpressionValueUnboxed", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.FontLabel", "type": "Type", "tags": [], "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.FontValue", "type": "Type", "tags": [], "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.InterpreterErrorType", "type": "Type", "tags": [ "deprecated" ], "label": "InterpreterErrorType", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": true, "trackAdoption": false, "references": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.KnownTypeToString", "type": "Type", "tags": [], "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], "signature": [ "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeries", "type": "Type", "tags": [], "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ "{ type: \"pointseries\"; } & { columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumns", "text": "PointSeriesColumns" }, "; rows: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumnName", "type": "Type", "tags": [], "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], "signature": [ "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesColumns", "type": "Type", "tags": [], "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], "signature": [ "{} | Record<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumnName", "text": "PointSeriesColumnName" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumn", "text": "PointSeriesColumn" }, ">" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.PointSeriesRow", "type": "Type", "tags": [], "label": "PointSeriesRow", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.ReactExpressionRendererType", "type": "Type", "tags": [], "label": "ReactExpressionRendererType", "description": [], "signature": [ "React.ComponentClass<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, ", any> | React.FunctionComponent<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, ">" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.Style", "type": "Type", "tags": [], "label": "Style", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TypeString", "type": "Type", "tags": [], "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ "(T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends string ? \"string\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends boolean ? \"boolean\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends number ? \"number\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends null ? \"null\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends { type: string; } ? ({ type: string; } & (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited))[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.TypeToString", "type": "Type", "tags": [], "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, "" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-public.UnmappedTypeStrings", "type": "Type", "tags": [], "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], "signature": [ "\"date\" | \"filter\"" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup", "type": "Interface", "tags": [], "label": "ExpressionsServiceSetup", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getFunction", "type": "Function", "tags": [ "deprecated" ], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/setup_expressions.ts" } ], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getFunctions", "type": "Function", "tags": [ "deprecated" ], "label": "getFunctions", "description": [ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.test.ts" } ], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getTypes", "type": "Function", "tags": [ "deprecated" ], "label": "getTypes", "description": [ "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." ], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/setup_expressions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/application.tsx" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" } ], "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.fork", "type": "Function", "tags": [], "label": "fork", "description": [ "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." ], "signature": [ "(namespace: string) => ", "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.fork.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [ "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." ], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerRenderer", "type": "Function", "tags": [], "label": "registerRenderer", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.registerRenderer.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsServiceSetup.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart", "type": "Interface", "tags": [], "label": "ExpressionsStart", "description": [ "\nExpressions public start contrect, extends {@link ExpressionServiceStart}" ], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionsStart", "text": "ExpressionsStart" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.loader", "type": "Function", "tags": [], "label": "loader", "description": [], "signature": [ "(element: HTMLElement, expression?: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined, params?: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" }, " | undefined) => Promise<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionLoader", "text": "ExpressionLoader" }, ">" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.loader.$1", "type": "Object", "tags": [], "label": "element", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.loader.$2", "type": "CompoundType", "tags": [], "label": "expression", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.loader.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.IExpressionLoaderParams", "text": "IExpressionLoaderParams" }, " | undefined" ], "path": "src/plugins/expressions/public/loader.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(element: HTMLElement, data: unknown, options?: ", "ExpressionRenderHandlerParams", " | undefined) => Promise<", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ExpressionRenderHandler", "text": "ExpressionRenderHandler" }, ">" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.render.$1", "type": "Object", "tags": [], "label": "element", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.render.$2", "type": "Unknown", "tags": [], "label": "data", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.render.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "ExpressionRenderHandlerParams", " | undefined" ], "path": "src/plugins/expressions/public/render.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.ReactExpressionRenderer", "type": "Function", "tags": [], "label": "ReactExpressionRenderer", "description": [], "signature": [ "(props: ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, ") => JSX.Element" ], "path": "src/plugins/expressions/public/plugin.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-public.ExpressionsStart.ReactExpressionRenderer.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" } ], "path": "src/plugins/expressions/public/react_expression_renderer_wrapper.tsx", "deprecated": false, "trackAdoption": false } ] } ], "lifecycle": "start", "initialIsOpen": true } }, "server": { "classes": [ { "parentPluginId": "expressions", "id": "def-server.Execution", "type": "Class", "tags": [], "label": "Execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.state", "type": "Object", "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, {}>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.input", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.context", "type": "Object", "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.result", "type": "Object", "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.contract", "type": "Object", "tags": [], "label": "contract", "description": [ "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Execution.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.Unnamed.$1", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionParams", "text": "ExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.Unnamed.$2", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nStop execution of expression." ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.start", "type": "Function", "tags": [], "label": "start", "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "(input?: Input, isSubExpression?: boolean | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.start.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.start.$2", "type": "CompoundType", "tags": [], "label": "isSubExpression", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain", "type": "Function", "tags": [], "label": "invokeChain", "description": [], "signature": [ "([head, ...tail]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[], input: unknown) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | ChainOutput>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain.$1", "type": "Array", "tags": [], "label": "[head, ...tail]", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.invokeChain.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction", "type": "Function", "tags": [], "label": "invokeFunction", "description": [], "signature": [ "(fn: Fn, input: unknown, args: Record) => ", "Observable", ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$1", "type": "Uncategorized", "tags": [], "label": "fn", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.invokeFunction.$3", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.cast", "type": "Function", "tags": [], "label": "cast", "description": [], "signature": [ "(value: unknown, toTypeNames?: string[] | undefined) => Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.cast.$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.cast.$2", "type": "Array", "tags": [], "label": "toTypeNames", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(value: Type, argDef: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, ") => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.validate.$1", "type": "Uncategorized", "tags": [], "label": "value", "description": [], "signature": [ "Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.validate.$2", "type": "Object", "tags": [], "label": "argDef", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs", "type": "Function", "tags": [], "label": "resolveArgs", "description": [], "signature": [ "(fnDef: Fn, input: unknown, argAsts: Record) => ", "Observable", " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$1", "type": "Uncategorized", "tags": [], "label": "fnDef", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.resolveArgs.$3", "type": "Object", "tags": [], "label": "argAsts", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Execution.interpret", "type": "Function", "tags": [], "label": "interpret", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, ", input: T) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Execution.interpret.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Execution.interpret.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.Executor", "type": "Class", "tags": [], "label": "Executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.createWithDefaults", "type": "Function", "tags": [], "label": "createWithDefaults", "description": [], "signature": [ " = Record>(logger?: ", { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.createWithDefaults.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-server.Executor.createWithDefaults.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.container", "type": "Object", "tags": [], "label": "container", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Executor.functions", "type": "Object", "tags": [ "deprecated" ], "label": "functions", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.types", "type": "Object", "tags": [ "deprecated" ], "label": "types", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-server.Executor.Unnamed.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Executor.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.context", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Executor.run", "type": "Function", "tags": [], "label": "run", "description": [ "\nExecute expression and return result.\n" ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression AST or a string representing expression." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Initial input to the first expression function." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.createExecution", "type": "Function", "tags": [], "label": "createExecution", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.createExecution.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.createExecution.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.inject.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.extract.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.telemetry.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.Executor.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.Executor.migrateToLatest", "type": "Function", "tags": [], "label": "migrateToLatest", "description": [], "signature": [ "(state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Executor.migrateToLatest.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction", "type": "Class", "tags": [], "label": "ExpressionFunction", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.name", "type": "string", "tags": [], "label": "name", "description": [ "\nName of function" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.type", "type": "string", "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], "signature": [ "(input: any, params: Record, handlers: object) => any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.fn.$1", "type": "Any", "tags": [], "label": "input", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.fn.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.fn.$3", "type": "Uncategorized", "tags": [], "label": "handlers", "description": [], "signature": [ "object" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of expression function parameters." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.disabled", "type": "boolean", "tags": [], "label": "disabled", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [ "\nDeprecation flag." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(state: Record, telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.telemetry.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: Record) => { state: Record; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.extract.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: Record, references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inject.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.migrations", "type": "CompoundType", "tags": [], "label": "migrations", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" }, " | ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.GetMigrationFunctionObjectFn", "text": "GetMigrationFunctionObjectFn" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.Unnamed.$1", "type": "Object", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.required", "type": "boolean", "tags": [], "label": "required", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.types", "type": "CompoundType", "tags": [], "label": "types", "description": [], "signature": [ "(string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, ")[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ArrayTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedArrayTypeToArgumentString)[]) | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.default", "type": "CompoundType", "tags": [], "label": "default", "description": [], "signature": [ "string | T | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.resolve", "type": "boolean", "tags": [], "label": "resolve", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.strict", "type": "CompoundType", "tags": [ "deprecated" ], "label": "strict", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "T[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "arg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer", "type": "Class", "tags": [], "label": "ExpressionRenderer", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.displayName", "type": "string", "tags": [], "label": "displayName", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "() => void | Error" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderer.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry", "type": "Class", "tags": [], "label": "ExpressionRendererRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, ">" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRendererRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "[]" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin", "type": "Class", "tags": [], "label": "ExpressionsServerPlugin", "description": [], "signature": [ { "pluginId": "expressions", "scope": "server", "docId": "kibExpressionsPluginApi", "section": "def-server.ExpressionsServerPlugin", "text": "ExpressionsServerPlugin" }, " implements ", { "pluginId": "@kbn/core-plugins-server", "scope": "server", "docId": "kibKbnCorePluginsServerPluginApi", "section": "def-server.Plugin", "text": "Plugin" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" }, ", object, object>" ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.expressions", "type": "Object", "tags": [], "label": "expressions", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsService", "text": "ExpressionsService" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.Unnamed.$1", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "pluginId": "@kbn/core-plugins-server", "scope": "server", "docId": "kibKbnCorePluginsServerPluginApi", "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, "" ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "(core: ", { "pluginId": "@kbn/core-lifecycle-server", "scope": "server", "docId": "kibKbnCoreLifecycleServerPluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.setup.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-server", "scope": "server", "docId": "kibKbnCoreLifecycleServerPluginApi", "section": "def-server.CoreSetup", "text": "CoreSetup" }, "" ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(core: ", { "pluginId": "@kbn/core-lifecycle-server", "scope": "server", "docId": "kibKbnCoreLifecycleServerPluginApi", "section": "def-server.CoreStart", "text": "CoreStart" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.start.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-server", "scope": "server", "docId": "kibKbnCoreLifecycleServerPluginApi", "section": "def-server.CoreStart", "text": "CoreStart" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerPlugin.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], "signature": [ "(type: unknown) => void | Error" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.create", "type": "Unknown", "tags": [], "label": "create", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], "signature": [ "((value: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") => unknown) | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((serialized: unknown[]) => ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.Unnamed.$1", "type": "Object", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" } ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.getToFn", "type": "Function", "tags": [], "label": "getToFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.getToFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.getFromFn", "type": "Function", "tags": [], "label": "getFromFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.getFromFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsTo", "type": "Function", "tags": [], "label": "castsTo", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsTo.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsFrom", "type": "Function", "tags": [], "label": "castsFrom", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.castsFrom.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.to", "type": "Function", "tags": [], "label": "to", "description": [], "signature": [ "(value: any, toTypeName: string, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$2", "type": "string", "tags": [], "label": "toTypeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.to.$3", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.from", "type": "Function", "tags": [], "label": "from", "description": [], "signature": [ "(value: any, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionType.from.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionType.from.$2", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry", "type": "Class", "tags": [], "label": "FunctionsRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.FunctionsRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.TypesRegistry", "type": "Class", "tags": [], "label": "TypesRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.TypesRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "expressions", "id": "def-server.buildExpression", "type": "Function", "tags": [ "return" ], "label": "buildExpression", "description": [ "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" ], "signature": [ "(initialState: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.buildExpression.$1", "type": "CompoundType", "tags": [], "label": "initialState", "description": [ "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction", "type": "Function", "tags": [ "return" ], "label": "buildExpressionFunction", "description": [ "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "String representing the name of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.buildExpressionFunction.$2", "type": "Object", "tags": [], "label": "initialArgs", "description": [ "Object containing the arguments to this function." ], "signature": [ "{ [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.format", "type": "Function", "tags": [], "label": "format", "description": [], "signature": [ "(ast: T, type: T extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " ? \"expression\" : \"argument\") => string" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.format.$1", "type": "Uncategorized", "tags": [], "label": "ast", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.format.$2", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "T extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " ? \"expression\" : \"argument\"" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.formatExpression", "type": "Function", "tags": [], "label": "formatExpression", "description": [ "\nGiven expression pipeline AST, returns formatted string.\n" ], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => string" ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.formatExpression.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression pipeline AST." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.isExpressionAstBuilder", "type": "Function", "tags": [ "return" ], "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], "signature": [ "(val: unknown) => boolean" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.isExpressionAstBuilder.$1", "type": "Unknown", "tags": [], "label": "val", "description": [ "Value you want to check." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "boolean" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.parse", "type": "Function", "tags": [], "label": "parse", "description": [], "signature": [ "(expression: E, startRule: S) => S extends \"expression\" ? ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " : ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.parse.$1", "type": "Uncategorized", "tags": [], "label": "expression", "description": [], "signature": [ "E" ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.parse.$2", "type": "Uncategorized", "tags": [], "label": "startRule", "description": [], "signature": [ "S" ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.parseExpression", "type": "Function", "tags": [], "label": "parseExpression", "description": [ "\nGiven expression pipeline string, returns parsed AST.\n" ], "signature": [ "(expression: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.parseExpression.$1", "type": "string", "tags": [], "label": "expression", "description": [ "Expression pipeline string." ], "signature": [ "string" ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "expressions", "id": "def-server.Datatable", "type": "Interface", "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Datatable.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Datatable.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Datatable.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ "DatatableMeta", " | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Datatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.DatatableColumn", "type": "Interface", "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.DatatableColumn.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.DatatableColumn.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.DatatableColumn.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext", "type": "Interface", "tags": [], "label": "ExecutionContext", "description": [ "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getSearchContext", "type": "Function", "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], "signature": [ "() => ExecutionContextSearch" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.variables", "type": "Object", "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.types", "type": "Object", "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.abortSignal", "type": "Object", "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], "signature": [ "AbortSignal" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getSearchSessionId", "type": "Function", "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], "signature": [ "() => string | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getKibanaRequest", "type": "Function", "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], "signature": [ "(() => ", { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [ "\nReturns the state (true|false) of the sync cursor across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [ "\nReturns the state (true|false) of the sync tooltips across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [ "\nContains the meta-data about the source of the expression." ], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.logDatatable", "type": "Function", "tags": [], "label": "logDatatable", "description": [ "\nLogs datatable." ], "signature": [ "((name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => void) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.logDatatable.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.logDatatable.$2", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionParams", "type": "Interface", "tags": [], "label": "ExecutionParams", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExecutionParams.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionParams.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionParams.expression", "type": "string", "tags": [], "label": "expression", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionParams.params", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionState", "type": "Interface", "tags": [], "label": "ExecutionState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExecutionState.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionState.state", "type": "CompoundType", "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], "signature": [ "\"error\" | \"not-started\" | \"pending\" | \"result\"" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionState.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], "signature": [ "Output | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionState.error", "type": "Object", "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], "signature": [ "Error | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutorState", "type": "Interface", "tags": [], "label": "ExecutorState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExecutorState.functions", "type": "Object", "tags": [], "label": "functions", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutorState.types", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutorState.context", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "Context" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], "signature": [ "\"expression_builder\"" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.functions", "type": "Array", "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.findFunction", "type": "Function", "tags": [ "return" ], "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]) => [] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "Name of the function to search for." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilder[]`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstExpression`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpressionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstFunctionBuilder", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], "signature": [ "\"expression_function_builder\"" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nName of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.arguments", "type": "Object", "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], "signature": [ "FunctionBuilderArguments" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.addArgument", "type": "Function", "tags": [ "return" ], "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], "signature": [ ">(name: A, value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to add." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", "description": [ "The value of the argument to add." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.getArgument", "type": "Function", "tags": [ "return" ], "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], "signature": [ ">(name: A) => (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to retrieve." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument", "type": "Function", "tags": [ "return" ], "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], "signature": [ ">(name: A, value: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to replace." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", "description": [ "The value of the argument. Must always be an array." ], "signature": [ "(", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.removeArgument", "type": "Function", "tags": [ "return" ], "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], "signature": [ ">>(name: A) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to remove." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstFunction`" ] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunctionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinition", "description": [ "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, " extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">>" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.deprecated", "type": "CompoundType", "tags": [], "label": "deprecated", "description": [ "\nThe flag to mark the function as deprecated." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.disabled", "type": "CompoundType", "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.type", "type": "CompoundType", "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited> | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypeToString", "text": "TypeToString" }, "[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], "signature": [ "{ [key in keyof Arguments]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "; }" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.aliases", "type": "Array", "tags": [ "todo" ], "label": "aliases", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nThe actual implementation of the function.\n" ], "signature": [ "(input: Input, args: Arguments, context: Context) => Output" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Output of the previous function, or initial input." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", "tags": [], "label": "args", "description": [ "Parameters set for this function in expression." ], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", "tags": [], "label": "context", "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], "signature": [ "Context" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.context", "type": "Object", "tags": [ "deprecated" ], "label": "context", "description": [], "signature": [ "{ types: any[] | undefined; } | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.clog", "type": "Object", "tags": [], "label": "clog", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"clog\", unknown, {}, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.font", "type": "Object", "tags": [], "label": "font", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"font\", null, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, ", ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.var_set", "type": "Object", "tags": [], "label": "var_set", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var_set\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.var", "type": "Object", "tags": [], "label": "var", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.theme", "type": "Object", "tags": [], "label": "theme", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"theme\", null, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", "tags": [], "label": "cumulative_sum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"cumulative_sum\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.overall_metric", "type": "Object", "tags": [], "label": "overall_metric", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"overall_metric\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.derivative", "type": "Object", "tags": [], "label": "derivative", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"derivative\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinitions.moving_average", "type": "Object", "tags": [], "label": "moving_average", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"moving_average\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionImage", "type": "Interface", "tags": [], "label": "ExpressionImage", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionImage.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"image\"" ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionImage.mode", "type": "string", "tags": [], "label": "mode", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionImage.dataurl", "type": "string", "tags": [], "label": "dataurl", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition", "type": "Interface", "tags": [], "label": "ExpressionRenderDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.name", "type": "string", "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.displayName", "type": "string", "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], "signature": [ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.render", "type": "Function", "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-server.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition", "type": "Interface", "tags": [], "label": "ExpressionTypeDefinition", "description": [ "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "((type: unknown) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.serialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.deserialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "SerializedType" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.from", "type": "Object", "tags": [], "label": "from", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.to", "type": "Object", "tags": [], "label": "to", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeDefinition.help", "type": "string", "tags": [], "label": "help", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle", "type": "Interface", "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"style\"" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.spec", "type": "Object", "tags": [], "label": "spec", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CSSStyle", "text": "CSSStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionTypeStyle.css", "type": "string", "tags": [], "label": "css", "description": [], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.Font", "type": "Interface", "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Font.label", "type": "CompoundType", "tags": [], "label": "label", "description": [], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Font.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers", "type": "Interface", "tags": [], "label": "IInterpreterRenderHandlers", "description": [], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.done", "type": "Function", "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.onDestroy", "type": "Function", "tags": [], "label": "onDestroy", "description": [], "signature": [ "(fn: () => void) => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.reload", "type": "Function", "tags": [], "label": "reload", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.update.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.event", "type": "Function", "tags": [], "label": "event", "description": [], "signature": [ "(event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.event.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", "tags": [], "label": "hasCompatibleActions", "description": [], "signature": [ "((event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => Promise) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.hasCompatibleActions.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.getRenderMode", "type": "Function", "tags": [], "label": "getRenderMode", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.RenderMode", "text": "RenderMode" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.isInteractive", "type": "Function", "tags": [], "label": "isInteractive", "description": [ "\nThe chart is rendered in a non-interactive environment and should not provide any affordances for interaction like brushing." ], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.uiState", "type": "Unknown", "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.IRegistry", "type": "Interface", "tags": [], "label": "IRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => T | null" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.IRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-server.IRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => T[]" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn", "type": "Interface", "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"string\" | \"number\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.role", "type": "CompoundType", "tags": [], "label": "role", "description": [], "signature": [ "\"measure\" | \"dimension\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumn.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.Range", "type": "Interface", "tags": [], "label": "Range", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.Range.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Range.from", "type": "number", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Range.to", "type": "number", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.Range.label", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.SerializedDatatable", "type": "Interface", "tags": [], "label": "SerializedDatatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-server.SerializedDatatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ "string[][]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "expressions", "id": "def-server.FontStyle", "type": "Enum", "tags": [], "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.FontWeight", "type": "Enum", "tags": [], "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.Overflow", "type": "Enum", "tags": [], "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.TextAlignment", "type": "Enum", "tags": [], "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.TextDecoration", "type": "Enum", "tags": [], "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "expressions", "id": "def-server.AnyExpressionFunctionDefinition", "type": "Type", "tags": [], "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, ", any, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.AnyExpressionTypeDefinition", "type": "Type", "tags": [], "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ArgumentType", "type": "Type", "tags": [], "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], "signature": [ "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" ], "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.DatatableColumnType", "type": "Type", "tags": [], "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.DatatableRow", "type": "Type", "tags": [], "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContainer", "type": "Type", "tags": [], "label": "ExecutionContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, ", {}>" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExecutorContainer", "type": "Type", "tags": [], "label": "ExecutorContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstArgument", "type": "Type", "tags": [], "label": "ExpressionAstArgument", "description": [], "signature": [ "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstExpression", "type": "Type", "tags": [], "label": "ExpressionAstExpression", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstFunction", "type": "Type", "tags": [], "label": "ExpressionAstFunction", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.AstFunction", "text": "AstFunction" }, ", \"arguments\"> & { arguments: Record; debug?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionDebug", "text": "ExpressionAstFunctionDebug" }, " | undefined; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionAstNode", "type": "Type", "tags": [], "label": "ExpressionAstNode", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValue", "type": "Type", "tags": [], "label": "ExpressionValue", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueBoxed", "type": "Type", "tags": [], "label": "ExpressionValueBoxed", "description": [], "signature": [ "{ type: Type; } & Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueConverter", "type": "Type", "tags": [], "label": "ExpressionValueConverter", "description": [], "signature": [ "(input: I, availableTypes: Record) => O" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-server.ExpressionValueConverter.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "I" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueConverter.$2", "type": "Object", "tags": [], "label": "availableTypes", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueError", "type": "Type", "tags": [], "label": "ExpressionValueError", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueFilter", "type": "Type", "tags": [], "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], "signature": [ "{ type: \"filter\"; } & { filterType?: string | undefined; filterGroup?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueFilter", "text": "ExpressionValueFilter" }, "[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueNum", "type": "Type", "tags": [], "label": "ExpressionValueNum", "description": [], "signature": [ "{ type: \"num\"; } & { value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueRender", "type": "Type", "tags": [], "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueRender", "type": "Type", "tags": [], "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.ExpressionValueUnboxed", "type": "Type", "tags": [], "label": "ExpressionValueUnboxed", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.FontLabel", "type": "Type", "tags": [], "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.FontValue", "type": "Type", "tags": [], "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.InterpreterErrorType", "type": "Type", "tags": [ "deprecated" ], "label": "InterpreterErrorType", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": true, "trackAdoption": false, "references": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.KnownTypeToString", "type": "Type", "tags": [], "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], "signature": [ "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeries", "type": "Type", "tags": [], "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ "{ type: \"pointseries\"; } & { columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumns", "text": "PointSeriesColumns" }, "; rows: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumnName", "type": "Type", "tags": [], "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], "signature": [ "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesColumns", "type": "Type", "tags": [], "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], "signature": [ "{} | Record<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumnName", "text": "PointSeriesColumnName" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumn", "text": "PointSeriesColumn" }, ">" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.PointSeriesRow", "type": "Type", "tags": [], "label": "PointSeriesRow", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.Style", "type": "Type", "tags": [], "label": "Style", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.TypeString", "type": "Type", "tags": [], "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ "(T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends string ? \"string\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends boolean ? \"boolean\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends number ? \"number\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends null ? \"null\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends { type: string; } ? ({ type: string; } & (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited))[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.TypeToString", "type": "Type", "tags": [], "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, "" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-server.UnmappedTypeStrings", "type": "Type", "tags": [], "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], "signature": [ "\"date\" | \"filter\"" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerSetup", "type": "Type", "tags": [], "label": "ExpressionsServerSetup", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "expressions", "id": "def-server.ExpressionsServerStart", "type": "Type", "tags": [], "label": "ExpressionsServerStart", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/server/plugin.ts", "deprecated": false, "trackAdoption": false, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [ { "parentPluginId": "expressions", "id": "def-common.Execution", "type": "Class", "tags": [], "label": "Execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.state", "type": "Object", "tags": [], "label": "state", "description": [ "\nDynamic state of the execution." ], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>, {}>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.input", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.context", "type": "Object", "tags": [], "label": "context", "description": [ "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.result", "type": "Object", "tags": [], "label": "result", "description": [ "\nFuture that tracks result or error of this execution." ], "signature": [ "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.contract", "type": "Object", "tags": [], "label": "contract", "description": [ "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Execution.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.Unnamed.$1", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionParams", "text": "ExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.Unnamed.$2", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nStop execution of expression." ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.start", "type": "Function", "tags": [], "label": "start", "description": [ "\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default." ], "signature": [ "(input?: Input, isSubExpression?: boolean | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.start.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.start.$2", "type": "CompoundType", "tags": [], "label": "isSubExpression", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain", "type": "Function", "tags": [], "label": "invokeChain", "description": [], "signature": [ "([head, ...tail]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[], input: unknown) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | ChainOutput>" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain.$1", "type": "Array", "tags": [], "label": "[head, ...tail]", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.invokeChain.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction", "type": "Function", "tags": [], "label": "invokeFunction", "description": [], "signature": [ "(fn: Fn, input: unknown, args: Record) => ", "Observable", ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$1", "type": "Uncategorized", "tags": [], "label": "fn", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.invokeFunction.$3", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.cast", "type": "Function", "tags": [], "label": "cast", "description": [], "signature": [ "(value: unknown, toTypeNames?: string[] | undefined) => Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.cast.$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.cast.$2", "type": "Array", "tags": [], "label": "toTypeNames", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(value: Type, argDef: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, ") => void" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.validate.$1", "type": "Uncategorized", "tags": [], "label": "value", "description": [], "signature": [ "Type" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.validate.$2", "type": "Object", "tags": [], "label": "argDef", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs", "type": "Function", "tags": [], "label": "resolveArgs", "description": [], "signature": [ "(fnDef: Fn, input: unknown, argAsts: Record) => ", "Observable", " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$1", "type": "Uncategorized", "tags": [], "label": "fnDef", "description": [], "signature": [ "Fn" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$2", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.resolveArgs.$3", "type": "Object", "tags": [], "label": "argAsts", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Execution.interpret", "type": "Function", "tags": [], "label": "interpret", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, ", input: T) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Execution.interpret.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Execution.interpret.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract", "type": "Class", "tags": [], "label": "ExecutionContract", "description": [ "\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.isPending", "type": "boolean", "tags": [], "label": "isPending", "description": [], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.execution", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.Unnamed.$1", "type": "Object", "tags": [], "label": "execution", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.cancel", "type": "Function", "tags": [], "label": "cancel", "description": [ "\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution." ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getData", "type": "Function", "tags": [], "label": "getData", "description": [ "\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws." ], "signature": [ "() => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, ">" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getExpression", "type": "Function", "tags": [], "label": "getExpression", "description": [ "\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST." ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.getAst", "type": "Function", "tags": [], "label": "getAst", "description": [ "\nGet AST used to execute the expression." ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContract.inspect", "type": "Function", "tags": [], "label": "inspect", "description": [ "\nGet Inspector adapters provided to all functions of expression through\nexecution context." ], "signature": [ "() => ", { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" } ], "path": "src/plugins/expressions/common/execution/execution_contract.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Executor", "type": "Class", "tags": [], "label": "Executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.createWithDefaults", "type": "Function", "tags": [], "label": "createWithDefaults", "description": [], "signature": [ " = Record>(logger?: ", { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined, state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.createWithDefaults.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-common.Executor.createWithDefaults.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.container", "type": "Object", "tags": [], "label": "container", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Executor.functions", "type": "Object", "tags": [ "deprecated" ], "label": "functions", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.types", "type": "Object", "tags": [ "deprecated" ], "label": "types", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed.$1", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-common.Executor.Unnamed.$2", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.state", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Executor.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.context", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Executor.run", "type": "Function", "tags": [], "label": "run", "description": [ "\nExecute expression and return result.\n" ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression AST or a string representing expression." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Initial input to the first expression function." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.createExecution", "type": "Function", "tags": [], "label": "createExecution", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Execution", "text": "Execution" }, "" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.createExecution.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.createExecution.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.inject.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.extract.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.telemetry.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.Executor.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.Executor.migrateToLatest", "type": "Function", "tags": [], "label": "migrateToLatest", "description": [], "signature": [ "(state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Executor.migrateToLatest.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction", "type": "Class", "tags": [], "label": "ExpressionFunction", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.name", "type": "string", "tags": [], "label": "name", "description": [ "\nName of function" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [ "\nAliases that can be used instead of `name`." ], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.type", "type": "string", "tags": [], "label": "type", "description": [ "\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nFunction to run function (context, args)" ], "signature": [ "(input: any, params: Record, handlers: object) => any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.fn.$1", "type": "Any", "tags": [], "label": "input", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.fn.$2", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.fn.$3", "type": "Uncategorized", "tags": [], "label": "handlers", "description": [], "signature": [ "object" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of expression function parameters." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nType of inputs that this function supports." ], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.disabled", "type": "boolean", "tags": [], "label": "disabled", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [ "\nDeprecation flag." ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(state: Record, telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.telemetry.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: Record) => { state: Record; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.extract.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: Record, references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => Record" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inject.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.migrations", "type": "CompoundType", "tags": [], "label": "migrations", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" }, " | ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.GetMigrationFunctionObjectFn", "text": "GetMigrationFunctionObjectFn" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.Unnamed.$1", "type": "Object", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" } ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter", "type": "Class", "tags": [], "label": "ExpressionFunctionParameter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionParameter", "text": "ExpressionFunctionParameter" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.required", "type": "boolean", "tags": [], "label": "required", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.types", "type": "CompoundType", "tags": [], "label": "types", "description": [], "signature": [ "(string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, ")[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ArrayTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedTypeToArgumentString)[]) | (string[] & (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | UnresolvedArrayTypeToArgumentString)[]) | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.default", "type": "CompoundType", "tags": [], "label": "default", "description": [], "signature": [ "string | T | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.deprecated", "type": "boolean", "tags": [], "label": "deprecated", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.resolve", "type": "boolean", "tags": [], "label": "resolve", "description": [], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.strict", "type": "CompoundType", "tags": [ "deprecated" ], "label": "strict", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": true, "trackAdoption": false, "references": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "T[]" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "arg", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.accepts", "type": "Function", "tags": [], "label": "accepts", "description": [], "signature": [ "(type: string) => boolean" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.accepts.$1", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer", "type": "Class", "tags": [], "label": "ExpressionRenderer", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.displayName", "type": "string", "tags": [], "label": "displayName", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "() => void | Error" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderer.Unnamed.$1", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry", "type": "Class", "tags": [], "label": "ExpressionRendererRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, ">" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRendererRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, "[]" ], "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter", "type": "Class", "tags": [], "label": "ExpressionsInspectorAdapter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" }, " extends EventEmitter" ], "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.logAST", "type": "Function", "tags": [], "label": "logAST", "description": [], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" }, ") => void" ], "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.logAST.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstNode", "text": "ExpressionAstNode" } ], "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsInspectorAdapter.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService", "type": "Class", "tags": [], "label": "ExpressionsService", "description": [ "\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsService", "text": "ExpressionsService" }, " implements ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableStateService", "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ">,", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" }, ",", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.renderers", "type": "Object", "tags": [], "label": "renderers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.Unnamed.$1", "type": "Object", "tags": [], "label": "{\n logger,\n executor = Executor.createWithDefaults(logger),\n renderers = new ExpressionRendererRegistry(),\n }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionServiceParams", "text": "ExpressionServiceParams" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(name: string, namespace: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [], "signature": [ "(namespace: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getRenderer", "type": "Function", "tags": [], "label": "getRenderer", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getRenderers", "type": "Function", "tags": [], "label": "getRenderers", "description": [], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerRenderer", "type": "Function", "tags": [], "label": "registerRenderer", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.registerRenderer.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.fork", "type": "Function", "tags": [], "label": "fork", "description": [], "signature": [ "(name: string) => ", "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.fork.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.execute", "type": "Function", "tags": [], "label": "execute", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.execute.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run", "type": "Function", "tags": [], "label": "run", "description": [], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [ "\nExtracts telemetry from expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData?: Record) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to extract references from" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.extract", "type": "Function", "tags": [], "label": "extract", "description": [ "\nExtracts saved object references from expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.extract.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to extract references from" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "new expression AST with references removed and array of references" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.inject", "type": "Function", "tags": [], "label": "inject", "description": [ "\nInjects saved object references into expression AST" ], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.inject.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [ "expression AST to update" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [ "array of saved object references" ], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "new expression AST with references injected" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [ "\ngets an object with semver mapped to a migration function" ], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.migrateToLatest", "type": "Function", "tags": [], "label": "migrateToLatest", "description": [ "\nmigrates an old expression to latest version" ], "signature": [ "(state: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.migrateToLatest.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.VersionedState", "text": "VersionedState" }, "<", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ">" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.setup", "type": "Function", "tags": [], "label": "setup", "description": [ "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." ], "signature": [ "(...args: unknown[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceSetup", "text": "ExpressionsServiceSetup" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.setup.$1", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "unknown[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.start", "type": "Function", "tags": [], "label": "start", "description": [ "\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." ], "signature": [ "(...args: unknown[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsServiceStart", "text": "ExpressionsServiceStart" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.start.$1", "type": "Array", "tags": [], "label": "args", "description": [], "signature": [ "unknown[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsService.stop", "type": "Function", "tags": [], "label": "stop", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType", "type": "Class", "tags": [], "label": "ExpressionType", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.help", "type": "string", "tags": [], "label": "help", "description": [ "\nA short help text." ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nType validation, useful for checking function output." ], "signature": [ "(type: unknown) => void | Error" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.create", "type": "Unknown", "tags": [], "label": "create", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [ "\nOptional serialization (used when passing context around client/server)." ], "signature": [ "((value: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") => unknown) | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((serialized: unknown[]) => ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.Serializable", "text": "Serializable" }, ") | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.Unnamed.$1", "type": "Object", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" } ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.getToFn", "type": "Function", "tags": [], "label": "getToFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.getToFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.getFromFn", "type": "Function", "tags": [], "label": "getFromFn", "description": [], "signature": [ "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.getFromFn.$1", "type": "string", "tags": [], "label": "typeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsTo", "type": "Function", "tags": [], "label": "castsTo", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsTo.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsFrom", "type": "Function", "tags": [], "label": "castsFrom", "description": [], "signature": [ "(value: any) => boolean" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.castsFrom.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.to", "type": "Function", "tags": [], "label": "to", "description": [], "signature": [ "(value: any, toTypeName: string, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$2", "type": "string", "tags": [], "label": "toTypeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.to.$3", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.from", "type": "Function", "tags": [], "label": "from", "description": [], "signature": [ "(value: any, types: Record) => any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionType.from.$1", "type": "Any", "tags": [], "label": "value", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionType.from.$2", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/expression_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry", "type": "Class", "tags": [], "label": "FunctionsRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FunctionsRegistry", "text": "FunctionsRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.FunctionsRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TablesAdapter", "type": "Class", "tags": [], "label": "TablesAdapter", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TablesAdapter", "text": "TablesAdapter" }, " extends EventEmitter" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable", "type": "Function", "tags": [], "label": "logDatatable", "description": [], "signature": [ "(name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => void" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.logDatatable.$2", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.reset", "type": "Function", "tags": [], "label": "reset", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TablesAdapter.tables", "type": "Object", "tags": [], "label": "tables", "description": [], "signature": [ "{ [key: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, "; }" ], "path": "src/plugins/expressions/common/util/tables_adapter.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TypesRegistry", "type": "Class", "tags": [], "label": "TypesRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypesRegistry", "text": "TypesRegistry" }, " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.Unnamed.$1", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.register", "type": "Function", "tags": [], "label": "register", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.register.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | null" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.TypesRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "[]" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "expressions", "id": "def-common.buildExpression", "type": "Function", "tags": [ "return" ], "label": "buildExpression", "description": [ "\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n" ], "signature": [ "(initialState: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.buildExpression.$1", "type": "CompoundType", "tags": [], "label": "initialState", "description": [ "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." ], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction", "type": "Function", "tags": [ "return" ], "label": "buildExpressionFunction", "description": [ "\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "String representing the name of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.buildExpressionFunction.$2", "type": "Object", "tags": [], "label": "initialArgs", "description": [ "Object containing the arguments to this function." ], "signature": [ "{ [K in keyof FunctionArgs]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, "[] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.buildResultColumns", "type": "Function", "tags": [], "label": "buildResultColumns", "description": [ "\nChecks whether input and output columns are defined properly\nand builds column array of the output table if that's the case.\n\n* Throws an error if the output column exists already.\n* Returns undefined if the input column doesn't exist." ], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", outputColumnId: string, inputColumnId: string, outputColumnName: string | undefined, options: { allowColumnOverwrite: boolean; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$1", "type": "Object", "tags": [], "label": "input", "description": [ "Input datatable" ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$2", "type": "string", "tags": [], "label": "outputColumnId", "description": [ "Id of the output column" ], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$3", "type": "string", "tags": [], "label": "inputColumnId", "description": [ "Id of the input column" ], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$4", "type": "string", "tags": [], "label": "outputColumnName", "description": [ "Optional name of the output column" ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$5", "type": "Object", "tags": [], "label": "options", "description": [], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.buildResultColumns.$5.allowColumnOverwrite", "type": "boolean", "tags": [], "label": "allowColumnOverwrite", "description": [], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createDefaultInspectorAdapters", "type": "Function", "tags": [], "label": "createDefaultInspectorAdapters", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DefaultInspectorAdapters", "text": "DefaultInspectorAdapters" } ], "path": "src/plugins/expressions/common/util/create_default_inspector_adapters.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createError", "type": "Function", "tags": [], "label": "createError", "description": [], "signature": [ "(err: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" } ], "path": "src/plugins/expressions/common/util/create_error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createError.$1", "type": "CompoundType", "tags": [], "label": "err", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" } ], "path": "src/plugins/expressions/common/util/create_error.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createExecutionContainer", "type": "Function", "tags": [], "label": "createExecutionContainer", "description": [], "signature": [ "(state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContainer", "text": "ExecutionContainer" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createExecutionContainer.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createExecutorContainer", "type": "Function", "tags": [], "label": "createExecutorContainer", "description": [], "signature": [ " = Record>(state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorContainer", "text": "ExecutorContainer" }, "" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createExecutorContainer.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createMockContext", "type": "Function", "tags": [], "label": "createMockContext", "description": [], "signature": [ "() => ", { "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/expressions/common/util/test_utils.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.format", "type": "Function", "tags": [], "label": "format", "description": [], "signature": [ "(ast: T, type: T extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " ? \"expression\" : \"argument\") => string" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.format.$1", "type": "Uncategorized", "tags": [], "label": "ast", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.format.$2", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "T extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " ? \"expression\" : \"argument\"" ], "path": "src/plugins/expressions/common/ast/format.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.formatExpression", "type": "Function", "tags": [], "label": "formatExpression", "description": [ "\nGiven expression pipeline AST, returns formatted string.\n" ], "signature": [ "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => string" ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.formatExpression.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [ "Expression pipeline AST." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/format_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier", "type": "Function", "tags": [], "label": "getBucketIdentifier", "description": [ "\nReturns a string identifying the group of a row by a list of columns to group by" ], "signature": [ "(row: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, ", groupColumns: string[] | undefined) => string" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier.$1", "type": "Object", "tags": [], "label": "row", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" } ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.getBucketIdentifier.$2", "type": "Array", "tags": [], "label": "groupColumns", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.getByAlias", "type": "Function", "tags": [], "label": "getByAlias", "description": [], "signature": [ "(node: T[] | Record, nodeName: string, nodeNamespace: string | undefined) => T | undefined" ], "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.getByAlias.$1", "type": "CompoundType", "tags": [], "label": "node", "description": [], "signature": [ "T[] | Record" ], "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.getByAlias.$2", "type": "string", "tags": [], "label": "nodeName", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.getByAlias.$3", "type": "string", "tags": [], "label": "nodeNamespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/util/get_by_alias.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(node: unknown) => string" ], "path": "src/plugins/expressions/common/expression_types/get_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.getType.$1", "type": "Unknown", "tags": [], "label": "node", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/get_type.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.getUiSettingFn", "type": "Function", "tags": [], "label": "getUiSettingFn", "description": [], "signature": [ "({\n getStartDependencies,\n}: UiSettingFnArguments) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionUiSetting", "text": "ExpressionFunctionUiSetting" } ], "path": "src/plugins/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.getUiSettingFn.$1", "type": "Object", "tags": [], "label": "{\n getStartDependencies,\n}", "description": [], "signature": [ "UiSettingFnArguments" ], "path": "src/plugins/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.isDatatable", "type": "Function", "tags": [], "label": "isDatatable", "description": [ "\nA Utility function that Typescript can use to determine if an object is a Datatable." ], "signature": [ "(datatable: unknown) => datatable is ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.isDatatable.$1", "type": "Unknown", "tags": [], "label": "datatable", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.isExpressionAstBuilder", "type": "Function", "tags": [ "return" ], "label": "isExpressionAstBuilder", "description": [ "\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n" ], "signature": [ "(val: unknown) => boolean" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.isExpressionAstBuilder.$1", "type": "Unknown", "tags": [], "label": "val", "description": [ "Value you want to check." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "boolean" ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.isExpressionValueError", "type": "Function", "tags": [], "label": "isExpressionValueError", "description": [], "signature": [ "(value: unknown) => value is ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" } ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.isExpressionValueError.$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.parse", "type": "Function", "tags": [], "label": "parse", "description": [], "signature": [ "(expression: E, startRule: S) => S extends \"expression\" ? ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " : ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.parse.$1", "type": "Uncategorized", "tags": [], "label": "expression", "description": [], "signature": [ "E" ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.parse.$2", "type": "Uncategorized", "tags": [], "label": "startRule", "description": [], "signature": [ "S" ], "path": "src/plugins/expressions/common/ast/parse.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.parseExpression", "type": "Function", "tags": [], "label": "parseExpression", "description": [ "\nGiven expression pipeline string, returns parsed AST.\n" ], "signature": [ "(expression: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.parseExpression.$1", "type": "string", "tags": [], "label": "expression", "description": [ "Expression pipeline string." ], "signature": [ "string" ], "path": "src/plugins/expressions/common/ast/parse_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.serializeProvider", "type": "Function", "tags": [], "label": "serializeProvider", "description": [], "signature": [ "(types: Record) => { serialize: (value: any) => unknown; deserialize: (value: any) => any; }" ], "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.serializeProvider.$1", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.unboxExpressionValue", "type": "Function", "tags": [], "label": "unboxExpressionValue", "description": [], "signature": [ "({\n type,\n ...value\n}: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, ") => T" ], "path": "src/plugins/expressions/common/expression_types/unbox_expression_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.unboxExpressionValue.$1", "type": "CompoundType", "tags": [], "label": "{\n type,\n ...value\n}", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, "" ], "path": "src/plugins/expressions/common/expression_types/unbox_expression_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "expressions", "id": "def-common.ContainerStyle", "type": "Interface", "tags": [], "label": "ContainerStyle", "description": [ "\nRepresents an object containing style information for a Container." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.border", "type": "CompoundType", "tags": [], "label": "border", "description": [], "signature": [ "string | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.borderRadius", "type": "CompoundType", "tags": [], "label": "borderRadius", "description": [], "signature": [ "string | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.padding", "type": "CompoundType", "tags": [], "label": "padding", "description": [], "signature": [ "string | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundColor", "type": "CompoundType", "tags": [], "label": "backgroundColor", "description": [], "signature": [ "string | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundImage", "type": "CompoundType", "tags": [], "label": "backgroundImage", "description": [], "signature": [ "string | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundSize", "type": "Enum", "tags": [], "label": "backgroundSize", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.BackgroundSize", "text": "BackgroundSize" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.backgroundRepeat", "type": "Enum", "tags": [], "label": "backgroundRepeat", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.BackgroundRepeat", "text": "BackgroundRepeat" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.opacity", "type": "CompoundType", "tags": [], "label": "opacity", "description": [], "signature": [ "number | null" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ContainerStyle.overflow", "type": "Enum", "tags": [], "label": "overflow", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Overflow", "text": "Overflow" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.CreateTableArguments", "type": "Interface", "tags": [], "label": "CreateTableArguments", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.CreateTableArguments.ids", "type": "Array", "tags": [], "label": "ids", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CreateTableArguments.names", "type": "CompoundType", "tags": [], "label": "names", "description": [], "signature": [ "string[] | null | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CreateTableArguments.rowCount", "type": "number", "tags": [], "label": "rowCount", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle", "type": "Interface", "tags": [], "label": "CSSStyle", "description": [ "\nRepresents the various style properties that can be applied to an element." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.CSSStyle.color", "type": "string", "tags": [], "label": "color", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.fill", "type": "string", "tags": [], "label": "fill", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontFamily", "type": "CompoundType", "tags": [], "label": "fontFamily", "description": [], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\" | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontSize", "type": "string", "tags": [], "label": "fontSize", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontStyle", "type": "CompoundType", "tags": [], "label": "fontStyle", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontStyle", "text": "FontStyle" }, " | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.fontWeight", "type": "CompoundType", "tags": [], "label": "fontWeight", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontWeight", "text": "FontWeight" }, " | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.lineHeight", "type": "CompoundType", "tags": [], "label": "lineHeight", "description": [], "signature": [ "string | number | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.textAlign", "type": "CompoundType", "tags": [], "label": "textAlign", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TextAlignment", "text": "TextAlignment" }, " | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CSSStyle.textDecoration", "type": "CompoundType", "tags": [], "label": "textDecoration", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TextDecoration", "text": "TextDecoration" }, " | undefined" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs", "type": "Interface", "tags": [], "label": "CumulativeSumArgs", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.by", "type": "Array", "tags": [], "label": "by", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.inputColumnId", "type": "string", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.outputColumnId", "type": "string", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.CumulativeSumArgs.outputColumnName", "type": "string", "tags": [], "label": "outputColumnName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Datatable", "type": "Interface", "tags": [], "label": "Datatable", "description": [ "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Datatable.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Datatable.columns", "type": "Array", "tags": [], "label": "columns", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Datatable.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ "DatatableMeta", " | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Datatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumn", "type": "Interface", "tags": [], "label": "DatatableColumn", "description": [ "\nThis type represents the shape of a column in a `Datatable`." ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.DatatableColumn.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumn.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumn.meta", "type": "Object", "tags": [], "label": "meta", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumnMeta", "text": "DatatableColumnMeta" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta", "type": "Interface", "tags": [], "label": "DatatableColumnMeta", "description": [ "\nDatatable column meta information" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.field", "type": "string", "tags": [], "label": "field", "description": [ "\nfield this column is based on" ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.index", "type": "string", "tags": [], "label": "index", "description": [ "\nindex/table this column is based on" ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.dimensionName", "type": "string", "tags": [], "label": "dimensionName", "description": [ "\nnames the domain this column represents" ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.params", "type": "Object", "tags": [], "label": "params", "description": [ "\nserialized field format" ], "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/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.source", "type": "string", "tags": [], "label": "source", "description": [ "\nsource function that produced this column" ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnMeta.sourceParams", "type": "Object", "tags": [], "label": "sourceParams", "description": [ "\nany extra parameters for the source that produced this column" ], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters", "type": "Interface", "tags": [], "label": "DefaultInspectorAdapters", "description": [ "\nDefault inspector adapters created if inspector adapters are not set explicitly." ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters.requests", "type": "Object", "tags": [], "label": "requests", "description": [], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.RequestAdapter", "text": "RequestAdapter" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters.tables", "type": "Object", "tags": [], "label": "tables", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TablesAdapter", "text": "TablesAdapter" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DefaultInspectorAdapters.expression", "type": "Object", "tags": [], "label": "expression", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionsInspectorAdapter", "text": "ExpressionsInspectorAdapter" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DerivativeArgs", "type": "Interface", "tags": [], "label": "DerivativeArgs", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.by", "type": "Array", "tags": [], "label": "by", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.inputColumnId", "type": "string", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.outputColumnId", "type": "string", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.DerivativeArgs.outputColumnName", "type": "string", "tags": [], "label": "outputColumnName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext", "type": "Interface", "tags": [], "label": "ExecutionContext", "description": [ "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContext", "text": "ExecutionContext" }, "" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getSearchContext", "type": "Function", "tags": [], "label": "getSearchContext", "description": [ "\nGet search context of the expression." ], "signature": [ "() => ExecutionContextSearch" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.variables", "type": "Object", "tags": [], "label": "variables", "description": [ "\nContext variables that can be consumed using `var` and `var_set` functions." ], "signature": [ "{ [x: string]: unknown; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.types", "type": "Object", "tags": [], "label": "types", "description": [ "\nA map of available expression types." ], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.abortSignal", "type": "Object", "tags": [], "label": "abortSignal", "description": [ "\nAdds ability to abort current execution." ], "signature": [ "AbortSignal" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.inspectorAdapters", "type": "Uncategorized", "tags": [], "label": "inspectorAdapters", "description": [ "\nAdapters for `inspector` plugin." ], "signature": [ "InspectorAdapters" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getSearchSessionId", "type": "Function", "tags": [], "label": "getSearchSessionId", "description": [ "\nSearch context in which expression should operate." ], "signature": [ "() => string | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getKibanaRequest", "type": "Function", "tags": [], "label": "getKibanaRequest", "description": [ "\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user." ], "signature": [ "(() => ", { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [ "\nReturns the state (true|false) of the sync colors across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [ "\nReturns the state (true|false) of the sync cursor across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [ "\nReturns the state (true|false) of the sync tooltips across panels switch." ], "signature": [ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [ "\nContains the meta-data about the source of the expression." ], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.logDatatable", "type": "Function", "tags": [], "label": "logDatatable", "description": [ "\nLogs datatable." ], "signature": [ "((name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => void) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.logDatatable.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.logDatatable.$2", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionParams", "type": "Interface", "tags": [], "label": "ExecutionParams", "description": [], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionParams.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, ">" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionParams.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionParams.expression", "type": "string", "tags": [], "label": "expression", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionParams.params", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" } ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions", "type": "Interface", "tags": [], "label": "ExecutionPureTransitions", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => () => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.start.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setResult", "type": "Function", "tags": [], "label": "setResult", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => (result: Output) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setResult.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setError", "type": "Function", "tags": [], "label": "setError", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => (error: Error) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionPureTransitions.setError.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionResult", "type": "Interface", "tags": [], "label": "ExecutionResult", "description": [ "\nThe result returned after an expression function execution." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionResult.partial", "type": "boolean", "tags": [], "label": "partial", "description": [ "\nPartial result flag." ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionResult.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "\nThe expression function result." ], "signature": [ "Output" ], "path": "src/plugins/expressions/common/execution/execution.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionState", "type": "Interface", "tags": [], "label": "ExecutionState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutionState.ast", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionState.state", "type": "CompoundType", "tags": [], "label": "state", "description": [ "\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error." ], "signature": [ "\"error\" | \"not-started\" | \"pending\" | \"result\"" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionState.result", "type": "Uncategorized", "tags": [], "label": "result", "description": [ "\nResult of the expression execution." ], "signature": [ "Output | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionState.error", "type": "Object", "tags": [], "label": "error", "description": [ "\nError happened during the execution." ], "signature": [ "Error | undefined" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors", "type": "Interface", "tags": [], "label": "ExecutorPureSelectors", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | null" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getFunction.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | null" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getType.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getContext", "type": "Function", "tags": [], "label": "getContext", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => () => Record" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureSelectors.getContext.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions", "type": "Interface", "tags": [], "label": "ExecutorPureTransitions", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addFunction", "type": "Function", "tags": [], "label": "addFunction", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (fn: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addFunction.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addType", "type": "Function", "tags": [], "label": "addType", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (type: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorPureTransitions.addType.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorState", "type": "Interface", "tags": [], "label": "ExecutorState", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, "" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExecutorState.functions", "type": "Object", "tags": [], "label": "functions", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorState.types", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorState.context", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "Context" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstExpressionBuilder", "description": [], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression builder objects." ], "signature": [ "\"expression_builder\"" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.functions", "type": "Array", "tags": [], "label": "functions", "description": [ "\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ">[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.findFunction", "type": "Function", "tags": [ "return" ], "label": "findFunction", "description": [ "\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n" ], "signature": [ "(fnName: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]) => [] | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "[]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", "description": [ "Name of the function to search for." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilder[]`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts expression to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstExpression`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpressionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts expression to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder", "type": "Interface", "tags": [], "label": "ExpressionAstFunctionBuilder", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionBuilder", "text": "ExpressionAstFunctionBuilder" }, "" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.type", "type": "string", "tags": [], "label": "type", "description": [ "\nUsed to identify expression function builder objects." ], "signature": [ "\"expression_function_builder\"" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nName of this expression function." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.InferFunctionDefinition", "text": "InferFunctionDefinition" }, "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.arguments", "type": "Object", "tags": [], "label": "arguments", "description": [ "\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs." ], "signature": [ "FunctionBuilderArguments" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.addArgument", "type": "Function", "tags": [ "return" ], "label": "addArgument", "description": [ "\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n" ], "signature": [ ">(name: A, value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to add." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", "description": [ "The value of the argument to add." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.getArgument", "type": "Function", "tags": [ "return" ], "label": "getArgument", "description": [ "\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n" ], "signature": [ ">(name: A) => (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[] | undefined" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to retrieve." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument", "type": "Function", "tags": [ "return" ], "label": "replaceArgument", "description": [ "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" ], "signature": [ ">(name: A, value: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to replace." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", "description": [ "The value of the argument. Must always be an array." ], "signature": [ "(", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpressionBuilder", "text": "ExpressionAstExpressionBuilder" }, " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.removeArgument", "type": "Function", "tags": [ "return" ], "label": "removeArgument", "description": [ "\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n" ], "signature": [ ">>(name: A) => this" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "The name of the argument to remove." ], "signature": [ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "`this`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.toAst", "type": "Function", "tags": [ "return" ], "label": "toAst", "description": [ "\nConverts function to an AST.\n" ], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" } ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`ExpressionAstFunction`" ] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionBuilder.toString", "type": "Function", "tags": [ "return" ], "label": "toString", "description": [ "\nConverts function to an expression string.\n" ], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ "`string`" ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecOptions", "type": "Interface", "tags": [], "label": "ExpressionExecOptions", "description": [], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionExecOptions.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [ "\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/executor/executor.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams", "type": "Interface", "tags": [], "label": "ExpressionExecutionParams", "description": [], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.searchContext", "type": "Object", "tags": [], "label": "searchContext", "description": [], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.variables", "type": "Object", "tags": [], "label": "variables", "description": [], "signature": [ "Record | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.debug", "type": "CompoundType", "tags": [], "label": "debug", "description": [ "\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.kibanaRequest", "type": "Object", "tags": [], "label": "kibanaRequest", "description": [ "\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user." ], "signature": [ { "pluginId": "@kbn/core-http-server", "scope": "server", "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.searchSessionId", "type": "string", "tags": [], "label": "searchSessionId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.syncColors", "type": "CompoundType", "tags": [], "label": "syncColors", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.syncCursor", "type": "CompoundType", "tags": [], "label": "syncCursor", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.syncTooltips", "type": "CompoundType", "tags": [], "label": "syncTooltips", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.inspectorAdapters", "type": "Object", "tags": [], "label": "inspectorAdapters", "description": [], "signature": [ { "pluginId": "inspector", "scope": "common", "docId": "kibInspectorPluginApi", "section": "def-common.Adapters", "text": "Adapters" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.executionContext", "type": "Object", "tags": [], "label": "executionContext", "description": [], "signature": [ { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.partial", "type": "CompoundType", "tags": [ "default" ], "label": "partial", "description": [ "\nToggles the partial results support." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.throttle", "type": "number", "tags": [ "deafult" ], "label": "throttle", "description": [ "\nThrottling of partial results in milliseconds. 0 is disabling the throttling." ], "signature": [ "number | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinition", "description": [ "\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, " extends Partial<", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.PersistableState", "text": "PersistableState" }, ">>" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [ "\nThe name of the function, as will be used in expression." ], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.deprecated", "type": "CompoundType", "tags": [], "label": "deprecated", "description": [ "\nThe flag to mark the function as deprecated." ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.disabled", "type": "CompoundType", "tags": [], "label": "disabled", "description": [ "\nif set to true function will be disabled (but its migrate function will still be available)" ], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.type", "type": "CompoundType", "tags": [], "label": "type", "description": [ "\nName of type of value this function outputs." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited> | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [ "\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TypeToString", "text": "TypeToString" }, "[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.args", "type": "Object", "tags": [], "label": "args", "description": [ "\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited." ], "signature": [ "{ [key in keyof Arguments]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ArgumentType", "text": "ArgumentType" }, "; }" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.aliases", "type": "Array", "tags": [ "todo" ], "label": "aliases", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text displayed in the Expression editor. This text should be\ninternationalized." ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn", "type": "Function", "tags": [], "label": "fn", "description": [ "\nThe actual implementation of the function.\n" ], "signature": [ "(input: Input, args: Arguments, context: Context) => Output" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [ "Output of the previous function, or initial input." ], "signature": [ "Input" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$2", "type": "Uncategorized", "tags": [], "label": "args", "description": [ "Parameters set for this function in expression." ], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.fn.$3", "type": "Uncategorized", "tags": [], "label": "context", "description": [ "Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain." ], "signature": [ "Context" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.context", "type": "Object", "tags": [ "deprecated" ], "label": "context", "description": [], "signature": [ "{ types: any[] | undefined; } | undefined" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions", "type": "Interface", "tags": [], "label": "ExpressionFunctionDefinitions", "description": [ "\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n" ], "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.clog", "type": "Object", "tags": [], "label": "clog", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"clog\", unknown, {}, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.font", "type": "Object", "tags": [], "label": "font", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"font\", null, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, ", ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.var_set", "type": "Object", "tags": [], "label": "var_set", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var_set\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.var", "type": "Object", "tags": [], "label": "var", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.theme", "type": "Object", "tags": [], "label": "theme", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"theme\", null, Arguments, unknown, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.cumulative_sum", "type": "Object", "tags": [], "label": "cumulative_sum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"cumulative_sum\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.overall_metric", "type": "Object", "tags": [], "label": "overall_metric", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"overall_metric\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.derivative", "type": "Object", "tags": [], "label": "derivative", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"derivative\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinitions.moving_average", "type": "Object", "tags": [], "label": "moving_average", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"moving_average\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionImage", "type": "Interface", "tags": [], "label": "ExpressionImage", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionImage.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"image\"" ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionImage.mode", "type": "string", "tags": [], "label": "mode", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionImage.dataurl", "type": "string", "tags": [], "label": "dataurl", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition", "type": "Interface", "tags": [], "label": "ExpressionRenderDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.name", "type": "string", "tags": [], "label": "name", "description": [ "\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.displayName", "type": "string", "tags": [], "label": "displayName", "description": [ "\nA user friendly name of the renderer as will be displayed to user in UI." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.help", "type": "string", "tags": [], "label": "help", "description": [ "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nUsed to validate the data before calling the render function." ], "signature": [ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.reuseDomNode", "type": "boolean", "tags": [], "label": "reuseDomNode", "description": [ "\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default." ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.render", "type": "Function", "tags": [], "label": "render", "description": [ "\nThe function called to render the output data of an expression." ], "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" }, ") => void | Promise" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderHandlers", "text": "IInterpreterRenderHandlers" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams", "type": "Interface", "tags": [], "label": "ExpressionServiceParams", "description": [], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.executor", "type": "Object", "tags": [], "label": "executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Executor", "text": "Executor" }, "> | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ { "pluginId": "@kbn/logging", "scope": "server", "docId": "kibKbnLoggingPluginApi", "section": "def-server.Logger", "text": "Logger" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionServiceParams.renderers", "type": "Object", "tags": [], "label": "renderers", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRendererRegistry", "text": "ExpressionRendererRegistry" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup", "type": "Interface", "tags": [], "label": "ExpressionsServiceSetup", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getFunction", "type": "Function", "tags": [ "deprecated" ], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/setup_expressions.ts" } ], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getFunctions", "type": "Function", "tags": [ "deprecated" ], "label": "getFunctions", "description": [ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.test.ts" } ], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getTypes", "type": "Function", "tags": [ "deprecated" ], "label": "getTypes", "description": [ "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." ], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/setup_expressions.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/application.tsx" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" } ], "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.fork", "type": "Function", "tags": [], "label": "fork", "description": [ "\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice." ], "signature": [ "(namespace: string) => ", "ExpressionsServiceFork" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.fork.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerFunction", "type": "Function", "tags": [], "label": "registerFunction", "description": [ "\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects." ], "signature": [ "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerFunction.$1", "type": "CompoundType", "tags": [], "label": "functionDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionFunctionDefinition", "text": "AnyExpressionFunctionDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerType.$1", "type": "CompoundType", "tags": [], "label": "typeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerRenderer", "type": "Function", "tags": [], "label": "registerRenderer", "description": [], "signature": [ "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")) => void" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.registerRenderer.$1", "type": "CompoundType", "tags": [], "label": "definition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionRenderDefinition", "text": "AnyExpressionRenderDefinition" }, ")" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceSetup.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart", "type": "Interface", "tags": [], "label": "ExpressionsServiceStart", "description": [ "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [ "\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string, namespace?: string | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunction.$2", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunctions", "type": "Function", "tags": [], "label": "getFunctions", "description": [ "\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances." ], "signature": [ "(namespace?: string | undefined) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getFunctions.$1", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getRenderer", "type": "Function", "tags": [], "label": "getRenderer", "description": [ "\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderer", "text": "ExpressionRenderer" }, " | null" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getRenderers", "type": "Function", "tags": [], "label": "getRenderers", "description": [ "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." ], "signature": [ "() => Record>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getType", "type": "Function", "tags": [], "label": "getType", "description": [ "\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object." ], "signature": [ "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getTypes", "type": "Function", "tags": [], "label": "getTypes", "description": [ "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." ], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.run", "type": "Function", "tags": [], "label": "run", "description": [ "\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```" ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", "Observable", "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionResult", "text": "ExecutionResult" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | Output>>" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.run.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.run.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.run.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.execute", "type": "Function", "tags": [], "label": "execute", "description": [ "\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution." ], "signature": [ "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", input: Input, params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionContract", "text": "ExecutionContract" }, "" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.execute.$3", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionExecutionParams", "text": "ExpressionExecutionParams" }, " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.extract.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.inject.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.telemetry", "type": "Function", "tags": [], "label": "telemetry", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, ", telemetryData: Record) => Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.telemetry.$1", "type": "CompoundType", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.telemetry.$2", "type": "Object", "tags": [], "label": "telemetryData", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionsServiceStart.getAllMigrations", "type": "Function", "tags": [], "label": "getAllMigrations", "description": [], "signature": [ "() => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.MigrateFunctionsObject", "text": "MigrateFunctionsObject" } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition", "type": "Interface", "tags": [], "label": "ExpressionTypeDefinition", "description": [ "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.name", "type": "Uncategorized", "tags": [], "label": "name", "description": [], "signature": [ "Name" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.namespace", "type": "string", "tags": [], "label": "namespace", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "((type: unknown) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.validate.$1", "type": "Unknown", "tags": [], "label": "type", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.serialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.deserialize.$1", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "SerializedType" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.from", "type": "Object", "tags": [], "label": "from", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.to", "type": "Object", "tags": [], "label": "to", "description": [], "signature": [ "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueConverter", "text": "ExpressionValueConverter" }, "; } | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeDefinition.help", "type": "string", "tags": [], "label": "help", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle", "type": "Interface", "tags": [], "label": "ExpressionTypeStyle", "description": [ "\nAn object that represents style information, typically CSS." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"style\"" ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.spec", "type": "Object", "tags": [], "label": "spec", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CSSStyle", "text": "CSSStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionTypeStyle.css", "type": "string", "tags": [], "label": "css", "description": [], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Font", "type": "Interface", "tags": [], "label": "Font", "description": [ "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Font.label", "type": "CompoundType", "tags": [], "label": "label", "description": [], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Font.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments", "type": "Interface", "tags": [], "label": "FontArguments", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.FontArguments.align", "type": "CompoundType", "tags": [], "label": "align", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TextAlignment", "text": "TextAlignment" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.color", "type": "string", "tags": [], "label": "color", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.family", "type": "CompoundType", "tags": [], "label": "family", "description": [], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\" | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.italic", "type": "CompoundType", "tags": [], "label": "italic", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.lHeight", "type": "CompoundType", "tags": [], "label": "lHeight", "description": [], "signature": [ "number | null | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.size", "type": "number", "tags": [], "label": "size", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.underline", "type": "CompoundType", "tags": [], "label": "underline", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.weight", "type": "CompoundType", "tags": [], "label": "weight", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontWeight", "text": "FontWeight" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.FontArguments.sizeUnit", "type": "string", "tags": [], "label": "sizeUnit", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderEvent", "type": "Interface", "tags": [], "label": "IInterpreterRenderEvent", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderEvent.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderEvent.data", "type": "Uncategorized", "tags": [], "label": "data", "description": [], "signature": [ "Context | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers", "type": "Interface", "tags": [], "label": "IInterpreterRenderHandlers", "description": [], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.done", "type": "Function", "tags": [], "label": "done", "description": [ "\nDone increments the number of rendering successes" ], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.onDestroy", "type": "Function", "tags": [], "label": "onDestroy", "description": [], "signature": [ "(fn: () => void) => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.reload", "type": "Function", "tags": [], "label": "reload", "description": [], "signature": [ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.update", "type": "Function", "tags": [], "label": "update", "description": [], "signature": [ "(params: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.update.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.event", "type": "Function", "tags": [], "label": "event", "description": [], "signature": [ "(event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.event.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions", "type": "Function", "tags": [], "label": "hasCompatibleActions", "description": [], "signature": [ "((event: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, ") => Promise) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions.$1", "type": "Object", "tags": [], "label": "event", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderEvent", "text": "IInterpreterRenderEvent" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.getRenderMode", "type": "Function", "tags": [], "label": "getRenderMode", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.RenderMode", "text": "RenderMode" } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.isInteractive", "type": "Function", "tags": [], "label": "isInteractive", "description": [ "\nThe chart is rendered in a non-interactive environment and should not provide any affordances for interaction like brushing." ], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.isSyncColorsEnabled", "type": "Function", "tags": [], "label": "isSyncColorsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.isSyncCursorEnabled", "type": "Function", "tags": [], "label": "isSyncCursorEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.isSyncTooltipsEnabled", "type": "Function", "tags": [], "label": "isSyncTooltipsEnabled", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.uiState", "type": "Unknown", "tags": [], "label": "uiState", "description": [ "\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now." ], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.getExecutionContext", "type": "Function", "tags": [], "label": "getExecutionContext", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderUpdateParams", "type": "Interface", "tags": [], "label": "IInterpreterRenderUpdateParams", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IInterpreterRenderUpdateParams", "text": "IInterpreterRenderUpdateParams" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderUpdateParams.newExpression", "type": "CompoundType", "tags": [], "label": "newExpression", "description": [], "signature": [ "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, " | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderUpdateParams.newParams", "type": "Uncategorized", "tags": [], "label": "newParams", "description": [], "signature": [ "Params" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.IRegistry", "type": "Interface", "tags": [], "label": "IRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.IRegistry", "text": "IRegistry" }, "" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IRegistry.get", "type": "Function", "tags": [], "label": "get", "description": [], "signature": [ "(id: string) => T | null" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.IRegistry.get.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IRegistry.toJS", "type": "Function", "tags": [], "label": "toJS", "description": [], "signature": [ "() => Record" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.IRegistry.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => T[]" ], "path": "src/plugins/expressions/common/types/registry.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments", "type": "Interface", "tags": [], "label": "MapColumnArguments", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.id", "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ "string | null | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.expression", "type": "Function", "tags": [], "label": "expression", "description": [], "signature": [ "(datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => ", "Observable", "" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.expression.$1", "type": "Object", "tags": [], "label": "datatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.MapColumnArguments.copyMetaFrom", "type": "CompoundType", "tags": [], "label": "copyMetaFrom", "description": [], "signature": [ "string | null | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs", "type": "Interface", "tags": [], "label": "MovingAverageArgs", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.by", "type": "Array", "tags": [], "label": "by", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.inputColumnId", "type": "string", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.outputColumnId", "type": "string", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.outputColumnName", "type": "string", "tags": [], "label": "outputColumnName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.MovingAverageArgs.window", "type": "number", "tags": [], "label": "window", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs", "type": "Interface", "tags": [], "label": "OverallMetricArgs", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs.by", "type": "Array", "tags": [], "label": "by", "description": [], "signature": [ "string[] | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs.inputColumnId", "type": "string", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs.outputColumnId", "type": "string", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs.outputColumnName", "type": "string", "tags": [], "label": "outputColumnName", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.OverallMetricArgs.metric", "type": "CompoundType", "tags": [], "label": "metric", "description": [], "signature": [ "\"min\" | \"max\" | \"sum\" | \"average\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn", "type": "Interface", "tags": [], "label": "PointSeriesColumn", "description": [ "\nColumn in a PointSeries" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ "\"string\" | \"number\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.role", "type": "CompoundType", "tags": [], "label": "role", "description": [], "signature": [ "\"measure\" | \"dimension\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumn.expression", "type": "string", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Range", "type": "Interface", "tags": [], "label": "Range", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.Range.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Range.from", "type": "number", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Range.to", "type": "number", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.Range.label", "type": "string", "tags": [], "label": "label", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.SerializedDatatable", "type": "Interface", "tags": [], "label": "SerializedDatatable", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" }, " extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.SerializedDatatable.rows", "type": "Array", "tags": [], "label": "rows", "description": [], "signature": [ "string[][]" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.UiSettingArguments", "type": "Interface", "tags": [], "label": "UiSettingArguments", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.UiSettingArguments.default", "type": "Unknown", "tags": [], "label": "default", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.UiSettingArguments.parameter", "type": "string", "tags": [], "label": "parameter", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "expressions", "id": "def-common.BackgroundRepeat", "type": "Enum", "tags": [], "label": "BackgroundRepeat", "description": [ "\nEnum of supported CSS `background-repeat` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.BackgroundSize", "type": "Enum", "tags": [], "label": "BackgroundSize", "description": [ "\nEnum of supported CSS `background-size` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontSizeUnit", "type": "Enum", "tags": [], "label": "FontSizeUnit", "description": [], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontStyle", "type": "Enum", "tags": [], "label": "FontStyle", "description": [ "\nEnum of supported CSS `font-style` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontWeight", "type": "Enum", "tags": [], "label": "FontWeight", "description": [ "\nEnum of supported CSS `font-weight` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Overflow", "type": "Enum", "tags": [], "label": "Overflow", "description": [ "\nEnum of supported CSS `overflow` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TextAlignment", "type": "Enum", "tags": [], "label": "TextAlignment", "description": [ "\nEnum of supported CSS `text-align` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TextDecoration", "type": "Enum", "tags": [], "label": "TextDecoration", "description": [ "\nEnum of supported CSS `text-decoration` properties." ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "expressions", "id": "def-common.AnyExpressionFunctionDefinition", "type": "Type", "tags": [], "label": "AnyExpressionFunctionDefinition", "description": [ "\nType to capture every possible expression function definition." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, ", any, ", { "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/expressions/common/expression_functions/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.AnyExpressionRenderDefinition", "type": "Type", "tags": [], "label": "AnyExpressionRenderDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionRenderDefinition", "text": "ExpressionRenderDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.AnyExpressionTypeDefinition", "type": "Type", "tags": [], "label": "AnyExpressionTypeDefinition", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeDefinition", "text": "ExpressionTypeDefinition" }, "" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ArgumentType", "type": "Type", "tags": [], "label": "ArgumentType", "description": [ "\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification." ], "signature": [ "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" ], "path": "src/plugins/expressions/common/expression_functions/arguments.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableColumnType", "type": "Type", "tags": [], "label": "DatatableColumnType", "description": [ "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" ], "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.DatatableRow", "type": "Type", "tags": [], "label": "DatatableRow", "description": [ "\nThis type represents a row in a `Datatable`." ], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ErrorLike", "type": "Type", "tags": [], "label": "ErrorLike", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedError", "text": "SerializedError" }, " & { original?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedError", "text": "SerializedError" }, " | undefined; }" ], "path": "src/plugins/expressions/common/util/create_error.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContainer", "type": "Type", "tags": [], "label": "ExecutionContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionPureTransitions", "text": "ExecutionPureTransitions" }, ", {}>" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExecutorContainer", "type": "Type", "tags": [], "label": "ExecutorContainer", "description": [], "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.StateContainer", "text": "StateContainer" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureTransitions", "text": "ExecutorPureTransitions" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorPureSelectors", "text": "ExecutorPureSelectors" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstArgument", "type": "Type", "tags": [], "label": "ExpressionAstArgument", "description": [], "signature": [ "string | number | boolean | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstExpression", "type": "Type", "tags": [], "label": "ExpressionAstExpression", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.Ast", "text": "Ast" }, ", \"chain\"> & { chain: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, "[]; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunction", "type": "Type", "tags": [], "label": "ExpressionAstFunction", "description": [], "signature": [ "Omit<", { "pluginId": "@kbn/interpreter", "scope": "common", "docId": "kibKbnInterpreterPluginApi", "section": "def-common.AstFunction", "text": "AstFunction" }, ", \"arguments\"> & { arguments: Record; debug?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunctionDebug", "text": "ExpressionAstFunctionDebug" }, " | undefined; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstFunctionDebug", "type": "Type", "tags": [], "label": "ExpressionAstFunctionDebug", "description": [], "signature": [ "{ success: boolean; fn: string; input: any; args: Record; output?: any; error?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, " | undefined; rawError?: any; duration: number | undefined; }" ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionAstNode", "type": "Type", "tags": [], "label": "ExpressionAstNode", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstFunction", "text": "ExpressionAstFunction" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstArgument", "text": "ExpressionAstArgument" } ], "path": "src/plugins/expressions/common/ast/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionClog", "type": "Type", "tags": [], "label": "ExpressionFunctionClog", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"clog\", unknown, {}, unknown, ", { "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/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionCumulativeSum", "type": "Type", "tags": [], "label": "ExpressionFunctionCumulativeSum", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"cumulative_sum\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDerivative", "type": "Type", "tags": [], "label": "ExpressionFunctionDerivative", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"derivative\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionFont", "type": "Type", "tags": [], "label": "ExpressionFunctionFont", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"font\", null, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" }, ", ", { "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/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionMovingAverage", "type": "Type", "tags": [], "label": "ExpressionFunctionMovingAverage", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"moving_average\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionOverallMetric", "type": "Type", "tags": [], "label": "ExpressionFunctionOverallMetric", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"overall_metric\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">, ", { "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/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionTheme", "type": "Type", "tags": [], "label": "ExpressionFunctionTheme", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"theme\", null, Arguments, unknown, ", { "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/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionUiSetting", "type": "Type", "tags": [], "label": "ExpressionFunctionUiSetting", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"uiSetting\", unknown, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSettingArguments", "text": "UiSettingArguments" }, ", Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ">, ", { "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/expressions/common/expression_functions/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionVar", "type": "Type", "tags": [], "label": "ExpressionFunctionVar", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionVarSet", "type": "Type", "tags": [], "label": "ExpressionFunctionVarSet", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, "<\"var_set\", unknown, Arguments, unknown, ", { "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/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValue", "type": "Type", "tags": [], "label": "ExpressionValue", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueBoxed", "type": "Type", "tags": [], "label": "ExpressionValueBoxed", "description": [], "signature": [ "{ type: Type; } & Value" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueConverter", "type": "Type", "tags": [], "label": "ExpressionValueConverter", "description": [], "signature": [ "(input: I, availableTypes: Record) => O" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "expressions", "id": "def-common.ExpressionValueConverter.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "I" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueConverter.$2", "type": "Object", "tags": [], "label": "availableTypes", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueError", "type": "Type", "tags": [], "label": "ExpressionValueError", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueFilter", "type": "Type", "tags": [], "label": "ExpressionValueFilter", "description": [ "\nRepresents an object that is a Filter." ], "signature": [ "{ type: \"filter\"; } & { filterType?: string | undefined; filterGroup?: string | undefined; value?: string | undefined; column?: string | undefined; and: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueFilter", "text": "ExpressionValueFilter" }, "[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueNum", "type": "Type", "tags": [], "label": "ExpressionValueNum", "description": [], "signature": [ "{ type: \"num\"; } & { value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueRender", "type": "Type", "tags": [], "label": "ExpressionValueRender", "description": [ "\nRepresents an object that is intended to be rendered." ], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.ExpressionValueUnboxed", "type": "Type", "tags": [], "label": "ExpressionValueUnboxed", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontLabel", "type": "Type", "tags": [], "label": "FontLabel", "description": [ "\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI." ], "signature": [ "\"Open Sans\" | \"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Inter\" | \"Lucida Grande\" | \"Myriad\" | \"Optima\" | \"Palatino\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.fonts", "type": "Array", "tags": [], "label": "fonts", "description": [ "\nA collection of supported fonts." ], "signature": [ "({ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; } | { label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; } | { label: \"Arial\"; value: \"Arial, sans-serif\"; } | { label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; } | { label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; } | { label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; } | { label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; } | { label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; } | { label: \"Inter\"; value: \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\"; } | { label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; } | { label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; })[]" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.FontValue", "type": "Type", "tags": [], "label": "FontValue", "description": [ "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." ], "signature": [ "\"'Open Sans', Helvetica, Arial, sans-serif\" | \"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.InferFunctionDefinition", "type": "Type", "tags": [], "label": "InferFunctionDefinition", "description": [], "signature": [ "FnDef extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, " ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.InterpreterErrorType", "type": "Type", "tags": [ "deprecated" ], "label": "InterpreterErrorType", "description": [], "signature": [ "{ type: \"error\"; } & { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ErrorLike", "text": "ErrorLike" }, "; info?: ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.SerializableRecord", "text": "SerializableRecord" }, " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": true, "trackAdoption": false, "references": [], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.KnownTypeToString", "type": "Type", "tags": [], "label": "KnownTypeToString", "description": [ "\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it." ], "signature": [ "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.MathArguments", "type": "Type", "tags": [], "label": "MathArguments", "description": [], "signature": [ "{ expression: string; onError?: \"null\" | \"zero\" | \"false\" | \"throw\" | undefined; }" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.MathColumnArguments", "type": "Type", "tags": [], "label": "MathColumnArguments", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathArguments", "text": "MathArguments" }, " & { id: string; name?: string | undefined; castColumns?: string[] | undefined; copyMetaFrom?: string | null | undefined; }" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.MathInput", "type": "Type", "tags": [], "label": "MathInput", "description": [], "signature": [ "number | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeries", "type": "Type", "tags": [], "label": "PointSeries", "description": [ "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "signature": [ "{ type: \"pointseries\"; } & { columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumns", "text": "PointSeriesColumns" }, "; rows: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumnName", "type": "Type", "tags": [], "label": "PointSeriesColumnName", "description": [ "\nAllowed column names in a PointSeries" ], "signature": [ "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumns", "type": "Type", "tags": [], "label": "PointSeriesColumns", "description": [ "\nRepresents a collection of valid Columns in a PointSeries" ], "signature": [ "{} | Record<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumnName", "text": "PointSeriesColumnName" }, ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeriesColumn", "text": "PointSeriesColumn" }, ">" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesRow", "type": "Type", "tags": [], "label": "PointSeriesRow", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Render", "type": "Type", "tags": [ "deprecated" ], "label": "Render", "description": [], "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": true, "trackAdoption": false, "references": [ { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/types/state.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/types/state.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/functions/pie.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/functions/pie.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/functions/plot/index.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/functions/plot/index.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts" }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts" } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.RenderMode", "type": "Type", "tags": [], "label": "RenderMode", "description": [ "\nMode of the expression render environment.\nThis value can be set from a consumer embedding an expression renderer and is accessible\nfrom within the active render function as part of the handlers.\nThe following modes are supported:\n* view (default): The chart is rendered in a container with the main purpose of viewing the chart (e.g. in a container like dashboard or canvas)\n* preview: The chart is rendered in very restricted space (below 100px width and height) and should only show a rough outline\n* edit: The chart is rendered within an editor and configuration elements within the chart should be displayed" ], "signature": [ "\"edit\" | \"preview\" | \"view\"" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.SerializedError", "type": "Type", "tags": [], "label": "SerializedError", "description": [], "signature": [ "{ name: string; message: string; stack?: string | undefined; }" ], "path": "src/plugins/expressions/common/util/create_error.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.Style", "type": "Type", "tags": [], "label": "Style", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionTypeStyle", "text": "ExpressionTypeStyle" } ], "path": "src/plugins/expressions/common/types/style.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.typeSpecs", "type": "Array", "tags": [], "label": "typeSpecs", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.AnyExpressionTypeDefinition", "text": "AnyExpressionTypeDefinition" }, "[]" ], "path": "src/plugins/expressions/common/expression_types/specs/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TypeString", "type": "Type", "tags": [], "label": "TypeString", "description": [ "\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`" ], "signature": [ "(T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends string ? \"string\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends boolean ? \"boolean\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends number ? \"number\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends null ? \"null\" : (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited) extends { type: string; } ? ({ type: string; } & (T extends ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.ObservableLike", "text": "ObservableLike" }, " ? ", { "pluginId": "@kbn/utility-types", "scope": "server", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-server.UnwrapObservable", "text": "UnwrapObservable" }, " : Awaited))[\"type\"] : never" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.TypeToString", "type": "Type", "tags": [], "label": "TypeToString", "description": [ "\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format." ], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UnmappedTypeStrings", "text": "UnmappedTypeStrings" }, " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.KnownTypeToString", "text": "KnownTypeToString" }, "" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.UiSetting", "type": "Type", "tags": [], "label": "UiSetting", "description": [], "signature": [ "{ type: \"ui_setting\"; } & { key: string; value: unknown; }" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.UnmappedTypeStrings", "type": "Type", "tags": [], "label": "UnmappedTypeStrings", "description": [ "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" ], "signature": [ "\"date\" | \"filter\"" ], "path": "src/plugins/expressions/common/types/common.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "expressions", "id": "def-common.americanTypewriter", "type": "Object", "tags": [], "label": "americanTypewriter", "description": [], "signature": [ "{ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.arial", "type": "Object", "tags": [], "label": "arial", "description": [], "signature": [ "{ label: \"Arial\"; value: \"Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.baskerville", "type": "Object", "tags": [], "label": "baskerville", "description": [], "signature": [ "{ label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.bookAntiqua", "type": "Object", "tags": [], "label": "bookAntiqua", "description": [], "signature": [ "{ label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.boolean", "type": "Object", "tags": [], "label": "boolean", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"boolean\"" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.boolean.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => false" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.boolean.from.number", "type": "Function", "tags": [], "label": "number", "description": [], "signature": [ "(n: number) => boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.from.number.$1", "type": "number", "tags": [], "label": "n", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.boolean.from.string", "type": "Function", "tags": [], "label": "string", "description": [], "signature": [ "(s: string) => boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.from.string.$1", "type": "string", "tags": [], "label": "s", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.boolean.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(value: boolean) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: string; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.to.render.$1", "type": "boolean", "tags": [], "label": "value", "description": [], "signature": [ "boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.boolean.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "(value: boolean) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.boolean.to.datatable.$1", "type": "boolean", "tags": [], "label": "value", "description": [], "signature": [ "boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.brushScript", "type": "Object", "tags": [], "label": "brushScript", "description": [], "signature": [ "{ label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.chalkboard", "type": "Object", "tags": [], "label": "chalkboard", "description": [], "signature": [ "{ label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.clog", "type": "Object", "tags": [], "label": "clog", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.clog.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"clog\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.clog.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-common.clog.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.clog.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: unknown) => unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.clog.fn.$1", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.createTable", "type": "Object", "tags": [], "label": "createTable", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"createTable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.args.ids", "type": "Object", "tags": [], "label": "ids", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.args.ids.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.ids.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.ids.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.ids.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.names", "type": "Object", "tags": [], "label": "names", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.args.names.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.names.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.names.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.names.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.rowCount", "type": "Object", "tags": [], "label": "rowCount", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.args.rowCount.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.rowCount.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.rowCount.default", "type": "number", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.createTable.args.rowCount.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.createTable.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CreateTableArguments", "text": "CreateTableArguments" }, ") => { columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]; rows: {}[]; type: \"datatable\"; }" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.createTable.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.createTable.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CreateTableArguments", "text": "CreateTableArguments" } ], "path": "src/plugins/expressions/common/expression_functions/specs/create_table.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum", "type": "Object", "tags": [], "label": "cumulativeSum", "description": [ "\nCalculates the cumulative sum of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate cumulative sum will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the cumulative sum of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Cumulative sums always start with 0, a cell will contain its own value plus the values of\n all cells of the same series further up in the table.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If the row value contains `null` or `undefined`, it will be ignored and overwritten with the cumulative sum of\n all cells of the same series further up in the table.\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's added to the\n cumulative sum of the current series - if this results in `NaN` (like in case of objects), all cells of the\n current series will be set to `NaN`.\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"cumulative_sum\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by", "type": "Object", "tags": [], "label": "by", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.by.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId", "type": "Object", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.inputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId", "type": "Object", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName", "type": "Object", "tags": [], "label": "outputColumnName", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.args.outputColumnName.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" }, ") => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.cumulativeSum.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CumulativeSumArgs", "text": "CumulativeSumArgs" } ], "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.datatable", "type": "Object", "tags": [], "label": "datatable", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.datatable.validate", "type": "Function", "tags": [], "label": "validate", "description": [], "signature": [ "(table: Record) => void" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.validate.$1", "type": "Object", "tags": [], "label": "table", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.datatable.serialize", "type": "Function", "tags": [], "label": "serialize", "description": [], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => { rows: any[][]; type: \"datatable\"; columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]; meta?: ", "DatatableMeta", " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.serialize.$1", "type": "Object", "tags": [], "label": "table", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.datatable.deserialize", "type": "Function", "tags": [], "label": "deserialize", "description": [], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" }, ") => { rows: ", "Dictionary", "[]; type: \"datatable\"; columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]; meta?: ", "DatatableMeta", " | undefined; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.deserialize.$1", "type": "Object", "tags": [], "label": "table", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.datatable.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.datatable.from.pointseries", "type": "Function", "tags": [], "label": "pointseries", "description": [], "signature": [ "(value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeries", "text": "PointSeries" }, ") => { type: \"datatable\"; meta: {}; rows: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[]; columns: { id: string; name: string; meta: { type: \"string\" | \"number\"; }; }[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.from.pointseries.$1", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeries", "text": "PointSeries" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.datatable.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "" ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.to.render.$1", "type": "Object", "tags": [], "label": "table", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.datatable.to.pointseries", "type": "Function", "tags": [], "label": "pointseries", "description": [], "signature": [ "(table: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeries", "text": "PointSeries" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.datatable.to.pointseries.$1", "type": "Object", "tags": [], "label": "table", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.defaultState", "type": "Object", "tags": [], "label": "defaultState", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.defaultState.functions", "type": "Object", "tags": [], "label": "functions", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-common.defaultState.types", "type": "Object", "tags": [], "label": "types", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [] }, { "parentPluginId": "expressions", "id": "def-common.defaultState.context", "type": "Object", "tags": [], "label": "context", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.derivative", "type": "Object", "tags": [], "label": "derivative", "description": [ "\nCalculates the derivative of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate derivative will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the derivative of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Derivative always start with an undefined value for the first row of a series, a cell will contain its own value minus the\n value of the previous cell of the same series.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If there is no previous row of the current series with a non `null` or `undefined` value, the output cell of the current row\n will be set to `undefined`.\n* If the row value contains `null` or `undefined`, it will be ignored and the output cell will be set to `undefined`\n* If the value of the previous row of the same series contains `null` or `undefined`, the output cell of the current row will be set to `undefined` as well\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"derivative\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.args.by", "type": "Object", "tags": [], "label": "by", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.by.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId", "type": "Object", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.inputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId", "type": "Object", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName", "type": "Object", "tags": [], "label": "outputColumnName", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.derivative.args.outputColumnName.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.derivative.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" }, ") => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.derivative.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.derivative.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DerivativeArgs", "text": "DerivativeArgs" } ], "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.didot", "type": "Object", "tags": [], "label": "didot", "description": [], "signature": [ "{ label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.error", "type": "Object", "tags": [], "label": "error", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.error.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"error\"" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.error.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.error.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, ">" ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.error.to.render.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueError", "text": "ExpressionValueError" } ], "path": "src/plugins/expressions/common/expression_types/specs/error.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions", "type": "Object", "tags": [], "label": "executionPureTransitions", "description": [], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => () => { state: \"pending\"; ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; result?: any; error?: Error | undefined; functions: Record; types: Record; context: Record; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.start.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.setResult", "type": "Function", "tags": [], "label": "setResult", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => (result: any) => { state: \"result\"; result: any; ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; error?: Error | undefined; functions: Record; types: Record; context: Record; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.setResult.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.setError", "type": "Function", "tags": [], "label": "setError", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, ") => (error: Error) => { state: \"error\"; error: Error; ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, "; result?: any; functions: Record; types: Record; context: Record; }" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.executionPureTransitions.setError.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutionState", "text": "ExecutionState" }, "" ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.filter", "type": "Object", "tags": [], "label": "filter", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.filter.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"filter\"" ], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.filter.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.filter.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: \"filter\"; filterType: string; meta: {}; and: never[]; }" ], "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.font", "type": "Object", "tags": [], "label": "font", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"font\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "never[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"style\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.align", "type": "Object", "tags": [], "label": "align", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.align.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.align.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.align.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.TextAlignment", "text": "TextAlignment" }, "[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.align.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.color", "type": "Object", "tags": [], "label": "color", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.color.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.color.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.color.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.family", "type": "Object", "tags": [], "label": "family", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.family.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.family.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.family.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.italic", "type": "Object", "tags": [], "label": "italic", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.italic.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.italic.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.italic.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "boolean[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.italic.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight", "type": "Object", "tags": [], "label": "lHeight", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.lHeight.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"null\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.size", "type": "Object", "tags": [], "label": "size", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.size.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.size.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.size.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.sizeUnit", "type": "Object", "tags": [], "label": "sizeUnit", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.sizeUnit.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.sizeUnit.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.sizeUnit.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.sizeUnit.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.underline", "type": "Object", "tags": [], "label": "underline", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.underline.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.underline.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.underline.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "boolean[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.underline.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"boolean\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.font.args.weight", "type": "Object", "tags": [], "label": "weight", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.args.weight.default", "type": "string", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.weight.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.weight.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontWeight", "text": "FontWeight" }, "[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.font.args.weight.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.font.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" }, ") => { type: \"style\"; spec: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.CSSStyle", "text": "CSSStyle" }, "; css: string; }" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.font.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.font.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.FontArguments", "text": "FontArguments" } ], "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.futura", "type": "Object", "tags": [], "label": "futura", "description": [], "signature": [ "{ label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.gillSans", "type": "Object", "tags": [], "label": "gillSans", "description": [], "signature": [ "{ label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.helveticaNeue", "type": "Object", "tags": [], "label": "helveticaNeue", "description": [], "signature": [ "{ label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.hoeflerText", "type": "Object", "tags": [], "label": "hoeflerText", "description": [], "signature": [ "{ label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.image", "type": "Object", "tags": [], "label": "image", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.image.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"image\"" ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.image.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.image.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionImage", "text": "ExpressionImage" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, ">" ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.image.to.render.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionImage", "text": "ExpressionImage" } ], "path": "src/plugins/expressions/common/expression_types/specs/image.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.inter", "type": "Object", "tags": [], "label": "inter", "description": [], "signature": [ "{ label: \"Inter\"; value: \"'Inter', 'Inter UI', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.lucidaGrande", "type": "Object", "tags": [], "label": "lucidaGrande", "description": [], "signature": [ "{ label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn", "type": "Object", "tags": [], "label": "mapColumn", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"mapColumn\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id", "type": "Object", "tags": [], "label": "id", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"null\" | \"string\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.id.default", "type": "Uncategorized", "tags": [], "label": "default", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name", "type": "Object", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.name.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression", "type": "Object", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"number\" | \"null\" | \"boolean\" | \"string\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.resolve", "type": "boolean", "tags": [], "label": "resolve", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.expression.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom", "type": "Object", "tags": [], "label": "copyMetaFrom", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"null\" | \"string\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.args.copyMetaFrom.default", "type": "Uncategorized", "tags": [], "label": "default", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MapColumnArguments", "text": "MapColumnArguments" }, ") => ", "Observable", "<{ columns: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, "[]; rows: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, "[] | (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.DatatableRow", "text": "DatatableRow" }, " | { [x: string]: any; })[]; type: \"datatable\"; meta?: ", "DatatableMeta", " | undefined; }>" ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mapColumn.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.mapColumn.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MapColumnArguments", "text": "MapColumnArguments" } ], "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.math", "type": "Object", "tags": [], "label": "math", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.math.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"math\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ "undefined" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "(\"number\" | \"datatable\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.math.args.expression", "type": "Object", "tags": [], "label": "expression", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.math.args.expression.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.args.expression.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.args.expression.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.math.args.onError", "type": "Object", "tags": [], "label": "onError", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.math.args.onError.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.args.onError.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "(\"null\" | \"zero\" | \"false\" | \"throw\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.math.args.onError.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.math.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathInput", "text": "MathInput" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathArguments", "text": "MathArguments" }, ") => Promise" ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.math.fn.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathInput", "text": "MathInput" } ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.math.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathArguments", "text": "MathArguments" } ], "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn", "type": "Object", "tags": [], "label": "mathColumn", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"mathColumn\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.id", "type": "Object", "tags": [], "label": "id", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.id.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.id.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.id.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.name", "type": "Object", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.name.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.name.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.name.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.name.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.castColumns", "type": "Object", "tags": [], "label": "castColumns", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.castColumns.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.castColumns.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.castColumns.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.castColumns.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.copyMetaFrom", "type": "Object", "tags": [], "label": "copyMetaFrom", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.copyMetaFrom.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "(\"null\" | \"string\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.copyMetaFrom.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.copyMetaFrom.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.args.copyMetaFrom.default", "type": "Uncategorized", "tags": [], "label": "default", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathColumnArguments", "text": "MathColumnArguments" }, ", context: ", { "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" }, ">) => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.mathColumn.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.fn.$2", "type": "CompoundType", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MathColumnArguments", "text": "MathColumnArguments" } ], "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.mathColumn.fn.$3", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "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/expressions/common/expression_functions/specs/math_column.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage", "type": "Object", "tags": [], "label": "movingAverage", "description": [ "\nCalculates the moving average of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate moving average will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the moving average of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Moving average always starts with an undefined value for the first row of a series. Each next cell will contain sum of the last\n* [window] of values divided by [window] excluding the current bucket.\nIf either of window edges moves outside the borders of data series, the window shrinks to include available values only.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If null or undefined value is encountered, skip the current row and do not change the window\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison." ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"moving_average\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by", "type": "Object", "tags": [], "label": "by", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.by.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId", "type": "Object", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.inputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId", "type": "Object", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName", "type": "Object", "tags": [], "label": "outputColumnName", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.outputColumnName.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window", "type": "Object", "tags": [], "label": "window", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"number\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.args.window.default", "type": "number", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" }, ") => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.movingAverage.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.movingAverage.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.MovingAverageArgs", "text": "MovingAverageArgs" } ], "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.myriad", "type": "Object", "tags": [], "label": "myriad", "description": [], "signature": [ "{ label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.nullType", "type": "Object", "tags": [], "label": "nullType", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.nullType.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"null\"" ], "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.nullType.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.nullType.from.", "type": "Function", "tags": [], "label": "'*'", "description": [], "signature": [ "() => null" ], "path": "src/plugins/expressions/common/expression_types/specs/null.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.num", "type": "Object", "tags": [], "label": "num", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"num\"" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.num.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: \"num\"; value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.num.from.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [], "signature": [ "(b: boolean) => { type: \"num\"; value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.from.boolean.$1", "type": "boolean", "tags": [], "label": "b", "description": [], "signature": [ "boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.num.from.string", "type": "Function", "tags": [], "label": "string", "description": [], "signature": [ "(n: string) => { type: \"num\"; value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.from.string.$1", "type": "string", "tags": [], "label": "n", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.num.from.", "type": "Function", "tags": [], "label": "'*'", "description": [], "signature": [ "(value: unknown) => { type: \"num\"; value: number; }" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.from..$1", "type": "Unknown", "tags": [], "label": "value", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.num.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "({ value }: { value: number; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: string; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.to.render.$1", "type": "Object", "tags": [], "label": "{ value }", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.to.render.$1.value", "type": "number", "tags": [], "label": "value", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.num.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "({ value }: { value: number; }) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.to.datatable.$1", "type": "Object", "tags": [], "label": "{ value }", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.num.to.datatable.$1.value", "type": "number", "tags": [], "label": "value", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/num.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.number", "type": "Object", "tags": [], "label": "number", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"number\"" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.number.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.number.from.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [], "signature": [ "(b: boolean) => number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.from.boolean.$1", "type": "boolean", "tags": [], "label": "b", "description": [], "signature": [ "boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.number.from.string", "type": "Function", "tags": [], "label": "string", "description": [], "signature": [ "(n: number) => number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.from.string.$1", "type": "number", "tags": [], "label": "n", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.number.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(value: number) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: string; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.to.render.$1", "type": "number", "tags": [], "label": "value", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.number.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "(value: number) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.number.to.datatable.$1", "type": "number", "tags": [], "label": "value", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/common/expression_types/specs/number.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.openSans", "type": "Object", "tags": [], "label": "openSans", "description": [], "signature": [ "{ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.optima", "type": "Object", "tags": [], "label": "optima", "description": [], "signature": [ "{ label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric", "type": "Object", "tags": [], "label": "overallMetric", "description": [ "\nCalculates the overall metric of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate overall metric will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the overall metric of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Each cell will contain the calculated metric based on the values of all cells belonging to the current series.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If the row value contains `null` or `undefined`, it will be ignored and overwritten with the overall metric of\n all cells of the same series.\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's added to the\n overall metric of the current series - if this results in `NaN` (like in case of objects), all cells of the\n current series will be set to `NaN`.\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings." ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"overall_metric\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"datatable\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"datatable\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.by", "type": "Object", "tags": [], "label": "by", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.by.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.by.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.by.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.by.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.metric", "type": "Object", "tags": [], "label": "metric", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.metric.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.metric.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.metric.options", "type": "Array", "tags": [], "label": "options", "description": [], "signature": [ "(\"min\" | \"max\" | \"sum\" | \"average\")[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.inputColumnId", "type": "Object", "tags": [], "label": "inputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.inputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.inputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.inputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnId", "type": "Object", "tags": [], "label": "outputColumnId", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnId.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnId.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnId.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnName", "type": "Object", "tags": [], "label": "outputColumnName", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnName.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnName.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.args.outputColumnName.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "false" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ", args: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" }, ") => Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, ">" ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.overallMetric.fn.$1", "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.overallMetric.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.OverallMetricArgs", "text": "OverallMetricArgs" } ], "path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.palatino", "type": "Object", "tags": [], "label": "palatino", "description": [], "signature": [ "{ label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "path": "src/plugins/expressions/common/fonts.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.pointseries", "type": "Object", "tags": [], "label": "pointseries", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pointseries.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"pointseries\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.pointseries.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pointseries.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: \"pointseries\"; rows: never[]; columns: {}; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.pointseries.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pointseries.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(pseries: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeries", "text": "PointSeries" }, ", types: Record) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" }, "; showHeader: boolean; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pointseries.to.render.$1", "type": "CompoundType", "tags": [], "label": "pseries", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.PointSeries", "text": "PointSeries" } ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.pointseries.to.render.$2", "type": "Object", "tags": [], "label": "types", "description": [], "signature": [ "Record" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.PointSeriesColumnNames", "type": "Object", "tags": [], "label": "PointSeriesColumnNames", "description": [], "signature": [ "{ readonly X: \"x\"; readonly Y: \"y\"; readonly COLOR: \"color\"; readonly SIZE: \"size\"; readonly TEXT: \"text\"; }" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.pureSelectors", "type": "Object", "tags": [], "label": "pureSelectors", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getFunction", "type": "Function", "tags": [], "label": "getFunction", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" } ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getFunction.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getType", "type": "Function", "tags": [], "label": "getType", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" } ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getType.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getContext", "type": "Function", "tags": [], "label": "getContext", "description": [], "signature": [ "({ context }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => () => Record" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureSelectors.getContext.$1", "type": "Object", "tags": [], "label": "{ context }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.pureTransitions", "type": "Object", "tags": [], "label": "pureTransitions", "description": [], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureTransitions.addFunction", "type": "Function", "tags": [], "label": "addFunction", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (fn: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, ") => { functions: { [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, "; }; types: Record; context: Record; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureTransitions.addFunction.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.pureTransitions.addType", "type": "Function", "tags": [], "label": "addType", "description": [], "signature": [ "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">) => (type: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, ") => { types: { [x: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionType", "text": "ExpressionType" }, "; }; functions: Record; context: Record; }" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.pureTransitions.addType.$1", "type": "Object", "tags": [], "label": "state", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExecutorState", "text": "ExecutorState" }, ">" ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.range", "type": "Object", "tags": [], "label": "range", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.range.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"range\"" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.range.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.range.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Range", "text": "Range" } ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.range.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.range.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Range", "text": "Range" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: string; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.range.to.render.$1", "type": "Object", "tags": [], "label": "value", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Range", "text": "Range" } ], "path": "src/plugins/expressions/common/expression_types/specs/range.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.render", "type": "Object", "tags": [], "label": "render", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.render.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"render\"" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.render.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.render.from.", "type": "Function", "tags": [], "label": "'*'", "description": [], "signature": [ "(v: T) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.render.from..$1", "type": "Uncategorized", "tags": [], "label": "v", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/expression_types/specs/render.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.shape", "type": "Object", "tags": [], "label": "shape", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.shape.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"shape\"" ], "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.shape.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.shape.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(input: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, ") => { type: string; as: string; value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "; }" ], "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.shape.to.render.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "" ], "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.string", "type": "Object", "tags": [], "label": "string", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"string\"" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.string.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => string" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.string.from.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [], "signature": [ "(b: boolean) => string" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.from.boolean.$1", "type": "boolean", "tags": [], "label": "b", "description": [], "signature": [ "boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.string.from.number", "type": "Function", "tags": [], "label": "number", "description": [], "signature": [ "(n: number) => string" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.from.number.$1", "type": "number", "tags": [], "label": "n", "description": [], "signature": [ "number" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] }, { "parentPluginId": "expressions", "id": "def-common.string.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(text: T) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: T; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.to.render.$1", "type": "Uncategorized", "tags": [], "label": "text", "description": [], "signature": [ "T" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.string.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "(value: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.string.to.datatable.$1", "type": "string", "tags": [], "label": "value", "description": [], "signature": [ "string" ], "path": "src/plugins/expressions/common/expression_types/specs/string.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.style", "type": "Object", "tags": [], "label": "style", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.style.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"style\"" ], "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.style.from", "type": "Object", "tags": [], "label": "from", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.style.from.null", "type": "Function", "tags": [], "label": "null", "description": [], "signature": [ "() => { type: \"style\"; spec: {}; css: string; }" ], "path": "src/plugins/expressions/common/expression_types/specs/style.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.theme", "type": "Object", "tags": [], "label": "theme", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.theme.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"theme\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "never[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", "description": [], "signature": [ "\"null\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.theme.args.variable", "type": "Object", "tags": [], "label": "variable", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.theme.args.variable.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.theme.args.default", "type": "Object", "tags": [], "label": "default", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.theme.args.default.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.theme.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: null, args: Arguments, handlers: ", { "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" }, ">) => any" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.theme.fn.$1", "type": "Uncategorized", "tags": [], "label": "input", "description": [], "signature": [ "null" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.theme.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.theme.fn.$3", "type": "Object", "tags": [], "label": "handlers", "description": [], "signature": [ { "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/expressions/common/expression_functions/specs/theme.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.uiSetting", "type": "Object", "tags": [], "label": "uiSetting", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"ui_setting\"" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.uiSetting.to", "type": "Object", "tags": [], "label": "to", "description": [], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.boolean", "type": "Function", "tags": [], "label": "boolean", "description": [], "signature": [ "({ value }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ") => boolean" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.boolean.$1", "type": "CompoundType", "tags": [], "label": "{ value }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.number", "type": "Function", "tags": [], "label": "number", "description": [], "signature": [ "({ value }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ") => number" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.number.$1", "type": "CompoundType", "tags": [], "label": "{ value }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.string", "type": "Function", "tags": [], "label": "string", "description": [], "signature": [ "({ value }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ") => string" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.string.$1", "type": "CompoundType", "tags": [], "label": "{ value }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "({ value }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.ExpressionValueRender", "text": "ExpressionValueRender" }, "<{ text: string; }>" ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.render.$1", "type": "CompoundType", "tags": [], "label": "{ value }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.datatable", "type": "Function", "tags": [], "label": "datatable", "description": [], "signature": [ "({ key, value }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" }, ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.Datatable", "text": "Datatable" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.uiSetting.to.datatable.$1", "type": "CompoundType", "tags": [], "label": "{ key, value }", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", "section": "def-common.UiSetting", "text": "UiSetting" } ], "path": "src/plugins/expressions/common/expression_types/specs/ui_setting.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.variable", "type": "Object", "tags": [], "label": "variable", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variable.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"var\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variable.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variable.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variable.args.name", "type": "Object", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variable.args.name.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variable.args.name.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variable.args.name.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variable.args.name.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.variable.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: unknown, args: Arguments, context: ", { "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" }, ">) => unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variable.fn.$1", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.variable.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.variable.fn.$3", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "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/expressions/common/expression_functions/specs/var.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet", "type": "Object", "tags": [], "label": "variableSet", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variableSet.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ "\"var_set\"" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args", "type": "Object", "tags": [], "label": "args", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name", "type": "Object", "tags": [], "label": "name", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.types", "type": "Array", "tags": [], "label": "types", "description": [], "signature": [ "\"string\"[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.required", "type": "boolean", "tags": [], "label": "required", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.name.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value", "type": "Object", "tags": [], "label": "value", "description": [], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.aliases", "type": "Array", "tags": [], "label": "aliases", "description": [], "signature": [ "string[]" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.multi", "type": "boolean", "tags": [], "label": "multi", "description": [], "signature": [ "true" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "expressions", "id": "def-common.variableSet.args.value.help", "type": "Any", "tags": [], "label": "help", "description": [], "signature": [ "any" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false } ] } ] }, { "parentPluginId": "expressions", "id": "def-common.variableSet.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "(input: unknown, args: Arguments, context: ", { "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" }, ">) => unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$1", "type": "Unknown", "tags": [], "label": "input", "description": [], "signature": [ "unknown" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$2", "type": "Object", "tags": [], "label": "args", "description": [], "signature": [ "Arguments" ], "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "expressions", "id": "def-common.variableSet.fn.$3", "type": "Object", "tags": [], "label": "context", "description": [], "signature": [ { "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/expressions/common/expression_functions/specs/var_set.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ] } }