Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

SettingsAPI

• webVis API Reference
• SettingsAPI

Interface SettingsAPI

The SettingsAPI provides basic functionalities to configure the 3D Space.

interface SettingsAPI {
    changeSetting<T extends string>(
        setting: T,
        value: ContextSettingType<T>,
    ): boolean;
    importConfig(
        config: {
            aaSetting?: any;
            additionalCookies?: any;
            additionalRequestHeaders?: any;
            additionalWSQueryParameters?: any;
            applicationIdentifier?: any;
            auxModeRecursiveSearch?: any;
            auxModeUncolorFacesOnLeave?: any;
            backgroundColor?: any;
            batchedQueries?: any;
            boosterURL?: any;
            cappingEffectEdgeColor?: any;
            cappingEffectEnabled?: any;
            cappingEffectInnerColor?: any;
            cappingGeometryColor?: any;
            colorComparisonFirstColor?: any;
            colorComparisonMatchingColor?: any;
            colorComparisonSecondColor?: any;
            colorizeEffect?: any;
            contextMenuFunction?: any;
            coordSys?: any;
            defaultFieldOfView?: any;
            defaultQueryLinkDepth?: any;
            disableDefaultInteraction?: any;
            disableSpecularHighlights?: any;
            doubleClickAnimationVolumeScale?: any;
            doubleClickTimeWindow?: any;
            drawingArrowheadEnd?: any;
            drawingArrowheadStart?: any;
            drawingColor?: any;
            drawingMode?: any;
            drawingSize?: any;
            dynamicAuxContrastEnabled?: any;
            dynamicClippingDistance?: any;
            dynamicClippingEnabled?: any;
            dynamicCOREnabled?: any;
            expandOnViewerSelection?: any;
            faceHighlightColor?: any;
            faceSelectionColor?: any;
            fitViewFactor?: any;
            flyNavigationSpeed?: any;
            flyToOnDoubleClick?: any;
            focusOnDoubleClick?: any;
            frontPlaneAxis?: any;
            frustumCulling?: any;
            ghostedSceneOpacity?: any;
            gizmoScalingFactor?: any;
            gizmosEnabled?: any;
            gpuMemoryReleaseFactor?: any;
            hoverColor?: any;
            hubURL?: any;
            initialFit?: any;
            initialStateActivation?: any;
            initView?: any;
            lightingEnvironment?: any;
            lineHighlightColor?: any;
            lineSelectionColor?: any;
            loadRemoteConfigFile?: any;
            logLevel?: any;
            maxActiveSceneVolumeDiameter?: any;
            maxConcurrentDownloads?: any;
            maxDynamicClipDistance?: any;
            maxGPUMemory?: any;
            maxSRCCPUMemory?: any;
            measurementAngularTolerance?: any;
            measurementMaterialDensities?: any;
            mouseInvertZoomingDirection?: any;
            navigationMode?: any;
            navigationSampling?: any;
            navigationSpeedFactor?: any;
            navigationSpeedThrottleFactor?: any;
            notificationLogLevels?: any;
            outlineColor?: any;
            outlineColorOccluded?: any;
            outlineInnerRadius?: any;
            outlineOuterRadius?: any;
            parentSelectEnabled?: any;
            preferXHRWithCredentials?: any;
            preSelectionColor?: any;
            projectionType?: any;
            renderAuxOnTop?: any;
            renderMode?: any;
            renderSetup?: any;
            sceneOpacity?: any;
            screenSpaceCoverageCalculationMethod?: any;
            selectionColor?: any;
            sessionDeviceTags?: any;
            sessionForwardUrl?: any;
            sessionInteractions?: any;
            sessionMemberName?: any;
            showAuxOnNavigation?: any;
            silhouetteEffect?: any;
            silhouetteEffectColor?: any;
            silhouetteEffectExclusiveEnabled?: any;
            skipSslVerify?: any;
            smallFeatureCulling?: any;
            smallFeaturePixelThreshold?: any;
            snapshotContentSelection?: any;
            soc?: any;
            spacemouseMultiplier?: any;
            ssaoEnabled?: any;
            taaEnabled?: any;
            topoGeometryColor?: any;
            topoGeometrySecondaryColor?: any;
            topoPointsEnabled?: any;
            transparencyMode?: any;
            turntableLowerVerticalLimit?: any;
            turntableUpperVerticalLimit?: any;
            turntableVerticalLimitsEnabled?: any;
            uriMap?: any;
            useDevicePixelRatio?: any;
            vertexColorsEnabled?: any;
            viewPerspective?: any;
            webglPreserveDrawingbuffer?: any;
            xrEnableDebugImages?: any;
            xrFusionMode?: any;
            xrImageCompressionQuality?: any;
            xrImageResolutionProfile?: any;
            xrModelTrackerQualityThreshold?: any;
            xrModelTrackerSmoothingFactor?: any;
        },
    ): void;
    readSetting<T extends string>(setting: T): ContextSettingType<T>;
    resetSetting(setting: ViewerSettingStrings | SettingStrings): void;
    resetUserSettings(): void;
}

