Class VariableValue

An interface that represents a variable value.

Index

Constructors

Properties

color? modeId type variableSourceId?

Accessors

Methods

generateColorObject fromJSON

Constructors

constructor

new VariableValue(variableValueData: VariableValueData): VariableValue
Parameters
- variableValueData: VariableValueData
Returns VariableValue
- Defined in variableValue.ts:50

Properties

`Optional`color

color?: ColorData

RGBA color of the variable value.

Available when type is "color"

modeId

modeId: string

Unique identifier of the variable value's mode.

type

type: VariableValueType

Type of the variable value.

`Optional`variableSourceId

variableSourceId?: string

Unique identifier of the linked variable to the variable value.

Available when type is "variable"

Accessors

`Static`ALLOWED_FIELDS

get ALLOWED_FIELDS(): string[]
Returns string[]
- Defined in variableValue.ts:41

Methods

generateColorObject

generateColorObject(variable: Variable, colorValue: ColorData): Color
Generates a Color object from the variable value
Parameters
- variable: Variable
  The variable containing this value
- colorValue: ColorData
  The color value of the variable
Returns Color
A new Color instance
- Defined in variableValue.ts:64

`Static`fromJSON

fromJSON(json: string): VariableValue
Creates a VariableValue instance from a JSON string
Parameters
- json: string
  JSON string representing a variable value
Returns VariableValue
A new VariableValue instance
- Defined in variableValue.ts:83