Contents Menu Expand Light mode Dark mode Auto light/dark mode
Threedy Documentation Portal
Light Logo Dark Logo
Threedy Documentation Portal

Getting Started

  • Introduction
  • Format Support
  • Installation
    • instant3Dhub requirements
    • instant3Dhub on Kubernetes
      • User Authentication Passing
      • Air-Gapped License Server
        • Manual Usage Export
    • instant3Dhub on Single Node
      • instant3Dhub on Single Node - Windows
    • install tools: Ansible
    • Guide: running instant3Dhub with Proxy
    • Guide: running instant3Dhub with external PostgreSQL
    • Guide: running instant3Dhub with Grafana
  • Feature Packages
    • 3D Spaces
    • CAD DMU
    • Collaboration
    • XR
    • Model-Tracking
  • Apps
  • Public Roadmap

What's New

  • Release Channels
  • instant3Dhub releases
    • End of Life (EoL)
    • Changelog
  • Migration Guides
    • Migration Guide for 3.11.0
    • Migration Guide for 3.10.0
    • Migration Guide for 3.9.0
    • Migration Guide for 3.8.0
    • Migration Guide for 3.7.0

Deep Dive

  • 3D Data Concepts
  • Hub Mesh

Integrator Guides

  • Data Gateway Integration
    • URN Mapper Configuration
  • Hub Mesh Guide
  • Troubleshooting
    • Admin UI
    • System Overview
  • License Server Usage Export

Developer Guides

  • webvis
  • webvis Developer Tutorials
    • webvis
    • webvis initialization
    • Modifying Nodes and Node Properties
    • Events
    • Selecting Nodes in the InstanceGraph
    • Configuration
    • Troubleshooting: Working with webvis API
  • Configuration
  • Troubleshooting: Working with webvis API

User Guides

  • Basics
    • UI Overview
    • Mobile UI Overview
    • Adding Data
    • Mouse Interaction
    • Shortcuts
  • UI Components
    • Tree View
    • Toolbar
    • Context Menu
    • Data Info and Meta Data
    • Settings
  • UI Tools
    • Snapshots
    • Clipping Planes
    • Measurements
    • Capping
    • Session
    • AR Tutorials
      • Quick start AR
      • Setup new connection
      • Object tracking
      • Advanced

