Contents Menu Expand Light mode Dark mode Auto light/dark mode
Threedy Documentation Portal
Light Logo Dark Logo
Threedy Documentation Portal
  • Welcome
  • Introduction to instant3Dhub
  • Share Feedback

Our Concepts

  • Getting Started
  • Format Support
  • Feature Packages
    • Basic
    • Advanced
    • Expert
  • 3DSpaces
    • InstanceGraph
      • Graph Composition
      • Node Types & Operations
    • Snapshot
    • Markup
    • Measurement
    • Clipplane
    • Members
  • 3D Streaming
  • 3D Data Resources
  • Hub Mesh
  • MCP Server

For Integrators

  • Getting Started
  • Installation
    • instant3Dhub requirements
    • instant3Dhub on Kubernetes
      • User Authentication Passing
      • Air-Gapped License Server
        • License Server Manual Usage Export
    • instant3Dhub on Single Node
      • instant3Dhub on Single Node - Windows
    • Guide: running instant3Dhub with Proxy
    • Guide: running instant3Dhub with external PostgreSQL
    • Guide: running instant3Dhub with Grafana
  • Get Latest Release
    • Changelog
    • Migration Guides
      • Migration Guide for 3.13.0
      • Migration Guide for 3.12.0
      • 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
    • End of Life Information
    • Nightly Releases
    • Open-Source Software License Report
  • Data Pool Configuration
    • Data Gateway Interface
    • PLM Reference Implementation
      • Siemens Teamcenter
      • PTC Windchill
      • Azure Blob Store
      • Microsoft SharePoint
    • Signed Input Configuration
  • Hub Mesh Guide
  • Troubleshooting
    • Admin UI
    • System Overview
  • License Server Manual Usage Export

For App Developers

  • Getting Started
  • SDKs
    • Unreal Plugin
    • JxVis
  • webvis Developer Tutorials
    • webvis
    • webvis initialization
    • Modifying Nodes and Node Properties
    • Events
    • Selecting Nodes in the InstanceGraph
    • Configuration
    • Navigation Modes
    • 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
    • 3DSpace Collaboration
    • AR Tutorials
      • Quick start AR
      • Setup new connection
      • Object tracking
      • Advanced

