Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ByNameReferenceListProperty<T>

Property value that references zero or more (model) elements by name.

The reference list is only used internally, and externally a view of the reference list that returns the real objects is exposed. So, the flow is either: [server] -> [internal ref list (observable)] -> [update view] or: [Sdk] -> [view] -- onchange ---> [internal ref list] --- onChange event ---> [send delta's]

For simplicity's sake, referencesByName should be considered immutable here (TODO: they should be in general?), so that their internal value doesn't need to be observed.

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 ByNameReferenceListProperty<T>

Properties

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

Accessors

  • get targetType(): string
  • Returns string

  • get versionInfo(): PropertyVersionInfo
  • Returns PropertyVersionInfo

Methods

  • dispose(): void
  • qualifiedNames(): string[]
  • Returns string[]

  • reportAvailabilityIssues(): void
  • updateWithRawValue(value: string[]): void

Generated using TypeDoc