PhantomJsCloud Automation API
    Preparing search index...

    Interface ScreenshotOptions

    Defines the screenshot options.

    interface ScreenshotOptions {
        clip?: BoundingBox;
        encoding?: "base64" | "binary";
        fullPage?: boolean;
        omitBackground?: boolean;
        path?: string;
        quality?: number;
        type?: "jpeg" | "png";
    }

    Hierarchy (View Summary)

    Index
    clip? encoding? fullPage? omitBackground? path? quality? type?
    clip?: BoundingBox

    An object which specifies clipping region of the page.

    encoding?: "base64" | "binary"

    The encoding of the image, can be either base64 or binary.

    binary
    fullPage?: boolean

    When true, takes a screenshot of the full scrollable page.

    false
    omitBackground?: boolean

    Hides default white background and allows capturing screenshots with transparency.

    false
    path?: string

    The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.

    quality?: number

    The quality of the image, between 0-100. Not applicable to png images.

    type?: "jpeg" | "png"

    The screenshot type.

    png

    Settings
    Member Visibility

    On This Page
    Properties