Class MouseEdges

Scroll viewport when mouse hovers near one of the edges.

Deprecated

use EdgeScroll (viewport.edgeScroll()) instead: its speed is in screen pixels per second, while this plugin's speed scrolls by speed * speed * 0.06 world pixels per frame. Kept unchanged for compatibility.

mouse-edge-start(Viewport) emitted when mouse-edge starts mouse-edge-end(Viewport) emitted when mouse-edge ends

Hierarchy (View Summary)

Plugin
- MouseEdges

Index

Constructors

constructor

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

Properties

`Protected`bottom

bottom: number | null

Scroll region size on the bottom side.

`Protected` `Optional`horizontal

horizontal?: number | null

`Protected`left

left: number | null

Scroll region size on the left side.

`Readonly`options

options: Readonly<Required<IMouseEdgesOptions>>

Options used to initialize this plugin, cannot be modified later.

`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` `Readonly`radiusSquared

radiusSquared: number | null

Radius squared

`Protected` `Readonly`reverse

reverse: -1 | 1

Factor from reverse option.

`Protected`right

right: number | null

Scroll region size on the right side.

`Protected`scrolling

scrolling: boolean = false

Whether the viewport is currently scrolling because of mouse-edges (used for start/end events)

`Protected`top

top: number | null

Scroll region size on the top size.

`Protected` `Optional`vertical

vertical?: number | null

Methods

destroy

destroy(): void
Called when plugin is removed

Returns void
Overrides Plugin.destroy
- Defined in src/plugins/MouseEdges.ts:300

down

down(): boolean
Handler for pointerdown PIXI event

Returns boolean
Overrides Plugin.down
- Defined in src/plugins/MouseEdges.ts:159

`Protected`end

end(): void
Stops scrolling and emits mouse-edge-end if it was scrolling

Returns void
- Defined in src/plugins/MouseEdges.ts:306

`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(event: FederatedPointerEvent): boolean
Handler for pointermove PIXI event
Parameters
- event: FederatedPointerEvent
Returns boolean
Overrides Plugin.move
- Defined in src/plugins/MouseEdges.ts:173

`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
Overrides Plugin.pause
- Defined in src/plugins/MouseEdges.ts:294

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/MouseEdges.ts:139

resume

resume(): void
Un-pause the plugin

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

up

up(): boolean
Handler for pointerup PIXI event

Returns boolean
Overrides Plugin.up
- Defined in src/plugins/MouseEdges.ts:275

update

update(): void
Called on each tick

Returns void
Overrides Plugin.update
- Defined in src/plugins/MouseEdges.ts:316

`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

Class MouseEdges

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MouseEdges

Properties

Protectedbottom

Protected Optionalhorizontal

Protectedleft

Readonlyoptions

Readonlyparent

paused

See

Protected ReadonlyradiusSquared

Protected Readonlyreverse

Protectedright

Protectedscrolling

Protectedtop

Protected Optionalvertical

Methods

destroy

Returns void

down

Returns boolean

Protectedend

Returns void

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

Returns boolean

update

Returns void

ProtectedviewportToParent

Type Parameters

Parameters

Returns P

wheel

Parameters

Returns boolean | undefined

Settings

On This Page

`Protected`bottom

`Protected` `Optional`horizontal

`Protected`left

`Readonly`options

`Readonly`parent

`Protected` `Readonly`radiusSquared

`Protected` `Readonly`reverse

`Protected`right

`Protected`scrolling

`Protected`top

`Protected` `Optional`vertical

`Protected`end

`Protected`globalToParent

`Protected`parentToViewport

`Protected`viewportToParent