Interface ViewRelation<R, V, I>

Type Parameters

R = any
V extends View = View
I extends any[] = [V | null]

Hierarchy

Fastener<R, V | null, I>
- ViewRelation

Index

Properties

coherentTime inlet inletVersion name owner version

Accessors

affinity binds coherent derived descriptorType fastenerType inheritName inherits inletKeys mounted observes parent parentType parentView viewType

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

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<ViewRelationDescriptor<R, V>>
Returns Proto<ViewRelationDescriptor<R, V>>
Overrides Fastener.descriptorType
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:18

fastenerType

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

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

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-view/lib/main/ViewRelation.d.ts:22

parent

get parent(): ViewRelation<any, V, any>
Returns ViewRelation<any, V, any>
Overrides Fastener.parent
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:24

parentType

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

parentView

get parentView(): View
Returns View
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:49

viewType

get viewType(): ViewFactory<V>
Returns ViewFactory<V>
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:21

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

createView

createView(): V
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:57

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

deinitView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:42

`Protected` detachInlets

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

detectView

detectView(view): V
Parameters
- view: View
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:56

`Protected` didAttachView

didAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:40

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

didDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:48

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

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

fromLike

fromLike(value): V
Parameters
- value: V | LikeType<V>
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:58

get

get(): V
Returns V
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` initView

initView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:34

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: View
- child: V
- target: View
- key: string
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:51

`Protected` onAttachView

onAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:38

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

onDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:46

`Protected` onMount

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

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

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

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

`Protected` willAttachView

willAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:36

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

willDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:44

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

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

Interface ViewRelation<R, V, I>

Type Parameters

R = any

V extends View = View

I extends any[] = [V | 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

derived

Returns boolean

descriptorType

Returns Proto<ViewRelationDescriptor<R, V>>

fastenerType

Returns Proto<ViewRelation<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

parent

Returns ViewRelation<any, V, any>

parentType

Returns Proto<any>

parentView

Returns View

viewType

Returns ViewFactory<V>

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

createView

Returns V

decohere

Parameters

Optional inlet: Fastener<any, any, any>

Returns void

decohereFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected deinitView

Parameters

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Protected` attachInlets

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

`Protected` deinitView

`Protected` detachInlets

`Protected` didAttachView

`Protected` didBindInlet

`Protected` didDetachView

`Protected` didMount

`Protected` didSetAffinity

`Protected` didSetInherits

`Protected` didUnbindInlet

`Protected` didUnmount

`Optional` fastenerType: Proto<F>

`Optional` contextType: Proto<any>

`Optional` fastenerType: Proto<F>

`Optional` contextType: Proto<any>

`Optional` getTransition

`Protected` incrementVersion