Class HtmlView

Hierarchy

ElementView
- HtmlView
  - StyleView

Index

Constructors

Methods

addConstraint addConstraintVariable addEventListener appendChild attachFastener bindFastener callObservers cascadeDisplay cascadeProcess cascadeUnhide commonAncestor constraint constraintVariable decohereFastener detectTheme didAnimate didApplyTheme didAttachParent didChange didComposite didCull didDetachParent didDisplay didHide didInsertChild didLayout didMount didObserve didProcess didProject didRasterize didReinsertChild didRemoveChild didRender didResize didScroll didSetAttribute didSetIntangible didSetStyle didSetUnbounded didUncull didUnhide didUnmount didUnobserve dispatchEvent displayChild displayChildren equals forEachChild getAncestor getAttribute getChild getFastener getFirstChild getLastChild getLook getLookOr getNextSibling getParentFastener getPreviousSibling getRoot getStyle getTargetChild getTransition hasConstraint hasConstraintVariable hashCode injectChild insertChild intersectsViewport isAncestorOf isPositioned likeType? modifyMood modifyTheme needsDisplay needsProcess needsUpdate observe onAnimate onApplyTheme onAttachParent onChange onComposite onCull onDetachParent onDisplay onHide onInsertChild onLayout onMount onObserve onProcess onProject onRasterize onReinsertChild onRemoveChild onRender onResize onScroll onSetAttribute onSetIntangible onSetStyle onSetUnbounded onUncull onUnhide onUnmount onUnobserve prependChild processChild processChildren reinsertChild remove removeChild removeChildren removeConstraint removeConstraintVariable removeEventListener replaceChild requestUpdate requireUpdate set setAttribute setChild setCulled setHidden setIntangible setIntrinsic setStyle setUnbounded sortChildren tryFastener unobserve willAnimate willApplyTheme willAttachParent willChange willComposite willCull willDetachParent willDisplay willHide willInsertChild willLayout willMount willObserve willProcess willProject willRasterize willReinsertChild willRemoveChild willRender willResize willScroll willSetAttribute willSetIntangible willSetStyle willSetUnbounded willUncull willUnhide willUnmount willUnobserve create forTag fromLike fromNode fromTag get

Constructors

constructor

new HtmlView(node): HtmlView
Parameters
- node: HTMLElement
Returns HtmlView
Overrides ElementView.constructor
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:200

Properties

`Protected` didMountObservers

didMountObservers: Set<Required<Pick<ViewObserver<View>, "viewDidMount">>>

`Protected` didUnmountObservers

didUnmountObservers: Set<Required<Pick<ViewObserver<View>, "viewDidUnmount">>>

`Readonly` firstChild

firstChild: View

`Readonly` key

key: string

`Readonly` lastChild

lastChild: View

`Readonly` mood

mood: Property<HtmlView, MoodVector<Feel>, [MoodVector<Feel>]> & {}

Type declaration

`Readonly` moodModifier

moodModifier: Property<HtmlView, MoodMatrix<Feel, Feel>, [MoodMatrix<Feel, Feel>]>

`Readonly` nextSibling

nextSibling: View

`Readonly` node

node: HTMLElement

`Optional` `Readonly` observerType

observerType?: Class<HtmlViewObserver<HtmlView>>

`Readonly` parent

parent: View

`Readonly` previousSibling

previousSibling: View

`Readonly` styler

styler: Provider<HtmlView, StylerService>

`Readonly` theme

theme: Property<HtmlView, ThemeMatrix, [ThemeMatrix]> & {}

Type declaration

`Readonly` themeModifier

themeModifier: Property<HtmlView, MoodMatrix<Feel, Feel>, [MoodMatrix<Feel, Feel>]>

`Readonly` updater

updater: Provider<HtmlView, DisplayerService>

`Protected` willMountObservers

willMountObservers: Set<Required<Pick<ViewObserver<View>, "viewWillMount">>>

`Protected` willUnmountObservers

willUnmountObservers: Set<Required<Pick<ViewObserver<View>, "viewWillUnmount">>>

`Static` `Readonly` InsertChildFlags

InsertChildFlags: number

`Static` `Readonly` MountFlags

MountFlags: number

`Static` `Readonly` NeedsAnimate

NeedsAnimate: number

`Static` `Readonly` NeedsChange

NeedsChange: number

`Static` `Readonly` NeedsComposite

NeedsComposite: number

`Static` `Readonly` NeedsDisplay

NeedsDisplay: number

`Static` `Readonly` NeedsLayout

NeedsLayout: number

`Static` `Readonly` NeedsProcess

NeedsProcess: number

`Static` `Readonly` NeedsProject

NeedsProject: number

`Static` `Readonly` NeedsRasterize

NeedsRasterize: number

`Static` `Readonly` NeedsRender

NeedsRender: number

`Static` `Readonly` NeedsResize

NeedsResize: number

`Static` `Readonly` NeedsScroll

NeedsScroll: number

`Static` `Readonly` ReinsertChildFlags

ReinsertChildFlags: number

`Static` `Readonly` RemoveChildFlags

RemoveChildFlags: number

`Static` `Readonly` UncullFlags

UncullFlags: number

`Static` `Readonly` UnhideFlags

UnhideFlags: number

`Static` `Readonly` tag

tag: string

Accessors

attributes

get attributes(): HtmlAttributes<this>
Returns HtmlAttributes<this>
Overrides ElementView.attributes
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:206

classList

get classList(): ClassList<this>
Returns ClassList<this>
Inherited from ElementView.classList
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:116

clientBounds

get clientBounds(): R2Box
Returns R2Box
Inherited from ElementView.clientBounds
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:125

