Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StructuralChildListProperty<T>

Property instance that wraps a list of structural units. Structural child values are updated through AbstractModel._addUnitToStructuralParent.

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 StructuralChildListProperty<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(): never
  • assertReadable(): void
  • assertWritable(): void
  • deepCopyInto(): void
  • detachChild(child: T): void
  • Parameters

    • child: T

    Returns void

  • dispose(): void
  • initialize(values: T[]): { disposer: Lambda; observableValue: IObservableArray<T> }
  • internal

    Parameters

    • values: T[]

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

    • disposer: Lambda
    • observableValue: IObservableArray<T>
  • processChildAddition(index: number): void
  • Parameters

    • index: number

    Returns void

  • processChildRemoval(unit: T): void
  • Parameters

    • unit: T

    Returns void

  • removeChild(child: T): boolean
  • Parameters

    • child: T

    Returns boolean

  • reportAvailabilityIssues(): void
  • shouldHandleChange(): boolean
  • updateWithRawValue(value: any): void

Generated using TypeDoc