Interface TraitSet<R, T, I>

Type Parameters

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

Hierarchy

TraitRelation<R, T, I>
- TraitSet

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

name: PropertyKey

`Readonly` owner

owner: R

`Readonly` traitCount

traitCount: number

`Readonly` version

version: number

Accessors

affinity

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

binds

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

coherent

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

consumed

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

consuming

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

derived

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

descriptorType

get descriptorType(): Proto<TraitSetDescriptor<R, T>>
Returns Proto<TraitSetDescriptor<R, T>>
Overrides TraitRelation.descriptorType
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:31

fastenerType

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

inheritName

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

inherits

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

inletKeys

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

mounted

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

observes

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

ordered

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

parent

get parent(): TraitSet<any, T, any>
Returns TraitSet<any, T, any>
Overrides TraitRelation.parent
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:35

parentModel

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

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from TraitRelation.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/TraitSet.d.ts:98

traitType

get traitType(): TraitFactory<T>
Returns TraitFactory<T>
Inherited from TraitRelation.traitType
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:32

Methods

addTrait

addTrait(trait?, target?, key?): T
Parameters
- Optional trait: T | LikeType<T>
- Optional target: Trait
- Optional key: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:46

addTraits

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

attachFastener

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

`Protected` attachInlets

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

attachTrait

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

attachTraits

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

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

`Protected` compare

compare(a, b): number
Protected
Parameters
- a: T
- b: T
Returns number
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:115

consume

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

consumeTraits

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

createTrait

createTrait(): T
Returns T
Inherited from TraitRelation.createTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:73

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from TraitRelation.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 TraitRelation.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

`Protected` deinitTrait

deinitTrait(trait): void
Protected
Parameters
- trait: T
Returns void
Inherited from TraitRelation.deinitTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:53

deleteTrait

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

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/TraitSet.d.ts:70

`Protected` detachInlets

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

detachTrait

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

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/TraitSet.d.ts:58

detectModel

detectModel(model): T
Parameters
- model: Model
Returns T
Overrides TraitRelation.detectModel
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:79

detectTrait

detectTrait(trait): T
Parameters
- trait: Trait
Returns T
Overrides TraitRelation.detectTrait
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:85

`Protected` didAttachTrait

didAttachTrait(trait, target): void
Protected
Parameters
- trait: T
- target: Trait
Returns void
Inherited from TraitRelation.didAttachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:51

`Protected` didBindInlet

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

`Protected` didDetachTrait

didDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
Inherited from TraitRelation.didDetachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:59

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from TraitRelation.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 TraitRelation.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 TraitRelation.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/TraitSet.d.ts:105

`Protected` didStartConsuming

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

`Protected` didStopConsuming

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

`Protected` didUnbindInlet

didUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from TraitRelation.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 TraitRelation.didUnconsume
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:93

`Protected` didUnmount

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

`Protected` fromLike

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

get

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

hasAffinity

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

hasTrait

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

`Protected` incrementVersion

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

`Protected` init

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

`Protected` initTrait

initTrait(trait): void
Protected
Parameters
- trait: T
Returns void
Inherited from TraitRelation.initTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:45

`Protected` insertChild

insertChild(model, trait, target, key): void
Protected
Parameters
- model: Model
- trait: T
- target: Trait
- key: string
Returns void
Inherited from TraitRelation.insertChild
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:62

insertTrait

insertTrait(model?, trait?, target?, key?): T
Parameters
- Optional model: Model
- Optional trait: T | LikeType<T>
- Optional target: Trait
- Optional key: string
Returns T
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:61

insertTraits

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

`Protected` onAttachTrait

onAttachTrait(trait, target): void
Protected
Parameters
- trait: T
- target: Trait
Returns void
Inherited from TraitRelation.onAttachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:49

`Protected` onBindInlet

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

`Protected` onDetachTrait

onDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
Inherited from TraitRelation.onDetachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:57

`Protected` onMount

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

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from TraitRelation.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 TraitRelation.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/TraitSet.d.ts:103

`Protected` onStartConsuming

onStartConsuming(): void
Protected
Returns void
Overrides TraitRelation.onStartConsuming
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:89

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Overrides TraitRelation.onStopConsuming
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:91

`Protected` onUnbindInlet

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

`Protected` onUnmount

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

order

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

recohere

recohere(t): void
Parameters
- t: number
Returns void
Overrides TraitRelation.recohere
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:93

reinsertTrait

reinsertTrait(trait, target?): void
Parameters
- trait: T
- Optional target: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:73

removeTrait

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

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/TraitSet.d.ts:66

requireRecohere

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

requireUpdate

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

setAffinity

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

setTraits

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

sort

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

toString

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

`Protected` traitKey

traitKey(trait): string
Protected
Parameters
- trait: T
Returns string
- Defined in swim-ui/swim-model/lib/main/TraitSet.d.ts:95

unbindInlet

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

unconsume

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

unconsumeTraits

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

`Protected` willAttachTrait

willAttachTrait(trait, target): void
Protected
Parameters
- trait: T
- target: Trait
Returns void
Inherited from TraitRelation.willAttachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:47

`Protected` willBindInlet

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

`Protected` willDetachTrait

willDetachTrait(trait): void
Protected
Parameters
- trait: T
Returns void
Inherited from TraitRelation.willDetachTrait
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:55

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from TraitRelation.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 TraitRelation.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 TraitRelation.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/TraitSet.d.ts:101

`Protected` willStartConsuming

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

`Protected` willStopConsuming

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

`Protected` willUnbindInlet

willUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from TraitRelation.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 TraitRelation.willUnconsume
- Defined in swim-ui/swim-model/lib/main/TraitRelation.d.ts:89

`Protected` willUnmount

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

Interface TraitSet<R, T, I>

Type Parameters

R = any

T extends Trait = Trait

I extends any[] = [T | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly inlet

Readonly inletVersion

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<TraitSetDescriptor<R, T>>

fastenerType

Returns Proto<TraitSet<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

ordered

Returns boolean

parent

Returns TraitSet<any, T, any>

parentModel

Returns Model

parentType

Returns Proto<any>

sorted

Returns boolean

traitType

Returns TraitFactory<T>

Methods

addTrait

Parameters

Optional trait: T | LikeType<T>

Optional target: Trait

Optional key: string

Returns T

addTraits

Parameters

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

[traitId: string]: T | undefined

Optional target: Trait

Returns void

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

attachTrait

Parameters

Optional trait: T | LikeType<T>

Optional target: Trait

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` traitCount

`Readonly` version

`Optional` trait: T | LikeType<T>

`Optional` target: Trait

`Optional` key: string

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

`Optional` target: Trait

`Protected` attachInlets

`Optional` trait: T | LikeType<T>

`Optional` target: Trait

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

`Optional` target: Trait

`Protected` compare

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

`Protected` deinitTrait

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

`Protected` detachInlets

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