pdfrx_web
    Preparing search index...

    Interface PdfZoom

    Zoom state and actions returned by usePdfZoom.

    interface PdfZoom {
        canZoomIn: boolean;
        canZoomOut: boolean;
        fitToHeight: (pageNumber?: number, duration?: number) => void;
        fitToPage: (pageNumber?: number, duration?: number) => void;
        fitToWidth: (pageNumber?: number, duration?: number) => void;
        setZoom: (zoom: number, viewCenter?: Offset, duration?: number) => void;
        setZoomMode: (mode: ZoomMode, duration?: number) => void;
        zoom: number;
        zoomIn: (duration?: number) => void;
        zoomMode: ZoomMode;
        zoomOut: (duration?: number) => void;
    }
    Index
    canZoomIn canZoomOut fitToHeight fitToPage fitToWidth setZoom setZoomMode zoom zoomIn zoomMode zoomOut
    canZoomIn: boolean

    Whether zoomIn would change anything (i.e. the max is not reached).

    canZoomOut: boolean

    Whether zoomOut would change anything.

    fitToHeight: (pageNumber?: number, duration?: number) => void

    Fits a page's height.

    fitToPage: (pageNumber?: number, duration?: number) => void

    Fits a whole page in the viewport (default: the current page).

    fitToWidth: (pageNumber?: number, duration?: number) => void

    Fits a page's width, aligned to its top.

    setZoom: (zoom: number, viewCenter?: Offset, duration?: number) => void

    Sets an absolute zoom, keeping viewCenter (default: the viewport center) fixed.

    setZoomMode: (mode: ZoomMode, duration?: number) => void

    Switches between an explicit zoom, fit-page, and fit-width mode.

    zoom: number

    Current zoom, where 1 means one PDF point per CSS pixel.

    zoomIn: (duration?: number) => void

    Steps to the next zoom stop (√2 apart by default).

    zoomMode: ZoomMode

    Active explicit, fit-page, or fit-width zoom mode.

    zoomOut: (duration?: number) => void

    Steps to the previous zoom stop.

    Settings
    Member Visibility

    On This Page
    Properties