Mobile Document Scanner API Reference / EditSettings

Interface: EditSettings

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

The settings of the edit phase.

Properties

buttons?

optional buttons?: ButtonSettingsFor<"cancel" | "undo" | "addPage" | "done" | "thumbnails" | "previousPage" | "nextPage" | "delete" | "redo" | "rectify" | "rotate" | "filter">

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

The settings of each button: whether the screen hides it, and a handler that runs before its default action. If the host application hides the rectify button, the fromEdit mode of the rectify screen turns off. If it hides the filter button, the filter mode turns off. If either mode is off, its button does not show.

---

container?

optional container?: string | HTMLElement

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

The element that the edit screen shows in, or a selector for one.

Default Value

ScannerSettings.container

---

layout?

optional layout?: EditLayout

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

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

---

modeButtons?

optional modeButtons?: ButtonSettingsFor<"cancel" | "apply">

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

The settings of the apply and cancel buttons of each mode: whether the screen hides them, and a handler that runs before their default action.

---

modes?

optional modes?: EditModes

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

The modes that the edit screen opens. Set one to false to remove its button.