Class Page

Implements

PageType

Constructors

constructor

new Page(options?: Options): Page
创建一个 Page 实例。请使用 create 来创建实例，而不是通过 new 模式创建实例。
Parameters
- Optionaloptions: Options
  使用指定的配置项创建一个 Page 实例。
Returns Page
Example
```
const page = await Page.create();
```

Properties

options

options: Options

Methods

destroy

destroy(): Promise<void>
销毁当前对象。

Returns Promise<void>
Implementation of PageType.destroy

enumObjectsBBox

enumObjectsBBox(filterArr: any[]): Promise<any[]>
枚举页面上对象的边界框。
Parameters
- filterArr: any[]
  用于指定要包含哪些对象的过滤数组。
Returns Promise<any[]>
返回页面上对象边界框的数组。

Implementation of PageType.enumObjectsBBox

generateContent

generateContent(): Promise<void>
生成页面的内容。

Returns Promise<void>
Implementation of PageType.generateContent

getBound

getBound(): Promise<Rect>
获取页面的边界框。

Returns Promise<Rect>
返回页面的边界框。

Implementation of PageType.getBound

getDict

getDict(): Promise<null | PDFDictionaryType>
Gets the page dictionary.

Returns Promise<null | PDFDictionaryType>
Implementation of PageType.getDict

getDoc

getDoc(): Promise<null | DocType>
获取与页面关联的文档。

Returns Promise<null | DocType>
返回与页面关联的文档。

Implementation of PageType.getDoc

getFirstObjectPosition

getFirstObjectPosition(): Promise<null | POSITIONType>
获取第一个对象的位置。

Returns Promise<null | POSITIONType>
返回第一个对象的位置。
Example
```
let pos = await page.getFirstObjectPosition();
```
Implementation of PageType.getFirstObjectPosition

getLastObjectPosition

getLastObjectPosition(): Promise<null | POSITIONType>
获取最后一个对象的位置。

Returns Promise<null | POSITIONType>
返回最后一个对象的位置。

Implementation of PageType.getLastObjectPosition

getNextPosition

getNextPosition(position: POSITIONType): Promise<null | POSITIONType>
获取指定位置之后的下一个对象。
Parameters
- position: POSITIONType
  要获取其下一个对象的位置。
Returns Promise<null | POSITIONType>
返回指定位置之后的下一个 PageObject。

Implementation of PageType.getNextPosition

getObjectAt

getObjectAt(position: POSITIONType): Promise<null | PageObjectType>
获取指定位置的对象。
Parameters
- position: POSITIONType
  要获取对象的位置。
Returns Promise<null | PageObjectType>
返回指定位置的对象。

Implementation of PageType.getObjectAt

getObjectByIndex

getObjectByIndex(index: number): Promise<null | PageObjectType>
通过索引获取对象。
Parameters
- index: number
  要获取的对象的索引。
Returns Promise<null | PageObjectType>
返回指定索引处的 PageObject。

Implementation of PageType.getObjectByIndex

getObjectCount

getObjectCount(): Promise<number>
获取页面上的对象数量。

Returns Promise<number>
返回页面上的对象数量。

Implementation of PageType.getObjectCount

getObjectIndex

getObjectIndex(obj: PageObjectType): Promise<number>
获取指定对象的索引。
Parameters
- obj: PageObjectType
  要获取其索引的对象。
Returns Promise<number>
返回指定对象的索引。

Implementation of PageType.getObjectIndex

getPageHeight

getPageHeight(): Promise<number>
获取页面高度。

Returns Promise<number>
返回页面的高度。

Implementation of PageType.getPageHeight

getPageRotation

getPageRotation(): Promise<number>
获取页面的旋转角度。

Returns Promise<number>
返回页面的旋转角度。

Implementation of PageType.getPageRotation

getPageWidth

getPageWidth(): Promise<number>
获取页面宽度。

Returns Promise<number>
返回页面的宽度。

Implementation of PageType.getPageWidth

getPrevPosition

