Class ClampZoom

Plugin to clamp the viewport's zoom to a specific range.

Hierarchy (View Summary)

Plugin
- ClampZoom

Index

Constructors

Properties

options parent paused

Methods

clamp destroy down globalToParent move parentToViewport pause reset resize resume up update viewportToParent wheel

Constructors

constructor

new ClampZoom(parent: Viewport, options?: {}): ClampZoom
This is called by Viewport.clampZoom.
Parameters
- parent: Viewport
- options: {} = {}
Returns ClampZoom
Overrides Plugin.constructor
- Defined in src/plugins/ClampZoom.ts:65

Properties

`Readonly`options

options: Required<IClampZoomOptions>

`Readonly`parent

parent: Viewport

The viewport to which this plugin is attached.

paused

paused: boolean

Flags whether this plugin has been "paused".

See

Plugin#pause
Plugin#resume

Methods

clamp

clamp(): void
Clamp the viewport scale zoom)

Returns void
- Defined in src/plugins/ClampZoom.ts:79

destroy

destroy(): void
Called when plugin is removed

Returns void
Inherited from Plugin.destroy
- Defined in src/plugins/Plugin.ts:64

down

down(_e: FederatedEvent): boolean
Handler for pointerdown PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.down
- Defined in src/plugins/Plugin.ts:70

`Protected`globalToParent

globalToParent<P extends PointData>(point: PointData, out: P): P
Converts a global point to the space the viewport moves in: its parent's, or global if it has no parent. A viewport can't measure in its own space, because that space changes as the viewport moves.
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.globalToParent
- Defined in src/plugins/Plugin.ts:35

move

move(_e: FederatedEvent): boolean
Handler for pointermove PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.move
- Defined in src/plugins/Plugin.ts:76

`Protected`parentToViewport

parentToViewport<P extends PointData>(point: PointData, out: P): P
Converts a point in the viewport's parent space (see globalToParent) to the viewport's local space
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.parentToViewport
- Defined in src/plugins/Plugin.ts:50

pause

pause(): void
Pause the plugin

Returns void
Inherited from Plugin.pause
- Defined in src/plugins/Plugin.ts:115

reset

reset(): void
Called when the viewport is manually moved

Returns void
Overrides Plugin.reset
- Defined in src/plugins/ClampZoom.ts:201

resize

resize(): void
Called when the viewport is resized

Returns void
Overrides Plugin.resize
- Defined in src/plugins/ClampZoom.ts:73

resume

resume(): void
Un-pause the plugin

Returns void
Inherited from Plugin.resume
- Defined in src/plugins/Plugin.ts:121

up

up(_e: FederatedEvent): boolean
Handler for pointerup PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.up
- Defined in src/plugins/Plugin.ts:82

update

update(_elapsed: number): void
Called on each tick
Parameters
- _elapsed: number
  time in milliseconds since last update
Returns void
Inherited from Plugin.update
- Defined in src/plugins/Plugin.ts:97

`Protected`viewportToParent

viewportToParent<P extends PointData>(point: PointData, out: P): P
Converts a point in the viewport's local space to its parent space (see globalToParent)
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.viewportToParent
- Defined in src/plugins/Plugin.ts:56

wheel

wheel(_e: WheelEvent): boolean | undefined
Handler for wheel event on div
Parameters
- _e: WheelEvent
Returns boolean | undefined
Inherited from Plugin.wheel
- Defined in src/plugins/Plugin.ts:88