Interface TraitModelRef<R, T, M, I>

Type Parameters

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

Hierarchy

ModelRef<R, M, I>
- TraitModelRef

Index

Properties

coherentTime inlet inletVersion model name owner trait version

Methods

attachFastener attachInlets attachModel attachTrait bindInlet consume createModel createTrait decohere decohereFastener deinitModel deinitTrait deleteModel deleteTrait detachInlets detachModel detachTrait detectModel detectModelTrait didAttachModel didAttachTrait didBindInlet didConsume didDetachModel didDetachTrait didMount didSetAffinity didSetInherits didStartConsuming didStopConsuming didUnbindInlet didUnconsume didUnmount fromLike fromTraitLike get getFastener getInletModel getModel getParentFastener getTrait getTransition? hasAffinity incrementVersion init initModel initTrait insertChild insertModel insertModelTrait insertTrait onAttachModel onAttachTrait onBindInlet onConsume onDetachModel onDetachTrait onMount onSetAffinity onSetInherits onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount recohere removeModel removeTrait requireRecohere requireUpdate resolveInlets set setAffinity setCoherent setCoherentTime setInherits setIntrinsic setModel setTrait toString unbindInlet unconsume willAttachModel willAttachTrait willBindInlet willConsume willDetachModel willDetachTrait willMount willSetAffinity willSetInherits 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` model

model: M

`Readonly` name

name: PropertyKey

`Readonly` owner

owner: R

`Readonly` trait

trait: T

`Readonly` version

version: number

Accessors

affinity

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

binds

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

coherent

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

consumed

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

consuming

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

derived

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

descriptorType

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

fastenerType

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

inheritName

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

inherits

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

inletKeys

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

inletModel

get inletModel(): M
Returns M
Inherited from ModelRef.inletModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:27

modelKey

get modelKey(): string
Returns string
Inherited from ModelRef.modelKey
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:32

modelType

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

mounted

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

observes

get observes(): boolean
Returns boolean
Inherited from ModelRef.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/TraitModelRef.d.ts:24

parent

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

parentModel

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

parentType

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

traitKey

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

traitType

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

Methods

attachFastener

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

`Protected` attachInlets

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

attachTrait

attachTrait(trait?, targetTrait?): T
Parameters
- Optional trait: T | LikeType<T>
- Optional targetTrait: Trait
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:32

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 ModelRef.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 ModelRef.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

consume

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

createModel

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

createTrait

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

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRef.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 ModelRef.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 ModelRef.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/TraitModelRef.d.ts:43

deleteModel

deleteModel(): M
Returns M
Inherited from ModelRef.deleteModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:40

deleteTrait

deleteTrait(): T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:52

`Protected` detachInlets

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

detachModel

detachModel(): M
Returns M
Inherited from ModelRef.detachModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:37

detachTrait

detachTrait(): T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:41

detectModel

detectModel(model): M
Parameters
- model: Model
Returns M
Inherited from ModelRef.detectModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:46

`Protected` detectModelTrait

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

`Protected` didAttachModel

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

`Protected` didAttachTrait

didAttachTrait(trait, targetTrait): void
Protected
Parameters
- trait: T
- targetTrait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:40

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRef.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 ModelRef.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 ModelRef.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/TraitModelRef.d.ts:49

`Protected` didMount

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

`Protected` didStartConsuming

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

`Protected` didStopConsuming

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

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ModelRef.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 ModelRef.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/TraitModelRef.d.ts:55

get

get(): M
Returns M
Inherited from ModelRef.get
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:29

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 ModelRef.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getInletModel

getInletModel(): M
Returns M
Inherited from ModelRef.getInletModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:28

getModel

getModel(): M
Returns M
Inherited from ModelRef.getModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:34

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 ModelRef.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:807

getTrait

getTrait(): T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:30

`Optional` getTransition

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

hasAffinity

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

`Protected` incrementVersion

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

`Protected` init

init(): void
Protected
Returns void
Inherited from ModelRef.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 ModelRef.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/TraitModelRef.d.ts:34

`Protected` insertChild

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

`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/TraitModelRef.d.ts:59

