Class Page

constructor

• new Page(options?: Options): Page

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

  Parameters

  • Optionaloptions: Options

    Create a Page instance with the specified options.

  Returns Page

  Example

  const page = await Page.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

enumObjectsBBox

• enumObjectsBBox(filterArr: any[]): Promise<any[]>

  Enumerate the bounding boxes of the objects on the page.

  Parameters

  • filterArr: any[]

    The filter array to specify which objects to include.

  Returns Promise<any[]>

  Returns an array of bounding boxes of the objects on the page.

generateContent

• generateContent(): Promise<void>

  Generate the content of the page.

  Returns Promise<void>

getBound

• getBound(): Promise<Rect>

  Get the bounding box of the page.

  Returns Promise<Rect>

  Return the bounding box of the page.

getDict

• getDict(): Promise<null | PDFDictionaryType>

  Gets the page dictionary.

  Returns Promise<null | PDFDictionaryType>

getDoc

• getDoc(): Promise<null | DocType>

  Get the document associated with the page.

  Returns Promise<null | DocType>

  Returns the document associated with the page.

getFirstObjectPosition

• getFirstObjectPosition(): Promise<null | POSITIONType>

  Get the position of first object.

  Returns Promise<null | POSITIONType>

  Return the position of first object.

  Example

  let pos = await page.getFirstObjectPosition();
  Copy

getLastObjectPosition

• getLastObjectPosition(): Promise<null | POSITIONType>

  Get the position of last object.

  Returns Promise<null | POSITIONType>

  Return the position of last object.

getNextPosition

• getNextPosition(position: POSITIONType): Promise<null | POSITIONType>

  Get the next object after the specified position.

  Parameters

  • position: POSITIONType

    The position to get the next object.

  Returns Promise<null | POSITIONType>

  Return the next PageObject after the specified position.

getObjectAt

• getObjectAt(position: POSITIONType): Promise<null | PageObjectType>

  Get the object at the specified position.

  Parameters

  • position: POSITIONType

    The position to get the object.

  Returns Promise<null | PageObjectType>

  Returns the object at the specified position.

getObjectByIndex

• getObjectByIndex(index: number): Promise<null | PageObjectType>

  Get the object by index.

  Parameters

  • index: number

    The index of the object to get.

  Returns Promise<null | PageObjectType>

  Return the PageObject at the specified index.

getObjectCount

• getObjectCount(): Promise<number>

  Get the number of objects on the page.

  Returns Promise<number>

  Return the number of objects on the page.

getObjectIndex

• getObjectIndex(obj: PageObjectType): Promise<number>

  Get the index of the specified object.

  Parameters

  • obj: PageObjectType

    The object to get the index of.

  Returns Promise<number>

  Return the index of the specified object.

getPageHeight

• getPageHeight(): Promise<number>

  Get the page height.

  Returns Promise<number>

  Returns the height of the page.

getPageRotation

• getPageRotation(): Promise<number>

  Get the page rotation.

  Returns Promise<number>

  Returns the rotation of the page.

getPageWidth

• getPageWidth(): Promise<number>

  Get the page width.

  Returns Promise<number>

  Returns the width of the page.

getPrevPosition

• getPrevPosition(position: POSITIONType): Promise<null | POSITIONType>

  Get the previous object before the specified position.

  Parameters

  • position: POSITIONType

    The position to get the previous object.

  Returns Promise<null | POSITIONType>

getTextPage

• getTextPage(flag?: number): Promise<null | TextPageType>

  Get the text page of the current page.

  Parameters

  • flag: number = 0

    Text order or display order, like DefineConst.FPD_TEXT_STREAM_ORDER, DefineConst.FPD_TEXT_DISPLAY_ORDER.

  Returns Promise<null | TextPageType>

  Get the text page of the current page.

insertObject

• insertObject(
      posInsertAfter: POSITIONType,
      newObj: InsertObjectType,
  ): Promise<null | POSITIONType>

  Insert an object after the specified position.

  Parameters

  • posInsertAfter: POSITIONType

    The position the object is inserted.
  • newObj: InsertObjectType

    The object to be inserted.

  Returns Promise<null | POSITIONType>

  Return the position of the inserted object.

  Example

  let pos = await page.getLastObjectPosition();
  let newObj = await PageObject.create({type: 1});
  await page.insertObject(pos, newObj);
  Copy

isParsed

• isParsed(): Promise<boolean>

  Check if the page has been parsed.

  Returns Promise<boolean>

  Return true if the page has been parsed, otherwise return false.

  Example

  let isParsed = await page.isParsed();
  if (!isParsed) {
     await page.parseContent();
  }
  Copy

load

• load(options: LoadPageType): Promise<void>

  Construct a page. For saving memory, the page caching feature can be disabled, then images and masks used in page rendering won't be cached. Of course this will affect the speed.

  Parameters

  • options: LoadPageType

    The input load page options.

  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});
  Copy

moveObject

• moveObject(
      position: POSITIONType,
      newPosAfter: POSITIONType,
  ): Promise<null | POSITIONType>

  Move the object from one position to another.

  Parameters

  • position: POSITIONType

    The position of the object to be moved.
  • newPosAfter: POSITIONType

    The new position after which the object is moved.

  Returns Promise<null | POSITIONType>

  A promise that resolves to the new position of the moved object.

opacityBatchUpdate

• opacityBatchUpdate(objectIdArr: string[], opacity: number): Promise<boolean>

  Batch update the opacity of the specified objects.

  Parameters

  • objectIdArr: string[]
  • opacity: number

    The opacity value to set (0-100).

  Returns Promise<boolean>

  Returns true if the operation was successful.

parseContent

• parseContent(options?: ParseOptionsType): Promise<void>

  Parse the content of the page.

  Parameters

  • Optionaloptions: ParseOptionsType

    The parse options.

  Returns Promise<void>

removeObject

• removeObject(position: POSITIONType): Promise<void>

  Remove the object at the specified position.

  Parameters

  • position: POSITIONType

    The position of the object to be removed.

  Returns Promise<void>

  A promise that resolves when the object has been removed.

removeObjectById

• removeObjectById(objId: string): Promise<boolean>

  Remove an object by its ID.

  Parameters

  • objId: string

    The ID of the object to remove.

  Returns Promise<boolean>

  Returns true if the object was successfully removed.

Staticcreate

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

  Create a Page instance.

  Parameters

  • Optionaloptions: Options

    Create a Page instance with the specified options.

  Returns Promise<PageType>

  Return a Page instance.

  Example

  const page = await Page.create();
  Copy