Hiyve Components - v1.0.0
    Preparing search index...

    Interface WhiteboardPdfOptions

    interface WhiteboardPdfOptions {
        imageFormat?: "png" | "jpeg";
        maxPixels?: number;
        quality?: number;
        scale?: number;
        title?: string;
    }
    Index

    Properties

    imageFormat?: "png" | "jpeg"

    'png' (default) keeps pen strokes and staff lines exact; 'jpeg' produces a smaller file, at the cost of haloing around fine dark lines.

    maxPixels?: number

    Ceiling on width × height of the rendered bitmap. Default DEFAULT_PDF_MAX_PIXELS.

    quality?: number

    JPEG quality 0..1, when imageFormat is 'jpeg'. Default 0.92.

    scale?: number

    Pixel scale applied to the logical canvas. Default DEFAULT_PDF_SCALE.

    title?: string

    Document title recorded in the PDF's metadata — the name a reader shows in its title bar. Pass the board's name, not the file name; a trailing extension is stripped.