clientTransform

get clientTransform(): Transform
Returns the transformation from viewport coordinates to view coordinates.

Returns Transform
Inherited from ElementView.clientTransform
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1264

componentType

get componentType(): Class<View>
Returns Class<View>
Inherited from ElementView.componentType
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:979

culled

get culled(): boolean
Returns boolean
Inherited from ElementView.culled
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1027

displaying

get displaying(): boolean
Returns boolean
Inherited from ElementView.displaying
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1127

dom

get dom(): Provider<this, DomService>
Returns Provider<this, DomService>
Inherited from ElementView.dom
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:119

edgeInsets

get edgeInsets(): Property<this, ViewInsets, [ViewInsets]>
Returns Property<this, ViewInsets, [ViewInsets]>
Inherited from ElementView.edgeInsets
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1245

hidden

get hidden(): boolean
Returns true if this view is ineligible for rendering and hit testing, and should be excluded from its parent's layout and hit bounds.

Returns boolean
Inherited from ElementView.hidden
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1048

insertChildFlags

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

inserting

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

intangible

get intangible(): boolean
Returns boolean
Inherited from ElementView.intangible
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1075

layoutViewport

get layoutViewport(): LayoutViewport
Returns LayoutViewport
Inherited from ElementView.layoutViewport
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1242

modal

get modal(): Provider<this, ModalService> & {
    dismiss(modalView?) => void;
    present(modalView?, options?) => void;
    toggle(modalView?) => void;
}
Returns Provider<this, ModalService> & {
    dismiss(modalView?) => void;
    present(modalView?, options?) => void;
    toggle(modalView?) => void;
}
Inherited from ElementView.modal
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:120

mountFlags

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

mounted

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

pageBounds

get pageBounds(): R2Box
Returns R2Box
Inherited from ElementView.pageBounds
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:126

pageTransform

get pageTransform(): Transform
Returns the transformation from page coordinates to view coordinates.

Returns Transform
Overrides ElementView.pageTransform
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:235

parentTransform

get parentTransform(): Transform
Returns Transform
Overrides ElementView.parentTransform
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:234

popoverFrame

get popoverFrame(): R2Box
Returns the bounding box, in page coordinates, the edges to which attached popovers should point.

Returns R2Box
Inherited from ElementView.popoverFrame
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1260

processing

get processing(): boolean
Returns boolean
Inherited from ElementView.processing
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1084

reinsertChildFlags

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

removeChildFlags

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

removing

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

solver

get solver(): Provider<this, SolverService>
Returns Provider<this, SolverService>
Inherited from ElementView.solver
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1166

style

get style(): StyleAttribute<this>
Returns StyleAttribute<this>
Inherited from ElementView.style
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:106

text

get text(): TextAnimator<this, any, [any]>
Returns TextAnimator<this, any, [any]>
Inherited from ElementView.text
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:37

textContent

get textContent(): string
Returns string
Inherited from ElementView.textContent
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:35
set textContent(textContent): void
Parameters
- textContent: string
Returns void
Inherited from ElementView.textContent
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:36

unbounded

get unbounded(): boolean
Returns boolean
Inherited from ElementView.unbounded
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1070

uncullFlags

get uncullFlags(): number
Returns number
Inherited from ElementView.uncullFlags
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1038

unhideFlags

get unhideFlags(): number
Returns number
Inherited from ElementView.unhideFlags
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1064

updateTime

get updateTime(): number
Returns number
Inherited from ElementView.updateTime
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1163

updating

get updating(): boolean
Returns boolean
Inherited from ElementView.updating
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1083

viewIdiom

get viewIdiom(): ViewIdiom
Returns ViewIdiom
Inherited from ElementView.viewIdiom
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1244

viewport

get viewport(): Provider<this, ViewportService> & Provider<NodeView, ViewportService> & ViewportServiceObserver<ViewportService>
Returns Provider<this, ViewportService> & Provider<NodeView, ViewportService> & ViewportServiceObserver<ViewportService>
Inherited from ElementView.viewport
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:118

visualViewport

get visualViewport(): VisualViewport_2
Returns VisualViewport_2
Inherited from ElementView.visualViewport
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1243

Methods

addConstraint

addConstraint(constraint): void
Parameters
- constraint: Constraint
Returns void
Inherited from ElementView.addConstraint
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1213

addConstraintVariable

addConstraintVariable(constraintVariable): void
Parameters
- constraintVariable: ConstraintVariable
Returns void
Inherited from ElementView.addConstraintVariable
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1227

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, event) => unknown)
  - - (this, event): unknown
    - Parameters
      
      this: HTMLElement
      
      event: HTMLElementEventMap[K]
      
      Returns unknown
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides ElementView.addEventListener
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:236
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides ElementView.addEventListener
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:237

appendChild

appendChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Overrides ElementView.appendChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:209
appendChild<V>(child, key?): V
Type Parameters
- V extends View
Parameters
- child: V | LikeType<V>
- Optional key: string
Returns V
Overrides ElementView.appendChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:210
appendChild<K>(tag, key?): HtmlViewTagMap[K]
Type Parameters
- K extends keyof HtmlViewTagMap
Parameters
- tag: K
- Optional key: string
Returns HtmlViewTagMap[K]
Overrides ElementView.appendChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:211
appendChild(child, key?): View
Parameters
- child: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
- Optional key: string
Returns View
Overrides ElementView.appendChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:212

attachFastener

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

`Protected` bindFastener

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

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 ElementView.callObservers
- Defined in swim-core/swim-component/dist/swim-component.d.ts:302

