MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface TableauBinding

    Handle returned by bindTableau.

    interface TableauBinding {
        maidr: Maidr;
        refresh: () => Promise<void>;
        dispose: () => void;
    }
    Index

    Properties

    maidr refresh dispose

    Properties

    maidr: Maidr

    The MAIDR data currently mounted, including the onNavigate callback.

    A getter rather than a snapshot: every successful refresh replaces the object wholesale, and a caller holding the one from bind time would be inspecting a figure that is no longer on the page.

    refresh: () => Promise<void>

    Re-read every bound worksheet and re-render.

    Never rejects: a read failure is logged and the previously mounted figure is left in place. Calls are serialized, so invoking it while a refresh is already running queues behind that one rather than opening a second reader.

    dispose: () => void

    Unregister every listener, clear the marks MAIDR selected in every bound worksheet, unmount the React tree, and remove the wrapper.

    Disposing the MAIDR controller and its services is not done here — <Maidr> owns that through useMaidrController, and unmounting is what triggers it. The <tableau-viz> element is left exactly as it was found.

    Settings

    Member Visibility

    On This Page

    Properties