weasel API - v0.8.0
    Preparing search index...

    Interface UseZoomOptions

    Prefer the descriptor-based viewport idiom: <SceneCanvas> now registers viewport.pan and viewport.zoom action descriptors via useStandardActions + useGestureDispatcher. Pass useHandTool() via ambient for drag-to-pan. The former useWheelZoomTool, useKeyboardZoomTool, and useWheelPanTool hooks are dissolved. useZoom was the original controller-style API; it remains exported with full test coverage but no kit-internal usage. Slated for removal in a future major.

    interface UseZoomOptions {
        keyStep?: number;
        max?: number;
        min?: number;
        pan: { x: number; y: number };
        setPan: (next: { x: number; y: number }) => void;
        setZoom: (next: number) => void;
        sources?: {
            doubleClick?: boolean;
            keys?: boolean;
            pinch?: boolean;
            wheel?: boolean;
        };
        viewport?: { height: number; width: number };
        wheelRequiresModifier?: boolean;
        wheelStep?: number;
        zoom: number;
    }
    Index

    Properties

    keyStep? max? min? pan setPan setZoom sources? viewport? wheelRequiresModifier? wheelStep? zoom

    Properties

    keyStep?: number
    max?: number
    min?: number
    pan: { x: number; y: number }
    setPan: (next: { x: number; y: number }) => void
    setZoom: (next: number) => void
    sources?: {
        doubleClick?: boolean;
        keys?: boolean;
        pinch?: boolean;
        wheel?: boolean;
    }
    viewport?: { height: number; width: number }
    wheelRequiresModifier?: boolean
    wheelStep?: number
    zoom: number

    Settings

    Member Visibility

    On This Page

    Properties