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

    Interface WhiteboardAddinRegistryInterface

    Add-in registry interface

    interface WhiteboardAddinRegistryInterface {
        disable: (addinId: string) => void;
        enable: (addinId: string) => void;
        exportData: () => Record<string, unknown>;
        getAddin: (addinId: string) => WhiteboardAddinInterface | undefined;
        getAllAddins: () => WhiteboardAddinInterface[];
        getContextMenuItems: (object: WhiteboardObject) => ContextMenuItem[];
        getEnabledAddins: () => WhiteboardAddinInterface[];
        getToolbarButtons: () => ToolbarButton[];
        handleMessage: (type: string, data: unknown, fromUserId: string) => void;
        importData: (data: Record<string, unknown>) => void;
        isEnabled: (addinId: string) => boolean;
        register: (addin: WhiteboardAddinInterface) => void;
        setCanvas: (canvas: Canvas) => void;
        setContext: (context: WhiteboardAddinContext) => void;
        unregister: (addinId: string) => void;
    }
    Index

    Properties

    disable enable exportData getAddin getAllAddins getContextMenuItems getEnabledAddins getToolbarButtons handleMessage importData isEnabled register setCanvas setContext unregister

    Properties

    disable: (addinId: string) => void

    Disable an add-in

    enable: (addinId: string) => void

    Enable an add-in

    exportData: () => Record<string, unknown>

    Export all add-in data

    getAddin: (addinId: string) => WhiteboardAddinInterface | undefined

    Get an add-in by ID

    getAllAddins: () => WhiteboardAddinInterface[]

    Get all registered add-ins

    getContextMenuItems: (object: WhiteboardObject) => ContextMenuItem[]

    Get context menu items for an object from enabled add-ins

    getEnabledAddins: () => WhiteboardAddinInterface[]

    Get all enabled add-ins

    getToolbarButtons: () => ToolbarButton[]

    Get all toolbar buttons from enabled add-ins

    handleMessage: (type: string, data: unknown, fromUserId: string) => void

    Handle a message for add-ins

    importData: (data: Record<string, unknown>) => void

    Import all add-in data

    isEnabled: (addinId: string) => boolean

    Check if an add-in is enabled

    register: (addin: WhiteboardAddinInterface) => void

    Register an add-in

    setCanvas: (canvas: Canvas) => void

    Set the canvas for all add-ins

    setContext: (context: WhiteboardAddinContext) => void

    Set the whiteboard context for all add-ins

    unregister: (addinId: string) => void

    Unregister an add-in

    Settings

    Member Visibility

    On This Page

    Properties