Interface ModelSet<R, M, I>

Type Parameters

R = any
M extends Model = Model
I extends any[] = [M | null]

Hierarchy

ModelRelation<R, M, I>
- ModelSet

Index

Properties

`Readonly` coherentTime

coherentTime: number

`Readonly` inlet

inlet: Fastener<any, any, any> | readonly Fastener<any, any, any>[]

`Readonly` inletVersion

inletVersion: number | readonly number[]

`Readonly` modelCount

modelCount: number

`Readonly` name

name: PropertyKey

`Readonly` owner

owner: R

`Readonly` version

version: number

Accessors

affinity

get affinity(): Affinity
Returns Affinity
Inherited from ModelRelation.affinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:777

binds

get binds(): boolean
Returns boolean
Inherited from ModelRelation.binds
- Defined in swim-core/swim-component/dist/swim-component.d.ts:723

coherent

get coherent(): boolean
Returns boolean
Inherited from ModelRelation.coherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:791

consumed

get consumed(): boolean
Returns boolean
Inherited from ModelRelation.consumed
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:30

consuming

get consuming(): boolean
Returns boolean
Inherited from ModelRelation.consuming
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:88

derived

get derived(): boolean
Returns boolean
Inherited from ModelRelation.derived
- Defined in swim-core/swim-component/dist/swim-component.d.ts:774

descriptorType

get descriptorType(): Proto<ModelSetDescriptor<R, M>>
Returns Proto<ModelSetDescriptor<R, M>>
Overrides ModelRelation.descriptorType
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:30

fastenerType

get fastenerType(): Proto<ModelSet<any, any, any>>
Returns Proto<ModelSet<any, any, any>>
Overrides ModelRelation.fastenerType
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:32

inheritName

get inheritName(): PropertyKey
Returns PropertyKey
Inherited from ModelRelation.inheritName
- Defined in swim-core/swim-component/dist/swim-component.d.ts:765

inherits

get inherits(): boolean
Returns boolean
Inherited from ModelRelation.inherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:766

inletKeys

get inletKeys(): readonly PropertyKey[]
Protected
Returns readonly PropertyKey[]
Inherited from ModelRelation.inletKeys
- Defined in swim-core/swim-component/dist/swim-component.d.ts:798

modelType

get modelType(): ModelFactory<M>
Returns ModelFactory<M>
Inherited from ModelRelation.modelType
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:31

mounted

get mounted(): boolean
Returns boolean
Inherited from ModelRelation.mounted
- Defined in swim-core/swim-component/dist/swim-component.d.ts:820

observes

get observes(): boolean
Returns boolean
Inherited from ModelRelation.observes
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:32

ordered

