Interface UseZoomReturn

Deprecated

See UseZoomOptions deprecation note. Prefer the descriptor-based viewport idiom.

interface UseZoomReturn {
    onDoubleClick(e: MouseEvent | MouseEvent<Element, MouseEvent>): void;
    onKeyDown(e: KeyboardEvent | KeyboardEvent<Element>): void;
    onWheel(e: WheelEvent | WheelEvent<Element>): void;
    reset(): void;
    zoomBy(factor: number, focal?: { x: number; y: number }): void;
    zoomTo(level: number, focal?: { x: number; y: number }): void;
}

Index

Methods

onDoubleClick onKeyDown onWheel reset zoomBy zoomTo

Methods

onDoubleClick

onDoubleClick(e: MouseEvent | MouseEvent<Element, MouseEvent>): void
Parameters
- e: MouseEvent | MouseEvent<Element, MouseEvent>
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:38

onKeyDown

onKeyDown(e: KeyboardEvent | KeyboardEvent<Element>): void
Parameters
- e: KeyboardEvent | KeyboardEvent<Element>
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:37

onWheel

onWheel(e: WheelEvent | WheelEvent<Element>): void
Parameters
- e: WheelEvent | WheelEvent<Element>
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:36

reset

reset(): void
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:41

zoomBy

zoomBy(factor: number, focal?: { x: number; y: number }): void
Parameters
- factor: number
- Optionalfocal: { x: number; y: number }
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:40

zoomTo

zoomTo(level: number, focal?: { x: number; y: number }): void
Parameters
- level: number
- Optionalfocal: { x: number; y: number }
Returns void
- Defined in packages/core/src/core/viewport/useZoom.ts:39

Interface UseZoomReturn

Deprecated

Index

Methods

Methods

onDoubleClick

Parameters

Returns void

onKeyDown

Parameters

Returns void

onWheel

Parameters

Returns void

reset

Returns void

zoomBy

Parameters

Returns void

zoomTo

Parameters

Returns void

Settings

On This Page