Class DocView

constructor

• new DocView(options?: Options): DocView

  Create a DocView instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    The options to create a DocView instance.

  Returns DocView

  Example

   const docview = await DocView.create();
  Copy

doc

options

destroy

• destroy(): Promise<void>

  Destroy DocView instance.

  Returns Promise<void>

drawNow

• drawNow(): Promise<void>

  Immediately render the current view.

  Returns Promise<void>

getCurrentPageView

• getCurrentPageView(): Promise<null | PageViewType>

  Retrieve the current page.

  Returns Promise<null | PageViewType>

  • The current PageView object.

getDoc

• getDoc(): Promise<null | DocType>

  Retrieve the PDF document object.

  Returns Promise<null | DocType>

  • A PDF document object

getLayoutMode

• getLayoutMode(): Promise<FRDOCVIEW_LAYOUTMODE>

  Retrieve the layout mode.

  Returns Promise<FRDOCVIEW_LAYOUTMODE>

  The return value includes:

  • 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>

  Retrieve the page view.

  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.

  Parameters

  • point: Point

    The view coordinates.

  Returns Promise<null | PageViewType>

getPageViewCount

• getPageViewCount(): Promise<number>

  Retrieve the number of page views.

  Returns Promise<number>

  • The number of page views

getRotation

• getRotation(): Promise<number>

  Retrieve the rotation angle.

  Returns Promise<number>

  • The rotation angle.

getVisiblePageView

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

  Retrieve the visible page view based on the index.

  Parameters

  • index: number

    The page index, starting from 0.

  Returns Promise<null | PageViewType>

  • PageView object.

getZoom

• getZoom(): Promise<number>

  Retrieve the zoom ratio

  Returns Promise<number>

  • The zoom ratio

getZoomType

• getZoomType(): Promise<FRDOCVIEW_ZOOMTYPE>

  Retrieve the zoom type.

  Returns Promise<FRDOCVIEW_ZOOMTYPE>

  The return value includes:

  • 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>

  Navigate to the previous position.

  Returns Promise<void>

goForward

• goForward(): Promise<void>

  Navigate to the next position.

  Returns Promise<void>

gotoPageView

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

  Navigate to the specified page.

  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.

  Parameters

  • index: number

    The page number, starting from 0.
  • rect: Rect

    The rectangular area.
  • isTopUp: boolean = true

    Whether to scroll to the top or bottom of the page. Defaults to true.
  • maxScale: number = 1

    The maximum zoom ratio. Defaults to 1.

  Returns Promise<boolean>

scrollTo

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

  Scroll to the specified coordinates.

  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.

  Parameters

  • mode: FRDOCVIEW_LAYOUTMODE

    The layout mode

  Returns Promise<void>

setRotation

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

  Set the rotation angle.

  Parameters

  • rotation: Rotation

    The rotation angle.

  Returns Promise<void>

zoomTo

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

  Zoom to the specified scale ratio.

  Parameters

  • scale: number

    The scale ratio
  • Optionalmode: FRDOCVIEW_ZOOMTYPE

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

  Returns Promise<void>

Staticcreate

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

  Create DocView instance.

  Parameters

  • Optionaloptions: Options

    Configuration options required for creation, including necessary initialization information.

  Returns Promise<DocViewType>

  • A DocView instance.

  Example

   const docview = await DocView.create();
  Copy