Interface ViewSet<R, V, I>

Type Parameters

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

Hierarchy

ViewRelation<R, V, I>
- ViewSet

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

`Readonly` viewCount

viewCount: number

Accessors

affinity

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

binds

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

coherent

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

derived

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

descriptorType

get descriptorType(): Proto<ViewSetDescriptor<R, V>>
Returns Proto<ViewSetDescriptor<R, V>>
Overrides ViewRelation.descriptorType
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:29

fastenerType

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

inheritName

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

inherits

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

inletKeys

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

mounted

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

observes

get observes(): boolean
Returns boolean
Inherited from ViewRelation.observes
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:22

ordered

get ordered(): boolean
Returns boolean
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:82

parent

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

parentType

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

parentView

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

sorted

get sorted(): boolean
Returns boolean
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:84

viewType

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

Methods

addView

addView(view?, target?, key?): V
Parameters
- Optional view: V | LikeType<V>
- Optional target: View
- Optional key: string
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:46

addViews

addViews(views, target?): void
Parameters
- views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
- Optional target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:47

attachFastener

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

`Protected` attachInlets

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

attachView

attachView(view?, target?): V
Parameters
- Optional view: V | LikeType<V>
- Optional target: View
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:53

attachViews

attachViews(views, target?): void
Parameters
- views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
- Optional target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.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 ViewRelation.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 ViewRelation.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

`Protected` compare

compare(a, b): number
Protected
Parameters
- a: V
- b: V
Returns number
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:101

createView

createView(): V
Returns V
Inherited from ViewRelation.createView
- 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 ViewRelation.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 ViewRelation.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

`Protected` deinitView

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

deleteView

deleteView(view): V
Parameters
- view: V
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:69

deleteViews

deleteViews(views?): void
Parameters
- Optional views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:70

`Protected` detachInlets

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

detachView

detachView(view): V
Parameters
- view: V
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:57

detachViews

detachViews(views?): void
Parameters
- Optional views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:58

detectView

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

`Protected` didAttachView

didAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
Inherited from ViewRelation.didAttachView
- 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 ViewRelation.didBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:751

`Protected` didDetachView

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

`Protected` didMount

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

`Protected` didSort

didSort(parent): void
Protected
Parameters
- parent: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:91

`Protected` didUnbindInlet

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

`Protected` didUnmount

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

fromLike

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

get

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

hasAffinity

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

hasView

hasView(view): boolean
Parameters
- view: View
Returns boolean
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:45

`Protected` incrementVersion

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

`Protected` init

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

`Protected` initView

initView(view): void
Protected
Parameters
- view: V
Returns void
Inherited from ViewRelation.initView
- 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
Inherited from ViewRelation.insertChild
- Defined in swim-ui/swim-view/lib/main/ViewRelation.d.ts:51

insertView

insertView(parent?, view?, target?, key?): V
Parameters
- Optional parent: View
- Optional view: V | LikeType<V>
- Optional target: View
- Optional key: string
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:61

insertViews

insertViews(parent, views, target?): void
Parameters
- parent: View
- views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
- Optional target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:62

`Protected` onAttachView

onAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
Inherited from ViewRelation.onAttachView
- 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 ViewRelation.onBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:749

`Protected` onDetachView

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

`Protected` onMount

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

`Protected` onSort

onSort(parent): void
Protected
Parameters
- parent: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:89

`Protected` onUnbindInlet

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

`Protected` onUnmount

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

order

order(ordered?): ViewSet<R, V, I>
Parameters
- Optional ordered: boolean
Returns ViewSet<R, V, I>
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:83

recohere

recohere(t): void
Parameters
- t: number
Returns void
Overrides ViewRelation.recohere
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:81

reinsertView

reinsertView(view, target?): void
Parameters
- view: V
- Optional target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:73

removeView

removeView(view): V
Parameters
- view: V
Returns V
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:65

removeViews

removeViews(views?): void
Parameters
- Optional views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:66

requireRecohere

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

requireUpdate

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

setAffinity

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

setViews

setViews(views, target?): void
Parameters
- views: {
  [viewId: string]: V | undefined;
  }
  - [viewId: string]: V | undefined
- Optional target: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:50

sort

sort(sorted?): ViewSet<R, V, I>
Parameters
- Optional sorted: boolean
Returns ViewSet<R, V, I>
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:85

toString

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

`Protected` viewKey

viewKey(view): string
Protected
Parameters
- view: V
Returns string
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:35

`Protected` willAttachView

willAttachView(view, target): void
Protected
Parameters
- view: V
- target: View
Returns void
Inherited from ViewRelation.willAttachView
- 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 ViewRelation.willBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:747

`Protected` willDetachView

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

`Protected` willMount

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

`Protected` willSort

willSort(parent): void
Protected
Parameters
- parent: View
Returns void
- Defined in swim-ui/swim-view/lib/main/ViewSet.d.ts:87

`Protected` willUnbindInlet

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

`Protected` willUnmount

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

Interface ViewSet<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

Readonly viewCount

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

derived

Returns boolean

descriptorType

Returns Proto<ViewSetDescriptor<R, V>>

fastenerType

Returns Proto<ViewSet<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

ordered

Returns boolean

parent

Returns ViewSet<any, V, any>

parentType

Returns Proto<any>

parentView

Returns View

sorted

Returns boolean

viewType

Returns ViewFactory<V>

Methods

addView

Parameters

Optional view: V | LikeType<V>

Optional target: View

Optional key: string

Returns V

addViews

Parameters

views: { [viewId: string]: V | undefined; }

[viewId: string]: V | undefined

Optional target: View

Returns void

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

attachView

Parameters

Optional view: V | LikeType<V>

Optional target: View

Returns V

attachViews

Parameters

views: { [viewId: string]: V | undefined; }

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Readonly` viewCount

`Optional` view: V | LikeType<V>

`Optional` target: View

`Optional` key: string

views: {
[viewId: string]: V | undefined;
}

`Optional` target: View

`Protected` attachInlets

`Optional` view: V | LikeType<V>

`Optional` target: View

views: {
[viewId: string]: V | undefined;
}

`Optional` target: View

`Protected` compare

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

`Protected` deinitView

`Optional` views: {
[viewId: string]: V | undefined;
}

`Protected` detachInlets

`Optional` views: {
[viewId: string]: V | undefined;
}

`Protected` didAttachView

`Protected` didBindInlet

`Protected` didDetachView