Member Junction
    Preparing search index...

    Interface DomFrameCaptureOptions

    Options for CreateDomFrameCapturer.

    interface DomFrameCaptureOptions {
        MaxConsecutiveFailures?: number;
        MaxEdgePx?: number;
        MaxNodes?: number;
        OnDegraded?: (reason: string) => void;
        Quality?: number;
        Rasterize?: DomRasterizer;
        TimeoutMs?: number;
    }
    Index

    Properties

    MaxConsecutiveFailures? MaxEdgePx? MaxNodes? OnDegraded? Quality? Rasterize? TimeoutMs?

    Properties

    MaxConsecutiveFailures?: number

    Consecutive transient failures (timeouts, unknown errors) after which capture is disabled for the session. Default 3.

    MaxEdgePx?: number

    The longest edge of the frame, in pixels; larger elements are scaled down. Default 1024.

    MaxNodes?: number

    Elements with more descendants than this are not rasterized (the synchronous clone would freeze the page). Default 3000.

    OnDegraded?: (reason: string) => void

    Called once, with the reason, the first time capture is degraded. Default: console.warn.

    Quality?: number

    JPEG quality, 0 to 1. Default 0.6 (a frame of a dashboard is roughly 40 to 120 KB).

    Rasterize?: DomRasterizer

    The rasterizer. Default: html-to-image's toJpeg.

    TimeoutMs?: number

    How long to wait for one capture before giving up on it. Default 4000 ms.

    Settings

    Member Visibility

    On This Page

    Properties