Skip to content

API reference / Common / Fit

Interface: Fit ​

A fit configuration: the [FitMode] plus the zoom ceiling the derived zoom is clamped to.

The ceiling rides with the fit because it isn't a property of the mode alone — a host opens a paged text document fit-to-width but capped at 1.0 (never enlarge a small page past natural size), while the same fit-to-width chosen from a menu is uncapped. Carrying it here keeps set_fit and fit symmetric.

Properties ​

PropertyDescription
mode
FitMode
Which dimension(s) of the spread to fit.
zoomCap
number | null
Ceiling the derived zoom is clamped to — Some(1.0) never enlarges past natural size, None is uncapped. Ignored when mode is [FitMode::None].