insertTrait

insertTrait(model?, trait?, targetTrait?, modelKey?): T
Parameters
- Optional model: M
- Optional trait: T | LikeType<T>
- Optional targetTrait: Trait
- Optional modelKey: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:50

`Protected` onAttachModel

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

`Protected` onAttachTrait

onAttachTrait(trait, targetTrait): void
Protected
Parameters
- trait: T
- targetTrait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:38

`Protected` onBindInlet

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

`Protected` onDetachTrait

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

`Protected` onMount

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

`Protected` onStartConsuming

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

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Inherited from ModelRef.onStopConsuming
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:50

`Protected` onUnbindInlet

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

`Protected` onUnmount

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

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from ModelRef.recohere
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:52

removeModel

removeModel(): M
Returns M
Inherited from ModelRef.removeModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:39

removeTrait

removeTrait(): T
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:51

requireRecohere

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

requireUpdate

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

set

set(traitOrModel): R
Parameters
- traitOrModel: T | M | Fastener<any, I[0], any> | LikeType<M>
Returns R
Overrides ModelRef.set
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:26

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ModelRef.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 ModelRef.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 ModelRef.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 ModelRef.setInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:767

setIntrinsic

setIntrinsic(traitOrModel): R
Parameters
- traitOrModel: T | M | Fastener<any, I[0], any> | LikeType<M>
Returns R
Overrides ModelRef.setIntrinsic
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:28

setModel

setModel(model, target?, key?): M
Parameters
- model: M | LikeType<M>
- Optional target: Model
- Optional key: string
Returns M
Inherited from ModelRef.setModel
- Defined in swim-ui/swim-model/lib/main/ModelRef.d.ts:35

setTrait

setTrait(trait, targetTrait?, modelKey?): T
Parameters
- trait: T | LikeType<T>
- Optional targetTrait: Trait
- Optional modelKey: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:31

toString

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

unconsume

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

`Protected` willAttachModel

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

`Protected` willAttachTrait

willAttachTrait(trait, targetTrait): void
Protected
Parameters
- trait: T
- targetTrait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitModelRef.d.ts:36

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ModelRef.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 ModelRef.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 ModelRef.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/TraitModelRef.d.ts:45

`Protected` willMount

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

`Protected` willStartConsuming

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

`Protected` willStopConsuming

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

`Protected` willUnmount

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

Interface TraitModelRef<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 model

Readonly name

Readonly owner

Readonly trait

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

consumed

Returns boolean

consuming

Returns boolean

derived

Returns boolean

descriptorType

Returns Proto<TraitModelRefDescriptor<R, T, M>>

fastenerType

Returns Proto<ModelRef<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

inletModel

Returns M

modelKey

Returns string

modelType

Returns ModelFactory<M>

mounted

Returns boolean

observes

Returns boolean

observesTrait

Returns boolean

parent

Returns ModelRef<any, M, any>

parentModel

Returns Model

parentType

Returns Proto<any>

traitKey

Returns string

traitType

Returns TraitFactory<T>

Methods

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

attachModel

Parameters

Optional model: M | LikeType<M>

Optional target: Model

Returns M

attachTrait

Parameters

Optional trait: T | LikeType<T>

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` model

`Readonly` name

`Readonly` owner

`Readonly` trait

`Readonly` version

`Protected` attachInlets

`Optional` model: M | LikeType<M>

`Optional` target: Model

`Optional` trait: T | LikeType<T>

`Optional` targetTrait: Trait

`Optional` trait: T

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

`Protected` deinitModel

`Protected` deinitTrait

`Protected` detachInlets

`Protected` detectModelTrait

`Protected` didAttachModel

`Protected` didAttachTrait

`Protected` didBindInlet