Class SnapZoom

snap-zoom-start(Viewport) emitted each time a fit animation starts snap-zoom-end(Viewport) emitted each time fit reaches its target snap-zoom-end(Viewport) emitted each time fit reaches its target

Hierarchy (View Summary)

Plugin
- SnapZoom

Index

Constructors

constructor

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

Properties

`Protected`ease

ease: any

`Readonly`options

options: Required<ISnapZoomOptions>

`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`snapping

snapping?:
    | {
        deltaX: number;
        deltaY: number;
        startX: number;
        startY: number;
        time: number;
    }
    | null

`Protected`xIndependent

xIndependent: boolean

`Protected`xScale

xScale: number

`Protected`yIndependent

yIndependent: boolean

`Protected`yScale

yScale: number

Methods

destroy

destroy(): void
Called when plugin is removed

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

down

down(): boolean
Handler for pointerdown PIXI event

Returns boolean
Overrides Plugin.down
- Defined in src/plugins/SnapZoom.ts:195

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

resize

resize(): void
Called when the viewport is resized

Returns void
Overrides Plugin.resize
- Defined in src/plugins/SnapZoom.ts:169

resume

resume(): void
Un-pause the plugin

Returns void
Overrides Plugin.resume
- Defined in src/plugins/SnapZoom.ts:278

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
Returns void
Overrides Plugin.update
- Defined in src/plugins/SnapZoom.ts:209

`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(): boolean
Handler for wheel event on div

Returns boolean
Overrides Plugin.wheel
- Defined in src/plugins/SnapZoom.ts:185

Class SnapZoom

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SnapZoom

Properties

Protectedease

Readonlyoptions

Readonlyparent

paused

See

Protected Optionalsnapping

ProtectedxIndependent

ProtectedxScale

ProtectedyIndependent

ProtectedyScale

Methods

destroy

Returns void

down

Returns boolean

ProtectedglobalToParent

Type Parameters

Parameters

Returns P

move

Parameters

Returns boolean

ProtectedparentToViewport

Type Parameters

Parameters

Returns P

pause

Returns void

reset

Returns void

resize

Returns void

resume

Returns void

up

Parameters

Returns boolean

update

Parameters

Returns void

ProtectedviewportToParent

Type Parameters

Parameters

Returns P

wheel

Returns boolean

Settings

On This Page

`Protected`ease

`Readonly`options

`Readonly`parent

`Protected` `Optional`snapping

`Protected`xIndependent

`Protected`xScale

`Protected`yIndependent

`Protected`yScale

`Protected`globalToParent

`Protected`parentToViewport

`Protected`viewportToParent