SettingsAPI#
Interface SettingsAPI
Hierarchy
- SettingsAPI
Index
Methods
change
- change
Setting<T>(setting, value): 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
-
import
- import
Config(config): 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;
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;
dynamicCOREnabled: any;
dynamicClippingDistance: any;
dynamicClippingEnabled: 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;
initView: any;
initialFit: any;
initialStateActivation: 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;
preSelectionColor: any;
preferXHRWithCredentials: any;
projectionType: any;
renderAuxOnTop: any;
renderMode: any;
renderSetup: 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;
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
-
aa
Setting: any -
additional
Cookies: any -
additional
Request Headers: any -
additionalWSQuery
Parameters: any -
application
Identifier: any -
aux
Mode Recursive Search: any -
aux
Mode Uncolor Faces On Leave: any -
background
Color: any -
boosterURL: any
-
capping
Effect Edge Color: any -
capping
Effect Enabled: any -
capping
Effect Inner Color: any -
capping
Geometry Color: any -
color
Comparison First Color: any -
color
Comparison Matching Color: any -
color
Comparison Second Color: any -
colorize
Effect: any -
context
Menu Function: any -
coord
Sys: any -
default
Field Of View: any -
default
Query Link Depth: any -
disable
Default Interaction: any -
disable
Specular Highlights: any -
double
Click Animation Volume Scale: any -
double
Click Time Window: any -
drawing
Arrowhead End: any -
drawing
Arrowhead Start: any -
drawing
Color: any -
drawing
Mode: any -
drawing
Size: any -
dynamic
Aux Contrast Enabled: any -
dynamicCOREnabled: any
-
dynamic
Clipping Distance: any -
dynamic
Clipping Enabled: any -
expand
On Viewer Selection: any -
face
Highlight Color: any -
face
Selection Color: any -
fit
View Factor: any -
fly
Navigation Speed: any -
fly
To On Double Click: any -
focus
On Double Click: any -
front
Plane Axis: any -
frustum
Culling: any -
ghosted
Scene Opacity: any -
gizmo
Scaling Factor: any -
gizmos
Enabled: any -
gpu
Memory Release Factor: any -
hover
Color: any -
hubURL: any
-
init
View: any -
initial
Fit: any -
initial
State Activation: any -
lighting
Environment: any -
line
Highlight Color: any -
line
Selection Color: any -
load
Remote Config File: any -
log
Level: any -
max
Active Scene Volume Diameter: any -
max
Concurrent Downloads: any -
max
Dynamic Clip Distance: any -
maxGPUMemory: any
-
maxSRCCPUMemory: any
-
measurement
Angular Tolerance: any -
measurement
Material Densities: any -
mouse
Invert Zooming Direction: any -
navigation
Mode: any -
navigation
Sampling: any -
navigation
Speed Factor: any -
navigation
Speed Throttle Factor: any -
notification
Log Levels: any -
outline
Color: any -
outline
Color Occluded: any -
outline
Inner Radius: any -
outline
Outer Radius: any -
parent
Select Enabled: any -
pre
Selection Color: any -
preferXHRWith
Credentials: any -
projection
Type: any -
render
Aux On Top: any -
render
Mode: any -
render
Setup: any -
screen
Space Coverage Calculation Method: any -
selection
Color: any -
session
Device Tags: any -
session
Forward Url: any -
session
Interactions: any -
session
Member Name: any -
show
Aux On Navigation: any -
silhouette
Effect: any -
silhouette
Effect Color: any -
silhouette
Effect Exclusive Enabled: any -
skip
Ssl Verify: any -
small
Feature Culling: any -
small
Feature Pixel Threshold: any -
snapshot
Content Selection: any -
soc: any
-
spacemouse
Multiplier: any -
ssao
Enabled: any -
taa
Enabled: any -
topo
Geometry Color: any -
topo
Geometry Secondary Color: any -
topo
Points Enabled: any -
turntable
Lower Vertical Limit: any -
turntable
Upper Vertical Limit: any -
turntable
Vertical Limits Enabled: any -
uri
Map: any -
use
Device Pixel Ratio: any -
vertex
Colors Enabled: any -
view
Perspective: any -
webgl
Preserve Drawingbuffer: any -
xr
Enable Debug Images: any -
xr
Fusion Mode: any -
xr
Image Compression Quality: any -
xr
Image Resolution Profile: any -
xr
Model Tracker Quality Threshold: any -
xr
Model Tracker Smoothing Factor: any
-
Returns void
-
read
reset
- reset
Setting(setting): 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
-
The SettingsAPI provides basic functionalities to configure the 3D Space.