UI Framework ReferenceIVariableManager

Interface: IVariableManager

Provides methods and properties for managing configuration variables.

Hierarchy

  • IVariableManager

Implemented by

Index

Properties

Methods

Properties

editor

editor: AuWizard

Defined in src/main/au-wizard/models/IVariableManager.ts:7

A reference to an editor's instance.


variables

variables: any

Defined in src/main/au-wizard/models/IVariableManager.ts:10

An object containing variables for the editor config.

Methods

append

append(name: string, value: any, updateScope?: boolean): void

Defined in src/main/au-wizard/models/IVariableManager.ts:24

Appends a new variable to the vars object or updates an existing variable.

Parameters:

Name Type Description
name string The name of the variable.
value any The value of the variable.
updateScope? boolean If true, runs scope recompilation so that widgets get updated parameters.

Returns:void


appendExpression

appendExpression(name: string, value: string): any

Defined in src/main/au-wizard/models/IVariableManager.ts:32

Appends a new expression to the editor's variables or updates an existing variable.

Parameters:

Name Type Description
name string The name of the variable.
value string The expression of the variable.

Returns:any

The calculated value of the expression.


calculate

calculate(name: string): any

Defined in src/main/au-wizard/models/IVariableManager.ts:39

Gets a variable by its name and calculates its value.

Parameters:

Name Type Description
name string The variable name.

Returns:any

The calculated value of the variable.


calculateAll

calculateAll(): object

Defined in src/main/au-wizard/models/IVariableManager.ts:45

Calculates all the editor's variables.

Returns:object

A dictionary of calculated variable values.

  • [ name: string]: any

init

init(initialVars: any): void

Defined in src/main/au-wizard/models/IVariableManager.ts:16

Initializes the variable manager with the defined editor's variables.

Parameters:

Name Type Description
initialVars any The vars object defined in the editor's config.

Returns:void