cascadeDisplay

cascadeDisplay(displayFlags): void
Parameters
- displayFlags: number
Returns void
Inherited from ElementView.cascadeDisplay
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1129

cascadeProcess

cascadeProcess(processFlags): void
Parameters
- processFlags: number
Returns void
Inherited from ElementView.cascadeProcess
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1086

cascadeUnhide

cascadeUnhide(): void
Returns void
Inherited from ElementView.cascadeUnhide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1063

commonAncestor

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

constraint

constraint(lhs, relation, rhs?, strength?): Constraint
Parameters
- lhs: ConstraintExpressionLike
- relation: ConstraintRelation
- Optional rhs: ConstraintExpressionLike
- Optional strength: ConstraintStrengthLike
Returns Constraint
Inherited from ElementView.constraint
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1207

constraintVariable

constraintVariable(name, value?, strength?): ConstraintProperty<unknown, number, [number]>
Parameters
- name: string
- Optional value: number
- Optional strength: ConstraintStrengthLike
Returns ConstraintProperty<unknown, number, [number]>
Inherited from ElementView.constraintVariable
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1221

decohereFastener

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

`Protected` detectTheme

detectTheme(): void
Returns void
Inherited from ElementView.detectTheme
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:117

`Protected` didAnimate

didAnimate(): void
Returns void
Inherited from ElementView.didAnimate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1117

`Protected` didApplyTheme

didApplyTheme(theme, mood, timing): void
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void
Inherited from ElementView.didApplyTheme
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1186

`Protected` didAttachParent

didAttachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.didAttachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:988

`Protected` didChange

didChange(): void
Returns void
Inherited from ElementView.didChange
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1110

`Protected` didComposite

didComposite(): void
Returns void
Inherited from ElementView.didComposite
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1160

`Protected` didCull

didCull(): void
Returns void
Inherited from ElementView.didCull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1033

`Protected` didDetachParent

didDetachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.didDetachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:995

`Protected` didDisplay

didDisplay(displayFlags): void
Parameters
- displayFlags: number
Returns void
Inherited from ElementView.didDisplay
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1132

`Protected` didHide

didHide(): void
Returns void
Inherited from ElementView.didHide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1060

`Protected` didInsertChild

didInsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.didInsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1002

`Protected` didLayout

didLayout(): void
Returns void
Inherited from ElementView.didLayout
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1139

`Protected` didMount

didMount(): void
Returns void
Inherited from ElementView.didMount
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1020

`Protected` didObserve

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

`Protected` didProcess

didProcess(processFlags): void
Parameters
- processFlags: number
Returns void
Inherited from ElementView.didProcess
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1089

`Protected` didProject

didProject(): void
Returns void
Inherited from ElementView.didProject
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1124

`Protected` didRasterize

didRasterize(): void
Returns void
Inherited from ElementView.didRasterize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1153

`Protected` didReinsertChild

didReinsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.didReinsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1014

`Protected` didRemoveChild

didRemoveChild(child): void
Parameters
- child: View
Returns void
Inherited from ElementView.didRemoveChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1011

`Protected` didRender

didRender(): void
Returns void
Inherited from ElementView.didRender
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1146

`Protected` didResize

didResize(): void
Returns void
Inherited from ElementView.didResize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1096

`Protected` didScroll

didScroll(): void
Returns void
Inherited from ElementView.didScroll
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1103

`Protected` didSetAttribute

didSetAttribute(attributeName, value): void
Parameters
- attributeName: string
- value: unknown
Returns void
Inherited from ElementView.didSetAttribute
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:105

`Protected` didSetIntangible

didSetIntangible(intangible): void
Parameters
- intangible: boolean
Returns void
Inherited from ElementView.didSetIntangible
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1079

`Protected` didSetStyle

didSetStyle(propertyName, value, priority): void
Parameters
- propertyName: string
- value: unknown
- priority: string
Returns void
Inherited from ElementView.didSetStyle
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:115

`Protected` didSetUnbounded

didSetUnbounded(unboundedFlag): void
Parameters
- unboundedFlag: boolean
Returns void
Inherited from ElementView.didSetUnbounded
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1074

`Protected` didUncull

didUncull(): void
Returns void
Inherited from ElementView.didUncull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1041

`Protected` didUnhide

didUnhide(): void
Returns void
Inherited from ElementView.didUnhide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1067

`Protected` didUnmount

didUnmount(): void
Returns void
Inherited from ElementView.didUnmount
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1026

`Protected` didUnobserve

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

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from ElementView.dispatchEvent
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:71

`Protected` displayChild

displayChild(child, displayFlags): void
Parameters
- child: View
- displayFlags: number
Returns void
Inherited from ElementView.displayChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1162

`Protected` displayChildren

displayChildren(displayFlags, displayChild): void
Parameters
- displayFlags: number
- displayChild: ((this, child, displayFlags) => void)
  - - (this, child, displayFlags): void
    - Parameters
      
      this: HtmlView
      
      child: View
      
      displayFlags: number
      
      Returns void
Returns void
Inherited from ElementView.displayChildren
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1161

equals

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

forEachChild

forEachChild<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((child) => void | T)
  - - (child): void | T
    - Parameters
      
      child: View
      
      Returns void | T
Returns T
Inherited from ElementView.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: View
      
      Returns void | T
- thisArg: S
Returns T
Inherited from ElementView.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:175

getAncestor

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

getAttribute

getAttribute(attributeName): string
Parameters
- attributeName: string
Returns string
Inherited from ElementView.getAttribute
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:96

getChild

