Interface ConfigurationInterface

Embed and URL configuration properties.

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

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;
    uploadToken?: string;
}

Properties

allowPointCloudActivation? info.terms.extra? info.terms.privacy? lang? loginToken? onLoadComplete? onWebGlFailed? tracking.code? tracking.enabled? uploadToken?

Properties

OptionalallowPointCloudActivation

allowPointCloudActivation?: boolean

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

Optionalinfo.terms.extra

info.terms.extra?: string

HTML to show as extra credits in about box.

Optionalinfo.terms.privacy

info.terms.privacy?: string

HTML to show as privacy policy in about box.

Optionallang

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

OptionalloginToken

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.

OptionalonLoadComplete

onLoadComplete?: (() => void)

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

Deprecated

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

OptionalonWebGlFailed

onWebGlFailed?: ((reason: string) => void)

Callback that is invoked when WebGL initialization has failed.

Type declaration

    • (reason): void

    • Parameters

      • reason: string

        Error message

      Returns void

Deprecated

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

Optionaltracking.code

tracking.code?: string

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

Optionaltracking.enabled

tracking.enabled?: boolean

Whether to insert the tracking code.

OptionaluploadToken

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