Interface ModelRelation<R, M, I>

Type Parameters

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

Hierarchy

Fastener<R, M | null, I>
Consumable
- ModelRelation

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

version: number

Accessors

affinity

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

binds

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

coherent

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

consumed

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

consuming

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

derived

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

descriptorType

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

fastenerType

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

inheritName

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

inherits

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

inletKeys

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

modelType

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

mounted

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

observes

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

parent

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

parentModel

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

parentType

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

Methods

attachFastener

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

`Protected` attachInlets

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

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

consume

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

createModel

createModel(): M
Returns M
- 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 Fastener.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 Fastener.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

`Protected` deinitModel

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

`Protected` detachInlets

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

detectModel

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

`Protected` didAttachModel

didAttachModel(model, target): void
Protected
Parameters
- model: M
- target: Model
Returns void
- 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 Fastener.didBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:751

`Protected` didConsume

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

`Protected` didDetachModel

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

`Protected` didMount

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

`Protected` didStartConsuming

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

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
- 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 Fastener.didUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:760

`Protected` didUnconsume

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

`Protected` didUnmount

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

get

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

hasAffinity

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

`Protected` incrementVersion

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

`Protected` init

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

`Protected` initModel

initModel(model): void
Protected
Parameters
- model: M
Returns void
- 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
- Defined in swim-ui/swim-model/lib/main/ModelRelation.d.ts:61

`Protected` onAttachModel

onAttachModel(model, target): void
Protected
Parameters
- model: M
- target: Model
Returns void
- 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 Fastener.onBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:749

`Protected` onConsume

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

`Protected` onDetachModel

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

`Protected` onMount

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

`Protected` onStartConsuming

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

`Protected` onStopConsuming

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

`Protected` onUnbindInlet

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

`Protected` onUnconsume

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

`Protected` onUnmount

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

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from Fastener.recohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:796

requireRecohere

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

requireUpdate

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

setAffinity

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

toString

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

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Overrides Consumable.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
- 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 Fastener.willBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:747

`Protected` willConsume

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

`Protected` willDetachModel

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

`Protected` willMount

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

`Protected` willStartConsuming

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

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
- 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 Fastener.willUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:756

`Protected` willUnconsume

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

`Protected` willUnmount

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

Interface ModelRelation<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 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<ModelRelationDescriptor<R, M>>

fastenerType

Returns Proto<ModelRelation<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

modelType

Returns ModelFactory<M>

mounted

Returns boolean

observes

Returns boolean

parent

Returns ModelRelation<any, M, any>

parentModel

Returns Model

parentType

Returns Proto<any>

Methods

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

bindInlet

Type Parameters

K extends string | number | symbol

IK

Parameters

inlet: Fastener<any, IK, any>

key: IK

Returns void

Type Parameters

I0 extends any

Parameters

inlet: Fastener<any, I0, any>

Returns void

consume

Parameters

consumer: unknown

Returns void

createModel

Returns M

decohere

Parameters

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Protected` attachInlets

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

`Protected` deinitModel

`Protected` detachInlets

`Protected` didAttachModel

`Protected` didBindInlet

`Protected` didConsume

`Protected` didDetachModel

`Protected` didMount

`Protected` didSetAffinity

`Protected` didSetInherits

`Protected` didStartConsuming

`Protected` didStopConsuming

`Protected` didUnbindInlet

`Protected` didUnconsume

`Protected` didUnmount

`Protected` fromLike