Skip to main content

CanvasOptions

Options for configuring the behavior of a canvas.

Implements​

Constructors​

new CanvasOptions()​

new CanvasOptions(options): CanvasOptions

Creates a new instance of CanvasOptions.

Parameters​

• options: Partial<ICanvasOptions> = {}

The partial options provided by the user.

Returns​

CanvasOptions

Defined in​

options/CanvasOptions.ts:63

Properties​

height​

height: number

The height of the canvas in pixels.

Implementation of​

ICanvasOptions.height

Defined in​

options/CanvasOptions.ts:18


interactive​

interactive: boolean

Determines whether interactivity is enabled for the canvas.

Implementation of​

ICanvasOptions.interactive

Defined in​

options/CanvasOptions.ts:23


pan​

pan: IPanOptions

The options for configuring the pan behavior of the canvas.

Implementation of​

ICanvasOptions.pan

Defined in​

options/CanvasOptions.ts:43


pannable​

pannable: boolean

Whether panning is enabled on the canvas.

Implementation of​

ICanvasOptions.pannable

Defined in​

options/CanvasOptions.ts:38


width​

width: number

The width of the canvas in pixels.

Implementation of​

ICanvasOptions.width

Defined in​

options/CanvasOptions.ts:13


zoom​

zoom: ZoomOptions

The options for configuring the zoom behavior of the canvas.

Implementation of​

ICanvasOptions.zoom

Defined in​

options/CanvasOptions.ts:33


zoomable​

zoomable: boolean

Whether zooming is enabled on the canvas.

Implementation of​

ICanvasOptions.zoomable

Defined in​

options/CanvasOptions.ts:28


DefaultOptions​

readonly static DefaultOptions: ICanvasOptions

Default canvas options.

Defined in​

options/CanvasOptions.ts:48