NavVis IVION API
    Preparing search index...

    Interface ConfigurationInterface

    Embed and URL configuration properties.

    These properties are used to modify the behavior and appearance of NavVis IVION when first loaded. Pass them to getApi.

    Only lang, info.terms.extra and info.terms.privacy can also be set via URL parameters, e.g. ?lang=de. A URL parameter takes precedence over the value passed to getApi.

    interface ConfigurationInterface {
        allowPointCloudActivation?: boolean;
        "info.terms.extra"?: string;
        "info.terms.privacy"?: string;
        lang?: string;
        loginToken?: string;
        onLoadComplete?: () => void;
        onWebGlFailed?: (reason: string) => void;
        "tracking.code"?: string;
        "tracking.enabled"?: boolean;
        "ui.logo.visible"?: boolean;
        uploadToken?: string;
    }
    Index
    allowPointCloudActivation? info.terms.extra? info.terms.privacy? lang? loginToken? onLoadComplete? onWebGlFailed? tracking.code? tracking.enabled? ui.logo.visible? uploadToken?
    allowPointCloudActivation?: boolean

    Whether to automatically show point clouds when no panorama is available. True by default.

    "info.terms.extra"?: string

    HTML to show as extra credits in about box.

    "info.terms.privacy"?: string

    HTML to show as privacy policy in about box.

    lang?: string

    Overrides the language settings from browser language, cookie and local store. Supported language keys are:

    • cs: Czech
    • de: German
    • en: English
    • fr: French
    • ja: Japanese
    • es: Spanish
    • zh: Simplified Chinese
    • zh-TW: Traditional Chinese
    loginToken?: string

    Logs a user in with the provided JWT, either for local NavVis IVION accounts or e.g. for OAuth Resource Server if the instance is set up to use one.

    Note that it also removes logout functionality from the UI and that NavVis IVION will not automatically refresh the token when it is about to expire. Use api.auth.updateToken(...) to apply an updated token before the previous one expires.

    onLoadComplete?: () => void

    Callback that is invoked after data has been loaded and the view has moved to the starting location.

    Do not use this with the NPM API, use getApi().then(callback) instead.

    onWebGlFailed?: (reason: string) => void

    Callback that is invoked when WebGL initialization has failed.

    Type Declaration

      • (reason: string): void

      • Parameters

        • reason: string

          Error message

        Returns void

    Do not use this with the NPM API, use getApi().catch(callback) instead.

    "tracking.code"?: string

    JavaScript code to insert into the page, e.g. for adding analytics.

    Cannot be set via URL parameter.

    "tracking.enabled"?: boolean

    Whether to insert the tracking code.

    Cannot be set via URL parameter.

    "ui.logo.visible"?: boolean

    Whether to show the NavVis logo in the top bar. True by default.

    When set to false, the logo is removed and the remaining top bar items move to the left. Users can still return to the overview of all sites through the "Back to all sites" action in the site selector in the center of the top bar, also on instances with a single site.

    Cannot be set via URL parameter.

    uploadToken?: string

    Optional, If provided along with loginToken, used for authorizing uploads with the provided JWT, either for local NavVis IVION accounts or e.g. for OAuth Resource Server if the instance is set up to use one.

    When not provided, loginToken will be used.

    Note that it also removes logout functionality from the UI and that NavVis IVION will not automatically refresh the token when it is about to expire. Use api.auth.updateToken(...) to apply an updated token before the previous one expires.

    Settings
    Member Visibility

    On This Page
    Properties