Class Model

Hierarchy

Component<Model>
- Model

Implements

Consumable
WarpRef

Index

Constructors

Methods

analyzeChild analyzeChildren analyzeOwnChildren analyzeTraitChildren appendChild appendTrait attachFastener authenticate bindFastener callObservers cascadeAnalyze cascadeRefresh command commonAncestor consume decohereFastener didAggregate didAnalyze didAttachParent didConsume didCorrelate didDetachParent didInsertChild didInsertTrait didMount didMutate didObserve didReconcile didRefresh didReinsertChild didRemoveChild didRemoveTrait didStartConsuming didStopConsuming didUnconsume didUnmount didUnobserve didValidate downlink downlinkList downlinkMap downlinkValue equals findTrait forEachChild forEachTrait getAncestor getAncestorTrait getChild getFastener getFirstChild getLastChild getNextSibling getParentFastener getPreviousSibling getRoot getRootTrait getTargetChild getTrait getTraitFastener hasTrait hashCode hostRef insertChild insertTrait isAncestorOf laneRef likeType? mount needsAnalyze needsRefresh needsUpdate nodeRef observe onAggregate onAnalyze onAttachParent onConsume onCorrelate onDetachParent onInsertChild onInsertTrait onMount onMutate onObserve onReconcile onRefresh onReinsertChild onRemoveChild onRemoveTrait onStartConsuming onStopConsuming onUnconsume onUnmount onUnobserve onValidate prependChild prependTrait refreshChild refreshChildren refreshOwnChildren refreshTraitChildren reinsertChild remove removeChild removeChildren removeTrait replaceChild replaceTrait requestUpdate requireUpdate set setChild setIntrinsic setTrait sortChildren sortTraits startConsuming stopConsuming tryFastener unconsume unmount unobserve willAggregate willAnalyze willAttachParent willConsume willCorrelate willDetachParent willInsertChild willInsertTrait willMount willMutate willObserve willReconcile willRefresh willReinsertChild willRemoveChild willRemoveTrait willStartConsuming willStopConsuming willUnconsume willUnmount willUnobserve willValidate create fromLike

Constructors

constructor

new Model(): Model
Returns Model
Overrides Component<Model>.constructor
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:81

Properties

`Readonly` firstChild

firstChild: Model

`Readonly` firstTrait

firstTrait: Trait

`Readonly` key

key: string

`Readonly` lastChild

lastChild: Model

`Readonly` lastTrait

lastTrait: Trait

`Readonly` nextSibling

nextSibling: Model

`Optional` `Readonly` observerType

observerType?: Class<ModelObserver<Model>>

`Readonly` parent

parent: Model

`Readonly` previousSibling

previousSibling: Model

`Readonly` updater

updater: Provider<Model, RefresherService>

`Static` `Readonly` InsertChildFlags

InsertChildFlags: number

`Static` `Readonly` InsertTraitFlags

InsertTraitFlags: number

`Static` `Readonly` MountFlags

MountFlags: number

`Static` `Readonly` NeedsAggregate

NeedsAggregate: number

`Static` `Readonly` NeedsAnalyze

NeedsAnalyze: number

`Static` `Readonly` NeedsCorrelate

NeedsCorrelate: number

`Static` `Readonly` NeedsMutate

NeedsMutate: number

`Static` `Readonly` NeedsReconcile

NeedsReconcile: number

`Static` `Readonly` NeedsRefresh

NeedsRefresh: number

`Static` `Readonly` NeedsValidate

NeedsValidate: number

`Static` `Readonly` ReinsertChildFlags

ReinsertChildFlags: number

`Static` `Readonly` RemoveChildFlags

RemoveChildFlags: number

`Static` `Readonly` RemoveTraitFlags

RemoveTraitFlags: number

`Static` `Readonly` StartConsumingFlags

StartConsumingFlags: number

`Static` `Readonly` StopConsumingFlags

StopConsumingFlags: number

Accessors

analyzing

