View | Swim Toolkit

Hierarchy

View

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new View(): View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:127
Returns View

Properties

Readonly Abstract childViewCount

childViewCount: number

Readonly Abstract childViews

childViews: readonly View[]

Readonly Abstract clientBounds

clientBounds: R2Box

Readonly Abstract constraintVariables

constraintVariables: readonly ConstraintVariable[]

Readonly Abstract constraints

constraints: readonly Constraint[]

Readonly displayService

displayService: DisplayService<View>

Readonly Abstract key

key: undefined | string

Readonly Abstract parentTransform

parentTransform: Transform

Returns the transformation from the parent view coordinates to view coordinates.

Readonly Abstract parentView

parentView: null | View

Readonly theme

theme: ViewProperty<View, null | ThemeMatrix, never>

Readonly themeService

themeService: ThemeService<View>

Readonly viewContext

viewContext: ViewContext

Readonly viewController

viewController: null | ViewController<View>

Readonly viewFlags

viewFlags: number

Readonly viewObservers

viewObservers: readonly ViewObserver<View>[]

Readonly viewportService

viewportService: ViewportService<View>

Static Readonly Extrinsic

Extrinsic: number = 1

Static Readonly Intrinsic

Intrinsic: number = 0

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 insertChildFlags

insertChildFlags: number = ...

Static Readonly mountFlags

mountFlags: number = ...

Static Readonly powerFlags

powerFlags: number = ...

Static Readonly removeChildFlags

removeChildFlags: number = ...

Static Readonly uncullFlags

uncullFlags: number = ...

Accessors

clientTransform

get clientTransform(): Transform

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1497
Returns the transformation from viewport coordinates to view coordinates.

Returns Transform

insertChildFlags

get insertChildFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:417
Returns number

mountFlags

get mountFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:536
Returns number

pageBounds

get pageBounds(): R2Box

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1480
Returns R2Box

pageTransform

get pageTransform(): Transform

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1471
Returns the transformation from page coordinates to view coordinates.

Returns Transform

popoverFrame

get popoverFrame(): R2Box

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1490
Returns the bounding box, in page coordinates, the edges to which attached popovers should point.

Returns R2Box

powerFlags

get powerFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:616
Returns number

removeChildFlags

get removeChildFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:460
Returns number

superViewContext

get superViewContext(): ViewContext

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1442
Returns ViewContext

uncullFlags

get uncullFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:731
Returns number

viewIdiom

get viewIdiom(): ViewIdiom

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1454
Returns ViewIdiom

viewport

get viewport(): Viewport

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1458
Returns Viewport

Methods

Abstract addConstraint

addConstraint(constraint: Constraint): void

Implementation of ConstraintScope.addConstraint
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1341
Parameters
- constraint: Constraint
Returns void

Abstract addConstraintVariable

addConstraintVariable(constraintVariable: ConstraintVariable): void

Implementation of ConstraintScope.addConstraintVariable
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1379
Parameters
- constraintVariable: ConstraintVariable
Returns void

addViewObserver

addViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:208
Parameters
- viewObserver: ViewObserver<View>
Returns void

Abstract appendChildView

