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

    Interface WhiteboardFile

    interface WhiteboardFile {
        activeBackgroundPage?: number;
        addinData: Record<string, unknown>;
        addinStates: Record<string, WhiteboardAddinState>;
        backgroundPages?: WhiteboardBackgroundPage[];
        canvas: WhiteboardCanvasJSON;
        currentColor: string;
        events?: WhiteboardAuditEntry[];
        lastModified: string;
        name: string;
        owner: string;
    }
    Index

    Properties

    activeBackgroundPage? addinData addinStates backgroundPages? canvas currentColor events? lastModified name owner

    Properties

    activeBackgroundPage?: number

    Index of the active background page, or undefined for no background

    addinData: Record<string, unknown>

    Add-in custom data

    addinStates: Record<string, WhiteboardAddinState>

    Add-in enabled states

    backgroundPages?: WhiteboardBackgroundPage[]

    Background pages (images / PDF pages)

    canvas: WhiteboardCanvasJSON

    Serialized Fabric.js canvas data

    currentColor: string

    Last used brush color

    events?: WhiteboardAuditEntry[]

    Persistent audit log — captured by useWhiteboardSync on every observed change (local + remote) and rolled into the file at save time. Append-only. Capped at ~10K entries with a __truncated__ sentinel inserted at the head when older entries are dropped. Pre-existing files (created before this field) load with an empty log and audit from that point forward.

    lastModified: string

    ISO timestamp of last modification

    name: string

    File display name

    owner: string

    User ID of the owner

    Settings

    Member Visibility

    On This Page

    Properties