getChild<F>(key, childType): InstanceType<F>
Type Parameters
- F extends Class<View>
Parameters
- key: string
- childType: F
Returns InstanceType<F>
Inherited from ElementView.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:182
getChild(key, childType?): View
Parameters
- key: string
- Optional childType: Class<View>
Returns View
Inherited from ElementView.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 ElementView.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:248

getFirstChild

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

getLastChild

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

getLook

getLook<T>(look, mood?): T
Type Parameters
- T
Parameters
- look: Look<T>
- Optional mood: MoodVector<Feel>
Returns T
Inherited from ElementView.getLook
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1177

getLookOr

getLookOr<T, E>(look, elseValue): T | E
Type Parameters
- T
- E
Parameters
- look: Look<T>
- elseValue: E
Returns T | E
Inherited from ElementView.getLookOr
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1179
getLookOr<T, E>(look, mood, elseValue): T | E
Type Parameters
- T
- E
Parameters
- look: Look<T>
- mood: MoodVector<Feel>
- elseValue: E
Returns T | E
Inherited from ElementView.getLookOr
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1181

getNextSibling

getNextSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<View>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from ElementView.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:155
getNextSibling(siblingType): View
Parameters
- siblingType: Class<View>
Returns View
Inherited from ElementView.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 ElementView.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:250

getPreviousSibling

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

getRoot

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

getStyle

getStyle(propertyNames): string | CSSStyleValue
Parameters
- propertyNames: string | readonly string[]
Returns string | CSSStyleValue
Inherited from ElementView.getStyle
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:107

getTargetChild

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

getTransition

getTransition(fastener): Timing
Parameters
- fastener: Fastener<any, any, any>
Returns Timing
Inherited from ElementView.getTransition
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1195

hasConstraint

hasConstraint(constraint): boolean
Parameters
- constraint: Constraint
Returns boolean
Inherited from ElementView.hasConstraint
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1211

hasConstraintVariable

hasConstraintVariable(constraintVariable): boolean
Parameters
- constraintVariable: ConstraintVariable
Returns boolean
Inherited from ElementView.hasConstraintVariable
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1225

hashCode

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

injectChild

injectChild<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, NodeView>> & Creatable<Instance<F, NodeView>>
Parameters
- childFactory: F
- target: Node | NodeView
- Optional key: string
Returns InstanceType<F>
Inherited from ElementView.injectChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:49
injectChild<V>(child, target, key?): V
Type Parameters
- V extends NodeView
Parameters
- child: V | LikeType<V>
- target: Node | NodeView
- Optional key: string
Returns V
Inherited from ElementView.injectChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:50
injectChild(child, target, key?): NodeView
Parameters
- child: Node | NodeView | {
  create?() => View;
  }
- target: Node | NodeView
- Optional key: string
Returns NodeView
Inherited from ElementView.injectChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:51

insertChild

insertChild<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>
Parameters
- childFactory: F
- target: Node | View
- Optional key: string
Returns InstanceType<F>
Overrides ElementView.insertChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:217
insertChild<V>(child, target, key?): V
Type Parameters
- V extends View
Parameters
- child: V | LikeType<V>
- target: Node | View
- Optional key: string
Returns V
Overrides ElementView.insertChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:218
insertChild<K>(tag, target, key?): HtmlViewTagMap[K]
Type Parameters
- K extends keyof HtmlViewTagMap
Parameters
- tag: K
- target: Node | View
- Optional key: string
Returns HtmlViewTagMap[K]
Overrides ElementView.insertChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:219
insertChild(child, target, key?): View
Parameters
- child: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
- target: Node | View
- Optional key: string
Returns View
Overrides ElementView.insertChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:220

intersectsViewport

intersectsViewport(): boolean
Returns boolean
Inherited from ElementView.intersectsViewport
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1266

isAncestorOf

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

isPositioned

isPositioned(): boolean
Returns boolean
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:229

`Optional` likeType

likeType(like): void
Parameters
- like: Node | {
  create?() => View;
  } | keyof HtmlViewTagMap
Returns void
Overrides ElementView.likeType
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:201

modifyMood

modifyMood(feel, updates, timing?): void
Parameters
- feel: Feel
- updates: MoodVectorUpdates<Feel>
- Optional timing: boolean | TimingLike
Returns void
Inherited from ElementView.modifyMood
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1190

modifyTheme

modifyTheme(feel, updates, timing?): void
Parameters
- feel: Feel
- updates: MoodVectorUpdates<Feel>
- Optional timing: boolean | TimingLike
Returns void
Inherited from ElementView.modifyTheme
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1192
modifyTheme(cols, timing?): void
Parameters
- cols: [feel: Feel, updates: MoodVectorUpdates<Feel>][]
- Optional timing: boolean | TimingLike
Returns void
Inherited from ElementView.modifyTheme
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1193

`Protected` needsDisplay

needsDisplay(displayFlags): number
Parameters
- displayFlags: number
Returns number
Inherited from ElementView.needsDisplay
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1128

`Protected` needsProcess

needsProcess(processFlags): number
Parameters
- processFlags: number
Returns number
Inherited from ElementView.needsProcess
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1085

`Protected` needsUpdate

needsUpdate(updateFlags, immediate): number
Parameters
- updateFlags: number
- immediate: boolean
Returns number
Inherited from ElementView.needsUpdate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1081

observe

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

`Protected` onAnimate

onAnimate(): void
Returns void
Inherited from ElementView.onAnimate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1114

`Protected` onApplyTheme

onApplyTheme(theme, mood, timing): void
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void
Overrides ElementView.onApplyTheme
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:224

`Protected` onAttachParent

onAttachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.onAttachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:985

