pdfrx_web
    Preparing search index...

    Interface PdfNavigation

    Navigation state and actions returned by usePdfNavigation.

    interface PdfNavigation {
        canGoNext: boolean;
        canGoPrevious: boolean;
        currentPageNumber: number | null;
        ensureVisiblePageRect: (
            pageNumber: number,
            rect: PdfRect,
            margin?: number,
        ) => void;
        goToDest: (dest: PdfDest | null, duration?: number) => void;
        goToNextPage: (duration?: number) => void;
        goToPage: (pageNumber: number, duration?: number) => void;
        goToPreviousPage: (duration?: number) => void;
        pageCount: number;
    }
    Index
    canGoNext canGoPrevious currentPageNumber ensureVisiblePageRect goToDest goToNextPage goToPage goToPreviousPage pageCount
    canGoNext: boolean

    Whether goToNextPage would do anything.

    canGoPrevious: boolean

    Whether goToPreviousPage would do anything.

    currentPageNumber: number | null

    The most-visible page (1-based), or null when no document is shown.

    ensureVisiblePageRect: (
        pageNumber: number,
        rect: PdfRect,
        margin?: number,
    ) => void

    Scrolls the minimum amount to bring a rect on a page into view, keeping the zoom.

    goToDest: (dest: PdfDest | null, duration?: number) => void

    Follows an outline/link destination. Falls back to the page when the dest has no view.

    goToNextPage: (duration?: number) => void
    goToPage: (pageNumber: number, duration?: number) => void

    Navigates to a 1-based page number while preserving the current zoom mode. Fit modes refit the target page; an explicit zoom preserves its factor.

    goToPreviousPage: (duration?: number) => void
    pageCount: number

    Number of pages, or 0 when nothing is open.

    Settings
    Member Visibility

    On This Page
    Properties