Hierarchy (View Summary)

• SettingsAPI
  • ContextAPI

Index

Methods

changeSetting importConfig readSetting resetSetting resetUserSettings

Methods

changeSetting

• changeSetting<T extends string>(
      setting: T,
      value: ContextSettingType<T>,
  ): boolean

• Changes the setting to the given value.

  Type Parameters

  • T extends string

  Parameters

  • setting: T

    A name that specifies a particular setting
  • value: ContextSettingType<T>

    The new value for the setting

  Returns boolean

  A boolean which indicates if the setting has changed

importConfig

• importConfig(
      config: {
          aaSetting?: any;
          additionalCookies?: any;
          additionalRequestHeaders?: any;
          additionalWSQueryParameters?: any;
          applicationIdentifier?: any;
          auxModeRecursiveSearch?: any;
          auxModeUncolorFacesOnLeave?: any;
          backgroundColor?: any;
          batchedQueries?: any;
          boosterURL?: any;
          cappingEffectEdgeColor?: any;
          cappingEffectEnabled?: any;
          cappingEffectInnerColor?: any;
          cappingGeometryColor?: any;
          colorComparisonFirstColor?: any;
          colorComparisonMatchingColor?: any;
          colorComparisonSecondColor?: any;
          colorizeEffect?: any;
          contextMenuFunction?: any;
          coordSys?: any;
          defaultFieldOfView?: any;
          defaultQueryLinkDepth?: any;
          disableDefaultInteraction?: any;
          disableSpecularHighlights?: any;
          doubleClickAnimationVolumeScale?: any;
          doubleClickTimeWindow?: any;
          drawingArrowheadEnd?: any;
          drawingArrowheadStart?: any;
          drawingColor?: any;
          drawingMode?: any;
          drawingSize?: any;
          dynamicAuxContrastEnabled?: any;
          dynamicClippingDistance?: any;
          dynamicClippingEnabled?: any;
          dynamicCOREnabled?: any;
          expandOnViewerSelection?: any;
          faceHighlightColor?: any;
          faceSelectionColor?: any;
          fitViewFactor?: any;
          flyNavigationSpeed?: any;
          flyToOnDoubleClick?: any;
          focusOnDoubleClick?: any;
          frontPlaneAxis?: any;
          frustumCulling?: any;
          ghostedSceneOpacity?: any;
          gizmoScalingFactor?: any;
          gizmosEnabled?: any;
          gpuMemoryReleaseFactor?: any;
          hoverColor?: any;
          hubURL?: any;
          initialFit?: any;
          initialStateActivation?: any;
          initView?: any;
          lightingEnvironment?: any;
          lineHighlightColor?: any;
          lineSelectionColor?: any;
          loadRemoteConfigFile?: any;
          logLevel?: any;
          maxActiveSceneVolumeDiameter?: any;
          maxConcurrentDownloads?: any;
          maxDynamicClipDistance?: any;
          maxGPUMemory?: any;
          maxSRCCPUMemory?: any;
          measurementAngularTolerance?: any;
          measurementMaterialDensities?: any;
          mouseInvertZoomingDirection?: any;
          navigationMode?: any;
          navigationSampling?: any;
          navigationSpeedFactor?: any;
          navigationSpeedThrottleFactor?: any;
          notificationLogLevels?: any;
          outlineColor?: any;
          outlineColorOccluded?: any;
          outlineInnerRadius?: any;
          outlineOuterRadius?: any;
          parentSelectEnabled?: any;
          preferXHRWithCredentials?: any;
          preSelectionColor?: any;
          projectionType?: any;
          renderAuxOnTop?: any;
          renderMode?: any;
          renderSetup?: any;
          sceneOpacity?: any;
          screenSpaceCoverageCalculationMethod?: any;
          selectionColor?: any;
          sessionDeviceTags?: any;
          sessionForwardUrl?: any;
          sessionInteractions?: any;
          sessionMemberName?: any;
          showAuxOnNavigation?: any;
          silhouetteEffect?: any;
          silhouetteEffectColor?: any;
          silhouetteEffectExclusiveEnabled?: any;
          skipSslVerify?: any;
          smallFeatureCulling?: any;
          smallFeaturePixelThreshold?: any;
          snapshotContentSelection?: any;
          soc?: any;
          spacemouseMultiplier?: any;
          ssaoEnabled?: any;
          taaEnabled?: any;
          topoGeometryColor?: any;
          topoGeometrySecondaryColor?: any;
          topoPointsEnabled?: any;
          transparencyMode?: any;
          turntableLowerVerticalLimit?: any;
          turntableUpperVerticalLimit?: any;
          turntableVerticalLimitsEnabled?: any;
          uriMap?: any;
          useDevicePixelRatio?: any;
          vertexColorsEnabled?: any;
          viewPerspective?: any;
          webglPreserveDrawingbuffer?: any;
          xrEnableDebugImages?: any;
          xrFusionMode?: any;
          xrImageCompressionQuality?: any;
          xrImageResolutionProfile?: any;
          xrModelTrackerQualityThreshold?: any;
          xrModelTrackerSmoothingFactor?: any;
      },
  ): void

