IPreviewOptions

Interfaces

IPreviewOptions

Properties

dpi?

optional dpi?: number;

Overrides the DPI used to compute the pixel size of the resulting preview (defaults to Environment.screenDpi, i.e. scales with the device's pixel ratio). Use a fixed value to get a preview whose pixel size doesn't depend on the device's pixel ratio - e.g. for lightweight thumbnails, where full device-pixel-ratio resolution is unnecessary and can be prohibitively large on high-DPI mobile devices.

ignoreContainers?

optional ignoreContainers?: string[];

Array of container IDs to exclude from the preview.

includeMockup?

optional includeMockup?: boolean;

Indicates whether mockup should be present on preview or not. If set, the size of the resulting preview will be equal to the size of the whole surface, regardless of the printAreaIndex property.

printAreaIndex?

optional printAreaIndex?: number;

Index of printArea to get preview of. If set, the size of the resulting preview will be equal to the bounds of the corresponding printArea.

Interfaces​