Class StructuralChildListProperty<T>

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

Type parameters

T: IStructuralUnit | IModelUnit

Hierarchy

AbstractProperty<T[], IObservableArray<T>>
- StructuralChildListProperty

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StructuralChildListProperty(declaredOn: any, parent: StructuralUnit, name: string, value: T[], targetRefType?: string): StructuralChildListProperty

Overwrites AbstractProperty.constructor

Parameters
- declaredOn: any
- parent: StructuralUnit
- name: string
- value: T[]
- Optional targetRefType: string
Returns StructuralChildListProperty

Properties

declaredOn

declaredOn: any

handle

handle: function

Type declaration

- (): void
- Returns void

isAvailable

isAvailable: boolean

Returns true if this property is not deleted, and already availabe in the current model version

isPublic

isPublic: boolean

isRequired

isRequired: boolean

name

name: string

observableValue

observableValue: IObservableArray<T>

parent

parent: Structure

versionInfo

versionInfo: PropertyVersionInfo

Methods

assertPropertyAvailableInCurrentVersion

assertPropertyAvailableInCurrentVersion(): void

Inherited from AbstractProperty.assertPropertyAvailableInCurrentVersion

Returns void

assertReadable

assertReadable(): void

Inherited from AbstractProperty.assertReadable

Returns void

assertWritable

assertWritable(): void

Inherited from AbstractProperty.assertWritable

Returns void

deepCopyInto

deepCopyInto(clone: any): void

Overwrites AbstractProperty.deepCopyInto

Parameters
- clone: any
Returns void

dispose

dispose(): void

Overwrites AbstractProperty.dispose

Returns void

fireOnChange

fireOnChange(): void

Inherited from AbstractProperty.fireOnChange

Returns void

get

get(): IList<T>

Overwrites AbstractProperty.get

Returns IList<T>

initialize

initialize(values: any): any

Overwrites AbstractProperty.initialize

Parameters
- values: any
Returns any

onChange

onChange(...args: any[]): void

Inherited from AbstractProperty.onChange

Parameters
- Rest ...args: any[]
Returns void

resolveReferences

resolveReferences(): void

Inherited from AbstractProperty.resolveReferences

Returns void

set

set(value: T[]): void

Overwrites AbstractProperty.set

Parameters
- value: T[]
Returns void

updateWithRawValue

updateWithRawValue(value: any): void

Overwrites AbstractProperty.updateWithRawValue

Parameters
- value: any
Returns void

Generated using TypeDoc