Interface: PanZoomControlsOptions

Defined in: src/interaction/PanZoomControls.ts:31

Options for PanZoomControls.

Properties

bounds?

optional bounds: PanZoomBounds

Defined in: src/interaction/PanZoomControls.ts:58

Clamp the camera center to these world bounds. Defaults to null (no bounds).

---

enabled?

optional enabled: boolean

Defined in: src/interaction/PanZoomControls.ts:60

Attach listeners immediately. Defaults to true. Set false to attach later with enable().

---

enablePanX?

optional enablePanX: boolean

Defined in: src/interaction/PanZoomControls.ts:52

Allow panning along the x axis. Defaults to true.

---

enablePanY?

optional enablePanY: boolean

Defined in: src/interaction/PanZoomControls.ts:54

Allow panning along the y axis. Defaults to true.

---

enableZoom?

optional enableZoom: boolean

Defined in: src/interaction/PanZoomControls.ts:56

Allow wheel zoom. Defaults to true.

---

invertZoom?

optional invertZoom: boolean

Defined in: src/interaction/PanZoomControls.ts:50

Invert the wheel zoom direction. Defaults to false.

---

maxZoom?

optional maxZoom: number

Defined in: src/interaction/PanZoomControls.ts:41

Maximum zoom-in factor relative to the frame size at construction (zoom = baseFrameWidth / frameWidth). Defaults to 10.

---

minZoom?

optional minZoom: number

Defined in: src/interaction/PanZoomControls.ts:46

Maximum zoom-out factor relative to the frame size at construction. Defaults to 0.1.

---

onChange()?

optional onChange: () => void

Defined in: src/interaction/PanZoomControls.ts:65

Called after each pan or zoom change. Use it to re-render the scene, e.g. { onChange: () => scene.render() }.

Returns

void

---

panButton?

optional panButton: number

Defined in: src/interaction/PanZoomControls.ts:48

Mouse button that starts a pan drag (0 = left, 1 = middle, 2 = right). Defaults to 0.

---

zoomSpeed?

optional zoomSpeed: number

Defined in: src/interaction/PanZoomControls.ts:36

Wheel sensitivity. The frame is scaled by exp(deltaY * zoomSpeed) per wheel event, so a larger value zooms faster. Defaults to 0.0015.