Options
All
  • Public
  • Public/Protected
  • All
Menu

A class representing a type of Variable for string values.

class
extends

Variable

implements

{IStringVariableParams}

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _callbacks

_callbacks: IVariableCallback[] = new Array<IVariableCallback>()

controlType

controlType: string

The rendered control type for this Variable.

type

{string}

dataType

dataType: string

The data type represented by this Variable.

type

{string}

initialValue

initialValue: any

The defalut value for this Variable.

type

{any}

key

key: string

The unique key for this Variable.

type

{string}

Optional limitedToValues

limitedToValues: string[]

The array of allowed values for this Variable.

override
type

{string[]}

title

title: string

The title for this Variable.

type

{string}

Accessors

callbacks

constraintType

  • get constraintType(): string

selectedValue

  • get selectedValue(): any
  • set selectedValue(value: any): void

Methods

addAndExecuteCallback

addCallback

clone

executeCallbacks

  • executeCallbacks(): void

formatValue

  • formatValue(value: any): any
  • Subclass should override this method and return a properly formatted value. For example, a ColorVariable may choose to return an rgba string when provided an RgbaColor object.

    Parameters

    • value: any

      The value that should be formatted.

    Returns any

    Return either the original or formatted value.

restore

  • restore(): void

save

  • save(): void

serialize

Static deserialize

Generated using TypeDoc