Viewer
    Preparing search index...

    Interface IGeneralOptions

    interface IGeneralOptions {
        caching: {
            enable: boolean;
            excludedQueryParameters: string[];
            maxCacheSize: number;
        };
        consoleBranding: boolean;
        loggingLevel: LOGGING_LEVEL;
        parallelGlTFProcessing: number;
        showMessages: boolean;
    }
    Index

    Properties

    caching: {
        enable: boolean;
        excludedQueryParameters: string[];
        maxCacheSize: number;
    }

    Caching options.

    Type Declaration

    • enable: boolean

      Option to enable/disable the caching. (default: true)

    • excludedQueryParameters: string[]

      Query parameters that are excluded when creating the key that is used for the comparison of data entries in the cache. (default: ['Expires', 'Signature', 'Key-Pair-Id']) Example: by the addition of 'Expires' the URLs https://link.example?Expires=0 and https://link.example?Expires=1 are both reduced to https://link.example for caching.

    • maxCacheSize: number

      The maximum size of the cache in bytes. (default: 1024^3)

    consoleBranding: boolean

    When set to false, the branding in the viewer console will be limited to a single line. This will only include the viewer version. (default: true)

    loggingLevel: LOGGING_LEVEL

    The logging level that is used.

    parallelGlTFProcessing: number

    The number of glTFs that are downloaded and processed at the same time. Restricting this number might help if too much data is downloaded at the same time. (default: Infinity)

    showMessages: boolean

    Option to show/hide messages in the browser console.