getPrevPosition(position: POSITIONType): Promise<null | POSITIONType>
获取指定位置之前的对象。
Parameters
- position: POSITIONType
  要获取其前一个对象的位置。
Returns Promise<null | POSITIONType>
Implementation of PageType.getPrevPosition

getTextPage

getTextPage(flag?: number): Promise<null | TextPageType>
获取当前页面的文本页。
Parameters
- flag: number = 0
  文本顺序或显示顺序，例如 DefineConst.FPD_TEXT_STREAM_ORDER、DefineConst.FPD_TEXT_DISPLAY_ORDER。
Returns Promise<null | TextPageType>
获取当前页面的文本页。

Implementation of PageType.getTextPage

insertObject

insertObject(
posInsertAfter: POSITIONType,
newObj: InsertObjectType,
): Promise<null | POSITIONType>
在指定位置之后插入一个对象。
Parameters
- posInsertAfter: POSITIONType
  插入对象的位置。
- newObj: InsertObjectType
  要插入的对象。
Returns Promise<null | POSITIONType>
返回插入对象的位置。
Example
```
let pos = await page.getLastObjectPosition();
let newObj = await PageObject.create({type: 1});
await page.insertObject(pos, newObj);
```
Implementation of PageType.insertObject

isParsed

isParsed(): Promise<boolean>
检查页面是否已被解析。

Returns Promise<boolean>
如果页面已被解析则返回 true，否则返回 false。
Example
```
let isParsed = await page.isParsed();
if (!isParsed) {
   await page.parseContent();
}
```
Implementation of PageType.isParsed

load

load(options: LoadPageType): Promise<void>
构造一个页面。为了节省内存，可以禁用页面缓存功能，这样在页面渲染中使用的图像和遮罩将不会被缓存。当然，这会影响渲染速度。
Parameters
- options: LoadPageType
  输入的加载页面选项。
Returns Promise<void>
Example
```
let page = await Page.create();
if (page === null) {
 throw new Error('Create page failed');
}
await page.load({doc: doc, pageDict: pageDict, pageCache: true});
```
Implementation of PageType.load

moveObject

moveObject(
position: POSITIONType,
newPosAfter: POSITIONType,
): Promise<null | POSITIONType>
将对象从一个位置移动到另一个位置。
Parameters
- position: POSITIONType
  要移动的对象的位置。
- newPosAfter: POSITIONType
  对象移动后所在的新位置。
Returns Promise<null | POSITIONType>
一个 Promise，解析为已移动对象的新位置。

Implementation of PageType.moveObject

opacityBatchUpdate

opacityBatchUpdate(objectIdArr: string[], opacity: number): Promise<boolean>
批量更新指定对象的不透明度。
Parameters
- objectIdArr: string[]
- opacity: number
  要设置的不透明度值（0-100）。
Returns Promise<boolean>
如果操作成功则返回 true。

Implementation of PageType.opacityBatchUpdate

parseContent

parseContent(options?: ParseOptionsType): Promise<void>
解析页面内容。
Parameters
- Optionaloptions: ParseOptionsType
  解析选项。
Returns Promise<void>
Implementation of PageType.parseContent

removeObject

removeObject(position: POSITIONType): Promise<void>
删除指定位置的对象。
Parameters
- position: POSITIONType
  要删除的对象所在的位置。
Returns Promise<void>
当对象被删除时解析的 Promise。

Implementation of PageType.removeObject

removeObjectById

removeObjectById(objId: string): Promise<boolean>
根据对象的 ID 删除对象。
Parameters
- objId: string
  要删除对象的 ID。
Returns Promise<boolean>
如果对象被成功删除则返回 true。

Implementation of PageType.removeObjectById

`Static`create

create(options?: Options): Promise<PageType>
创建一个 Page 实例。
Parameters
- Optionaloptions: Options
  使用指定的选项创建一个 Page 实例。
Returns Promise<PageType>
返回一个 Page 实例。
Example
```
const page = await Page.create();
```