Interface IAspectRatioContentDisplayAreaOptions

Restrict the Content Display Area based on a fixed aspect-ratio.

interface IAspectRatioContentDisplayAreaOptions {
    aspectRatio?: number;
    insets?: IRectMargins;
    type: ASPECT_RATIO;
}

Hierarchy (View Summary)

IContentDisplayAreaOptions
- IAspectRatioContentDisplayAreaOptions

Properties

`Optional`aspectRatio

aspectRatio?: number

The aspect-ratio to use for Content Display Areas. Defined as (width / height).

Double

Default

0.66666666666

`Optional` `Experimental`insets

insets?: IRectMargins

Configures insets that reserve space along the edges of the ReaderView, typically set to match the device's safe area insets to keep content clear of camera notches, rounded corners, or system UI elements.

For paginated renderers, publication content will not be rendered in the inset areas except when zooming in.

For scrolling renderers, the vertical (top and bottom) insets do not limit the content display area. Instead, they add extra space at the top and bottom of the scrolling container. This ensures that content can be scrolled fully into view within the safe area. The horizontal (left and right) insets will still constrain the content display area.

Percentage values are based on the ReaderView's dimensions. Any value higher than 40% of the ReaderView's width or height will be clamped to 40%.

Defaults to 0 for all sides.

Nodefault

This API is experimental and might be subject to changes in future releases.

type

type: ASPECT_RATIO

Identifies the type of Content Display Area options.