browser-image
    Preparing search index...

    Interface PreviewOptions

    Options for createPreviewRunner.

    interface PreviewOptions {
        output?: OutputKind;
        type?: string;
        quality?: number;
        worker?: boolean;
        maxSize?: number;
        colorMode?: ColorMode;
    }

    Hierarchy

    Index
    output? type? quality? worker? maxSize? colorMode?
    output?: OutputKind

    Result type. Default imageData.

    type?: string

    Encoding for output: 'blob'. Default image/png.

    quality?: number

    Encoder quality 0-1 for lossy types.

    worker?: boolean

    Run in Web Workers (default true). Falls back to the main thread automatically.

    maxSize?: number

    Longest side, in pixels, the preview is computed at. A larger input is shrunk once (and reused while the same input is passed) and each run works on the small copy, with the sharpen radius scaled to match, so slider moves are fast. Results then have the reduced size. Default: no limit. Run the pipeline on the original for the final full-size result.

    colorMode?: ColorMode

    Default auto.

    Settings
    Member Visibility

    On This Page
    Properties