Class PageView

constructor

• new PageView(options?: Options): PageView

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

  Parameters

  • Optionaloptions: Options

    Create a PageView instance with the specified options.

  Returns PageView

  Example

  const pageView = await PageView.create();
  Copy

doc

docView

Optionaloptions

page

addAnnot

• addAnnot(annotDict: PDFDictionaryType, index: number): Promise<null | AnnotType>

  Add an annotation object.

  Parameters

  • annotDict: PDFDictionaryType

    The input annotation dictionary.
  • index: number

    The index of the annotation.

  Returns Promise<null | AnnotType>

  Return the annotation object.

deleteAnnot

• deleteAnnot(annot: AnnotType): Promise<boolean>

  Delete the annotation object.

  Parameters

  • annot: AnnotType

  Returns Promise<boolean>

  Return true if the annotation is deleted successfully, otherwise return false.

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

deviceRectToPage

• deviceRectToPage(deviceRect: Rect): Promise<Rect>

  Transforms a rectangle from device space to user space.

  Parameters

  • deviceRect: Rect

    A device space rectangle whose coordinates are transformed to user space.

  Returns Promise<Rect>

  Return a user space rectangle.

getAnnotAtPoint

• getAnnotAtPoint(point: Point, subType: string): Promise<null | AnnotType>

  Get the annotation object at the specified point.

  Parameters

  • point: Point

    The point to get the annotation.
  • subType: string

    The subtype of the annotation.

  Returns Promise<null | AnnotType>

  Return the annotation object.

  Example

  const doc = await app.getActiveDoc();
  const docView = await doc.getDocView(0);
  const pageView = await docView.getCurrentPageView();
  const pt = {
     x: 10,
     y: 10
  }
  await pageview.GetAnnotAtPoint(pt, 'Highlight);
  Copy

getAnnotByIndex

• getAnnotByIndex(index: number): Promise<null | AnnotType>

  Get the annotation object by index.

  Parameters

  • index: number

    The index of the annotation.

  Returns Promise<null | AnnotType>

  Return the annotation object.

getAnnotCount

• getAnnotCount(): Promise<number>

  Get the number of annotations on the current pageview.

  Returns Promise<number>

  Return the number of annotations on the current pageview.

getAnnotList

• getAnnotList(): Promise<AnnotType[]>

  Get the annotation list of the current pageview.

  Returns Promise<AnnotType[]>

  Return the annotation list of the current pageview.

getCurrentMatrix

• getCurrentMatrix(): Promise<Matrix>

  Get the current matrix of the page view.

  Returns Promise<Matrix>

  Return the current matrix of the page view.

getDoc

• getDoc(): Promise<null | DocType>

  Get the document object.

  Returns Promise<null | DocType>

  Return the document object.

getDocView

• getDocView(): Promise<null | DocViewType>

  Get the document view object.

  Returns Promise<null | DocViewType>

  Return the document view object.

getFocusAnnot

• getFocusAnnot(): Promise<null | AnnotType>

  Get the focus annotation object.

  Returns Promise<null | AnnotType>

  Return the focus annotation object.

getPage

• getPage(): Promise<null | PageType>

  Get the page object.

  Returns Promise<null | PageType>

  Return the page object.

getPageIndex

• getPageIndex(): Promise<number>

  Get the page index of the current pageview.

  Returns Promise<number>

  Return the page index of the current pageview.

getPageRect

• getPageRect(): Promise<Rect>

  Get the rectangle of the current pageview.

  Returns Promise<Rect>

  Return the rectangle of the current pageview.

getPageScale

• getPageScale(): Promise<number>

  Get the scale of the current pageview.

  Returns Promise<number>

  Return the scale of the current pageview.

getPageVisibleRect

• getPageVisibleRect(): Promise<Rect>

  Get the visible rectangle of the current pageview.

  Returns Promise<Rect>

  Return the visible rectangle of the current pageview.

rectToDevice

• rectToDevice(pageRect: Rect): Promise<Rect>

  Transforms a rectangle from user space to device space.

  Parameters

  • pageRect: Rect

    A user space rectangle whose coordinates are transformed to device space.

  Returns Promise<Rect>

  Return a device space rectangle.

renderToBitmap

• renderToBitmap(bitmap: DIBitmapType, rect: Rect): Promise<boolean>

  Render the current page view to a bitmap.

  Parameters

  • bitmap: DIBitmapType

    The target bitmap object.
  • rect: Rect

    The rectangle area object.

  Returns Promise<boolean>

  Return the rendering result, true indicates success, false indicates failure.

Staticcreate

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

  Create a PageView instance.

  Parameters

  • Optionaloptions: Options

    The options to create a PageView instance.

  Returns Promise<PageViewType>

  Return a PageView instance.