Mobile Document Scanner API Reference / ScannedPage

Interface: ScannedPage

Defined in: src/results.ts:128

A page of the scanned document.

Properties

boundary

readonly boundary: Quadrilateral

Defined in: src/results.ts:146

The boundary that the page was rectified to, in the coordinates of original. For a page that was not rectified, it is the whole image.

---

id

readonly id: PageId

Defined in: src/results.ts:130

The identifier of the page, which stays the same when the page moves.

---

index

readonly index: number

Defined in: src/results.ts:132

The position of the page in the document when the document scanner made this object.

---

origin

readonly origin: "camera" | "file"

Defined in: src/results.ts:134

Where the page came from.

---

original

readonly original: PageImage

Defined in: src/results.ts:136

The page as the camera or the file gave it, before any processing.

---

processed

readonly processed: PageImage

Defined in: src/results.ts:141

The page rectified to boundary, with every later edit applied. It can be a raster image when original is a vector image.