Options
All
  • Public
  • Public/Protected
  • All
Menu

Property value that references a (model) element by name.

Type parameters

Hierarchy

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

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

Properties

_skipOnChange: boolean = false
internal
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

  • _toJSON(): null | string
  • assertReadable(): void
  • assertWritable(): void
  • dispose(): void
  • get(): null | T
  • initialize(value: T, _targetType: string): { observableValue: IObservableValue<null | string> }
  • internal

    Parameters

    • value: T
    • _targetType: string

    Returns { observableValue: IObservableValue<null | string> }

    • observableValue: IObservableValue<null | string>
  • qualifiedName(): null | string
  • Returns null | string

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

    • newValue: null | T

    Returns void

  • shouldHandleChange(): boolean
  • updateQualifiedNameForRename(value: string): void
  • This method is used to update the qualified name as part of a rename. _skipOnChange is used to prevent sending deltas for this change, as the Model Server handles this itself.

    internal

    Parameters

    • value: string

    Returns void

  • updateWithRawValue(value: string): void

Generated using TypeDoc