MAIDR JavaScript API
    Preparing search index...

    Interface TableauExtensionOptions

    Where the extension finds the Extensions library, and how to lay itself out.

    interface TableauExtensionOptions {
        container?: HTMLElement;
        configureUrl?: string;
        settingsKey?: string;
        defaults?: TableauAdapterOptions;
        extensions?: TableauExtensions;
    }
    Index

    Properties

    container? configureUrl? settingsKey? defaults? extensions?

    Properties

    container?: HTMLElement

    The element the figure is appended to. Defaults to document.body; a page that wants a landmark around it passes its own <main>.

    configureUrl?: string

    URL of the configuration dialog, relative to the extension's page. When it is set, the extension's Configure menu opens it; see configureTableauExtension. Leave it off and the options come from defaults and whatever was saved already.

    settingsKey?: string

    The settings key the options are saved under. Defaults to 'maidr'.

    defaults?: TableauAdapterOptions

    Options that apply when the saved settings leave them out. The saved settings win key by key, so a page can ship sensible defaults and let an author override any of them.

    extensions?: TableauExtensions

    The Extensions API. Defaults to window.tableau.extensions, which the Extensions library defines; passed in by tests and by pages that load the library under another name.

    Settings

    Member Visibility

    On This Page

    Properties