Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadResult

Package version

Text extracted from a page in the input document.

Hierarchy

  • ReadResult

Index

Properties

angle

angle: number

The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].

height

height: number

The height of the image/PDF in pixels/inches, respectively.

Optional lines

lines: TextLine[]

When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.

pageNumber

pageNumber: number

The 1-based page number in the input document.

Optional selectionMarks

selectionMarks: SelectionMark[]

List of selection marks extracted from the page.

unit

The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch".

width

width: number

The width of the image/PDF in pixels/inches, respectively.

Generated using TypeDoc