`Protected` onChange

onChange(): void
Returns void
Inherited from ElementView.onChange
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1107

`Protected` onComposite

onComposite(): void
Returns void
Inherited from ElementView.onComposite
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1157

`Protected` onCull

onCull(): void
Returns void
Inherited from ElementView.onCull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1032

`Protected` onDetachParent

onDetachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.onDetachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:992

`Protected` onDisplay

onDisplay(displayFlags): void
Parameters
- displayFlags: number
Returns void
Inherited from ElementView.onDisplay
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1131

`Protected` onHide

onHide(): void
Returns void
Inherited from ElementView.onHide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1059

`Protected` onInsertChild

onInsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.onInsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:999

`Protected` onLayout

onLayout(): void
Returns void
Inherited from ElementView.onLayout
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1136

`Protected` onMount

onMount(): void
Returns void
Inherited from ElementView.onMount
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:133

`Protected` onObserve

onObserve(observer): void
Parameters
- observer: HtmlViewObserver<HtmlView>
Returns void
Inherited from ElementView.onObserve
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:131

`Protected` onProcess

onProcess(processFlags): void
Parameters
- processFlags: number
Returns void
Inherited from ElementView.onProcess
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1088

`Protected` onProject

onProject(): void
Returns void
Inherited from ElementView.onProject
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1121

`Protected` onRasterize

onRasterize(): void
Returns void
Inherited from ElementView.onRasterize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1150

`Protected` onReinsertChild

onReinsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.onReinsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1013

`Protected` onRemoveChild

onRemoveChild(child): void
Parameters
- child: View
Returns void
Inherited from ElementView.onRemoveChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1008

`Protected` onRender

onRender(): void
Returns void
Inherited from ElementView.onRender
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1143

`Protected` onResize

onResize(): void
Returns void
Inherited from ElementView.onResize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1093

`Protected` onScroll

onScroll(): void
Returns void
Inherited from ElementView.onScroll
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1100

`Protected` onSetAttribute

onSetAttribute(attributeName, value): void
Parameters
- attributeName: string
- value: unknown
Returns void
Inherited from ElementView.onSetAttribute
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:102

`Protected` onSetIntangible

onSetIntangible(intangible): void
Parameters
- intangible: boolean
Returns void
Inherited from ElementView.onSetIntangible
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1078

`Protected` onSetStyle

onSetStyle(propertyName, value, priority): void
Parameters
- propertyName: string
- value: unknown
- priority: string
Returns void
Inherited from ElementView.onSetStyle
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:112

`Protected` onSetUnbounded

onSetUnbounded(unboundedFlag): void
Parameters
- unboundedFlag: boolean
Returns void
Inherited from ElementView.onSetUnbounded
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1073

`Protected` onUncull

onUncull(): void
Returns void
Inherited from ElementView.onUncull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1040

`Protected` onUnhide

onUnhide(): void
Returns void
Inherited from ElementView.onUnhide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1066

`Protected` onUnmount

onUnmount(): void
Returns void
Inherited from ElementView.onUnmount
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:134

`Protected` onUnobserve

onUnobserve(observer): void
Parameters
- observer: HtmlViewObserver<HtmlView>
Returns void
Inherited from ElementView.onUnobserve
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:132

prependChild

prependChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Overrides ElementView.prependChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:213
prependChild<V>(child, key?): V
Type Parameters
- V extends View
Parameters
- child: V | LikeType<V>
- Optional key: string
Returns V
Overrides ElementView.prependChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:214
prependChild<K>(tag, key?): HtmlViewTagMap[K]
Type Parameters
- K extends keyof HtmlViewTagMap
Parameters
- tag: K
- Optional key: string
Returns HtmlViewTagMap[K]
Overrides ElementView.prependChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:215
prependChild(child, key?): View
Parameters
- child: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
- Optional key: string
Returns View
Overrides ElementView.prependChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:216

`Protected` processChild

processChild(child, processFlags): void
Parameters
- child: View
- processFlags: number
Returns void
Inherited from ElementView.processChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1126

`Protected` processChildren

processChildren(processFlags, processChild): void
Parameters
- processFlags: number
- processChild: ((this, child, processFlags) => void)
  - - (this, child, processFlags): void
    - Parameters
      
      this: HtmlView
      
      child: View
      
      processFlags: number
      
      Returns void
Returns void
Inherited from ElementView.processChildren
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1125

reinsertChild

reinsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.reinsertChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:59

remove

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

removeChild

removeChild<V>(child): V
Type Parameters
- V extends Node | View
Parameters
- child: V
Returns V
Inherited from ElementView.removeChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:55
removeChild(key): View
Parameters
- key: string | View
Returns View
Inherited from ElementView.removeChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:56
removeChild(key): Node | View
Parameters
- key: string | Node | View
Returns Node | View
Inherited from ElementView.removeChild
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:57

removeChildren

removeChildren(): void
Returns void
Inherited from ElementView.removeChildren
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:58

removeConstraint

removeConstraint(constraint): void
Parameters
- constraint: Constraint
Returns void
Inherited from ElementView.removeConstraint
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1215

removeConstraintVariable

removeConstraintVariable(constraintVariable): void
Parameters
- constraintVariable: ConstraintVariable
Returns void
Inherited from ElementView.removeConstraintVariable
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1229

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, event) => unknown)
  - - (this, event): unknown
    - Parameters
      
      this: HTMLElement
      
      event: HTMLElementEventMap[K]
      
      Returns unknown
- Optional options: boolean | EventListenerOptions
Returns void
Overrides ElementView.removeEventListener
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:238
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Overrides ElementView.removeEventListener
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:239

