Skip to main content

VariableDef

Typeobject
Backlinks8

Define a variable.

PropertyTypeRequired
classstringRequired
idstringRequired
varTypeintegerRequired
valueNot specifiedRequired

class​

Required

Type

string

Value

constant: the value of this property must be equal to:

"variableDef"

id​

Required

Description

The ID of the variable is not globally unique but unique under the object tree.

Type

string

varType​

Required

Description

The value type of the variable.

Type

integer

Value

enum: the value of this property must be equal to one of the following values:

ValueExplanation
1
boolean
2
textProperty: contains some attributes of the text.
3
string
4
reference: references the definition of another variable, where value is a string and pointing to the ID of the referenced variable.

value​

Required

Description

The value of the variable, whose type is determined by varType. In the master, the object refers to a variable, and you don't need to care about the value of the variable; you just use its own value. In an instance, if the variable is not reassigned, the value of the corresponding variable in the master is used. In an instance, reassigning a variable affects all objects in that instance that reference the variable. In an instance, the direct override of a property takes precedence over the value of the corresponding variable.

Type

Not specified