Class PageView

constructor

• new PageView(options?: Options): PageView

  创建一个 PageView 实例。 请使用 create 来创建实例，而不是通过 new 模式创建实例。

  Parameters

  • Optionaloptions: Options

    使用指定的配置项创建一个 PageView 实例。

  Returns PageView

  Example

  const pageView = await PageView.create();
  Copy

doc

docView

Optionaloptions

page

addAnnot

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

  添加注释对象。

  Parameters

  • annotDict: PDFDictionaryType

    输入的注释字典。
  • index: number

    注释的索引。

  Returns Promise<null | AnnotType>

  返回注释对象。

deleteAnnot

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

  删除注释对象。

  Parameters

  • annot: AnnotType

  Returns Promise<boolean>

  如果注释删除成功则返回 true，否则返回 false。

destroy

• destroy(): Promise<void>

  销毁当前对象。

  Returns Promise<void>

deviceRectToPage

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

  将矩形从设备空间转换为用户空间。

  Parameters

  • deviceRect: Rect

    一个设备空间的矩形，其坐标将被转换为用户空间。

  Returns Promise<Rect>

  返回一个用户空间的矩形。

getAnnotAtPoint

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

  获取指定点处的注释对象。

  Parameters

  • point: Point

    要获取注释的点。
  • subType: string

    注释的子类型。

  Returns Promise<null | AnnotType>

  返回注释对象。

  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>

  通过索引获取注释对象。

  Parameters

  • index: number

    注释的索引。

  Returns Promise<null | AnnotType>

  返回注释对象。

getAnnotCount

• getAnnotCount(): Promise<number>

  获取当前页面视图上的注释数量。

  Returns Promise<number>

  返回当前页面视图上的注释数量。

getAnnotList

• getAnnotList(): Promise<AnnotType[]>

  获取当前页面视图的批注列表。

  Returns Promise<AnnotType[]>

  返回当前页面视图的批注列表。

getCurrentMatrix

• getCurrentMatrix(): Promise<Matrix>

  获取当前页面视图的矩阵。

  Returns Promise<Matrix>

  返回当前页面视图的矩阵。

getDoc

• getDoc(): Promise<null | DocType>

  获取文档对象。

  Returns Promise<null | DocType>

  返回文档对象。

getDocView

• getDocView(): Promise<null | DocViewType>

  获取文档视图对象。

  Returns Promise<null | DocViewType>

  返回文档视图对象。

getFocusAnnot

• getFocusAnnot(): Promise<null | AnnotType>

  获取当前聚焦的注解对象。

  Returns Promise<null | AnnotType>

  返回当前聚焦的注解对象。

getPage

• getPage(): Promise<null | PageType>

  获取页面对象。

  Returns Promise<null | PageType>

  返回页面对象。

getPageIndex

• getPageIndex(): Promise<number>

  获取当前页面视图的页索引。

  Returns Promise<number>

  返回当前页面视图的页索引。

getPageRect

• getPageRect(): Promise<Rect>

  获取当前页面视图的矩形区域。

  Returns Promise<Rect>

  返回当前页面视图的矩形区域。

getPageScale

• getPageScale(): Promise<number>

  获取当前页面视图的缩放比例。

  Returns Promise<number>

  返回当前页面视图的缩放比例。

getPageVisibleRect

• getPageVisibleRect(): Promise<Rect>

  获取当前页面视图的可见矩形区域。

  Returns Promise<Rect>

  返回当前页面视图的可见矩形区域。

rectToDevice

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

  将矩形从用户空间转换为设备空间。

  Parameters

  • pageRect: Rect

    一个用户空间的矩形，其坐标将被转换为设备空间。

  Returns Promise<Rect>

  返回一个设备空间的矩形。

renderToBitmap

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

  将当前页面视图渲染到位图。

  Parameters

  • bitmap: DIBitmapType

    目标位图对象。
  • rect: Rect

    矩形区域对象。

  Returns Promise<boolean>

  返回渲染结果，true 表示成功，false 表示失败。

Staticcreate

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

  创建一个 PageView 实例。

  Parameters

  • Optionaloptions: Options

    用于创建 PageView 实例的配置项。

  Returns Promise<PageViewType>

  返回一个 PageView 实例。