replaceChild

replaceChild<F>(newChildFactory, oldChild): View
Type Parameters
- F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>
Parameters
- newChildFactory: F
- oldChild: View
Returns View
Overrides ElementView.replaceChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:221
replaceChild<V>(newChild, oldChild): V
Type Parameters
- V extends View
Parameters
- newChild: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
- oldChild: V
Returns V
Overrides ElementView.replaceChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:222
replaceChild(newChild, oldChild): View
Parameters
- newChild: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
- oldChild: View
Returns View
Overrides ElementView.replaceChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:223

requestUpdate

requestUpdate(target, updateFlags, immediate): void
Parameters
- target: View
- updateFlags: number
- immediate: boolean
Returns void
Inherited from ElementView.requestUpdate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1082

requireUpdate

requireUpdate(updateFlags, immediate?): void
Parameters
- updateFlags: number
- Optional immediate: boolean
Returns void
Inherited from ElementView.requireUpdate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1080

set

set<S>(this, properties, timing?): HtmlView
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 HtmlView
Inherited from ElementView.set
- Defined in swim-core/swim-component/dist/swim-component.d.ts:266

setAttribute

setAttribute(attributeName, value): HtmlView
Parameters
- attributeName: string
- value: unknown
Returns HtmlView
Inherited from ElementView.setAttribute
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:98

setChild

setChild<F>(key, newChildFactory): View
Type Parameters
- F extends Class<Instance<F, View>> & Creatable<Instance<F, View>>
Parameters
- key: string
- newChildFactory: F
Returns View
Overrides ElementView.setChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:207
setChild(key, newChild): View
Parameters
- key: string
- newChild: Node | View | {
  create?() => View;
  } | keyof HtmlViewTagMap
Returns View
Overrides ElementView.setChild
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:208

setCulled

setCulled(culled): void
Parameters
- culled: boolean
Returns void
Inherited from ElementView.setCulled
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1028

setHidden

setHidden(hidden): void
Makes this view ineligible for rendering and hit testing, and excludes this view from its parent's layout and hit bounds, when hidden is true. Makes this view eligible for rendering and hit testing, and includes this view in its parent's layout and hit bounds, when hidden is false.
Parameters
- hidden: boolean
Returns void
Inherited from ElementView.setHidden
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1055

setIntangible

setIntangible(intangible): void
Parameters
- intangible: boolean
Returns void
Inherited from ElementView.setIntangible
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1076

setIntrinsic

setIntrinsic<S>(this, properties, timing?): HtmlView
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 HtmlView
Inherited from ElementView.setIntrinsic
- Defined in swim-core/swim-component/dist/swim-component.d.ts:273

setStyle

setStyle(propertyName, value, priority?): HtmlView
Parameters
- propertyName: string
- value: unknown
- Optional priority: string
Returns HtmlView
Inherited from ElementView.setStyle
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:108

setUnbounded

setUnbounded(unboundedFlag): void
Parameters
- unboundedFlag: boolean
Returns void
Inherited from ElementView.setUnbounded
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1071

sortChildren

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

tryFastener

tryFastener<K, F>(fastenerName): F extends Fastener<any, any, any>
? F
: never
Type Parameters
- K extends keyof HtmlView
- F extends string | number | boolean | HTMLElement | Transform | R2Box | readonly Fastener<any, any, any>[] | {} | {} | (() => void) | {} | {} | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | View | LayoutViewport | Class<View> | {} | {} | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): View;
  } | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): View;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): View;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): View;
  } | {} | {
      <T>(callback): T;
      <T, S>(callback, thisArg): T;
  } | Dictionary<View> | {
      <F>(key, childType): InstanceType<F>;
      (key, childType?): View;
  } | {} | ((comparator) => void) | ((child, comparator) => View) | {
      <F>(ancestorType): InstanceType<F>;
      (ancestorType): View;
  } | {
      <F>(rootType): InstanceType<F>;
      (rootType): View;
  } | ((descendant) => boolean) | ((relative) => View) | {} | ((updateFlags, immediate?) => void) | {} | ((lhs, relation, rhs?, strength?) => Constraint) | ((constraint) => boolean) | ((constraint) => void) | ((constraint) => void) | ((name, value?, strength?) => ConstraintProperty<unknown, number, [number]>) | ((constraintVariable) => boolean) | ((constraintVariable) => void) | ((constraintVariable) => void) | {} | {} | {} | {} | {} | (<T>(look, mood?) => T) | {
      <T, E>(look, elseValue): T | E;
      <T, E>(look, mood, elseValue): T | E;
  } | ReadonlySet<Constraint> | ReadonlySet<ConstraintVariable> | VisualViewport_2 | {} | {} | ((feel, updates, timing?) => void) | {
      (feel, updates, timing?): void;
      (cols, timing?): void;
  } | ((fastener) => Timing) | ((event) => boolean) | {
      <V>(child): V;
      (key): View;
      (key): Node | View;
  } | (() => void) | ((child, target) => void) | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <V>(child, target, key?): V;
      (child, target, key?): NodeView;
  } | ((attributeName) => string) | ((propertyNames) => string | CSSStyleValue) | ((like) => void) | Class<HtmlViewObserver<HtmlView>> | HtmlAttributes<HtmlView> | ((attributeName, value) => HtmlView) | StyleAttribute<HtmlView> | ((propertyName, value, priority?) => HtmlView) | ClassList<HtmlView> | Provider<HtmlView, ViewportService> & Provider<NodeView, ViewportService> & ViewportServiceObserver<ViewportService> | TextAnimator<HtmlView, any, [any]> | {
      <F>(key, newChildFactory): View;
      (key, newChild): View;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <V>(child, key?): V;
      <K>(tag, key?): HtmlViewTagMap[K];
      (child, key?): View;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <V>(child, key?): V;
      <K>(tag, key?): HtmlViewTagMap[K];
      (child, key?): View;
  } | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <V>(child, target, key?): V;
      <K>(tag, target, key?): HtmlViewTagMap[K];
      (child, target, key?): View;
  } | {
      <F>(newChildFactory, oldChild): View;
      <V>(newChild, oldChild): V;
      (newChild, oldChild): View;
  } | {
      <K>(type, listener, options?): void;
      (type, listener, options?): void;
  } | {
      <K>(type, listener, options?): void;
      (type, listener, options?): void;
  } | Provider<HtmlView, DisplayerService> | Provider<HtmlView, SolverService> | Provider<HtmlView, StylerService> | Property<HtmlView, MoodVector<Feel>, [MoodVector<Feel>]> & {} | Property<HtmlView, ThemeMatrix, [ThemeMatrix]> & {} | Property<HtmlView, MoodMatrix<Feel, Feel>, [MoodMatrix<Feel, Feel>]> | Property<HtmlView, ViewInsets, [ViewInsets]> | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
      ? F
      : never) | (<S>(this, properties, timing?) => HtmlView) | (<S>(this, properties, timing?) => HtmlView) | ReadonlySet<HtmlViewObserver<HtmlView>> | ((observer) => void) | ((observer) => void) | Provider<HtmlView, DomService> | Provider<HtmlView, ModalService> & {
      dismiss(modalView?) => void;
      present(modalView?, options?) => void;
      toggle(modalView?) => void;
  } | {} | ((culled) => void) | {} | {} | ((hidden) => void) | {} | (() => void) | ((unboundedFlag) => void) | ((intangible) => void) | ((target, updateFlags, immediate) => void) | ((processFlags) => void) | ((displayFlags) => void) | {} | {} | (() => boolean) | (() => boolean) = HtmlView[K]
