Class TxTextPage

constructor

• new TxTextPage(options: TxTextPageOptions): TxTextPage

  Constructs an instance of TxTextPage.

  Parameters

  • options: TxTextPageOptions

    Configuration options.

  Returns TxTextPage

Readonlylayout

Readonlytext

hasMoreText

• get hasMoreText(): boolean

  Returns true if there is more text to be laid out.

  Returns boolean

remainingText

• get remainingText(): string

  The portion of the text that has not yet been processed into a page.

  Returns string

measureNextPage

• measureNextPage(): Promise<null | PageData>

  Measures the next page of text using the Canvas 2D API and returns a PageData without rasterizing any sprites. Returns null if there is no remaining text or if no text fits on the page.

  Returns Promise<null | PageData>

rasterizeNextPage

• rasterizeNextPage(): Promise<null | PageData>

  Measures and rasterizes the next page in one call. Returns null if there is no remaining text or nothing fit on the page.

  Returns Promise<null | PageData>