• Applies the specified set of settings to the context.

  Parameters

  • config: {
        aaSetting?: any;
        additionalCookies?: any;
        additionalRequestHeaders?: any;
        additionalWSQueryParameters?: any;
        applicationIdentifier?: any;
        auxModeRecursiveSearch?: any;
        auxModeUncolorFacesOnLeave?: any;
        backgroundColor?: any;
        batchedQueries?: any;
        boosterURL?: any;
        cappingEffectEdgeColor?: any;
        cappingEffectEnabled?: any;
        cappingEffectInnerColor?: any;
        cappingGeometryColor?: any;
        colorComparisonFirstColor?: any;
        colorComparisonMatchingColor?: any;
        colorComparisonSecondColor?: any;
        colorizeEffect?: any;
        contextMenuFunction?: any;
        coordSys?: any;
        defaultFieldOfView?: any;
        defaultQueryLinkDepth?: any;
        disableDefaultInteraction?: any;
        disableSpecularHighlights?: any;
        doubleClickAnimationVolumeScale?: any;
        doubleClickTimeWindow?: any;
        drawingArrowheadEnd?: any;
        drawingArrowheadStart?: any;
        drawingColor?: any;
        drawingMode?: any;
        drawingSize?: any;
        dynamicAuxContrastEnabled?: any;
        dynamicClippingDistance?: any;
        dynamicClippingEnabled?: any;
        dynamicCOREnabled?: any;
        expandOnViewerSelection?: any;
        faceHighlightColor?: any;
        faceSelectionColor?: any;
        fitViewFactor?: any;
        flyNavigationSpeed?: any;
        flyToOnDoubleClick?: any;
        focusOnDoubleClick?: any;
        frontPlaneAxis?: any;
        frustumCulling?: any;
        ghostedSceneOpacity?: any;
        gizmoScalingFactor?: any;
        gizmosEnabled?: any;
        gpuMemoryReleaseFactor?: any;
        hoverColor?: any;
        hubURL?: any;
        initialFit?: any;
        initialStateActivation?: any;
        initView?: any;
        lightingEnvironment?: any;
        lineHighlightColor?: any;
        lineSelectionColor?: any;
        loadRemoteConfigFile?: any;
        logLevel?: any;
        maxActiveSceneVolumeDiameter?: any;
        maxConcurrentDownloads?: any;
        maxDynamicClipDistance?: any;
        maxGPUMemory?: any;
        maxSRCCPUMemory?: any;
        measurementAngularTolerance?: any;
        measurementMaterialDensities?: any;
        mouseInvertZoomingDirection?: any;
        navigationMode?: any;
        navigationSampling?: any;
        navigationSpeedFactor?: any;
        navigationSpeedThrottleFactor?: any;
        notificationLogLevels?: any;
        outlineColor?: any;
        outlineColorOccluded?: any;
        outlineInnerRadius?: any;
        outlineOuterRadius?: any;
        parentSelectEnabled?: any;
        preferXHRWithCredentials?: any;
        preSelectionColor?: any;
        projectionType?: any;
        renderAuxOnTop?: any;
        renderMode?: any;
        renderSetup?: any;
        sceneOpacity?: any;
        screenSpaceCoverageCalculationMethod?: any;
        selectionColor?: any;
        sessionDeviceTags?: any;
        sessionForwardUrl?: any;
        sessionInteractions?: any;
        sessionMemberName?: any;
        showAuxOnNavigation?: any;
        silhouetteEffect?: any;
        silhouetteEffectColor?: any;
        silhouetteEffectExclusiveEnabled?: any;
        skipSslVerify?: any;
        smallFeatureCulling?: any;
        smallFeaturePixelThreshold?: any;
        snapshotContentSelection?: any;
        soc?: any;
        spacemouseMultiplier?: any;
        ssaoEnabled?: any;
        taaEnabled?: any;
        topoGeometryColor?: any;
        topoGeometrySecondaryColor?: any;
        topoPointsEnabled?: any;
        transparencyMode?: any;
        turntableLowerVerticalLimit?: any;
        turntableUpperVerticalLimit?: any;
        turntableVerticalLimitsEnabled?: any;
        uriMap?: any;
        useDevicePixelRatio?: any;
        vertexColorsEnabled?: any;
        viewPerspective?: any;
        webglPreserveDrawingbuffer?: any;
        xrEnableDebugImages?: any;
        xrFusionMode?: any;
        xrImageCompressionQuality?: any;
        xrImageResolutionProfile?: any;
        xrModelTrackerQualityThreshold?: any;
        xrModelTrackerSmoothingFactor?: any;
    }

    Settings to import

  Returns void

readSetting

• readSetting<T extends string>(setting: T): ContextSettingType<T>

• Returns the value of a setting.

  Type Parameters

  • T extends string

  Parameters

  • setting: T

    The name of the setting that should be read

  Returns ContextSettingType<T>

  The value of the specified setting

resetSetting

• resetSetting(setting: ViewerSettingStrings | SettingStrings): void

• Resets the value of a setting to the installation default.

  Parameters

  • setting: ViewerSettingStrings | SettingStrings

    The name of the setting that should be reset.

  Returns void

resetUserSettings

• resetUserSettings(): void

• Returns void