QueryVariable

View as Markdown

A named value that can be referenced in Expressions via VAR('name').

TypeScript
export interface

Properties

PropertyTypeDescription
descriptionstringOptional description shown in the Expression Editor lookups
namestringUnique name used to reference the variable in expressions: VAR('name')
valueQueryVariableValue| ((context:QueryVariableContext) =>QueryVariableValue)Static value, or resolver evaluated with each expression evaluation

Property Details

description

Optional description shown in the Expression Editor lookups

TypeScript
description?: string;
Property Value

string

name

Unique name used to reference the variable in expressions: VAR('name')

TypeScript
name: string;
Property Value

string

value

Static value, or resolver evaluated with each expression evaluation

TypeScript
value: QueryVariableValue | ((context: QueryVariableContext) => QueryVariableValue);
Property Value

QueryVariableValue| ((context:QueryVariableContext) =>QueryVariableValue)