API Reference

  • webvis API
    • Interfaces
      • AnimationAPI
      • AnnotationAPI
      • AttachmentAPI
      • BoxVolume
      • ClipPlaneAPI
      • CollectionAPI
      • ContextAPI
      • ContextStateAPI
      • CoordinateSystemAPI
      • DrawingAPI
      • DrawingPlaneAPI
      • EventAPI
      • ExplosionAPI
      • FrameAPI
      • HubAPI
      • ICollection
      • IEventListener
      • InstanceGraphAPI
      • InteractionAPI
      • LayerFilterAPI
      • MaterialAPI
      • MeasurementAPI
      • NodePathAPI
      • QueryAPI
      • RealityAPI
      • SelectionAPI
      • SessionStorageAPI
      • SettingsAPI
      • TopologyAPI
      • UtilityAPI
      • VariantsAPI
      • ViewerAPI
      • ViewerDrawingAPI
      • ViewerGizmoAPI
      • ViewerHeatmapAPI
      • ViewerHighlightAPI
      • ViewerInteractionAPI
      • ViewerMagnifierAPI
      • ViewerPointCloudAPI
      • ViewerPolylineAPI
      • ViewerStateAPI
      • ViewerXREdgeCompareAPI
    • Events
      • ActiveItemEvent
      • ActiveSceneVolumeChangedEvent
      • AnimationEndedEvent
      • AnimationFramesCreatedEvent
      • AnimationFramesRemovedEvent
      • AnimationIterationEvent
      • AnimationStartedEvent
      • AnnotationChangedEvent
      • AnnotationCreatedEvent
      • AnnotationRemovedEvent
      • AttachmentCreatedEvent
      • AttachmentDataChangedEvent
      • AttachmentRemovedEvent
      • BackgroundClickedEvent
      • ClipPlaneChangedEvent
      • ClipPlaneCreatedEvent
      • ClipPlaneRemovedEvent
      • ClippingRoomChangedEvent
      • ClippingRoomCreatedEvent
      • ClippingRoomRemovedEvent
      • CustomNodeAddedEvent
      • CustomPropertyRegisteredEvent
      • DrawingChangedEvent
      • DrawingCreatedEvent
      • DrawingPlaneChangedEvent
      • DrawingPlaneCreatedEvent
      • DrawingPlaneRemovedEvent
      • DrawingRemovedEvent
      • ExplosionChangedEvent
      • ExplosionFinishedEvent
      • ExplosionStartedEvent
      • InteractionModeChangedEvent
      • InternalSnapshotCreatedEvent
      • LayerFilterChangedEvent
      • LayerFilterRegisteredEvent
      • LayerFilterUnregisteredEvent
      • LogEvent
      • MaterialChangedEvent
      • MaterialCreatedEvent
      • MaterialRemovedEvent
      • MeasurementChangedEvent
      • MeasurementCreatedEvent
      • MeasurementRemovedEvent
      • ModelRenderedEvent
      • NodeAddedEvent
      • NodeChangedEvent
      • NodeClickedEvent
      • NodeErrorEvent
      • NodePointerEnterEvent
      • NodePointerOutEvent
      • NodePointerOverEvent
      • NodePropertiesResetEvent
      • NodeRemovedEvent
      • NotificationEvent
      • ProgressChangedEvent
      • RequestContextMenuEvent
      • SelectionChangedEvent
      • ServiceConnectionLostEvent
      • ServiceErrorEvent
      • ServiceStateChangedEvent
      • SettingChangedEvent
      • SnapshotChangedEvent
      • SnapshotCreatedEvent
      • SnapshotCreationStartedEvent
      • SnapshotRemovedEvent
      • SnapshotRestoreStartedEvent
      • SnapshotRestoredEvent
      • TopologyPointerEnterEvent
      • TopologyPointerOutEvent
      • VariantChangedEvent
      • ViewChangedEvent
      • ViewerCreatedEvent
      • ViewerErrorEvent
      • ViewerGizmoChangedEvent
      • ViewerGizmoModeChangedEvent
      • ViewerHeatmapChangedEvent
      • ViewerHeatmapConfigChangedEvent
      • ViewerHeatmapCreatedEvent
      • ViewerHeatmapRemovedEvent
      • ViewerMagnifierChangedEvent
      • ViewerNavigationEndedEvent
      • ViewerNavigationStartedEvent
      • ViewerPointCloudChangedEvent
      • ViewerPointCloudCreatedEvent
      • ViewerPointCloudRemovedEvent
      • ViewerRemovedEvent
      • ViewerSettingChangedEvent
      • ViewerStateChangedEvent
      • ViewerXREdgeCompareChangedEvent
      • ViewportChangedEvent
      • WebVisEvent
      • WebVisResetEvent
      • XRMemberAddedEvent
      • XRMemberRemovedEvent
      • XRModelTrackerEdgeImgReceivedEvent
      • XRModelTrackerInfoReceivedEvent
      • XRPlaybackStateChangedEvent
      • XRSpectateStartedEvent
      • XRSpectateStoppedEvent
      • XRStateChangedEvent
    • Enums
      • ActiveItemType
      • AnimationDirection
      • AnimationPlayState
      • AnimationProperty
      • AnimationTargetType
      • AnimationTimingFunction
      • AnimationTransformOrigin
      • AttachmentType
      • CacheStrategy
      • CameraProjectionType
      • ComparisonGroup
      • DrawingArrowhead
      • DrawingMode
      • EnabledState
      • EntityType
      • EventType
      • FrontPlaneAxis
      • GizmoTransformationMode
      • GizmoType
      • HeatmapColorScheme
      • HeatmapKernel
      • InteractionMode
      • InteractionModifier
      • InteractionProgress
      • InteractionType
      • LogLevel
      • MeasurementState
      • MeasurementTargetClass
      • MeasurementType
      • NavigationMode
      • NodeInfoState
      • NodePathFragmentType
      • NodeRepresentation
      • NodeResourceState
      • NodeState
      • NodeStateCategory
      • NodeType
      • PointerActionTrigger
      • PointerActionType
      • Property
      • RemoveState
      • RenderMode
      • RenderSetup
      • ServiceState
      • ServiceStateCategory
      • ServiceType
      • SettingStrings
      • SnapshotStatus
      • TopologyProperty
      • TopologySubType
      • TopologyType
      • TransparencyMode
      • ViewDirection
      • ViewPerspective
      • ViewerInteractionLevel
      • ViewerLightingEnvironment
      • ViewerSettingStrings
      • ViewerState
      • ViewerStateCategory
      • XRAutoDetectViewportEnclosure
      • XRCapability
      • XREdgeCompareMode
      • XRFusionMode
      • XRImageResolutionProfile
      • XRImageSource
      • XRModelTrackingPhase
      • XRModelTrackingState
      • XRWorldMappingStatus
    • Types
      • ActiveItemInfo
      • AddNodeOptions
      • AnimationFrame
      • AnimationOptions
      • AnnotationData
      • AnnotationProperties
      • BetweenMeasurementResult
      • BoxGizmoProperties
      • ChangeSelectionResult
      • ClipPlaneProperties
      • ClipRoomProperties
      • CloudPoint
      • ContentType
      • ContextCreatedListener
      • ContextCreatedListenerOptions
      • ContextMenuData
      • ContextMenuEntry
      • ContextRemovedListener
      • ContextRemovedListenerOptions
      • ContextState
      • CustomHeatmapColorScheme
      • DistanceConstraintMatch
      • DrawingData
      • DrawingPlaneProperties
      • DrawingProperties
      • FrameListener
      • HeatmapConfig
      • HeatmapProperties
      • InitialNodeProperties
      • InteractionData
      • MaterialProperties
      • MeasurementProperties
      • MeasurementResult
      • MeasurementTarget
      • MeasurementTargetClassMap
      • MeasurementTypeToResultMap
      • MeasurementTypeToTargetMap
      • NodePathHandle
      • NodePathHandleMap
      • OriginalTopologyHandle
      • PointCloudProperties
      • PointerInfo
      • PolylineProperties
      • ProgressState
      • PropertyType
      • Query
      • QueryCondition
      • QueryResult
      • QuerySelect
      • Serializable
      • SessionStore
      • SetLayerFilterEnabledResult
      • SnapshotCreationOptions
      • SnapshotProperties
      • SnapshotRestoreOptions
      • StoreSessionProgressCallback
      • TangentMeasurementResult
      • ThicknessMeasurementResult
      • TopologyBoxDescriptor
      • TopologyCircleDescriptor
      • TopologyCircularArcDescriptor
      • TopologyConeDescriptor
      • TopologyCurveDescriptor
      • TopologyCylinderDescriptor
      • TopologyDescriptor
      • TopologyDescriptorMap
      • TopologyEdgeDescriptor
      • TopologyEllipseDescriptor
      • TopologyFaceDescriptor
      • TopologyHandle
      • TopologyLineSegmentDescriptor
      • TopologyLoopDescriptor
      • TopologyPlanarFaceDescriptor
      • TopologyPointDescriptor
      • TopologyPropertyTypeMap
      • TopologyShapeDescriptor
      • TopologySphereDescriptor
      • TopologyTorusDescriptor
      • URIMap
      • UsageString
      • UserFeedback
      • VariantProperties
      • VersionInfo
      • ViewerDrawingGeometry
      • ViewerDrawingProcessOptions
      • ViewerDrawingResult
      • ViewerHighlightParameters
      • ViewerMagnifierProperties
      • XRAnchorOptions
      • XRAutoDetectScore
      • XRConfiguration
      • XREdgeCompareProperties
      • XRImage
      • XRImageSourceConfig
      • XRImageSourceConfigDevice
      • XRImageSourceConfigPlayback
      • XRInitOptions
      • XRModelTrackerInfo
      • XRPlaybackProperties
      • XRPlaybackState
      • XRScanshot
      • XRState
    • Variables
      • about
    • Functions
      • addContextCreatedListener
      • addContextRemovedListener
      • getContext
      • getContexts
      • removeContext
      • removeContextCreatedListener
      • removeContextRemovedListener
      • requestContext
  • webvisUI API
    • Events
      • UINotificationEvent
      • UISettingChangedEvent
    • Enums
      • CircleUnit
      • ContextMenuEntryId
      • HoverLabelMode
      • Language
      • LogLevel
      • PrintLayout
      • PrintQuality
      • UINotificationLevel
      • UISetting
      • Unit
    • Types
      • ContextMenuCallbackInfo
      • ContextMenuClickCallback
      • ContextMenuEntry
      • ContextMenuHoverCallback
      • ContextMenuLabelCallback
      • ContextMenuSubEntryCallback
      • ContextMenuVisibleCallback
      • EventMap
    • Functions
      • addContextMenuEntries
      • addEventListener
      • addTranslation
      • exportUserSettings
      • getSetting
      • getStaticUIElement
      • notifyError
      • notifyInfo
      • notifyWarning
      • removeContextMenuEntries
      • removeEventListener
      • restoreContextMenuEntries
      • setContextMenuEntries
      • setLogLevel
      • setSetting
      • translate
  • Rest Interfaces
    • Resource API
    • Data Gateway API
    • License Server API
    • [EXPERIMENTAL] 3DSpaces API
Back to top

getSettingΒΆ

  • webvisUI API Reference
  • getSetting

Function getSetting

  • getSetting(setting: UISetting): any

  • Parameters

    • setting: UISetting

    Returns any

Next
getStaticUIElement
Previous
exportUserSettings
Copyright ©
GmbH
Imprint Privacy Policy threedy.io
Last updated on May 06, 2025