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>

销毁 DocView 实例。

doc

doc: null | DocType

drawNow

drawNow: () => Promise<void>

立即渲染当前视图。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getCurrentPageView

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

获取当前页面。

Type declaration

getDoc

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

获取 PDF 文档对象。

Type declaration

    • (): Promise<null | DocType>

    • Returns Promise<null | DocType>

      • 一个 PDF 文档对象。

getLayoutMode

getLayoutMode: () => Promise<FRDOCVIEW_LAYOUTMODE>

获取布局模式。

Type declaration

getPageView

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

获取页面视图。

Type declaration

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

    • Parameters

      • index: number

        页面视图的索引，从 0 开始。

      Returns Promise<null | PageViewType>

      • 页面视图。

getPageViewAtPoint

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

根据坐标获取页面视图。

Type declaration

getPageViewCount

getPageViewCount: () => Promise<number>

获取页面浏览次数。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 页面浏览次数

getRotation

getRotation: () => Promise<number>

获取旋转角度。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 旋转角度。

getVisiblePageView

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

根据索引获取可见的页面视图。

Type declaration

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

    • Parameters

      • index: number

        页面索引，从 0 开始。

      Returns Promise<null | PageViewType>

      • PageView 对象。

getZoom

getZoom: () => Promise<number>

获取缩放比例。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      • 缩放比例。

getZoomType

getZoomType: () => Promise<FRDOCVIEW_ZOOMTYPE>

获取缩放类型。

Type declaration

goBack

goBack: () => Promise<void>

导航到上一个位置。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

goForward

goForward: () => Promise<void>

跳转到下一个位置。

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

gotoPageView

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

导航到指定页面。

Type declaration

    • (index: number): Promise<void>

    • Parameters

      • index: number

        页码，从 0 开始，

      Returns Promise<void>

gotoPageViewByRect

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

导航到指定页面上的指定矩形区域。

Type declaration

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

    • Parameters

      • index: number

        页码，从 0 开始。

      • rect: Rect

        矩形区域。

      • isTopUp: boolean

        是否滚动到页面顶部或底部。

      • maxScale: number

        最大缩放比例。

      Returns Promise<boolean>

options

options: Options

scrollTo

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

滚动到指定坐标。

Type declaration

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

    • Parameters

      • x: number

        目标水平坐标

      • y: number

        目标垂直坐标

      Returns Promise<void>

setLayoutMode

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

设置布局模式。

Type declaration

setRotation

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

设置旋转角度。

Type declaration

    • (rotation: number): Promise<void>

    • Parameters

      • rotation: number

        旋转角度。

      Returns Promise<void>

zoomTo

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

缩放到指定的比例。

Type declaration

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

    • Parameters

      • scale: number

        缩放比例

      • Optionalmode: FRDOCVIEW_ZOOMTYPE

        缩放类型（可选，默认为当前模式）

      Returns Promise<void>

Settings

Member Visibility

On This Page

Properties