API Reference

  • webvis API
    • Interfaces
      • ActiveItemInfo
      • AddNodeOptions
      • AnimationAPI
      • AnimationFrame
      • AnimationOptions
      • AnnotationAPI
      • AnnotationData
      • AnnotationProperties
      • AppearancePatternAPI
      • AppearancePatternProperties
      • AttachmentAPI
      • BetweenMeasurementResult
      • BoxGizmoProperties
      • BoxVolume
      • ChangeSelectionResult
      • ClipPlaneAPI
      • ClipPlaneProperties
      • ClipRoomProperties
      • CloudPoint
      • CollectionAPI
      • ContentType
      • ContextAPI
      • ContextCreatedListenerOptions
      • ContextMenuData
      • ContextMenuEntry
      • ContextRemovedListenerOptions
      • ContextStateAPI
      • CoordinateSystemAPI
      • DistanceConstraintMatch
      • DrawingAPI
      • DrawingData
      • DrawingPlaneAPI
      • DrawingPlaneProperties
      • DrawingProperties
      • EventAPI
      • ExplosionAPI
      • FrameAPI
      • HeatmapConfig
      • HeatmapProperties
      • HubAPI
      • ICollection
      • IEventListener
      • InitialNodeProperties
      • InstanceGraphAPI
      • InteractionAPI
      • InteractionData
      • LayerFilterAPI
      • MaterialAPI
      • MaterialProperties
      • MeasurementAPI
      • MeasurementProperties
      • MeasurementTargetClassMap
      • MeasurementTypeToResultMap
      • MeasurementTypeToTargetMap
      • MemberAPI
      • MemberActionsToDetailsMap
      • MemberActionsToOptionsMap
      • MemberProfile
      • MemberProperties
      • NodePathAPI
      • NodePathHandle
      • NodePathHandleMap
      • NormalMeasurementResult
      • OriginalTopologyHandle
      • POISetProperties
      • POIStyleProperties
      • PointCloudProperties
      • PointOfInterest
      • PointerInfo
      • PolylineProperties
      • ProgressState
      • Query
      • QueryAPI
      • QueryCondition
      • QueryResult
      • RealityAPI
      • SelectionAPI
      • SessionStorageAPI
      • SessionStore
      • SetLayerFilterEnabledResult
      • SettingsAPI
      • SnapshotCreationOptions
      • SnapshotProperties
      • SnapshotRestoreOptions
      • SpaceAPI
      • SpaceHandle
      • TangentMeasurementResult
      • ThicknessMeasurementResult
      • TopologyAPI
      • TopologyBoxDescriptor
      • TopologyCircleDescriptor
      • TopologyCircularArcDescriptor
      • TopologyConeDescriptor
      • TopologyCurveDescriptor
      • TopologyCylinderDescriptor
      • TopologyDescriptorMap
      • TopologyEdgeDescriptor
      • TopologyEllipseDescriptor
      • TopologyFaceDescriptor
      • TopologyHandle
      • TopologyLineSegmentDescriptor
      • TopologyLoopDescriptor
      • TopologyPlanarFaceDescriptor
      • TopologyPointDescriptor
      • TopologyPropertyTypeMap
      • TopologyShapeDescriptor
      • TopologySphereDescriptor
      • TopologyTorusDescriptor
      • UserFeedback
      • UtilityAPI
      • VariantProperties
      • VariantsAPI
      • VersionInfo
      • ViewerAPI
      • ViewerDrawingAPI
      • ViewerDrawingGeometry
      • ViewerDrawingProcessOptions
      • ViewerDrawingResult
      • ViewerGizmoAPI
      • ViewerHeatmapAPI
      • ViewerHighlightAPI
      • ViewerHighlightParameters
      • ViewerInteractionAPI
      • ViewerMagnifierAPI
      • ViewerMagnifierProperties
      • ViewerPointCloudAPI
      • ViewerPointsOfInterestAPI
      • ViewerPolylineAPI
      • ViewerStateAPI
      • ViewerXREdgeCompareAPI
      • XRAnchorOptions
      • XRAutoDetectScore
      • XRConfiguration
      • XREdgeCompareProperties
      • XRImage
      • XRImageSourceConfigDevice
      • XRImageSourceConfigPlayback
      • XRInitOptions
      • XRModelTrackerInfo
      • XRPlaybackProperties
      • XRPlaybackState
      • XRScanshot
      • XRState
    • Events
      • ActiveItemEvent
      • ActiveSceneVolumeChangedEvent
      • AnimationEndedEvent
      • AnimationFramesCreatedEvent
      • AnimationFramesRemovedEvent
      • AnimationIterationEvent
      • AnimationStartedEvent
      • AnnotationChangedEvent
      • AnnotationCreatedEvent
      • AnnotationRemovedEvent
      • AppearancePatternChangedEvent
      • AppearancePatternCreatedEvent
      • AppearancePatternRemovedEvent
      • AttachmentCreatedEvent
      • AttachmentDataChangedEvent
      • AttachmentRemovedEvent
      • BackgroundClickedEvent
      • ClipPlaneChangedEvent
      • ClipPlaneCreatedEvent
      • ClipPlaneRemovedEvent
      • ClippingRoomChangedEvent
      • ClippingRoomCreatedEvent
      • ClippingRoomRemovedEvent
      • CustomPropertyRegisteredEvent
      • DrawingChangedEvent
      • DrawingCreatedEvent
      • DrawingPlaneChangedEvent
      • DrawingPlaneCreatedEvent
      • DrawingPlaneRemovedEvent
      • DrawingRemovedEvent
      • ExplosionChangedEvent
      • ExplosionFinishedEvent
      • ExplosionStartedEvent
      • InteractionModeChangedEvent
      • LayerFilterChangedEvent
      • LayerFilterRegisteredEvent
      • LayerFilterUnregisteredEvent
      • LogEvent
      • MaterialChangedEvent
      • MaterialCreatedEvent
      • MaterialRemovedEvent
      • MeasurementChangedEvent
      • MeasurementCreatedEvent
      • MeasurementRemovedEvent
      • MemberActionAddedEvent
      • MemberActionRemovedEvent
      • MemberChangedEvent
      • MemberCreatedEvent
      • MemberProfileEntryChangedEvent
      • MemberRemovedEvent
      • ModelRenderedEvent
      • NodeAddedEvent
      • NodeChangedEvent
      • NodeClickedEvent
      • NodeErrorEvent
      • NodePointerEnterEvent
      • NodePointerOutEvent
      • NodePointerOverEvent
      • NodePropertiesResetEvent
      • NodeRemovedEvent
      • NotificationEvent
      • ProgressChangedEvent
      • RequestContextMenuEvent
      • SelectionChangedEvent
      • ServiceConnectionLostEvent
      • ServiceErrorEvent
      • ServiceStateChangedEvent
      • SettingChangedEvent
      • SnapshotChangedEvent
      • SnapshotCreatedEvent
      • SnapshotCreationStartedEvent
      • SnapshotRemovedEvent
      • SnapshotRestoreStartedEvent
      • SnapshotRestoredEvent
      • SpaceChangedEvent
      • TopologyPointerEnterEvent
      • TopologyPointerOutEvent
      • VariantChangedEvent
      • ViewChangedEvent
      • ViewerCreatedEvent
      • ViewerErrorEvent
      • ViewerGizmoChangedEvent
      • ViewerGizmoModeChangedEvent
      • ViewerHeatmapChangedEvent
      • ViewerHeatmapConfigChangedEvent
      • ViewerHeatmapCreatedEvent
      • ViewerHeatmapRemovedEvent
      • ViewerMagnifierChangedEvent
      • ViewerNavigationEndedEvent
      • ViewerNavigationStartedEvent
      • ViewerPOIClickedEvent
      • ViewerPOIPointerEnterEvent
      • ViewerPOIPointerOutEvent
      • ViewerPOISetChangedEvent
      • ViewerPOISetCreatedEvent
      • ViewerPOISetPointsAddedEvent
      • ViewerPOISetPointsChangedEvent
      • ViewerPOISetPointsRemovedEvent
      • ViewerPOISetRemovedEvent
      • ViewerPOIStyleChangedEvent
      • ViewerPOIStyleCreatedEvent
      • ViewerPOIStyleRemovedEvent
      • ViewerPointCloudChangedEvent
      • ViewerPointCloudCreatedEvent
      • ViewerPointCloudRemovedEvent
      • ViewerRemovedEvent
      • ViewerSettingChangedEvent
      • ViewerStateChangedEvent
      • ViewerXREdgeCompareChangedEvent
      • ViewportChangedEvent
      • WebVisEvent
      • WebVisResetEvent
      • XRModelTrackerEdgeImgReceivedEvent
      • XRModelTrackerInfoReceivedEvent
      • XRPlaybackStateChangedEvent
      • XRStateChangedEvent
    • Enums
      • ActiveItemType
      • AnimationPlayState
      • AnimationProperty
      • AnimationTargetType
      • AnimationTimingFunction
      • AnimationTransformOrigin
      • AppearancePatternType
      • AttachmentType
      • BudgetingMode
      • CacheStrategy
      • CameraProjectionType
      • ComparisonGroup
      • DrawingArrowhead
      • DrawingMode
      • EnabledState
      • EntityType
      • EventType
      • FrontPlaneAxis
      • GizmoTransformationMode
      • GizmoType
      • HeatmapColorScheme
      • HeatmapKernel
      • InteractionMode
      • InteractionModifier
      • InteractionProgress
      • InteractionType
      • LogLevel
      • MeasurementState
      • MeasurementTargetClass
      • MeasurementType
      • MemberAction
      • MemberRole
      • MemberState
      • 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
      • ContextCreatedListener
      • ContextRemovedListener
      • ContextState
      • CustomHeatmapColorScheme
      • FrameListener
      • MeasurementResult
      • MeasurementTarget
      • PropertyType
      • QuerySelect
      • Serializable
      • SerializableValue
      • StoreSessionProgressCallback
      • TopologyDescriptor
      • URIMap
      • UnserializableValue
      • UsageString
      • XRImageSourceConfig
    • Variables
      • about
    • Functions
      • addContextCreatedListener
      • addContextRemovedListener
      • getContext
      • getContexts
      • removeContext
      • removeContextCreatedListener
      • removeContextRemovedListener
      • requestContext
  • webvisUI API
    • Interfaces
      • ContextMenuCallbackInfo
      • ContextMenuEntry
      • EventMap
    • Events
      • UINotificationEvent
      • UISettingChangedEvent
    • Enums
      • CircleUnit
      • ContextMenuEntryId
      • HoverLabelMode
      • Language
      • LogLevel
      • PrintLayout
      • PrintQuality
      • UINotificationLevel
      • UISetting
      • Unit
    • Types
      • ContextMenuClickCallback
      • ContextMenuHoverCallback
      • ContextMenuLabelCallback
      • ContextMenuSubEntryCallback
      • ContextMenuVisibleCallback
    • Functions
      • addContextMenuEntries
      • addEventListener
      • addTranslation
      • exportUserSettings
      • getSetting
      • getStaticUIElement
      • notifyError
      • notifyInfo
      • notifyWarning
      • removeContextMenuEntries
      • removeEventListener
      • requestDialog
      • restoreContextMenuEntries
      • setContextMenuEntries
      • setLogLevel
      • setSetting
      • translate
  • Rest Interfaces
    • Resource API
    • Data Gateway API
    • License Server API
    • [EXPERIMENTAL] 3DSpaces API
Back to top

getSettingΒΆ

  • getSetting

Function getSetting

  • getSetting(setting: UISetting): any

    Parameters

    • setting: UISetting

    Returns any

Next
getStaticUIElement
Previous
exportUserSettings
Copyright ©
GmbH
Legal Notice Privacy Policy threedy.io
Last updated on Jun 16, 2026