Options
All
  • Public
  • Public/Protected
  • All
Menu

A property value that is an enum literal.

Type parameters

Hierarchy

Index

Constructors

  • parent is the structure that the value of this property attaches to, so e.g. for all values item of Part(List)Property we (should) have the invariant: item.container === this.parent.

    initialValue is default value except parts and GUID-typed primitives. (by-id/name references do not have default values.)

    Type parameters

    Parameters

    Returns EnumProperty<T>

Properties

_skipOnChange: boolean = false
internal
declaredOn: IStructureClass
defaultValue: T
disposer: undefined | (() => void)
enumType: new (key: string, lifeCycle: ILifeCycle) => AbstractEnum

Type declaration

isAvailable: boolean = false
isPublic: boolean = false
isRequired: boolean = false
name: string
observableValue: IObservableValue<T>

Accessors

  • get versionInfo(): PropertyVersionInfo
  • Returns PropertyVersionInfo

Methods

  • _toJSON(): string
  • assertReadable(): void
  • assertWritable(): void
  • dispose(): void
  • get(): T
  • getRawValue(value: T): string
  • initialize(defaultValue: T, primitiveType: PrimitiveTypeEnum): { disposer: Lambda; observableValue: IObservableValue<T> }
  • internal

    Parameters

    • defaultValue: T
    • primitiveType: PrimitiveTypeEnum

    Returns { disposer: Lambda; observableValue: IObservableValue<T> }

    • disposer: Lambda
    • observableValue: IObservableValue<T>
  • markCurrentValueAsDefault(): void
  • onChange(change: IValueDidChange<T>): void
  • reportAvailabilityIssues(): void
  • set(value: T): void
  • shouldHandleChange(): boolean
  • updateWithRawValue(value: any): void

Generated using TypeDoc