Class ViewportService<V>

Type parameters

V: View = View

Hierarchy

Service<V>
- ViewportService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ViewportService<V>(): ViewportService<V>

Overrides Service.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:8
Type parameters
- V: View<V> = View
Returns ViewportService<V>

Properties

Optional Readonly observerType

observerType: Class<ViewportServiceObserver<V, ViewportService<V>>>

Readonly observers

observers: readonly ViewportServiceObserver<V, ViewportService<V>>[]

reorientationTimer

reorientationTimer: number

Readonly roots

roots: readonly V[]

Readonly viewContext

viewContext: ViewContext

viewportResizeTimer

viewportResizeTimer: number

Static ReorientationDelay

ReorientationDelay: number

Static ViewportResizeDelay

ViewportResizeDelay: number

Accessors

attached

get attached(): boolean

- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:16
Returns boolean

viewIdiom

get viewIdiom(): ViewIdiom

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:12
Returns ViewIdiom

viewport

get viewport(): Viewport

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:11
Returns Viewport

Methods

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:25
Returns void

attachRoot

attachRoot(root: V): void

Inherited from Service.attachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:8
Parameters
- root: V
Returns void

Protected debounceReorientation

debounceReorientation(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:33
Returns void

Protected debounceViewportResize

debounceViewportResize(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:30
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:26
Returns void

detachRoot

detachRoot(root: V): void

Inherited from Service.detachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:12
Parameters
- root: V
Returns void

detectViewIdiom

detectViewIdiom(viewport: Viewport): undefined | ViewIdiom

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:13
Parameters
- viewport: Viewport
Returns undefined | ViewIdiom

Protected didAttach

didAttach(): void

Inherited from Service.didAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:19
Returns void

Protected didAttachRoot

didAttachRoot(root: V): void

Inherited from Service.didAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:11
Parameters
- root: V
Returns void

Protected didDetach

didDetach(): void

Inherited from Service.didDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:22
Returns void

Protected didDetachRoot

didDetachRoot(root: V): void

Inherited from Service.didDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:15
Parameters
- root: V
Returns void

Protected didObserve

didObserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.didObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:27
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Protected didReorient

didReorient(orientation: OrientationType): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:21
Parameters
- orientation: OrientationType
Returns void

Protected didSetViewIdiom

didSetViewIdiom(newViewIdiom: ViewIdiom, oldViewIdiom: ViewIdiom): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:18
Parameters
- newViewIdiom: ViewIdiom
- oldViewIdiom: ViewIdiom
Returns void

Protected didUnobserve

didUnobserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.didUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:31
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Protected forEachObserver

forEachObserver<T>(callback: (observer: ViewportServiceObserver<V, ViewportService<V>>) => void | T): undefined | T

Inherited from Service.forEachObserver
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:32
Type parameters
- T
Parameters
- callback: (observer: ViewportServiceObserver<V, ViewportService<V>>) => void | T
  - - (observer: ViewportServiceObserver<V, ViewportService<V>>): void | T
    - Parameters
      - observer: ViewportServiceObserver<V, ViewportService<V>>
      Returns void | T
Returns undefined | T

observe

observe(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.observe
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:24
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Protected onAttach

onAttach(): void

Overrides Service.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:23
Returns void

Protected onAttachRoot

onAttachRoot(root: V): void

Inherited from Service.onAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:10
Parameters
- root: V
Returns void

Protected onDetach

onDetach(): void

Overrides Service.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:24
Returns void

Protected onDetachRoot

onDetachRoot(root: V): void

Inherited from Service.onDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:14
Parameters
- root: V
Returns void

Protected onObserve

onObserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Overrides Service.onObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:22
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Protected onReorient

onReorient(orientation: OrientationType): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:20
Parameters
- orientation: OrientationType
Returns void

Protected onSetViewIdiom

onSetViewIdiom(newViewIdiom: ViewIdiom, oldViewIdiom: ViewIdiom): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:17
Parameters
- newViewIdiom: ViewIdiom
- oldViewIdiom: ViewIdiom
Returns void

Protected onUnobserve

onUnobserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.onUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:30
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

setViewIdiom

setViewIdiom(newViewIdiom: ViewIdiom): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:15
Parameters
- newViewIdiom: ViewIdiom
Returns void

Protected throttleReorientation

throttleReorientation(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:34
Returns void

throttleResize

throttleResize(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:28
Returns void

throttleScroll

throttleScroll(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:27
Returns void

Protected throttleViewportResize

throttleViewportResize(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:31
Returns void

unobserve

unobserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.unobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:28
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

updateViewIdiom

updateViewIdiom(viewport: Viewport): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:14
Parameters
- viewport: Viewport
Returns void

Protected willAttach

willAttach(): void

Inherited from Service.willAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:17
Returns void

Protected willAttachRoot

willAttachRoot(root: V): void

Inherited from Service.willAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:9
Parameters
- root: V
Returns void

Protected willDetach

willDetach(): void

Inherited from Service.willDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:20
Returns void

Protected willDetachRoot

willDetachRoot(root: V): void

Inherited from Service.willDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:13
Parameters
- root: V
Returns void

Protected willObserve

willObserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.willObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:25
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Protected willReorient

willReorient(orientation: OrientationType): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:19
Parameters
- orientation: OrientationType
Returns void

Protected willSetViewIdiom

willSetViewIdiom(newViewIdiom: ViewIdiom, oldViewIdiom: ViewIdiom): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:16
Parameters
- newViewIdiom: ViewIdiom
- oldViewIdiom: ViewIdiom
Returns void

Protected willUnobserve

willUnobserve(observer: ViewportServiceObserver<V, ViewportService<V>>): void

Inherited from Service.willUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:29
Parameters
- observer: ViewportServiceObserver<V, ViewportService<V>>
Returns void

Static global

global<V>(): ViewportService<V>

- Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/ViewportService.d.ts:37
Type parameters
- V: View<V>
Returns ViewportService<V>

Generated using TypeDoc