get ordered(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:89

parent

get parent(): ModelSet<any, M, any>
Returns ModelSet<any, M, any>
Overrides ModelRelation.parent
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:34

parentModel

get parentModel(): Model
Returns Model
Inherited from ModelRelation.parentModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:59

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from ModelRelation.parentType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:738

sorted

get sorted(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:91

Methods

addModel

addModel(model?, target?, key?): M
Parameters
- Optional model: M | LikeType<M>
- Optional target: Model
- Optional key: string
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:47

addModels

addModels(models, target?): void
Parameters
- models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
- Optional target: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:48

attachFastener

attachFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.attachFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:809

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from ModelRelation.attachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:801

attachModel

attachModel(model?, target?): M
Parameters
- Optional model: M | LikeType<M>
- Optional target: Model
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:54

attachModels

attachModels(models, target?): void
Parameters
- models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
- Optional target: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:55

bindInlet

bindInlet<K, IK>(inlet, key): void
Type Parameters
- K extends string | number | symbol
- IK
Parameters
- inlet: Fastener<any, IK, any>
- key: IK
Returns void
Inherited from ModelRelation.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:744
bindInlet<I0>(inlet): void
Type Parameters
- I0 extends any
Parameters
- inlet: Fastener<any, I0, any>
Returns void
Inherited from ModelRelation.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

`Protected` compare

compare(a, b): number
Protected
Parameters
- a: M
- b: M
Returns number
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:108

consume

consume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.consume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:73

consumeModels

consumeModels(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:81

createModel

createModel(): M
Returns M
Inherited from ModelRelation.createModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:67

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.decohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:794

decohereFastener

decohereFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

`Protected` deinitModel

deinitModel(model): void
Protected
Parameters
- model: M
Returns void
Inherited from ModelRelation.deinitModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:52

deleteModel

deleteModel(model): M
Parameters
- model: M
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:70

deleteModels

deleteModels(models?): void
Parameters
- Optional models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:71

`Protected` detachInlets

detachInlets(): void
Protected
Returns void
Inherited from ModelRelation.detachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:803

detachModel

detachModel(model): M
Parameters
- model: M
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:58

detachModels

detachModels(models?): void
Parameters
- Optional models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:59

detectModel

detectModel(model): M
Parameters
- model: Model
Returns M
Overrides ModelRelation.detectModel
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:80

`Protected` didAttachModel

didAttachModel(model, target): void
Protected
Parameters
- model: M
- target: Model
Returns void
Inherited from ModelRelation.didAttachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:50

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.didBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:751

`Protected` didConsume

didConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.didConsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:79

`Protected` didDetachModel

didDetachModel(model): void
Protected
Parameters
- model: M
Returns void
Inherited from ModelRelation.didDetachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:58

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from ModelRelation.didMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:828

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ModelRelation.didSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:789

`Protected` didSetInherits

didSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ModelRelation.didSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:773

`Protected` didSort

didSort(parent): void
Protected
Parameters
- parent: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:98

`Protected` didStartConsuming

didStartConsuming(): void
Protected
Returns void
Inherited from ModelRelation.didStartConsuming
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:96

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
Inherited from ModelRelation.didStopConsuming
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:104

`Protected` didUnbindInlet

didUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.didUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:760

`Protected` didUnconsume

didUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.didUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:87

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ModelRelation.didUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:836

`Protected` fromLike

fromLike(value): M
Protected
Parameters
- value: M | LikeType<M>
Returns M
Inherited from ModelRelation.fromLike
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:69

get

get(): M
Returns M
Inherited from ModelRelation.get
- Defined in swim-core/swim-component/dist/swim-component.d.ts:790

getFastener

getFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ModelRelation.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getParentFastener

getParentFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: string
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ModelRelation.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:807

`Optional` getTransition

getTransition(fastener): Timing
Parameters
- fastener: Fastener<any, any, any>
Returns Timing
Inherited from ModelRelation.getTransition
- Defined in swim-core/swim-component/dist/swim-component.d.ts:815

hasAffinity

hasAffinity(affinity): boolean
Parameters
- affinity: Affinity
Returns boolean
Inherited from ModelRelation.hasAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:778

hasModel

hasModel(model): boolean
Parameters
- model: Model
Returns boolean
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:46

`Protected` incrementVersion

incrementVersion(): void
Protected
Returns void
Inherited from ModelRelation.incrementVersion
- Defined in swim-core/swim-component/dist/swim-component.d.ts:737

`Protected` init

init(): void
Protected
Returns void
Inherited from ModelRelation.init
- Defined in swim-core/swim-component/dist/swim-component.d.ts:725

`Protected` initModel

initModel(model): void
Protected
Parameters
- model: M
Returns void
Inherited from ModelRelation.initModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:44

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Model
- child: M
- target: Model
- key: string
Returns void
Inherited from ModelRelation.insertChild
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:61

insertModel

insertModel(parent?, model?, target?, key?): M
Parameters
- Optional parent: Model
- Optional model: M | LikeType<M>
- Optional target: Model
- Optional key: string
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:62

insertModels

insertModels(parent, models, target?): void
Parameters
- parent: Model
- models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
- Optional target: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:63

`Protected` modelKey

modelKey(model): string
Protected
Parameters
- model: M
Returns string
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:36

`Protected` onAttachModel

onAttachModel(model, target): void
Protected
Parameters
- model: M
- target: Model
Returns void
Inherited from ModelRelation.onAttachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:48

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.onBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:749

`Protected` onConsume

onConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.onConsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:77

`Protected` onDetachModel

onDetachModel(model): void
Protected
Parameters
- model: M
Returns void
Inherited from ModelRelation.onDetachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:56

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from ModelRelation.onMount
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:106

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ModelRelation.onSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:787

`Protected` onSetInherits

onSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ModelRelation.onSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:771

`Protected` onSort

onSort(parent): void
Protected
Parameters
- parent: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:96

`Protected` onStartConsuming

onStartConsuming(): void
Protected
Returns void
Overrides ModelRelation.onStartConsuming
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:84

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Overrides ModelRelation.onStopConsuming
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:86

`Protected` onUnbindInlet

onUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.onUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:758

`Protected` onUnconsume

onUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.onUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:85

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Inherited from ModelRelation.onUnmount
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:108

order

order(ordered?): ModelSet<R, M, I>
Parameters
- Optional ordered: boolean
Returns ModelSet<R, M, I>
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:90

recohere

recohere(t): void
Parameters
- t: number
Returns void
Overrides ModelRelation.recohere
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:88

reinsertModel

reinsertModel(model, target?): void
Parameters
- model: M
- Optional target: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:74

removeModel

removeModel(model): M
Parameters
- model: M
Returns M
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:66

removeModels

removeModels(models?): void
Parameters
- Optional models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:67

requireRecohere

requireRecohere(): void
Returns void
Inherited from ModelRelation.requireRecohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:795

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from ModelRelation.requireUpdate
- Defined in swim-core/swim-component/dist/swim-component.d.ts:813

resolveInlets

resolveInlets(): readonly Fastener<any, any, any>[]
Returns readonly Fastener<any, any, any>[]
Inherited from ModelRelation.resolveInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:799

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ModelRelation.setAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:783

`Protected` setCoherent

setCoherent(coherent): void
Protected
Parameters
- coherent: boolean
Returns void
Inherited from ModelRelation.setCoherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:793

`Protected` setCoherentTime

setCoherentTime(coherentTime): void
Protected
Parameters
- coherentTime: number
Returns void
Inherited from ModelRelation.setCoherentTime
- Defined in swim-core/swim-component/dist/swim-component.d.ts:734

setInherits

setInherits(inherits): void
Parameters
- inherits: boolean | PropertyKey
Returns void
Inherited from ModelRelation.setInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:767

setModels

setModels(models, target?): void
Parameters
- models: {
  [modelId: string]: M | undefined;
  }
  - [modelId: string]: M | undefined
- Optional target: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:51

sort

sort(sorted?): ModelSet<R, M, I>
Parameters
- Optional sorted: boolean
Returns ModelSet<R, M, I>
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:92

toString

toString(): string
Returns string
Inherited from ModelRelation.toString
- Defined in swim-core/swim-component/dist/swim-component.d.ts:838

unbindInlet

unbindInlet(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.unbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:754

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.unconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:81

unconsumeModels

unconsumeModels(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:82

`Protected` willAttachModel

willAttachModel(model, target): void
Protected
Parameters
- model: M
- target: Model
Returns void
Inherited from ModelRelation.willAttachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:46

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.willBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:747

`Protected` willConsume

willConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.willConsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:75

`Protected` willDetachModel

willDetachModel(model): void
Protected
Parameters
- model: M
Returns void
Inherited from ModelRelation.willDetachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:54

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from ModelRelation.willMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:824

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ModelRelation.willSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:785

`Protected` willSetInherits

willSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ModelRelation.willSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:769

`Protected` willSort

willSort(parent): void
Protected
Parameters
- parent: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:94

`Protected` willStartConsuming

willStartConsuming(): void
Protected
Returns void
Inherited from ModelRelation.willStartConsuming
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:92

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
Inherited from ModelRelation.willStopConsuming
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:100

`Protected` willUnbindInlet

willUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRelation.willUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:756

`Protected` willUnconsume

willUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ModelRelation.willUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:83

`Protected` willUnmount

willUnmount(): void
Protected
Returns void
Inherited from ModelRelation.willUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:832

Interface ModelSet<R, M, I>

Type Parameters

R = any

M extends Model = Model

I extends any[] = [M | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly inlet

Readonly inletVersion

Readonly modelCount

Readonly name

Readonly owner

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

consumed

Returns boolean

consuming

Returns boolean

derived

Returns boolean

descriptorType

Returns Proto<ModelSetDescriptor<R, M>>

fastenerType

Returns Proto<ModelSet<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

modelType

Returns ModelFactory<M>

mounted

Returns boolean

observes

Returns boolean

ordered

Returns boolean

parent

Returns ModelSet<any, M, any>

parentModel

Returns Model

parentType

Returns Proto<any>

sorted

Returns boolean

Methods

addModel

Parameters

Optional model: M | LikeType<M>

Optional target: Model

Optional key: string

Returns M

addModels

Parameters

models: { [modelId: string]: M | undefined; }

[modelId: string]: M | undefined

Optional target: Model

Returns void

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

attachModel

Parameters

Optional model: M | LikeType<M>

Optional target: Model

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` modelCount

`Readonly` name

`Readonly` owner

`Readonly` version

`Optional` model: M | LikeType<M>

`Optional` target: Model

`Optional` key: string

models: {
[modelId: string]: M | undefined;
}

`Optional` target: Model

`Protected` attachInlets

`Optional` model: M | LikeType<M>

`Optional` target: Model

models: {
[modelId: string]: M | undefined;
}

`Optional` target: Model

`Protected` compare

`Optional` inlet: Fastener<any, any, any>

`Protected` deinitModel

`Optional` models: {
[modelId: string]: M | undefined;
}

`Protected` detachInlets

`Optional` models: {
[modelId: string]: M | undefined;
}