Parameters
- fastenerName: K
Returns F extends Fastener<any, any, any>
? F
: never
Inherited from ElementView.tryFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:247

unobserve

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

`Protected` willAnimate

willAnimate(): void
Returns void
Inherited from ElementView.willAnimate
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1113

`Protected` willApplyTheme

willApplyTheme(theme, mood, timing): void
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void
Inherited from ElementView.willApplyTheme
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1184

`Protected` willAttachParent

willAttachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.willAttachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:984

`Protected` willChange

willChange(): void
Returns void
Inherited from ElementView.willChange
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1106

`Protected` willComposite

willComposite(): void
Returns void
Inherited from ElementView.willComposite
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1156

`Protected` willCull

willCull(): void
Returns void
Inherited from ElementView.willCull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1031

`Protected` willDetachParent

willDetachParent(parent): void
Parameters
- parent: View
Returns void
Inherited from ElementView.willDetachParent
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:991

`Protected` willDisplay

willDisplay(displayFlags): void
Parameters
- displayFlags: number
Returns void
Inherited from ElementView.willDisplay
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1130

`Protected` willHide

willHide(): void
Returns void
Inherited from ElementView.willHide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1058

`Protected` willInsertChild

willInsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.willInsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:998

`Protected` willLayout

willLayout(): void
Returns void
Inherited from ElementView.willLayout
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1135

`Protected` willMount

willMount(): void
Returns void
Inherited from ElementView.willMount
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1018

`Protected` willObserve

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

`Protected` willProcess

willProcess(processFlags): void
Parameters
- processFlags: number
Returns void
Inherited from ElementView.willProcess
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1087

`Protected` willProject

willProject(): void
Returns void
Inherited from ElementView.willProject
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1120

`Protected` willRasterize

willRasterize(): void
Returns void
Inherited from ElementView.willRasterize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1149

`Protected` willReinsertChild

willReinsertChild(child, target): void
Parameters
- child: View
- target: View
Returns void
Inherited from ElementView.willReinsertChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1012

`Protected` willRemoveChild

willRemoveChild(child): void
Parameters
- child: View
Returns void
Inherited from ElementView.willRemoveChild
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1007

`Protected` willRender

willRender(): void
Returns void
Inherited from ElementView.willRender
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1142

`Protected` willResize

willResize(): void
Returns void
Inherited from ElementView.willResize
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1092

`Protected` willScroll

willScroll(): void
Returns void
Inherited from ElementView.willScroll
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1099

`Protected` willSetAttribute

willSetAttribute(attributeName, value): void
Parameters
- attributeName: string
- value: unknown
Returns void
Inherited from ElementView.willSetAttribute
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:101

`Protected` willSetIntangible

willSetIntangible(intangible): void
Parameters
- intangible: boolean
Returns void
Inherited from ElementView.willSetIntangible
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1077

`Protected` willSetStyle

willSetStyle(propertyName, value, priority): void
Parameters
- propertyName: string
- value: unknown
- priority: string
Returns void
Inherited from ElementView.willSetStyle
- Defined in swim-ui/swim-dom/lib/main/ElementView.d.ts:111

`Protected` willSetUnbounded

willSetUnbounded(unboundedFlag): void
Parameters
- unboundedFlag: boolean
Returns void
Inherited from ElementView.willSetUnbounded
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1072

`Protected` willUncull

willUncull(): void
Returns void
Inherited from ElementView.willUncull
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1039

`Protected` willUnhide

willUnhide(): void
Returns void
Inherited from ElementView.willUnhide
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1065

