Class TextPage

constructor

• new TextPage(options: Options): TextPage

  Creates an instance of TextPage. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • options: Options

    Create a TextPage instance with the specified options.

    let textPage = await TextPage.create({
        page,
        flag: 0,
    });
    Copy

  Returns TextPage

options

createPageTextSearch

• createPageTextSearch(): Promise<PageTextSearchType>

  Create a PageTextSearch object.

  Returns Promise<PageTextSearchType>

  Returns a PageTextSearch object.

destroy

• destroy(): Promise<void>

  Destroy the TextPage object.

  Returns Promise<void>

getRectArray

• getRectArray(start: number, count: number): Promise<null | FloatRectArrayType>

  Get the rectangle array for character index interzone.

  Parameters

  • start: number

    The start character index.
  • count: number

    The count of characters.

  Returns Promise<null | FloatRectArrayType>

  Example

  let textPage = await TextPage.create({
      page,
      flag: 0
  });
  await textPage.parseTextPage();
  let pageTextSearch = await textPage.createPageTextSearch();
  let bFind = await pageTextSearch.findFirst("search text", 0, 0);
  if (bFind) {
     let floatRectArray = await textPage.getRectArray(0, 10);
  }
  Copy

getTextByRect

• getTextByRect(rect: Rect): Promise<string>

  Get the text by rect.

  Parameters

  • rect: Rect

    The rect object.

  Returns Promise<string>

  Returns the text.

isParsed

• isParsed(): Promise<boolean>

  Check whether the text page has been parsed.

  Returns Promise<boolean>

  True means has been parsed, otherwise false.

  Example

  let bRet = await textPage.isParsed();
  Copy

parseTextPage

• parseTextPage(): Promise<boolean>

  The page object may have parsed content objects.

  Returns Promise<boolean>

  True if the parsing is successful, otherwise false.

  Example

  let textPage = await TextPage.create({
      page,
      flag: 0
  });
  let bRet = await textPage.parseTextPage();
  Copy

Staticcreate

• create(options: Options): Promise<TextPageType>

  Create a TextPage instance with the specified options.

  Parameters

  • options: Options

    Create a TextPage instance with the specified options.

  Returns Promise<TextPageType>

  Returns a TextPage instance.

  Example

  let textPage = await TextPage.create({
      page,
      flag: 0,
  });
  Copy