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

    Interface WhiteboardAddinLifecycle

    Add-in lifecycle interface

    interface WhiteboardAddinLifecycle {
        onMessage?: (message: unknown, fromUserId: string) => void;
        onMount: (context: WhiteboardAddinContext) => void;
        onObjectAdded?: (object: WhiteboardObject) => void;
        onObjectLoaded?: (object: WhiteboardObject) => void;
        onObjectModified?: (object: WhiteboardObject) => void;
        onObjectRemoved?: (object: WhiteboardObject) => void;
        onSelectionChanged?: (objects: WhiteboardObject[]) => void;
        onUnmount: () => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    onMessage? onMount onObjectAdded? onObjectLoaded? onObjectModified? onObjectRemoved? onSelectionChanged? onUnmount

    Properties

    onMessage?: (message: unknown, fromUserId: string) => void

    Called when a message is received from another user

    onMount: (context: WhiteboardAddinContext) => void

    Called when add-in is mounted/enabled

    onObjectAdded?: (object: WhiteboardObject) => void

    Called when an object is added to canvas

    onObjectLoaded?: (object: WhiteboardObject) => void

    Called when object is loaded from file

    onObjectModified?: (object: WhiteboardObject) => void

    Called when an object is modified

    onObjectRemoved?: (object: WhiteboardObject) => void

    Called when an object is removed

    onSelectionChanged?: (objects: WhiteboardObject[]) => void

    Called when selection changes

    onUnmount: () => void

    Called when add-in is unmounted/disabled

    Settings

    Member Visibility

    On This Page

    Properties