Member Junction
    Preparing search index...

    Interface WhiteboardWidgetBrokerHost

    What the broker needs from the board it serves.

    interface WhiteboardWidgetBrokerHost {
        ActionsChanged?(
            itemId: string,
            actions: WhiteboardWidgetActionInfo[],
        ): void;
        GetRestoreState?(itemId: string): string;
        ReleaseMount(itemId: string): void;
        RequestMount(itemId: string, reveal: boolean): void;
        StateChanged?(itemId: string, stateJson: string): void;
    }
    Index

    Methods

    ActionsChanged? GetRestoreState? ReleaseMount RequestMount StateChanged?

    Methods

    • Stored state to hand a widget when it reports ready (null = none). Optional.

      Parameters

      • itemId: string

      Returns string

    • Keep the item's frame mounted while a command needs it. With reveal, also bring it into view (only when it is off-screen); without, never move the viewport. Calls nest: every call is matched by one ReleaseMount.

      Parameters

      • itemId: string
      • reveal: boolean

      Returns void

    • A widget saved state (only accepted after its restore was delivered). Optional.

      Parameters

      • itemId: string
      • stateJson: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods