Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocalByNameReferenceProperty<T>

Property value that references a (model) element by a simple name, within the same model unit.

Type parameters

Hierarchy

  • AbstractProperty<T | null, IObservableValue<string | null>>
    • LocalByNameReferenceProperty

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

Properties

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

Accessors

  • get targetType(): string
  • Returns string

  • get versionInfo(): PropertyVersionInfo
  • Returns PropertyVersionInfo

Methods

  • dispose(): void
  • get(): null | T
  • localName(): null | string
  • Returns null | string

  • reportAvailabilityIssues(): void
  • set(newValue: null | T): void
  • Parameters

    • newValue: null | T

    Returns void

  • updateWithRawValue(value: string): void

Generated using TypeDoc