Interface DocViewType

interface DocViewType {
    destroy: () => Promise<void>;
    doc: null | DocType;
    drawNow: () => Promise<void>;
    getCurrentPageView: () => Promise<null | PageViewType>;
    getDoc: () => Promise<null | DocType>;
    getLayoutMode: () => Promise<FRDOCVIEW_LAYOUTMODE>;
    getPageView: (index: number) => Promise<null | PageViewType>;
    getPageViewAtPoint: (point: Point) => Promise<null | PageViewType>;
    getPageViewCount: () => Promise<number>;
    getRotation: () => Promise<number>;
    getVisiblePageView: (index: number) => Promise<null | PageViewType>;
    getZoom: () => Promise<number>;
    getZoomType: () => Promise<FRDOCVIEW_ZOOMTYPE>;
    goBack: () => Promise<void>;
    goForward: () => Promise<void>;
    gotoPageView: (index: number) => Promise<void>;
    gotoPageViewByRect: (
        index: number,
        rect: Rect,
        isTopUp: boolean,
        maxScale: number,
    ) => Promise<boolean>;
    options: Options;
    scrollTo: (x: number, y: number) => Promise<void>;
    setLayoutMode: (mode: FRDOCVIEW_LAYOUTMODE) => Promise<void>;
    setRotation: (rotation: number) => Promise<void>;
    zoomTo: (scale: number, mode?: FRDOCVIEW_ZOOMTYPE) => Promise<void>;
}

Implemented by

Properties

destroy doc drawNow getCurrentPageView getDoc getLayoutMode getPageView getPageViewAtPoint getPageViewCount getRotation getVisiblePageView getZoom getZoomType goBack goForward gotoPageView gotoPageViewByRect options scrollTo setLayoutMode setRotation zoomTo

Properties

destroy

destroy: () => Promise<void>

Destroy DocView instance.

doc

doc: null | DocType

drawNow

drawNow: () => Promise<void>

Immediately render the current view.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getCurrentPageView

getCurrentPageView: () => Promise<null | PageViewType>

Retrieve the current page.

Type declaration

getDoc

getDoc: () => Promise<null | DocType>

Retrieve the PDF document object.

Type declaration

    • (): Promise<null | DocType>

    • Returns Promise<null | DocType>

      • A PDF document object.

getLayoutMode

getLayoutMode: () => Promise<FRDOCVIEW_LAYOUTMODE>

Retrieve the layout mode.

Type declaration

getPageView

getPageView: (index: number) => Promise<null | PageViewType>

Retrieve the page view.

Type declaration

    • (index: number): Promise<null | PageViewType>

    • Parameters

      • index: number

        The index of the page view, starting from 0.

      Returns Promise<null | PageViewType>

      • A page view.

getPageViewAtPoint

getPageViewAtPoint: (point: Point) => Promise<null | PageViewType>

Retrieve the page view based on coordinates.

Type declaration

getPageViewCount

getPageViewCount: () => Promise<number>

Retrieve the number of page views.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • The number of page views

getRotation

getRotation: () => Promise<number>

Retrieve the rotation angle.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • The rotation angle.

getVisiblePageView

getVisiblePageView: (index: number) => Promise<null | PageViewType>

Retrieve the visible page view based on the index.

Type declaration

    • (index: number): Promise<null | PageViewType>

    • Parameters

      • index: number

        The page index, starting from 0.

      Returns Promise<null | PageViewType>

      • PageView object.

getZoom

getZoom: () => Promise<number>

Retrieve the zoom ratio.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • The zoom ratio.

getZoomType

getZoomType: () => Promise<FRDOCVIEW_ZOOMTYPE>

Retrieve the zoom type.

Type declaration

goBack

goBack: () => Promise<void>

Navigate to the previous position.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

goForward

goForward: () => Promise<void>

Navigate to the next position.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

gotoPageView

gotoPageView: (index: number) => Promise<void>

Navigate to the specified page.

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        The page number, starting from 0,

      Returns Promise<void>

gotoPageViewByRect

gotoPageViewByRect: (
    index: number,
    rect: Rect,
    isTopUp: boolean,
    maxScale: number,
) => Promise<boolean>

Navigate to the specified rectangular area on the specified page.

Type declaration

    • (
          index: number,
          rect: Rect,
          isTopUp: boolean,
          maxScale: number,
      ): Promise<boolean>

    • Parameters

      • index: number

        The page number, starting from 0.

      • rect: Rect

        The rectangular area.

      • isTopUp: boolean

        Whether to scroll to the top or bottom of the page.

      • maxScale: number

        The maximum zoom ratio.

      Returns Promise<boolean>

options

options: Options

scrollTo

scrollTo: (x: number, y: number) => Promise<void>

Scroll to the specified coordinates.

Type declaration

    • (x: number, y: number): Promise<void>

    • Parameters

      • x: number

        The target horizontal coordinate

      • y: number

        The target vertical coordinate

      Returns Promise<void>

setLayoutMode

setLayoutMode: (mode: FRDOCVIEW_LAYOUTMODE) => Promise<void>

Set the layout mode.

Type declaration

setRotation

setRotation: (rotation: number) => Promise<void>

Set the rotation angle.

Type declaration

    • (rotation: number): Promise<void>

    • Parameters

      • rotation: number

        The rotation angle.

      Returns Promise<void>

zoomTo

zoomTo: (scale: number, mode?: FRDOCVIEW_ZOOMTYPE) => Promise<void>

Zoom to the specified scale ratio.

Type declaration

    • (scale: number, mode?: FRDOCVIEW_ZOOMTYPE): Promise<void>

    • Parameters

      • scale: number

        The scale ratio

      • Optionalmode: FRDOCVIEW_ZOOMTYPE

        The zoom type (optional, defaults to the current mode)

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties