Class Wheel

Plugin for handling wheel scrolling for viewport zoom.

wheel-start({event, viewport})

Hierarchy (View Summary)

Plugin
- Wheel

Index

Constructors

Properties

keyIsPressed options parent paused smoothing? smoothingCenter? smoothingCount?

Methods

checkKeyPress destroy down globalToParent handleKeyPresses isAxisX isAxisY move parentToViewport pause reset resize resume up update viewportToParent wheel

Constructors

constructor

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

Properties

`Protected`keyIsPressed

keyIsPressed: boolean

Flags whether the keys required to zoom are pressed currently.

`Readonly`options

options: Required<IWheelOptions>

`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

`Protected` `Optional`smoothing

smoothing?: PointData | null

`Protected` `Optional`smoothingCenter

smoothingCenter?: Point | null

`Protected` `Optional`smoothingCount

smoothingCount?: number

Methods

`Protected`checkKeyPress

checkKeyPress(): boolean
Returns boolean
- Defined in src/plugins/Wheel.ts:197

destroy

destroy(): void
Called when plugin is removed

Returns void
Overrides Plugin.destroy
- Defined in src/plugins/Wheel.ts:184

down

down(): boolean
Handler for pointerdown PIXI event

Returns boolean
Overrides Plugin.down
- Defined in src/plugins/Wheel.ts:202

`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

`Protected`handleKeyPresses

handleKeyPresses(codes: string[]): void
Handles keypress events and set the keyIsPressed boolean accordingly
Parameters
- codes: string[]
  key codes that can be used to trigger zoom event
Returns void
- Defined in src/plugins/Wheel.ts:162

`Protected`isAxisX

isAxisX(): boolean
Returns boolean
- Defined in src/plugins/Wheel.ts:212

`Protected`isAxisY

isAxisY(): boolean
Returns boolean
- Defined in src/plugins/Wheel.ts:217

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
Inherited from Plugin.reset
- Defined in src/plugins/Plugin.ts:109

resize

resize(): void
Called when the viewport is resized

Returns void
Inherited from Plugin.resize
- Defined in src/plugins/Plugin.ts:103

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(): void
Called on each tick

Returns void
Overrides Plugin.update
- Defined in src/plugins/Wheel.ts:222

`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
Handler for wheel event on div
Parameters
- e: WheelEvent
Returns boolean
Overrides Plugin.wheel
- Defined in src/plugins/Wheel.ts:326