Kiri API reference
    Preparing search index...

    Interface ExportOptions

    Options for export().

    interface ExportOptions {
        type?: ExportType;
        format?: ExportFormat;
        quality?: number;
        width?: number;
        height?: number;
    }

    Hierarchy (View Summary)

    Index
    type?: ExportType

    Default "base64" (a data URL string).

    format?: ExportFormat

    Default "image/png". A circle frame exported as "image/jpeg" warns — JPEG has no alpha channel.

    quality?: number

    0-1. Only meaningful for "image/jpeg"/"image/webp". Default: browser default.

    width?: number

    Output pixel width. Default: the frame's width.

    height?: number

    Output pixel height. Default: the frame's height.