Options
All
  • Public
  • Public/Protected
  • All
Menu

Primitive-typed property values list.

Type parameters

  • T

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

    • T

    Parameters

    Returns PrimitiveListProperty<T>

Properties

_skipOnChange: boolean = false
internal
declaredOn: IStructureClass
disposer: undefined | (() => void)
isAvailable: boolean = false
isPublic: boolean = false
isRequired: boolean = false
name: string
observableValue: IList<T>

Accessors

  • get versionInfo(): PropertyVersionInfo
  • Returns PropertyVersionInfo

Methods

  • _toJSON(): any[]
  • assertReadable(): void
  • assertWritable(): void
  • dispose(): void
  • initialize(initialItems: T[], primitiveType: PrimitiveTypeEnum): { observableValue: IObservableArray<T> }
  • Initialize should return something that is observable. The property will observe this internal structure and make sure changes are pushed to the server whenever needed, in its onChange event.

    Parameters

    • initialItems: T[]
    • primitiveType: PrimitiveTypeEnum

    Returns { observableValue: IObservableArray<T> }

    • observableValue: IObservableArray<T>
  • reportAvailabilityIssues(): void
  • shouldHandleChange(): boolean
  • toRawChangeValue(value: T): any
  • internal

    Parameters

    • value: T

    Returns any

  • updateWithRawValue(value: T[]): void

Generated using TypeDoc