kibana/docs/development/plugins/expressions/public/kibana-plugin-plugins-expressions-public.executioncontext.md

Home > kibana-plugin-plugins-expressions-public > ExecutionContext

ExecutionContext interface

ExecutionContext is an object available to all functions during a single execution; it provides various methods to perform side-effects.

Signature:

export interface ExecutionContext<InspectorAdapters extends Adapters = Adapters, ExecutionContextSearch extends SerializableState = SerializableState> 

Properties

Property	Type	Description
abortSignal	AbortSignal	Adds ability to abort current execution.
getKibanaRequest	() => KibanaRequest	Getter to retrieve the KibanaRequest object inside an expression function. Useful for functions which are running on the server and need to perform operations that are scoped to a specific user.
getSearchContext	() => ExecutionContextSearch	Get search context of the expression.
getSearchSessionId	() => string | undefined	Search context in which expression should operate.
inspectorAdapters	InspectorAdapters	Adapters for inspector plugin.
isSyncColorsEnabled	() => boolean	Returns the state (true|false) of the sync colors across panels switch.
types	Record<string, ExpressionType>	A map of available expression types.
variables	Record<string, unknown>	Context variables that can be consumed using var and var_set functions.