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

Properties

Accessors

Methods

Constructors

constructor

  • 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

Protected _skipOnChange

_skipOnChange: boolean = false
internal

declaredOn

declaredOn: IStructureClass

disposer

disposer: undefined | (() => void)

Readonly isAvailable

isAvailable: boolean = false

Readonly isPublic

isPublic: boolean = false

Readonly isRequired

isRequired: boolean = false

name

name: string

observableValue

observableValue: IObservableValue<null | string>

parent

parent: AbstractElement<IAbstractModel, Container>

Accessors

targetType

  • get targetType(): string

  • Returns string

versionInfo

  • get versionInfo(): PropertyVersionInfo

  • Returns PropertyVersionInfo

Methods

_toJSON

  • _toJSON(): null | string

Protected assertReadable

  • assertReadable(): void

Protected assertWritable

  • assertWritable(): void

deepCopyInto

dispose

  • dispose(): void

get

  • get(): null | T

Protected initialize

  • initialize(value: T, _targetType: string): { observableValue: IObservableValue<null | string> }
  • internal

    Parameters

    • value: T
    • _targetType: string

    Returns { observableValue: IObservableValue<null | string> }

    • observableValue: IObservableValue<null | string>

localName

  • localName(): null | string

  • Returns null | string

reportAvailabilityIssues

  • reportAvailabilityIssues(): void

set

  • set(newValue: null | T): void

  • Parameters

    • newValue: null | T

    Returns void

Protected shouldHandleChange

  • shouldHandleChange(): boolean

updateWithRawValue

  • updateWithRawValue(value: string): void

Generated using TypeDoc