MAIDR JavaScript API
    Preparing search index...

    Interface TableauExtensionSettings

    Settings saved with the workbook, one string per key.

    Mirrors Settings in ExternalContract/Extensions/Namespaces/Settings.d.ts. Settings are per extension instance, so two MAIDR zones on one dashboard are configured independently.

    interface TableauExtensionSettings {
        addEventListener: (
            eventType: string,
            handler: (event: unknown) => void,
        ) => TableauEventUnregisterFn;
        get: (key: string) => string | undefined;
        set: (key: string, value: string) => void;
        saveAsync: () => Promise<unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addEventListener get set saveAsync

    Properties

    addEventListener: (
        eventType: string,
        handler: (event: unknown) => void,
    ) => TableauEventUnregisterFn
    get: (key: string) => string | undefined
    set: (key: string, value: string) => void
    saveAsync: () => Promise<unknown>

    Settings

    Member Visibility

    On This Page

    Properties