Mobile Document Scanner API Reference / RectifySettings

Interface: RectifySettings

Defined in: src/settings/settings.ts:256

The settings of the rectify phase.

Properties

container?

optional container?: string | HTMLElement

Defined in: src/settings/settings.ts:263

The element that the rectify screen shows in, or a selector for one. Without it, the rectify screen shows in the element of the screen that opens it. After a capture, this is the element of the capture screen. From the edit screen, it is the element of the edit screen.

---

layout?

optional layout?: RectifyLayout

Defined in: src/settings/settings.ts:275

New content for the header or the footer of the rectify screen, in both modes. The areas work as phases.capture.layout does, with the buttons of RectifyScreenButton. The published file dist/defaults/rectify-layout.xml holds the built-in template of each area, to copy and change.

---

modes?

optional modes?: RectifyModes

Defined in: src/settings/settings.ts:266

The two ways to reach the screen. Set one to false to remove it.