Class DocView

constructor

• new DocView(options?: Options): DocView

  创建一个 DocView 实例。 不要使用 new 模式创建实例，而应使用 create 来创建实例。

  Parameters

  • Optionaloptions: Options

    用于创建 DocView 实例的选项。

  Returns DocView

  Example

   const docview = await DocView.create();
  Copy

doc

options

destroy

• destroy(): Promise<void>

  销毁 DocView 实例。

  Returns Promise<void>

drawNow

• drawNow(): Promise<void>

  立即渲染当前视图。

  Returns Promise<void>

getCurrentPageView

• getCurrentPageView(): Promise<null | PageViewType>

  获取当前页面。

  Returns Promise<null | PageViewType>

  • 当前的 PageView 对象。

getDoc

• getDoc(): Promise<null | DocType>

  获取 PDF 文档对象。

  Returns Promise<null | DocType>

  • PDF 文档对象

getLayoutMode

• getLayoutMode(): Promise<FRDOCVIEW_LAYOUTMODE>

  获取版式模式。

  Returns Promise<FRDOCVIEW_LAYOUTMODE>

  返回值包括：

  • Enum.FRDOCVIEW_LAYOUTMODE.FR_LAYOUTMODE_SINGLE = 0
  • Enum.FRDOCVIEW_LAYOUTMODE.FR_LAYOUTMODE_CONTINUOUS = 1
  • Enum.FRDOCVIEW_LAYOUTMODE.FR_LAYOUTMODE_FACING = 2
  • Enum.FRDOCVIEW_LAYOUTMODE.FR_LAYOUTMODE_CONTINUOUS_FACING = 3
  • Enum.FRDOCVIEW_LAYOUTMODE.FR_LAYOUTMODE_AUTOMATIC = 4

getPageView

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

  获取页面视图。

  Parameters

  • index: number

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

  Returns Promise<null | PageViewType>

  • 页面视图

getPageViewAtPoint

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

  根据坐标获取页面视图。

  Parameters

  • point: Point

    视图坐标。

  Returns Promise<null | PageViewType>

getPageViewCount

• getPageViewCount(): Promise<number>

  获取页面浏览次数。

  Returns Promise<number>

  • 页面浏览次数

getRotation

• getRotation(): Promise<number>

  获取旋转角度。

  Returns Promise<number>

  • 旋转角度。

getVisiblePageView

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

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

  Parameters

  • index: number

    页面索引，从 0 开始。

  Returns Promise<null | PageViewType>

  • PageView 对象。

getZoom

• getZoom(): Promise<number>

  获取缩放比例

  Returns Promise<number>

  • 缩放比例

getZoomType

• getZoomType(): Promise<FRDOCVIEW_ZOOMTYPE>

  获取缩放类型。

  Returns Promise<FRDOCVIEW_ZOOMTYPE>

  返回值包括：

  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_NONE = 0
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_ACTUAL_SCALE = 1
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_ACTUAL_SIZE = 2
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_FIT_PAGE = 3
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_FIT_WIDTH = 4
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_FIT_HEIGHT = 5
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_FIT_RECTANGLE = 6
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_FIT_VISIBLE = 7
  • Enum.FRDOCVIEW_ZOOMTYPE.FR_ZOOM_MODE_AUTOMATIC = 8

goBack

• goBack(): Promise<void>

  导航到上一个位置。

  Returns Promise<void>

goForward

• goForward(): Promise<void>

  跳转到下一个位置。

  Returns Promise<void>

gotoPageView

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

  导航到指定页面。

  Parameters

  • index: number

    页码，从 0 开始。

  Returns Promise<void>

gotoPageViewByRect

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

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

  Parameters

  • index: number

    页码，从 0 开始。
  • rect: Rect

    矩形区域。
  • isTopUp: boolean = true

    是否滚动到页面顶部或底部。默认为 true。
  • maxScale: number = 1

    最大缩放比例。默认为 1。

  Returns Promise<boolean>

scrollTo

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

  滚动到指定的坐标。

  Parameters

  • x: number

    目标水平坐标。
  • y: number

    目标垂直坐标。

  Returns Promise<void>

setLayoutMode

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

  设置布局模式。

  Parameters

  • mode: FRDOCVIEW_LAYOUTMODE

    布局模式

  Returns Promise<void>

setRotation

• setRotation(rotation: Rotation): Promise<void>

  设置旋转角度。

  Parameters

  • rotation: Rotation

    旋转角度。

  Returns Promise<void>

zoomTo

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

  缩放到指定的比例。

  Parameters

  • scale: number

    缩放比例
  • Optionalmode: FRDOCVIEW_ZOOMTYPE

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

  Returns Promise<void>

Staticcreate

• create(options?: Options): Promise<DocViewType>

  创建 DocView 实例。

  Parameters

  • Optionaloptions: Options

    创建所需的配置选项，包括必要的初始化信息。

  Returns Promise<DocViewType>

  • 一个 DocView 实例。

  Example

   const docview = await DocView.create();
  Copy