Skip to content

ViewportHandle

Defined in: src/components/primitives/viewport/Viewport.types.ts:132

Methods

centerOn()

centerOn(point, zoom?): void

Defined in: src/components/primitives/viewport/Viewport.types.ts:141

Center the viewport on a world point, optionally setting zoom.

Parameters

point

Point2D

zoom?

number

Returns

void


fitToContent()

fitToContent(bounds, padding?): void

Defined in: src/components/primitives/viewport/Viewport.types.ts:137

Pan and zoom so that bounds fits inside the viewport with optional inner padding. Padding is in screen pixels (deducted from the viewport on each side).

Parameters

bounds

WorldRect

padding?

number

Returns

void


getSize()

getSize(): ViewportSize

Defined in: src/components/primitives/viewport/Viewport.types.ts:145

Read the current viewport size in CSS pixels.

Returns

ViewportSize


getTransform()

getTransform(): ViewportTransform

Defined in: src/components/primitives/viewport/Viewport.types.ts:143

Read the current transform.

Returns

ViewportTransform


invalidate()

invalidate(layerName?): void

Defined in: src/components/primitives/viewport/Viewport.types.ts:150

Force a redraw. With no layerName, all layers redraw on the next frame; with layerName, only that layer redraws.

Parameters

layerName?

string

Returns

void


zoomToRect()

zoomToRect(rect, padding?): void

Defined in: src/components/primitives/viewport/Viewport.types.ts:139

Alias for fitToContent — pan/zoom to fit the given world rect.

Parameters

rect

WorldRect

padding?

number

Returns

void