kibana/docs/development/plugins/expressions/server/kibana-plugin-plugins-expressions-server.md

Home > kibana-plugin-plugins-expressions-server

kibana-plugin-plugins-expressions-server package

Classes

Class	Description
Execution
Executor
ExpressionFunction
ExpressionFunctionParameter
ExpressionRenderer
ExpressionRendererRegistry
ExpressionsServerPlugin
ExpressionType
FunctionsRegistry
TypesRegistry

Enumerations

Enumeration	Description
FontStyle	Enum of supported CSS font-style properties.
FontWeight	Enum of supported CSS font-weight properties.
Overflow	Enum of supported CSS overflow properties.
TextAlignment	Enum of supported CSS text-align properties.
TextDecoration	Enum of supported CSS text-decoration properties.

Functions

Function	Description
buildExpression(initialState)	Makes it easy to progressively build, update, and traverse an expression AST. You can either start with an empty AST, or provide an expression string, AST, or array of expression function builders to use as initial state.
buildExpressionFunction(fnName, initialArgs)	Manages an AST for a single expression function. The return value can be provided to buildExpression to add this function to an expression.Note that to preserve type safety and ensure no args are missing, all required arguments for the specified function must be provided up front. If desired, they can be changed or removed later.
format(ast, type)
formatExpression(ast)	Given expression pipeline AST, returns formatted string.
isExpressionAstBuilder(val)	Type guard that checks whether a given value is an ExpressionAstExpressionBuilder. This is useful when working with subexpressions, where you might be retrieving a function argument, and need to know whether it is an expression builder instance which you can perform operations on.
parse(expression, startRule)
parseExpression(expression)	Given expression pipeline string, returns parsed AST.
plugin(initializerContext)

Interfaces

Interface	Description
Datatable	A Datatable in Canvas is a unique structure that represents tabulated data.
DatatableColumn	This type represents the shape of a column in a Datatable.
ExecutionContext	ExecutionContext is an object available to all functions during a single execution; it provides various methods to perform side-effects.
ExecutionParams
ExecutionState
ExecutorState
ExpressionAstExpressionBuilder
ExpressionAstFunctionBuilder
ExpressionFunctionDefinition	ExpressionFunctionDefinition is the interface plugins have to implement to register a function in expressions plugin.
ExpressionFunctionDefinitions	A mapping of ExpressionFunctionDefinitions for functions which the Expressions services provides out-of-the-box. Any new functions registered by the Expressions plugin should have their types added here.
ExpressionImage
ExpressionRenderDefinition
ExpressionTypeDefinition	A generic type which represents a custom Expression Type Definition that's registered to the Interpreter.
ExpressionTypeStyle	An object that represents style information, typically CSS.
Font	An interface representing a font in Canvas, with a textual label and the CSS font-value.
IInterpreterRenderHandlers
IRegistry
PointSeriesColumn	Column in a PointSeries
Range
SerializedDatatable
SerializedFieldFormat	JSON representation of a field formatter configuration. Is used to carry information about how to format data in a data table as part of the column definition.

Type Aliases

Type Alias	Description
AnyExpressionFunctionDefinition	Type to capture every possible expression function definition.
AnyExpressionTypeDefinition
ArgumentType	This type represents all of the possible combinations of properties of an Argument in an Expression Function. The presence or absence of certain fields influence the shape and presence of others within each arg in the specification.
DatatableColumnType	This type represents the type of any DatatableColumn in a Datatable. its duplicated from KBN_FIELD_TYPES
DatatableRow	This type represents a row in a Datatable.
ExecutionContainer
ExecutorContainer
ExpressionAstArgument
ExpressionAstExpression
ExpressionAstFunction
ExpressionAstNode
ExpressionFunctionKibana
ExpressionsServerSetup
ExpressionsServerStart
ExpressionValue
ExpressionValueBoxed
ExpressionValueConverter
ExpressionValueError
ExpressionValueFilter	Represents an object that is a Filter.
ExpressionValueNum
ExpressionValueRender	Represents an object that is intended to be rendered.
ExpressionValueSearchContext
ExpressionValueUnboxed
FontLabel	This type contains a unions of all supported font labels, or the the name of the font the user would see in a UI.
FontValue	This type contains a union of all supported font values, equivalent to the CSS font-value property.
InterpreterErrorType
KIBANA_CONTEXT_NAME
KibanaContext
KnownTypeToString	Map the type of the generic to a string-based representation of the type.If the provided generic is its own type interface, we use the value of the type key as a string literal type for it.
PointSeries	A PointSeries is a unique structure that represents dots on a chart.
PointSeriesColumnName	Allowed column names in a PointSeries
PointSeriesColumns	Represents a collection of valid Columns in a PointSeries
PointSeriesRow
Style
TypeString	If the type extends a Promise, we still need to return the string representation:someArgument: Promise<boolean | string> results in types: ['boolean', 'string']
TypeToString	This can convert a type into a known Expression string representation of that type. For example, TypeToString<Datatable> will resolve to 'datatable'. This allows Expression Functions to continue to specify their type in a simple string format.
UnmappedTypeStrings	Types used in Expressions that don't map to a primitive cleanly:date is typed as a number or string, and represents a date