get analyzing(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:115

componentType

get componentType(): Class<Model>
Returns Class<Model>
Overrides Component.componentType
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:84

consuming

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

hostUri

get hostUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.hostUri
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:252

insertChildFlags

get insertChildFlags(): number
Returns number
Inherited from Component.insertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:198

insertTraitFlags

get insertTraitFlags(): number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:185

inserting

get inserting(): boolean
Returns boolean
Inherited from Component.inserting
- Defined in swim-core/swim-component/dist/swim-component.d.ts:199

laneUri

get laneUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.laneUri
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:256

mountFlags

get mountFlags(): number
Returns number
Inherited from Component.mountFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:229

mounted

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

nodeUri

get nodeUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.nodeUri
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:254

refreshing

get refreshing(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:134

reinsertChildFlags

get reinsertChildFlags(): number
Returns number
Inherited from Component.reinsertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:215

removeChildFlags

get removeChildFlags(): number
Returns number
Inherited from Component.removeChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:208

removeTraitFlags

get removeTraitFlags(): number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:191

removing

get removing(): boolean
Returns boolean
Inherited from Component.removing
- Defined in swim-core/swim-component/dist/swim-component.d.ts:209

selection

get selection(): Provider<this, SelectionService>
Returns Provider<this, SelectionService>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:250

startConsumingFlags

get startConsumingFlags(): number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:234

stopConsumingFlags

get stopConsumingFlags(): number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:239

updateTime

get updateTime(): number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:248

updating

get updating(): boolean
Returns boolean
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:114

warpRef

get warpRef(): Property<this, WarpRef, [WarpRef]>
Returns Property<this, WarpRef, [WarpRef]>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:293

Methods

`Protected` analyzeChild

analyzeChild(child, analyzeFlags): void
Parameters
- child: Model
- analyzeFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:133

`Protected` analyzeChildren

analyzeChildren(analyzeFlags, analyzeChild): void
Parameters
- analyzeFlags: number
- analyzeChild: ((this, child, analyzeFlags) => void)
  - - (this, child, analyzeFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      analyzeFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:130

`Protected` analyzeOwnChildren

analyzeOwnChildren(analyzeFlags, analyzeChild): void
Parameters
- analyzeFlags: number
- analyzeChild: ((this, child, analyzeFlags) => void)
  - - (this, child, analyzeFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      analyzeFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:132

`Protected` analyzeTraitChildren

analyzeTraitChildren(trait, analyzeFlags, analyzeChild): void
Parameters
- trait: Trait
- analyzeFlags: number
- analyzeChild: ((this, child, analyzeFlags) => void)
  - - (this, child, analyzeFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      analyzeFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:131

appendChild

appendChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Model>> & Creatable<Instance<F, Model>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:186
appendChild<Child>(child, key?): Child
Type Parameters
- Child extends Model
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:187
appendChild(child, key?): Model
Parameters
- child: Model | {
  create?() => Model;
  }
- Optional key: string
Returns Model
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:188

appendTrait

appendTrait<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Trait>> & Creatable<Instance<F, Trait>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:173
appendTrait<T>(trait, key?): T
Type Parameters
- T extends Trait
Parameters
- trait: T | LikeType<T>
- Optional key: string
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:174
appendTrait(trait, key?): Trait
Parameters
- trait: Trait | {
  create?() => Trait;
  }
- Optional key: string
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:175

attachFastener

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

authenticate

authenticate(hostUri, credentials): void
Parameters
- hostUri: UriLike
- credentials: ValueLike
Returns void
Implementation of WarpRef.authenticate
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:274
authenticate(credentials): void
Parameters
- credentials: ValueLike
Returns void
Implementation of WarpRef.authenticate
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:276

`Protected` bindFastener

bindFastener(fastener): void
Parameters
- fastener: Fastener<any, any, [any]>
Returns void
Overrides Component.bindFastener
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:202

callObservers

callObservers<O, K>(this, key, ...args): void
Type Parameters
- O
- K extends string | number | symbol
Parameters
- this: {
  observerType?: Class<O>;
  }
  - Optional Readonly observerType?: Class<O>
- key: K
- Rest ...args: ObserverParameters<O, K>
Returns void
Inherited from Component.callObservers
- Defined in swim-core/swim-component/dist/swim-component.d.ts:302

cascadeAnalyze

cascadeAnalyze(analyzeFlags): void
Parameters
- analyzeFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:117

cascadeRefresh

cascadeRefresh(refreshFlags): void
Parameters
- refreshFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:136

command

command(hostUri, nodeUri, laneUri, body): void
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:266
command(nodeUri, laneUri, body): void
Parameters
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:268
command(laneUri, body): void
Parameters
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:270
command(body): void
Parameters
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:272

commonAncestor

commonAncestor(relative): Model
Parameters
- relative: Model
Returns Model
Inherited from Component.commonAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:227

consume

consume(consumer): void
Parameters
- consumer: unknown
Returns void
Implementation of Consumable.consume
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:224

decohereFastener

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

`Protected` didAggregate

didAggregate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:126

`Protected` didAnalyze

didAnalyze(analyzeFlags): void
Parameters
- analyzeFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:120

`Protected` didAttachParent

didAttachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.didAttachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:87

`Protected` didConsume

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

`Protected` didCorrelate

didCorrelate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:129

`Protected` didDetachParent

didDetachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.didDetachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:90

`Protected` didInsertChild

didInsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.didInsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:93

`Protected` didInsertTrait

didInsertTrait(trait, target): void
Parameters
- trait: Trait
- target: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:188

`Protected` didMount

didMount(): void
Returns void
Overrides Component.didMount
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:105

`Protected` didMutate

didMutate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:123

`Protected` didObserve

didObserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.didObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:296

`Protected` didReconcile

didReconcile(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:145

`Protected` didRefresh

didRefresh(refreshFlags): void
Parameters
- refreshFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:139

`Protected` didReinsertChild

didReinsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.didReinsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:101

`Protected` didRemoveChild

didRemoveChild(child): void
Parameters
- child: Model
Returns void
Overrides Component.didRemoveChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:98

`Protected` didRemoveTrait

didRemoveTrait(trait): void
Parameters
- trait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:194

`Protected` didStartConsuming

didStartConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:238

`Protected` didStopConsuming

didStopConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:243

`Protected` didUnconsume

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

`Protected` didUnmount

didUnmount(): void
Returns void
Overrides Component.didUnmount
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:109

`Protected` didUnobserve

didUnobserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.didUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:301

`Protected` didValidate

didValidate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:142

downlink

downlink(template?): EventDownlink<WarpRef, any, [any]>
Parameters
- Optional template: ThisType<EventDownlink<WarpRef, any, [any]>> & EventDownlinkDescriptor<WarpRef> & Partial<Omit<EventDownlink<WarpRef, any, [any]>, keyof EventDownlinkDescriptor<WarpRef>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns EventDownlink<WarpRef, any, [any]>
Implementation of WarpRef.downlink
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:258

downlinkList

downlinkList<V>(template?): ListDownlink<WarpRef, V, [Iterable<V>]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ListDownlink<WarpRef, V, [Iterable<V>]>> & ListDownlinkDescriptor<WarpRef, V> & Partial<Omit<ListDownlink<WarpRef, V, [Iterable<V>]>, keyof ListDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ListDownlink<WarpRef, V, [Iterable<V>]>
Implementation of WarpRef.downlinkList
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:262

downlinkMap

downlinkMap<K, V>(template?): MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
Type Parameters
- K = Value
- V = Value
Parameters
- Optional template: ThisType<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>> & MapDownlinkDescriptor<WarpRef, K, V> & Partial<Omit<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>, keyof MapDownlinkDescriptor<WarpRef, K, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
Implementation of WarpRef.downlinkMap
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:264

downlinkValue

downlinkValue<V>(template?): ValueDownlink<WarpRef, V, [V]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ValueDownlink<WarpRef, V, [V]>> & ValueDownlinkDescriptor<WarpRef, V> & Partial<Omit<ValueDownlink<WarpRef, V, [V]>, keyof ValueDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ValueDownlink<WarpRef, V, [V]>
Implementation of WarpRef.downlinkValue
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:260

equals

equals(that): boolean
Parameters
- that: unknown
Returns boolean
Inherited from Component.equals
- Defined in swim-core/swim-component/dist/swim-component.d.ts:306

findTrait

findTrait<F>(key, traitClass): InstanceType<F>
Type Parameters
- F extends Class<Trait>
Parameters
- key: string
- traitClass: F
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:164
findTrait(key, traitClass): Trait
Parameters
- key: string
- traitClass: Class<Trait>
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:165

forEachChild

forEachChild<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((child) => void | T)
  - - (child): void | T
    - Parameters
      
      child: Model
      
      Returns void | T
Returns T
Inherited from Component.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:174
forEachChild<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, child) => void | T)
  - - (this, child): void | T
    - Parameters
      
      this: S
      
      child: Model
      
      Returns void | T
- thisArg: S
Returns T
Inherited from Component.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:175

forEachTrait

forEachTrait<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((trait) => void | T)
  - - (trait): void | T
    - Parameters
      
      trait: Trait
      
      Returns void | T
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:156
forEachTrait<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, trait) => void | T)
  - - (this, trait): void | T
    - Parameters
      
      this: S
      
      trait: Trait
      
      Returns void | T
- thisArg: S
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:157

getAncestor

getAncestor<F>(ancestorType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- ancestorType: F
Returns InstanceType<F>
Inherited from Component.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:222
getAncestor(ancestorType): Model
Parameters
- ancestorType: Class<Model>
Returns Model
Inherited from Component.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:223

getAncestorTrait

getAncestorTrait<F>(ancestorType): InstanceType<F>
Type Parameters
- F extends Class<Trait>
Parameters
- ancestorType: F
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:200

getChild

getChild<F>(key, childType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- key: string
- childType: F
Returns InstanceType<F>
Inherited from Component.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:182
getChild(key, childType?): Model
Parameters
- key: string
- Optional childType: Class<Model>
Returns Model
Inherited from Component.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:183

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

getFirstChild

getFirstChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from Component.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:165
getFirstChild(childType): Model
Parameters
- childType: Class<Model>
Returns Model
Inherited from Component.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:166

getLastChild

getLastChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from Component.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:170
getLastChild(childType): Model
Parameters
- childType: Class<Model>
Returns Model
Inherited from Component.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:171

getNextSibling

getNextSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from Component.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:155
getNextSibling(siblingType): Model
Parameters
- siblingType: Class<Model>
Returns Model
Inherited from Component.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:156

getParentFastener

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

getPreviousSibling

getPreviousSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from Component.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:160
getPreviousSibling(siblingType): Model
Parameters
- siblingType: Class<Model>
Returns Model
Inherited from Component.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:161

getRoot

getRoot<F>(rootType): InstanceType<F>
Type Parameters
- F extends Class<Model>
Parameters
- rootType: F
Returns InstanceType<F>
Inherited from Component.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:224
getRoot(rootType): Model
Parameters
- rootType: Class<Model>
Returns Model
Inherited from Component.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:225

getRootTrait

getRootTrait<F>(rootType): InstanceType<F>
Type Parameters
- F extends Class<Trait>
Parameters
- rootType: F
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:201

getTargetChild

getTargetChild(child, comparator): Model
Parameters
- child: Model
- comparator: Comparator<Model>
Returns Model
Inherited from Component.getTargetChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:221

getTrait

getTrait<F>(key, traitClass): InstanceType<F>
Type Parameters
- F extends Class<Trait>
Parameters
- key: string
- traitClass: F
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:168
getTrait(key, traitClass?): Trait
Parameters
- key: string
- Optional traitClass: Class<Trait>
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:169
getTrait<F>(traitClass): InstanceType<F>
Type Parameters
- F extends Class<Trait>
Parameters
- traitClass: F
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:170

getTraitFastener

getTraitFastener<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
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:110

hasTrait

hasTrait(key, traitClass?): boolean
Parameters
- key: string
- Optional traitClass: Class<Trait>
Returns boolean
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:166
hasTrait(traitClass): boolean
Parameters
- traitClass: Class<Trait>
Returns boolean
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:167

hashCode

hashCode(): number
Returns number
Inherited from Component.hashCode
- Defined in swim-core/swim-component/dist/swim-component.d.ts:308

hostRef

hostRef(hostUri): WarpRef
Parameters
- hostUri: UriLike
Returns WarpRef
Implementation of WarpRef.hostRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:278

insertChild

insertChild<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Model>> & Creatable<Instance<F, Model>>
Parameters
- childFactory: F
- target: Model
- Optional key: string
Returns InstanceType<F>
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:192
insertChild<Child>(child, target, key?): Child
Type Parameters
- Child extends Model
Parameters
- child: Child | LikeType<Child>
- target: Model
- Optional key: string
Returns Child
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:193
insertChild(child, target, key?): Model
Parameters
- child: Model | {
  create?() => Model;
  }
- target: Model
- Optional key: string
Returns Model
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:194

insertTrait

insertTrait<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Trait>> & Creatable<Instance<F, Trait>>
Parameters
- childFactory: F
- target: Trait
- Optional key: string
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:179
insertTrait<T>(trait, target, key?): T
Type Parameters
- T extends Trait
Parameters
- trait: T | LikeType<T>
- target: Trait
- Optional key: string
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:180
insertTrait(trait, target, key?): Trait
Parameters
- trait: Trait | {
  create?() => Trait;
  }
- target: Trait
- Optional key: string
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:181

isAncestorOf

isAncestorOf(descendant): boolean
Parameters
- descendant: Model
Returns boolean
Inherited from Component.isAncestorOf
- Defined in swim-core/swim-component/dist/swim-component.d.ts:226

laneRef

laneRef(hostUri, nodeUri, laneUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:284
laneRef(nodeUri, laneUri): WarpRef
Parameters
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:286
laneRef(laneUri): WarpRef
Parameters
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:288

`Optional` likeType

likeType(like): void
Parameters
- like: {
  create?() => Model;
  }
  - create?:function
    - create(): Model
    - Returns Model
      
      Defined in swim-core/swim-component/dist/swim-component.d.ts:127
Returns void
Inherited from Component.likeType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:126

mount

mount(): void
Returns void
Inherited from Component.mount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:230

`Protected` needsAnalyze

needsAnalyze(analyzeFlags): number
Parameters
- analyzeFlags: number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:116

`Protected` needsRefresh

needsRefresh(refreshFlags): number
Parameters
- refreshFlags: number
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:135

`Protected` needsUpdate

needsUpdate(updateFlags, immediate): number
Parameters
- updateFlags: number
- immediate: boolean
Returns number
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:112

nodeRef

nodeRef(hostUri, nodeUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
Returns WarpRef
Implementation of WarpRef.nodeRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:280
nodeRef(nodeUri): WarpRef
Parameters
- nodeUri: UriLike
Returns WarpRef
Implementation of WarpRef.nodeRef
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:282

observe

observe(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.observe
- Defined in swim-core/swim-component/dist/swim-component.d.ts:293

`Protected` onAggregate

onAggregate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:125

`Protected` onAnalyze

onAnalyze(analyzeFlags): void
Parameters
- analyzeFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:119

`Protected` onAttachParent

onAttachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.onAttachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:86

`Protected` onConsume

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

`Protected` onCorrelate

onCorrelate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:128

`Protected` onDetachParent

onDetachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.onDetachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:89

`Protected` onInsertChild

onInsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.onInsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:92

`Protected` onInsertTrait

onInsertTrait(trait, target): void
Parameters
- trait: Trait
- target: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:187

`Protected` onMount

onMount(): void
Returns void
Inherited from Component.onMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:234

`Protected` onMutate

onMutate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:122

`Protected` onObserve

onObserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.onObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:295

`Protected` onReconcile

onReconcile(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:144

`Protected` onRefresh

onRefresh(refreshFlags): void
Parameters
- refreshFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:138

`Protected` onReinsertChild

onReinsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.onReinsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:100

`Protected` onRemoveChild

onRemoveChild(child): void
Parameters
- child: Model
Returns void
Overrides Component.onRemoveChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:97

`Protected` onRemoveTrait

onRemoveTrait(trait): void
Parameters
- trait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:193

`Protected` onStartConsuming

onStartConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:237

`Protected` onStopConsuming

onStopConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:242

`Protected` onUnconsume

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

`Protected` onUnmount

onUnmount(): void
Returns void
Inherited from Component.onUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:242

`Protected` onUnobserve

onUnobserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.onUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:300

`Protected` onValidate

onValidate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:141

prependChild

prependChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Model>> & Creatable<Instance<F, Model>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:189
prependChild<Child>(child, key?): Child
Type Parameters
- Child extends Model
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:190
prependChild(child, key?): Model
Parameters
- child: Model | {
  create?() => Model;
  }
- Optional key: string
Returns Model
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:191

prependTrait

prependTrait<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Trait>> & Creatable<Instance<F, Trait>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:176
prependTrait<T>(trait, key?): T
Type Parameters
- T extends Trait
Parameters
- trait: T | LikeType<T>
- Optional key: string
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:177
prependTrait(trait, key?): Trait
Parameters
- trait: Trait | {
  create?() => Trait;
  }
- Optional key: string
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:178

`Protected` refreshChild

refreshChild(child, refreshFlags): void
Parameters
- child: Model
- refreshFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:149

`Protected` refreshChildren

refreshChildren(refreshFlags, refreshChild): void
Parameters
- refreshFlags: number
- refreshChild: ((this, child, refreshFlags) => void)
  - - (this, child, refreshFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      refreshFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:146

`Protected` refreshOwnChildren

refreshOwnChildren(refreshFlags, refreshChild): void
Parameters
- refreshFlags: number
- refreshChild: ((this, child, refreshFlags) => void)
  - - (this, child, refreshFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      refreshFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:148

`Protected` refreshTraitChildren

refreshTraitChildren(trait, refreshFlags, refreshChild): void
Parameters
- trait: Trait
- refreshFlags: number
- refreshChild: ((this, child, refreshFlags) => void)
  - - (this, child, refreshFlags): void
    - Parameters
      
      this: Model
      
      child: Model
      
      refreshFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:147

reinsertChild

reinsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Inherited from Component.reinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:216

remove

remove(): void
Returns void
Inherited from Component.remove
- Defined in swim-core/swim-component/dist/swim-component.d.ts:214

removeChild

removeChild<Child>(child): Child
Type Parameters
- Child extends Model
Parameters
- child: Child
Returns Child
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:205
removeChild(child): Model
Parameters
- child: Model
Returns Model
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:206
removeChild(key): Model
Parameters
- key: string | Model
Returns Model
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:207

removeChildren

removeChildren(): void
Returns void
Inherited from Component.removeChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:213

removeTrait

removeTrait<T>(trait): T
Type Parameters
- T extends Trait
Parameters
- trait: T
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:189
removeTrait(key): Trait
Parameters
- key: string | Trait
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:190

replaceChild

replaceChild<F>(newChildFactory, oldChild): Model
Type Parameters
- F extends Class<Instance<F, Model>> & Creatable<Instance<F, Model>>
Parameters
- newChildFactory: F
- oldChild: Model
Returns Model
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:195
replaceChild<Child>(newChild, oldChild): Child
Type Parameters
- Child extends Model
Parameters
- newChild: Model | {
  create?() => Model;
  }
- oldChild: Child
Returns Child
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:196
replaceChild(newChild, oldChild): Model
Parameters
- newChild: Model | {
  create?() => Model;
  }
- oldChild: Model
Returns Model
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:197

replaceTrait

replaceTrait<F>(newChildFactory, oldTrait): Trait
Type Parameters
- F extends Class<Instance<F, Trait>> & Creatable<Instance<F, Trait>>
Parameters
- newChildFactory: F
- oldTrait: Trait
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:182
replaceTrait<T>(newTrait, oldTrait): T
Type Parameters
- T extends Trait
Parameters
- newTrait: Trait | {
  create?() => Trait;
  }
- oldTrait: T
Returns T
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:183
replaceTrait(newTrait, oldTrait): Trait
Parameters
- newTrait: Trait | {
  create?() => Trait;
  }
- oldTrait: Trait
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:184

requestUpdate

requestUpdate(target, updateFlags, immediate): void
Parameters
- target: Model
- updateFlags: number
- immediate: boolean
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:113

requireUpdate

requireUpdate(updateFlags, immediate?): void
Parameters
- updateFlags: number
- Optional immediate: boolean
Returns void
Overrides Component.requireUpdate
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:111

set

set<S>(this, properties, timing?): Model
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              set(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              set(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns Model
Inherited from Component.set
- Defined in swim-core/swim-component/dist/swim-component.d.ts:266

setChild

setChild<F>(key, newChildFactory): Model
Type Parameters
- F extends Class<Instance<F, Model>> & Creatable<Instance<F, Model>>
Parameters
- key: string
- newChildFactory: F
Returns Model
Inherited from Component.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:184
setChild(key, newChild): Model
Parameters
- key: string
- newChild: Model | {
  create?() => Model;
  }
Returns Model
Inherited from Component.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:185

setIntrinsic

setIntrinsic<S>(this, properties, timing?): Model
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              setIntrinsic(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              setIntrinsic(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns Model
Inherited from Component.setIntrinsic
- Defined in swim-core/swim-component/dist/swim-component.d.ts:273

setTrait

setTrait<F>(key, newChildFactory): Trait
Type Parameters
- F extends Class<Instance<F, Trait>> & Creatable<Instance<F, Trait>>
Parameters
- key: string
- newChildFactory: F
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:171
setTrait(key, newTrait): Trait
Parameters
- key: string
- newTrait: Trait | {
  create?() => Trait;
  }
Returns Trait
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:172

sortChildren

sortChildren(comparator): void
Parameters
- comparator: Comparator<Model>
Returns void
Inherited from Component.sortChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:220

sortTraits

sortTraits(comparator): void
Parameters
- comparator: Comparator<Trait>
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:195

`Protected` startConsuming

startConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:235

`Protected` stopConsuming

stopConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:240

tryFastener

tryFastener<K, F>(fastenerName): F extends Fastener<any, any, any>
? F
: never
Type Parameters
- K extends keyof Model
- F extends string | number | boolean | readonly Fastener<any, any, any>[] | {} | {} | (() => void) | (() => void) | (() => void) | (() => void) | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | ReadonlySet<unknown> | Model | ((like) => void) | Class<ModelObserver<Model>> | Class<Model> | {} | {} | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Model;
  } | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Model;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Model;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Model;
  } | {} | {
      <T>(callback): T;
      <T, S>(callback, thisArg): T;
  } | Dictionary<Model> | {
      <F>(key, childType): InstanceType<F>;
      (key, childType?): Model;
  } | {
      <F>(key, newChildFactory): Model;
      (key, newChild): Model;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Model;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Model;
  } | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <Child>(child, target, key?): Child;
      (child, target, key?): Model;
  } | {
      <F>(newChildFactory, oldChild): Model;
      <Child>(newChild, oldChild): Child;
      (newChild, oldChild): Model;
  } | {} | {
      <Child>(child): Child;
      (child): Model;
      (key): Model;
  } | ((child, target) => void) | ((comparator) => void) | ((child, comparator) => Model) | {
      <F>(ancestorType): InstanceType<F>;
      (ancestorType): Model;
  } | {
      <F>(rootType): InstanceType<F>;
      (rootType): Model;
  } | ((descendant) => boolean) | ((relative) => Model) | {} | {} | ((updateFlags, immediate?) => void) | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
      ? F
      : never) | (<S>(this, properties, timing?) => Model) | (<S>(this, properties, timing?) => Model) | {} | ReadonlySet<ModelObserver<Model>> | ((observer) => void) | ((observer) => void) | Trait | ((consumer) => void) | ((consumer) => void) | ((template?) => EventDownlink<WarpRef, any, [any]>) | (<V>(template?) => ValueDownlink<WarpRef, V, [V]>) | (<V>(template?) => ListDownlink<WarpRef, V, [Iterable<V>]>) | (<K, V>(template?) => MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>) | {
      (hostUri, nodeUri, laneUri, body): void;
      (nodeUri, laneUri, body): void;
      (laneUri, body): void;
      (body): void;
  } | {
      (hostUri, credentials): void;
      (credentials): void;
  } | ((hostUri) => WarpRef) | {
      (hostUri, nodeUri): WarpRef;
      (nodeUri): WarpRef;
  } | {
      (hostUri, nodeUri, laneUri): WarpRef;
      (nodeUri, laneUri): WarpRef;
      (laneUri): WarpRef;
  } | {} | {} | Dictionary<Trait> | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((target, updateFlags, immediate) => void) | ((analyzeFlags) => void) | ((refreshFlags) => void) | {} | {} | {
      <T>(callback): T;
      <T, S>(callback, thisArg): T;
  } | {
      <F>(key, traitClass): InstanceType<F>;
      (key, traitClass): Trait;
  } | {
      (key, traitClass?): boolean;
      (traitClass): boolean;
  } | {
      <F>(key, traitClass): InstanceType<F>;
      (key, traitClass?): Trait;
      <F>(traitClass): InstanceType<F>;
  } | {
      <F>(key, newChildFactory): Trait;
      (key, newTrait): Trait;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <T>(trait, key?): T;
      (trait, key?): Trait;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <T>(trait, key?): T;
      (trait, key?): Trait;
  } | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <T>(trait, target, key?): T;
      (trait, target, key?): Trait;
  } | {
      <F>(newChildFactory, oldTrait): Trait;
      <T>(newTrait, oldTrait): T;
      (newTrait, oldTrait): Trait;
  } | {
      <T>(trait): T;
      (key): Trait;
  } | ((comparator) => void) | (<F>(ancestorType) => InstanceType<F>) | (<F>(rootType) => InstanceType<F>) | {} | Provider<Model, RefresherService> | Property<Model, Uri, [Uri]> | Provider<Model, SelectionService> | Property<Model, WarpRef, [WarpRef]> = Model[K]
Parameters
- fastenerName: K
Returns F extends Fastener<any, any, any>
? F
: never
Inherited from Component.tryFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:247

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Implementation of Consumable.unconsume
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:229

unmount

unmount(): void
Returns void
Inherited from Component.unmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:238

unobserve

unobserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.unobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:298

`Protected` willAggregate

willAggregate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:124

`Protected` willAnalyze

willAnalyze(analyzeFlags): void
Parameters
- analyzeFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:118

`Protected` willAttachParent

willAttachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.willAttachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:85

`Protected` willConsume

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

`Protected` willCorrelate

willCorrelate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:127

`Protected` willDetachParent

willDetachParent(parent): void
Parameters
- parent: Model
Returns void
Overrides Component.willDetachParent
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:88

`Protected` willInsertChild

willInsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.willInsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:91

`Protected` willInsertTrait

willInsertTrait(trait, target): void
Parameters
- trait: Trait
- target: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:186

`Protected` willMount

willMount(): void
Returns void
Overrides Component.willMount
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:104

`Protected` willMutate

willMutate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:121

`Protected` willObserve

willObserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.willObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:294

`Protected` willReconcile

willReconcile(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:143

`Protected` willRefresh

willRefresh(refreshFlags): void
Parameters
- refreshFlags: number
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:137

`Protected` willReinsertChild

willReinsertChild(child, target): void
Parameters
- child: Model
- target: Model
Returns void
Overrides Component.willReinsertChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:99

`Protected` willRemoveChild

willRemoveChild(child): void
Parameters
- child: Model
Returns void
Overrides Component.willRemoveChild
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:96

`Protected` willRemoveTrait

willRemoveTrait(trait): void
Parameters
- trait: Trait
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:192

`Protected` willStartConsuming

willStartConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:236

`Protected` willStopConsuming

willStopConsuming(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:241

`Protected` willUnconsume

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

`Protected` willUnmount

willUnmount(): void
Returns void
Overrides Component.willUnmount
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:108

`Protected` willUnobserve

willUnobserve(observer): void
Parameters
- observer: ModelObserver<Model>
Returns void
Inherited from Component.willUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:299

`Protected` willValidate

willValidate(): void
Returns void
- Defined in swim-ui/swim-model/lib/main/Model.d.ts:140

`Static` create

create<S>(this): InstanceType<S>
Type Parameters
- S extends (new () => InstanceType<S>)
Parameters
- this: S
Returns InstanceType<S>
Inherited from Component.create
- Defined in swim-core/swim-component/dist/swim-component.d.ts:309

`Static` fromLike

fromLike<S>(this, value): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, Component<Component<any>>>>
Parameters
- this: S
- value: InstanceType<S> | LikeType<InstanceType<S>>
Returns InstanceType<S>
Inherited from Component.fromLike
- Defined in swim-core/swim-component/dist/swim-component.d.ts:310

Class Model

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Model

Properties

Readonly firstChild

Readonly firstTrait

Readonly key

Readonly lastChild

Readonly lastTrait

Readonly nextSibling

Optional Readonly observerType

Readonly parent

Readonly previousSibling

Readonly updater

Static Readonly InsertChildFlags

Static Readonly InsertTraitFlags

Static Readonly MountFlags

Static Readonly NeedsAggregate

Static Readonly NeedsAnalyze

Static Readonly NeedsCorrelate

Static Readonly NeedsMutate

Static Readonly NeedsReconcile

Static Readonly NeedsRefresh

Static Readonly NeedsValidate

Static Readonly ReinsertChildFlags

Static Readonly RemoveChildFlags

Static Readonly RemoveTraitFlags

Static Readonly StartConsumingFlags

Static Readonly StopConsumingFlags

Accessors

analyzing

Returns boolean

componentType

Returns Class<Model>

consuming

Returns boolean

hostUri

Returns Property<this, Uri, [Uri]>

insertChildFlags

Returns number

insertTraitFlags

Returns number

inserting

Returns boolean

laneUri

Returns Property<this, Uri, [Uri]>

mountFlags

Returns number

mounted

Returns boolean

nodeUri

Returns Property<this, Uri, [Uri]>

refreshing

Returns boolean

reinsertChildFlags

Returns number

removeChildFlags

Returns number

removeTraitFlags

Returns number

removing

Returns boolean

selection

Returns Provider<this, SelectionService>

startConsumingFlags

Returns number

stopConsumingFlags

Returns number

updateTime

Returns number

updating

Returns boolean

`Readonly` firstChild

`Readonly` firstTrait

`Readonly` key

`Readonly` lastChild

`Readonly` lastTrait

`Readonly` nextSibling

`Optional` `Readonly` observerType

`Readonly` parent

`Readonly` previousSibling

`Readonly` updater

`Static` `Readonly` InsertChildFlags

`Static` `Readonly` InsertTraitFlags

`Static` `Readonly` MountFlags

`Static` `Readonly` NeedsAggregate

`Static` `Readonly` NeedsAnalyze

`Static` `Readonly` NeedsCorrelate

`Static` `Readonly` NeedsMutate

`Static` `Readonly` NeedsReconcile

`Static` `Readonly` NeedsRefresh

`Static` `Readonly` NeedsValidate

`Static` `Readonly` ReinsertChildFlags

`Static` `Readonly` RemoveChildFlags

`Static` `Readonly` RemoveTraitFlags

`Static` `Readonly` StartConsumingFlags

`Static` `Readonly` StopConsumingFlags

`Protected` analyzeChild

`Protected` analyzeChildren

`Protected` analyzeOwnChildren

`Protected` analyzeTraitChildren

`Optional` key: string

`Optional` key: string

child: Model | {
create?() => Model;
}

`Optional` key: string

`Optional` key: string

`Optional` key: string