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

    Interface WhiteboardBackgroundPage

    A background page — an image or rendered PDF page used as the canvas background.

    interface WhiteboardBackgroundPage {
        dataUrl?: string;
        pageNumber?: number;
        pageNumbers?: number[];
        sourceFileId: string;
        sourceFileName: string;
        thumbDataUrl?: string;
        type: "image" | "pdf-page";
    }
    Index

    Properties

    dataUrl? pageNumber? pageNumbers? sourceFileId sourceFileName thumbDataUrl? type

    Properties

    dataUrl?: string

    Data URL of the rendered image (persisted for offline/cross-session). OPTIONAL: an entry persisted without one (e.g. by a data migration that cannot render PDFs server-side) is rendered lazily on load — resolved from sourceFileId via the host's onGetFileUrl and composited client-side, exactly like a peer rebuilding from a pages spec.

    pageNumber?: number

    First PDF page number (1-based). Kept for backward compatibility.

    pageNumbers?: number[]

    Full list of selected PDF page numbers (1-based). Lets the page-picker restore the user's selection when the same PDF is re-opened.

    sourceFileId: string

    Source file ID from the file manager

    sourceFileName: string

    Source file name for display

    thumbDataUrl?: string

    Small preview of the rendered page for the page drawer (~160px wide). Optional — older files have none and the drawer falls back to dataUrl.

    type: "image" | "pdf-page"

    'image' for direct images, 'pdf-page' for rendered PDF pages

    Settings

    Member Visibility

    On This Page

    Properties