appendChildView(childView: View, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:411
Parameters
- childView: View
- Optional key: string
Returns void

applyTheme

applyTheme(theme: ThemeMatrix, mood: MoodVector<Feel>, timing?: boolean | AnyTiming): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1168
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- Optional timing: boolean | AnyTiming
Returns void

Protected attachParentView

attachParentView(parentView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:333
Parameters
- parentView: View
Returns void

Abstract cascadeCull

cascadeCull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:695
Returns void

Abstract cascadeDisplay

cascadeDisplay(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1064
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Abstract cascadeInsert

cascadeInsert(updateFlags?: number, viewContext?: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:453
Parameters
- Optional updateFlags: number
- Optional viewContext: ViewContext
Returns void

Abstract cascadeMount

cascadeMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:540
Returns void

Abstract cascadePower

cascadePower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:620
Returns void

Abstract cascadeProcess

cascadeProcess(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:855
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Abstract cascadeUncull

cascadeUncull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:729
Returns void

Abstract cascadeUnmount

cascadeUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:578
Returns void

Abstract cascadeUnpower

cascadeUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:655
Returns void

constraint

constraint(lhs: AnyConstraintExpression, relation: ConstraintRelation, rhs?: AnyConstraintExpression, strength?: AnyConstraintStrength): Constraint

Implementation of ConstraintScope.constraint
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1320
Parameters
- lhs: AnyConstraintExpression
- relation: ConstraintRelation
- Optional rhs: AnyConstraintExpression
- Optional strength: AnyConstraintStrength
Returns Constraint

constraintVariable

constraintVariable(name: string, value?: number, strength?: AnyConstraintStrength): ConstraintBinding

Implementation of ConstraintScope.constraintVariable
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1363
Parameters
- name: string
- Optional value: number
- Optional strength: AnyConstraintStrength
Returns ConstraintBinding

Protected detachParentView

detachParentView(parentView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:345
Parameters
- parentView: View
Returns void

Protected didAddViewObserver

didAddViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:263
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected didAnimate

didAnimate(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:997
Parameters
- viewContext: ViewContext
Returns void

Protected didApplyTheme

didApplyTheme(theme: ThemeMatrix, mood: MoodVector<Feel>, timing: boolean | Timing): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1197
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void

Protected didChange

didChange(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:951
Parameters
- viewContext: ViewContext
Returns void

Protected didCull

didCull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:715
Returns void

Protected didDisplay

didDisplay(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1074
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected didDisplayChildView

didDisplayChildView(childView: View, displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1151
Parameters
- childView: View
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected didDisplayChildViews

didDisplayChildViews(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1118
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected didInsertChildView

didInsertChildView(childView: View, targetView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:439
Parameters
- childView: View
- targetView: null | View
Returns void

Protected didLayout

didLayout(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1096
Parameters
- viewContext: ViewContext
Returns void

Protected didMount

didMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:564
Returns void

Protected didPower

didPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:641
Returns void

Protected didProcess

didProcess(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:865
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected didProcessChildView

didProcessChildView(childView: View, processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1052
Parameters
- childView: View
- processFlags: number
- viewContext: ViewContext
Returns void

Protected didProcessChildViews

didProcessChildViews(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1019
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected didRemoveChildView

didRemoveChildView(childView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:483
Parameters
- childView: View
Returns void

Protected didRemoveViewObserver

didRemoveViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:319
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected didRequestUpdate

didRequestUpdate(targetView: View, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:835
Parameters
- targetView: View
- updateFlags: number
- immediate: boolean
Returns void

Protected didRequireUpdate

didRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:795
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected didResize

didResize(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:887
Parameters
- viewContext: ViewContext
Returns void

Protected didScroll

didScroll(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:919
Parameters
- viewContext: ViewContext
Returns void

Protected didSetParentView

didSetParentView(newParentView: null | View, oldParentView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:375
Parameters
- newParentView: null | View
- oldParentView: null | View
Returns void

Protected didSetViewController

didSetViewController(viewController: null | ViewController<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:202
Parameters
- viewController: null | ViewController<View>
Returns void

Protected didUncull

didUncull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:757
Returns void

Protected didUnmount

didUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:598
Returns void

Protected didUnpower

didUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:675
Returns void

Abstract dispatchEvent

dispatchEvent(event: Event): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1520
Parameters
- event: Event
Returns boolean

Protected displayChildViews

displayChildViews(displayFlags: number, viewContext: ViewContext, displayChildView: (childView: View, displayFlags: number, viewContext: ViewContext) => void): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1122
Parameters
- displayFlags: number
- viewContext: ViewContext
- displayChildView: (childView: View, displayFlags: number, viewContext: ViewContext) => void
  - - (childView: View, displayFlags: number, viewContext: ViewContext): void
    - Parameters
      - childView: View
      - displayFlags: number
      - viewContext: ViewContext
      Returns void
Returns void

extendViewContext

extendViewContext(viewContext: ViewContext): ViewContext

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1438
Parameters
- viewContext: ViewContext
Returns ViewContext

Abstract firstChildView

firstChildView(): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:395
Returns null | View

Abstract forEachChildView

forEachChildView<T>(callback: (childView: View) => void | T): undefined | T
forEachChildView<T, S>(callback: (childView: View) => void | T, thisArg: S): undefined | T

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:403
Type parameters
- T
Parameters
- callback: (childView: View) => void | T
  - - (childView: View): void | T
    - Parameters
      - childView: View
      Returns void | T
Returns undefined | T
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:404
Type parameters
- T
- S
Parameters
- callback: (childView: View) => void | T
  - - (childView: View): void | T
    - Parameters
      - childView: View
      Returns void | T
- thisArg: S
Returns undefined | T

getBaseView

getBaseView<V>(viewClass: ViewClass<V>): null | V

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:508
Type parameters
- V: View<V>
Parameters
- viewClass: ViewClass<V>
Returns null | V

Abstract getChildView

getChildView(key: string): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:407
Parameters
- key: string
Returns null | View

Abstract getLook

getLook<T>(look: Look<T, unknown>, mood?: null | MoodVector<Feel>): undefined | T

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1159
Type parameters
- T
Parameters
- look: Look<T, unknown>
- Optional mood: null | MoodVector<Feel>
Returns undefined | T

Abstract getLookOr

getLookOr<T, E>(look: Look<T, unknown>, elseValue: E): T | E
getLookOr<T, E>(look: Look<T, unknown>, mood: null | MoodVector<Feel>, elseValue: E): T | E

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1161
Type parameters
- T
- E
Parameters
- look: Look<T, unknown>
- elseValue: E
Returns T | E
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1162
Type parameters
- T
- E
Parameters
- look: Look<T, unknown>
- mood: null | MoodVector<Feel>
- elseValue: E
Returns T | E

getSuperView

getSuperView<V>(viewClass: ViewClass<V>): null | V

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:497
Type parameters
- V: View<V>
Parameters
- viewClass: ViewClass<V>
Returns null | V

Abstract getViewAnimator

getViewAnimator(animatorName: string): null | ViewAnimator<View, unknown, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1251
Parameters
- animatorName: string
Returns null | ViewAnimator<View, unknown, never>

Abstract getViewFastener

getViewFastener(fastenerName: string): null | ViewFastener<View, View, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1300
Parameters
- fastenerName: string
Returns null | ViewFastener<View, View, never>

Abstract getViewProperty

getViewProperty(propertyName: string): null | ViewProperty<View, unknown, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1232
Parameters
- propertyName: string
Returns null | ViewProperty<View, unknown, never>

Abstract getViewService

getViewService(serviceName: string): null | ViewService<View, unknown>

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1213
Parameters
- serviceName: string
Returns null | ViewService<View, unknown>

Abstract hasConstraint

hasConstraint(constraint: Constraint): boolean

Implementation of ConstraintScope.hasConstraint
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1339
Parameters
- constraint: Constraint
Returns boolean

Abstract hasConstraintVariable

hasConstraintVariable(constraintVariable: ConstraintVariable): boolean

Implementation of ConstraintScope.hasConstraintVariable
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1377
Parameters
- constraintVariable: ConstraintVariable
Returns boolean

Abstract hasViewAnimator

hasViewAnimator(animatorName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1249
Parameters
- animatorName: string
Returns boolean

Abstract hasViewFastener

hasViewFastener(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1298
Parameters
- fastenerName: string
Returns boolean

Abstract hasViewProperty

hasViewProperty(propertyName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1230
Parameters
- propertyName: string
Returns boolean

Abstract hasViewService

hasViewService(serviceName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1211
Parameters
- serviceName: string
Returns boolean

initView

initView(init: ViewInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:156
Parameters
- init: ViewInit
Returns void

Abstract insertChildView

insertChildView(childView: View, targetView: null | View, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:415
Parameters
- childView: View
- targetView: null | View
- Optional key: string
Returns void

intersectsViewport

intersectsViewport(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1512
Returns boolean

isCulled

isCulled(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:689
Returns boolean

isDisplaying

isDisplaying(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1056
Returns boolean

isMounted

isMounted(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:532
Returns boolean

isPowered

isPowered(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:612
Returns boolean

isProcessing

isProcessing(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:847
Returns boolean

isTraversing

isTraversing(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:839
Returns boolean

isUpdating

isUpdating(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:843
Returns boolean

Abstract lastChildView

lastChildView(): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:397
Returns null | View

Abstract modifyMood

modifyMood(feel: Feel, updates: MoodVectorUpdates<Feel>, timing?: boolean | AnyTiming): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1164
Parameters
- feel: Feel
- updates: MoodVectorUpdates<Feel>
- Optional timing: boolean | AnyTiming
Returns void

Abstract modifyTheme

modifyTheme(feel: Feel, updates: MoodVectorUpdates<Feel>, timing?: boolean | AnyTiming): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1166
Parameters
- feel: Feel
- updates: MoodVectorUpdates<Feel>
- Optional timing: boolean | AnyTiming
Returns void

needsDisplay

needsDisplay(displayFlags: number, viewContext: ViewContext): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1060
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns number

needsProcess

needsProcess(processFlags: number, viewContext: ViewContext): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:851
Parameters
- processFlags: number
- viewContext: ViewContext
Returns number

Abstract nextChildView

nextChildView(targetView: View): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:399
Parameters
- targetView: View
Returns null | View

Abstract off

off(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1525
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns View

Abstract on

on(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1522
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns View

Protected onAddViewObserver

onAddViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:230
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected onAnimate

onAnimate(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:979
Parameters
- viewContext: ViewContext
Returns void

Protected onApplyTheme

onApplyTheme(theme: ThemeMatrix, mood: MoodVector<Feel>, timing: boolean | Timing): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1193
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void

Protected onChange

onChange(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:947
Parameters
- viewContext: ViewContext
Returns void

Protected onCull

onCull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:711
Returns void

Protected onDisplay

onDisplay(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1070
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected onDisplayChildView

onDisplayChildView(childView: View, displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1147
Parameters
- childView: View
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected onDisplayChildViews

onDisplayChildViews(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1114
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected onInsertChildView

onInsertChildView(childView: View, targetView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:435
Parameters
- childView: View
- targetView: null | View
Returns void

Protected onLayout

onLayout(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1092
Parameters
- viewContext: ViewContext
Returns void

Protected onMount

onMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:556
Returns void

Protected onPower

onPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:636
Returns void

Protected onProcess

onProcess(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:861
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected onProcessChildView

onProcessChildView(childView: View, processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1048
Parameters
- childView: View
- processFlags: number
- viewContext: ViewContext
Returns void

Protected onProcessChildViews

onProcessChildViews(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1015
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected onRemoveChildView

onRemoveChildView(childView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:479
Parameters
- childView: View
Returns void

Protected onRemoveViewObserver

onRemoveViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:286
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected onRequestUpdate

onRequestUpdate(targetView: View, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:831
Parameters
- targetView: View
- updateFlags: number
- immediate: boolean
Returns void

Protected onRequireUpdate

onRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:791
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected onResize

onResize(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:883
Parameters
- viewContext: ViewContext
Returns void

Protected onScroll

onScroll(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:915
Parameters
- viewContext: ViewContext
Returns void

Protected onSetParentView

onSetParentView(newParentView: null | View, oldParentView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:371
Parameters
- newParentView: null | View
- oldParentView: null | View
Returns void

Protected onSetViewController

onSetViewController(viewController: null | ViewController<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:198
Parameters
- viewController: null | ViewController<View>
Returns void

Protected onUncull

onUncull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:749
Returns void

Protected onUnmount

onUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:594
Returns void

Protected onUnpower

onUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:671
Returns void

Abstract prependChildView

prependChildView(childView: View, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:413
Parameters
- childView: View
- Optional key: string
Returns void

Abstract previousChildView

previousChildView(targetView: View): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:401
Parameters
- targetView: View
Returns null | View

Protected processChildViews

processChildViews(processFlags: number, viewContext: ViewContext, processChildView: (childView: View, processFlags: number, viewContext: ViewContext) => void): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1023
Parameters
- processFlags: number
- viewContext: ViewContext
- processChildView: (childView: View, processFlags: number, viewContext: ViewContext) => void
  - - (childView: View, processFlags: number, viewContext: ViewContext): void
    - Parameters
      - childView: View
      - processFlags: number
      - viewContext: ViewContext
      Returns void
Returns void

Abstract remove

remove(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:389
Returns void

Abstract removeAll

removeAll(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:458
Returns void

Abstract removeChildView

removeChildView(key: string): null | View
removeChildView(childView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:455
Parameters
- key: string
Returns null | View
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:456
Parameters
- childView: View
Returns void

Abstract removeConstraint

removeConstraint(constraint: Constraint): void

Implementation of ConstraintScope.removeConstraint
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1343
Parameters
- constraint: Constraint
Returns void

Abstract removeConstraintVariable

removeConstraintVariable(constraintVariable: ConstraintVariable): void

Implementation of ConstraintScope.removeConstraintVariable
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1381
Parameters
- constraintVariable: ConstraintVariable
Returns void

removeViewObserver

removeViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:267
Parameters
- viewObserver: ViewObserver<View>
Returns void

requestUpdate

requestUpdate(targetView: View, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:799
Parameters
- targetView: View
- updateFlags: number
- immediate: boolean
Returns void

requireUpdate

requireUpdate(updateFlags: number, immediate?: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:771
Parameters
- updateFlags: number
- immediate: boolean = false
Returns void

Abstract setChildView

setChildView(key: string, newChildView: null | View): null | View

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:409
Parameters
- key: string
- newChildView: null | View
Returns null | View

Abstract setCulled

setCulled(culled: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:693
Parameters
- culled: boolean
Returns void

Abstract setViewAnimator

setViewAnimator(animatorName: string, viewAnimator: null | ViewAnimator<View, unknown, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1253
Parameters
- animatorName: string
- viewAnimator: null | ViewAnimator<View, unknown, never>
Returns void

setViewController

setViewController(newViewController: null | ViewController<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:174
Parameters
- newViewController: null | ViewController<View>
Returns void

Abstract setViewFastener

setViewFastener(fastenerName: string, viewFastener: null | ViewFastener<View, any, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1302
Parameters
- fastenerName: string
- viewFastener: null | ViewFastener<View, any, never>
Returns void

setViewFlags

setViewFlags(viewFlags: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:164
Parameters
- viewFlags: number
Returns void

Abstract setViewProperty

setViewProperty(propertyName: string, viewProperty: null | ViewProperty<View, unknown, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1234
Parameters
- propertyName: string
- viewProperty: null | ViewProperty<View, unknown, never>
Returns void

Abstract setViewService

setViewService(serviceName: string, viewService: null | ViewService<View, unknown>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1215
Parameters
- serviceName: string
- viewService: null | ViewService<View, unknown>
Returns void

setViewState

setViewState<S>(state: ViewMemberMap<S>, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
setViewState<S>(state: ViewMemberMap<S>, timing?: boolean | AnyTiming, precedence?: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1423
Type parameters
- S: View<S>
Parameters
- state: ViewMemberMap<S>
- precedenceOrTiming: undefined | number | boolean | AnyTiming
Returns void
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1424
Type parameters
- S: View<S>
Parameters
- state: ViewMemberMap<S>
- Optional timing: boolean | AnyTiming
- Optional precedence: number
Returns void

trackDidStartAnimating

trackDidStartAnimating(track: AnimationTrack): void

Implementation of AnimationTimeline.trackDidStartAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1282
Parameters
- track: AnimationTrack
Returns void

trackDidStopAnimating

trackDidStopAnimating(track: AnimationTrack): void

Implementation of AnimationTimeline.trackDidStopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1290
Parameters
- track: AnimationTrack
Returns void

trackWillStartAnimating

trackWillStartAnimating(track: AnimationTrack): void

Implementation of AnimationTimeline.trackWillStartAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1271
Parameters
- track: AnimationTrack
Returns void

trackWillStopAnimating

trackWillStopAnimating(track: AnimationTrack): void

Implementation of AnimationTimeline.trackWillStopAnimating
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1286
Parameters
- track: AnimationTrack
Returns void

Protected willAddViewObserver

willAddViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:226
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected willAnimate

willAnimate(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:965
Parameters
- viewContext: ViewContext
Returns void

Protected willApplyTheme

willApplyTheme(theme: ThemeMatrix, mood: MoodVector<Feel>, timing: boolean | Timing): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1179
Parameters
- theme: ThemeMatrix
- mood: MoodVector<Feel>
- timing: boolean | Timing
Returns void

Protected willChange

willChange(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:933
Parameters
- viewContext: ViewContext
Returns void

Protected willCull

willCull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:697
Returns void

Protected willDisplay

willDisplay(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1066
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected willDisplayChildView

willDisplayChildView(childView: View, displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1143
Parameters
- childView: View
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected willDisplayChildViews

willDisplayChildViews(displayFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1110
Parameters
- displayFlags: number
- viewContext: ViewContext
Returns void

Protected willInsertChildView

willInsertChildView(childView: View, targetView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:421
Parameters
- childView: View
- targetView: null | View
Returns void

Protected willLayout

willLayout(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1078
Parameters
- viewContext: ViewContext
Returns void

Protected willMount

willMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:542
Returns void

Protected willPower

willPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:622
Returns void

Protected willProcess

willProcess(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:857
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected willProcessChildView

willProcessChildView(childView: View, processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1044
Parameters
- childView: View
- processFlags: number
- viewContext: ViewContext
Returns void

Protected willProcessChildViews

willProcessChildViews(processFlags: number, viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:1011
Parameters
- processFlags: number
- viewContext: ViewContext
Returns void

Protected willRemoveChildView

willRemoveChildView(childView: View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:464
Parameters
- childView: View
Returns void

Protected willRemoveViewObserver

willRemoveViewObserver(viewObserver: ViewObserver<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:282
Parameters
- viewObserver: ViewObserver<View>
Returns void

Protected willRequestUpdate

willRequestUpdate(targetView: View, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:827
Parameters
- targetView: View
- updateFlags: number
- immediate: boolean
Returns void

Protected willRequireUpdate

willRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:787
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected willResize

willResize(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:869
Parameters
- viewContext: ViewContext
Returns void

Protected willScroll

willScroll(viewContext: ViewContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:901
Parameters
- viewContext: ViewContext
Returns void

Protected willSetParentView

willSetParentView(newParentView: null | View, oldParentView: null | View): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:357
Parameters
- newParentView: null | View
- oldParentView: null | View
Returns void

Protected willSetViewController

willSetViewController(viewController: null | ViewController<View>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:194
Parameters
- viewController: null | ViewController<View>
Returns void

Protected willUncull

willUncull(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:735
Returns void

Protected willUnmount

willUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:580
Returns void

Protected willUnpower

willUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/main/View.ts:657
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns View

Properties

Readonly Abstract childViewCount

Readonly Abstract childViews

Readonly Abstract clientBounds

Readonly Abstract constraintVariables

Readonly Abstract constraints

Readonly displayService

Readonly Abstract key

Readonly layoutService

Readonly modalService

Readonly mood

Readonly Abstract parentTransform

Readonly Abstract parentView

Readonly theme

Readonly themeService

Readonly viewContext

Readonly viewController

Readonly viewFlags

Readonly viewObservers

Readonly viewportService

Static Readonly Extrinsic

Static Readonly Intrinsic

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 insertChildFlags

Static Readonly mountFlags

Static Readonly powerFlags

Static Readonly removeChildFlags

Static Readonly uncullFlags

Accessors

clientTransform

Returns Transform

insertChildFlags

Returns number

mountFlags

Returns number

pageBounds

Returns R2Box

pageTransform

Returns Transform

popoverFrame

Returns R2Box

powerFlags

Returns number

removeChildFlags

Returns number

superViewContext

Returns ViewContext

uncullFlags

Returns number

viewIdiom

Returns ViewIdiom

viewport

Returns Viewport

Methods

Abstract addConstraint

Parameters

constraint: Constraint

Returns void

Abstract addConstraintVariable

Parameters