`Protected` willUnmount

willUnmount(): void
Returns void
Inherited from ElementView.willUnmount
- Defined in swim-ui/swim-view/dist/swim-view.d.ts:1024

`Protected` willUnobserve

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

`Static` create

create<S>(this): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, HtmlView>>
Parameters
- this: S
Returns InstanceType<S>
Overrides ElementView.create
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:241
create(): HtmlView
Returns HtmlView
Overrides ElementView.create
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:242

`Static` forTag

forTag<S>(this, tag): HtmlViewFactory<InstanceType<S>>
Type Parameters
- S extends Class<Instance<S, HtmlView>>
Parameters
- this: S
- tag: string
Returns HtmlViewFactory<InstanceType<S>>
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:250
forTag(tag): HtmlViewFactory<HtmlView>
Parameters
- tag: string
Returns HtmlViewFactory<HtmlView>
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:251

`Static` fromLike

fromLike<S>(this, value): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, View>>
Parameters
- this: S
- value: InstanceType<S> | LikeType<InstanceType<S>>
Returns InstanceType<S>
Overrides ElementView.fromLike
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:243

`Static` fromNode

fromNode<S>(this, node): InstanceType<S>
Type Parameters
- S extends (new (node) => Instance<S, HtmlView>)
Parameters
- this: S
- node: HTMLElement
Returns InstanceType<S>
Overrides ElementView.fromNode
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:244
fromNode(node): HtmlView
Parameters
- node: HTMLElement
Returns HtmlView
Overrides ElementView.fromNode
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:245

`Static` fromTag

fromTag(tag): StyleView
Parameters
- tag: "style"
Returns StyleView
Overrides ElementView.fromTag
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:246
fromTag(tag): SvgView
Parameters
- tag: "svg"
Returns SvgView
Overrides ElementView.fromTag
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:247
fromTag<S>(this, tag): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, HtmlView>>
Parameters
- this: S
- tag: string
Returns InstanceType<S>
Overrides ElementView.fromTag
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:248
fromTag(tag): HtmlView
Parameters
- tag: string
Returns HtmlView
Overrides ElementView.fromTag
- Defined in swim-ui/swim-dom/lib/main/HtmlView.d.ts:249

`Static` get

get<S>(this, node): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, NodeView>>
Parameters
- this: S
- node: Node
Returns InstanceType<S>
Inherited from ElementView.get
- Defined in swim-ui/swim-dom/lib/main/NodeView.d.ts:76

Class HtmlView

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

node: HTMLElement

Returns HtmlView

Properties

Protected didMountObservers

Protected didUnmountObservers

Readonly firstChild

Readonly key

Readonly lastChild

Readonly mood

Type declaration

Readonly moodModifier

Readonly nextSibling

Readonly node

Optional Readonly observerType

Readonly parent

Readonly previousSibling

Readonly styler

Readonly theme

Type declaration

Readonly themeModifier

Readonly updater

Protected willMountObservers

Protected willUnmountObservers

Static Readonly InsertChildFlags

Static Readonly MountFlags

Static Readonly NeedsAnimate

Static Readonly NeedsChange

Static Readonly NeedsComposite

Static Readonly NeedsDisplay

Static Readonly NeedsLayout

Static Readonly NeedsProcess

Static Readonly NeedsProject

Static Readonly NeedsRasterize

Static Readonly NeedsRender

Static Readonly NeedsResize

Static Readonly NeedsScroll

Static Readonly ReinsertChildFlags

Static Readonly RemoveChildFlags

Static Readonly UncullFlags

Static Readonly UnhideFlags

Static Readonly tag

Accessors

attributes

Returns HtmlAttributes<this>

classList

Returns ClassList<this>

clientBounds

Returns R2Box

clientTransform

Returns Transform

componentType

Returns Class<View>

culled

Returns boolean

displaying

Returns boolean

dom

Returns Provider<this, DomService>

edgeInsets

Returns Property<this, ViewInsets, [ViewInsets]>

hidden

Returns boolean

insertChildFlags

Returns number

inserting

Returns boolean

intangible

Returns boolean

layoutViewport

Returns LayoutViewport

`Protected` didMountObservers

`Protected` didUnmountObservers

`Readonly` firstChild

`Readonly` key

`Readonly` lastChild

`Readonly` mood

`Readonly` moodModifier

`Readonly` nextSibling

`Readonly` node

`Optional` `Readonly` observerType

`Readonly` parent

`Readonly` previousSibling

`Readonly` styler

`Readonly` theme

`Readonly` themeModifier

`Readonly` updater

`Protected` willMountObservers

`Protected` willUnmountObservers

`Static` `Readonly` InsertChildFlags

`Static` `Readonly` MountFlags

`Static` `Readonly` NeedsAnimate

`Static` `Readonly` NeedsChange

`Static` `Readonly` NeedsComposite

`Static` `Readonly` NeedsDisplay

`Static` `Readonly` NeedsLayout

`Static` `Readonly` NeedsProcess

`Static` `Readonly` NeedsProject

`Static` `Readonly` NeedsRasterize

`Static` `Readonly` NeedsRender

`Static` `Readonly` NeedsResize

`Static` `Readonly` NeedsScroll

`Static` `Readonly` ReinsertChildFlags

`Static` `Readonly` RemoveChildFlags

`Static` `Readonly` UncullFlags

`Static` `Readonly` UnhideFlags

`Static` `Readonly` tag

Returns Provider<this, ModalService> & {
dismiss(modalView?) => void;
present(modalView?, options?) => void;
toggle(modalView?) => void;
}

`Optional` options: boolean | AddEventListenerOptions