Interface TraitModelSet<R, T, M, I>

Type Parameters

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

Hierarchy

ModelSet<R, M, I>
- TraitModelSet

Index

Properties

coherentTime inlet inletVersion modelCount name owner traitCount version

Methods

addModel addModels addTrait addTraits attachFastener attachInlets attachModel attachModels attachTrait attachTraits bindInlet compare compareTraits consume consumeModels consumeTraits createModel createTrait decohere decohereFastener deinitModel deinitTrait deleteModel deleteModels deleteTrait deleteTraits detachInlets detachModel detachModels detachTrait detachTraits detectModel detectModelTrait didAttachModel didAttachTrait didBindInlet didConsume didDetachModel didDetachTrait didMount didSetAffinity didSetInherits didSort didStartConsuming didStopConsuming didUnbindInlet didUnconsume didUnmount fromLike fromTraitLike get getFastener getParentFastener getTransition? hasAffinity hasModel hasTrait incrementVersion init initModel initTrait insertChild insertModel insertModelTrait insertModels insertTrait insertTraits modelKey onAttachModel onAttachTrait onBindInlet onConsume onDetachModel onDetachTrait onMount onSetAffinity onSetInherits onSort onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount order recohere reinsertModel reinsertTrait removeModel removeModels removeTrait removeTraits requireRecohere requireUpdate resolveInlets setAffinity setCoherent setCoherentTime setInherits setModels setTraits sort toString unbindInlet unconsume unconsumeModels unconsumeTraits willAttachModel willAttachTrait willBindInlet willConsume willDetachModel willDetachTrait willMount willSetAffinity willSetInherits willSort willStartConsuming willStopConsuming willUnbindInlet willUnconsume willUnmount

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` traitCount

traitCount: number

`Readonly` version

version: number

Accessors

affinity

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

binds

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

coherent

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

consumed

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

consuming

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

derived

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

descriptorType

get descriptorType(): Proto<TraitModelSetDescriptor<R, T, M>>
Returns Proto<TraitModelSetDescriptor<R, T, M>>
Overrides ModelSet.descriptorType
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:21

fastenerType

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

inheritName

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

inherits

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

inletKeys

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

modelType

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

mounted

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

observes

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

observesTrait

get observesTrait(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:24

ordered

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

parent

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

parentModel

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

parentType

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

sorted

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

traitKey

get traitKey(): string
Returns string
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:23

traitType

get traitType(): TraitFactory<T>
Returns TraitFactory<T>
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:22

Methods

addModel

addModel(model?, target?, key?): M
Parameters
- Optional model: M | LikeType<M>
- Optional target: Model
- Optional key: string
Returns M
Inherited from ModelSet.addModel
- 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
Inherited from ModelSet.addModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:48

addTrait

addTrait(trait?, targetModel?, modelKey?): T
Parameters
- Optional trait: T | LikeType<T>
- Optional targetModel: Model
- Optional modelKey: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:31

addTraits

addTraits(traits, targetModel?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:32

attachFastener

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

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from ModelSet.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
Inherited from ModelSet.attachModel
- 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
Inherited from ModelSet.attachModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:55

attachTrait

attachTrait(trait?, targetModel?): T
Parameters
- Optional trait: T | LikeType<T>
- Optional targetModel: Model
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:38

attachTraits

attachTraits(traits, targetModel?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:47

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 ModelSet.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 ModelSet.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
Overrides ModelSet.compare
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:93

`Protected` compareTraits

compareTraits(a, b): number
Protected
Parameters
- a: T
- b: T
Returns number
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:95

consume

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

consumeModels

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

consumeTraits

consumeTraits(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:75

createModel

createModel(trait?): M
Parameters
- Optional trait: T
Returns M
Overrides ModelSet.createModel
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:91

createTrait

createTrait(): T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:77

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.deinitModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:52

`Protected` deinitTrait

deinitTrait(trait): void
Protected
Parameters
- trait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:52

deleteModel

deleteModel(model): M
Parameters
- model: M
Returns M
Inherited from ModelSet.deleteModel
- 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
Inherited from ModelSet.deleteModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:71

deleteTrait

deleteTrait(trait): T
Parameters
- trait: T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:70

deleteTraits

deleteTraits(traits?): void
Parameters
- Optional traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:71

`Protected` detachInlets

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

detachModel

detachModel(model): M
Parameters
- model: M
Returns M
Inherited from ModelSet.detachModel
- 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
Inherited from ModelSet.detachModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:59

detachTrait

detachTrait(trait): T
Parameters
- trait: T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:50

detachTraits

detachTraits(traits?): void
Parameters
- Optional traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:59

detectModel

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

`Protected` detectModelTrait

detectModelTrait(model): T
Protected
Parameters
- model: Model
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:81

`Protected` didAttachModel

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

`Protected` didAttachTrait

didAttachTrait(trait, targetModel): void
Protected
Parameters
- trait: T
- targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:46

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.didDetachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:58

`Protected` didDetachTrait

didDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:58

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.didSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:773

`Protected` didSort

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

`Protected` didStartConsuming

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

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.didUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:87

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.fromLike
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:69

`Protected` fromTraitLike

fromTraitLike(value): T
Protected
Parameters
- value: T | LikeType<T>
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:79

get

get(): M
Returns M
Inherited from ModelSet.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 ModelSet.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 ModelSet.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 ModelSet.getTransition
- Defined in swim-core/swim-component/dist/swim-component.d.ts:815

hasAffinity

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

hasModel

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

hasTrait

hasTrait(trait): boolean
Parameters
- trait: Trait
Returns boolean
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:30

`Protected` incrementVersion

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

`Protected` init

init(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.initModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:44

`Protected` initTrait

initTrait(trait): void
Protected
Parameters
- trait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:40

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Model
- child: M
- target: Model
- key: string
Returns void
Inherited from ModelSet.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
Inherited from ModelSet.insertModel
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:62

`Protected` insertModelTrait

insertModelTrait(model, trait, targetTrait, traitKey): void
Protected
Parameters
- model: M
- trait: T
- targetTrait: Trait
- traitKey: string
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:83

insertModels

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

insertTrait

insertTrait(parent?, trait?, targetModel?, modelKey?): T
Parameters
- Optional parent: Model
- Optional trait: T | LikeType<T>
- Optional targetModel: Model
- Optional modelKey: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:62

insertTraits

insertTraits(parent, traits, targetModel?): void
Parameters
- parent: Model
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:63

`Protected` modelKey

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

`Protected` onAttachModel

onAttachModel(model, targetModel): void
Protected
Parameters
- model: M
- targetModel: Model
Returns void
Overrides ModelSet.onAttachModel
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:87

`Protected` onAttachTrait

onAttachTrait(trait, targetModel): void
Protected
Parameters
- trait: T
- targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:44

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelSet.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 ModelSet.onConsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:77

`Protected` onDetachModel

onDetachModel(model): void
Protected
Parameters
- model: M
Returns void
Overrides ModelSet.onDetachModel
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:89

`Protected` onDetachTrait

onDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:56

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.onSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:771

`Protected` onSort

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

`Protected` onStartConsuming

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

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.onUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:85

`Protected` onUnmount

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

order

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

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from ModelSet.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
Inherited from ModelSet.reinsertModel
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:74

reinsertTrait

reinsertTrait(trait, targetTrait?): void
Parameters
- trait: T
- Optional targetTrait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:74

removeModel

removeModel(model): M
Parameters
- model: M
Returns M
Inherited from ModelSet.removeModel
- 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
Inherited from ModelSet.removeModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:67

removeTrait

removeTrait(trait): T
Parameters
- trait: T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:66

removeTraits

removeTraits(traits?): void
Parameters
- Optional traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:67

requireRecohere

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

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from ModelSet.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 ModelSet.resolveInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:799

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.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 ModelSet.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
Inherited from ModelSet.setModels
- Defined in swim-ui/swim-model/lib/main/ModelSet.d.ts:51

setTraits

setTraits(traits, targetModel?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:35

sort

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

toString

toString(): string
Returns string
Inherited from ModelSet.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 ModelSet.unbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:754

unconsume

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

unconsumeModels

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

unconsumeTraits

unconsumeTraits(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:76

`Protected` willAttachModel

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

`Protected` willAttachTrait

willAttachTrait(trait, targetModel): void
Protected
Parameters
- trait: T
- targetModel: Model
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:42

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.willDetachModel
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:54

`Protected` willDetachTrait

willDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelSet.d.ts:54

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.willSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:769

`Protected` willSort

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

`Protected` willStartConsuming

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

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
Inherited from ModelSet.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 ModelSet.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 ModelSet.willUnconsume
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:83

`Protected` willUnmount

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

Interface TraitModelSet<R, T, M, I>

Type Parameters

R = any

T extends Trait = Trait

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 traitCount

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

consumed

Returns boolean

consuming

Returns boolean

derived

Returns boolean

descriptorType

Returns Proto<TraitModelSetDescriptor<R, T, 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

observesTrait

Returns boolean

ordered

Returns boolean

parent

Returns ModelSet<any, M, any>

parentModel

Returns Model

parentType

Returns Proto<any>

sorted

Returns boolean

traitKey

Returns string

traitType

Returns TraitFactory<T>

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

addTrait

Parameters

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` modelCount

`Readonly` name

`Readonly` owner

`Readonly` traitCount

`Readonly` version

`Optional` model: M | LikeType<M>

`Optional` target: Model

`Optional` key: string

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

`Optional` target: Model

`Optional` trait: T | LikeType<T>

`Optional` targetModel: Model

`Optional` modelKey: string

traits: {
[traitId: string]: T | undefined;
}

`Optional` targetModel: Model

`Protected` attachInlets

`Optional` model: M | LikeType<M>

`Optional` target: Model

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

`Optional` target: Model

`Optional` trait: T | LikeType<T>

`Optional` targetModel: Model

traits: {
[traitId: string]: T | undefined;
}

`Optional` targetModel: Model

`Protected` compare

`Protected` compareTraits