Interface SnapshotSettings

interface SnapshotSettings {
largestAxisSize?: null | number;
maxWaitTimeMs?: null | number;
}

Properties

largestAxisSize?: null | number

The maximum size of the snapshot's longest dimension in pixels.

If set to a number (e.g., 100), the longest side of the snapshot will be limited to that value.
In case when layout size is smaller than the specified value, the snapshot will be upscaled.
If set to null or ignored, the snapshot will use the full page dimensions.
The maximum allowed value is 1000 pixels.

maxWaitTimeMs?: null | number

The maximum time to wait in milliseconds for the assets to load before the snapshot is taken.

When the time is exceeded, the snapshot will be taken even if not all assets are loaded yet.

When not defined, the default value is 10000 ms.