Skip to main content

PanOptions

Options for configuring the pan behavior of a canvas.

Implements

Constructors

new PanOptions()

new PanOptions(options): PanOptions

Creates a new instance of PanOptions.

Parameters

options: Partial<IPanOptions> = {}

The partial options provided by the user.

Returns

PanOptions

Defined in

options/PanOptions.ts:31

Properties

mouseButtons

mouseButtons: MouseButton[]

List of mouse buttons that are used for panning.

Implementation of

IPanOptions.mouseButtons

Defined in

options/PanOptions.ts:11


useMouse

useMouse: boolean

Whether panning with the mouse is enabled.

Implementation of

IPanOptions.useMouse

Defined in

options/PanOptions.ts:16


DefaultOptions

readonly static DefaultOptions: IPanOptions

Default pan options.

Defined in

options/PanOptions.ts:21