Interface TextPageType

interface TextPageType {
    createPageTextSearch: () => Promise<PageTextSearchType>;
    destroy: () => Promise<void>;
    getRectArray: (
        start: number,
        count: number,
    ) => Promise<null | FloatRectArrayType>;
    getTextByRect: (rect: Rect) => Promise<string>;
    isParsed: () => Promise<boolean>;
    options: Options;
    parseTextPage: () => Promise<boolean>;
}

Implemented by

Properties

createPageTextSearch destroy getRectArray getTextByRect isParsed options parseTextPage

Properties

createPageTextSearch

createPageTextSearch: () => Promise<PageTextSearchType>

Create a PageTextSearch object.

Type declaration

destroy

destroy: () => Promise<void>

Destroy the TextPage object.

getRectArray

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

Get the rectangle array for character index interzone.

Type declaration

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

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

getTextByRect

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

Get the text by rect.

Type declaration

    • (rect: Rect): Promise<string>

    • Parameters

      • rect: Rect

        The rect object.

      Returns Promise<string>

      Returns the text.

isParsed

isParsed: () => Promise<boolean>

Check whether the text page has been parsed.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

      True means has been parsed, otherwise false.

Example

let bRet = await textPage.isParsed();

options

options: Options

parseTextPage

parseTextPage: () => Promise<boolean>

The page object may have parsed content objects.

Type declaration

    • (): Promise<boolean>

    • 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();

Settings

Member Visibility

On This Page

Properties