ExpressionEditorOptions

View as Markdown

Options for which Expression UI editors are available and which opens first

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
availableEditorsExpressionEditorsWhich UI editors can be used for Boolean Expressions (Query Builder, Expression Editor, or both).
Takes precedence over defaultEditor: if only one editor is listed, that editor is shown
and defaultEditor is not evaluated.
['QueryBuilder', 'ExpressionEditor']
defaultColumnViewExpressionEditorColumnViewInitial Columns/Fields panel layout in the Expression Editor.
- collapsed — column names only (more room for the editor)
- expanded — names plus sample/test value inputs
'collapsed'
defaultEditorExpressionEditorKind| ((context:DefaultExpressionEditorContext) =>ExpressionEditorKind)Which editor to open first when more than one editor is available.
Receives context (including Module) so the choice can vary by user or surface.
Ignored when availableEditors contains a single item.

Overridden to 'ExpressionEditor' when the current expression cannot be
edited in the Query Builder (non-boolean / value-producing expressions,
advanced constructs such as QUERY / FIELD, or expressions QB cannot
parse). Empty / new expressions still honour this preference.
'QueryBuilder'

Property Details

availableEditors

Which UI editors can be used for Boolean Expressions (Query Builder, Expression Editor, or both). Takes precedence over defaultEditor: if only one editor is listed, that editor is shown and defaultEditor is not evaluated.

TypeScript
availableEditors?: ExpressionEditors;
Default Value

['QueryBuilder', 'ExpressionEditor']

Property Value

ExpressionEditors

defaultColumnView

Initial Columns/Fields panel layout in the Expression Editor.

  • collapsed — column names only (more room for the editor)
  • expanded — names plus sample/test value inputs
TypeScript
defaultColumnView?: ExpressionEditorColumnView;
Default Value

'collapsed'

Property Value

ExpressionEditorColumnView

defaultEditor

Which editor to open first when more than one editor is available. Receives context (including Module) so the choice can vary by user or surface. Ignored when availableEditors contains a single item.

Overridden to 'ExpressionEditor' when the current expression cannot be edited in the Query Builder (non-boolean / value-producing expressions, advanced constructs such as QUERY / FIELD, or expressions QB cannot parse). Empty / new expressions still honour this preference.

TypeScript
defaultEditor?: ExpressionEditorKind | ((context: DefaultExpressionEditorContext) => ExpressionEditorKind);
Default Value

'QueryBuilder'

Property Value

ExpressionEditorKind| ((context:DefaultExpressionEditorContext) =>ExpressionEditorKind)