Getting Started
Tutorials
Programming Guide
API References
Animation
BatchedCameraValues
BatchedNodeValues
BatchedValues
CameraChannel
ColorPosition
KeyframeBuffer
Manager
NodeChannel
Player
Sampler
AssemblyDataParseError
AssemblyDataParseError.constructor()
AssemblyDataParseError.message
AssemblyDataParseError.name
AssemblyDataParseError.stack
Attribute
AxisTriad
BCFComment
BCFComment.constructor()
BCFData
BCFData.constructor()
BCFManager
BCFManager.constructor()
BCFMarkup
BCFMarkup.constructor()
BCFMarkupHeaderFile
BCFMarkupHeaderFile.constructor()
BCFMarkupViewpoint
BCFMarkupViewpoint.constructor()
BcfNode
BcfNode.genericId
BcfNode.nodeId
BCFSnapshot
BCFSnapshot.constructor()
BCFTopic
BCFTopic.constructor()
BCFViewpoint
BCFViewpoint.constructor()
BloomLayerInfo
BloomLayerInfo.blurInterval
BloomLayerInfo.blurSamples
BloomLayerInfo.intensity
Box
Box.constructor()
Box.max
Box.min
CallbackMap
CallbackMap.XHRonerror
CallbackMap.XHRonloadend
CallbackMap.XHRonprogress
CallbackMap.addCuttingSection
CallbackMap.assemblyTreeReady
CallbackMap.bcfLoaded
CallbackMap.bcfRemoved
CallbackMap.beginInteraction
CallbackMap.cadViewCreated
CallbackMap.camera
CallbackMap.cappingIdle
CallbackMap.configurationActivated
CallbackMap.contextMenu
CallbackMap.cuttingPlaneDrag
CallbackMap.cuttingPlaneDragEnd
CallbackMap.cuttingPlaneDragStart
CallbackMap.cuttingSectionsLoaded
CallbackMap.deprecated
CallbackMap.endInteraction
CallbackMap.explode
CallbackMap.firstModelLoaded
CallbackMap.frameDrawn
CallbackMap.handleEvent
CallbackMap.handleEventEnd
CallbackMap.handleEventStart
CallbackMap.hwfParseComplete
CallbackMap.incrementalSelectionBatchBegin
CallbackMap.incrementalSelectionBatchEnd
CallbackMap.incrementalSelectionEnd
CallbackMap.info
CallbackMap.lineCreated
CallbackMap.lineDeleted
CallbackMap.lineLoaded
CallbackMap.measurement
CallbackMap.measurementBegin
CallbackMap.measurementCreated
CallbackMap.measurementDeleted
CallbackMap.measurementHidden
CallbackMap.measurementLoaded
CallbackMap.measurementShown
CallbackMap.measurementValueSet
CallbackMap.missingModel
CallbackMap.modelLoadBegin
CallbackMap.modelLoadFailure
CallbackMap.modelLoaded
CallbackMap.modelStructureHeaderParsed
CallbackMap.modelStructureLoadBegin
CallbackMap.modelStructureLoadEnd
CallbackMap.modelStructureParseBegin
CallbackMap.modelStructureReady
CallbackMap.modelSwitchStart
CallbackMap.modelSwitched
CallbackMap.noteTextCreated
CallbackMap.noteTextHidden
CallbackMap.noteTextShown
CallbackMap.overlayViewportSet
CallbackMap.partsVisibilityHidden
CallbackMap.partsVisibilityShown
CallbackMap.redlineCreated
CallbackMap.redlineDeleted
CallbackMap.redlineUpdated
CallbackMap.removeCuttingSection
CallbackMap.sceneReady
CallbackMap.sceneRendered
CallbackMap.selection
CallbackMap.selectionArray
CallbackMap.shatteredXmlStructureReady
CallbackMap.sheetActivated
CallbackMap.sheetDeactivated
CallbackMap.streamingActivated
CallbackMap.streamingDeactivated
CallbackMap.subtreeDeleted
CallbackMap.subtreeLoaded
CallbackMap.timeout
CallbackMap.timeoutWarning
CallbackMap.transitionBegin
CallbackMap.transitionEnd
CallbackMap.viewAxes
CallbackMap.viewCreated
CallbackMap.viewDeactivated
CallbackMap.viewDeleted
CallbackMap.viewLoaded
CallbackMap.viewOrientation
CallbackMap.visibilityChanged
CallbackMap.volumeSelectionBatchBegin
CallbackMap.volumeSelectionBatchEnd
CallbackMap.volumeSelectionEnd
CallbackMap.walkOperatorActivated
CallbackMap.walkOperatorDeactivated
CallbackMap.webGlContextLost
CallbackMap.websocketConnectionClosed
Camera
Color
Color.constructor()
Color.b
Color.g
Color.r
CommunicatorError
CommunicatorError.constructor()
CommunicatorError.message
CommunicatorError.name
CommunicatorError.stack
CommunicatorError.Error
ComparisonConfig
ComparisonConfig.only1Color
ComparisonConfig.only2Color
ComparisonConfig.sameColor
CullingVector
CullingVector.space
CullingVector.toleranceDegrees
CullingVector.vector
CuttingManager
CuttingSection
DeprecatedPromise
DeprecatedPromise.Promise
DeprecatedPromise.[Symbol.toStringTag]
InputEvent
KeyInputEvent
MouseInputEvent
MouseInputEventBase
MouseWheelInputEvent
NodeSelectionEvent
TouchInputEvent
ExplodeManager
FaceFaceDistanceItem
FaceFaceDistanceItem.distance
FaceFaceDistanceItem.pos1
FaceFaceDistanceItem.pos2
FilteredNodes
FilteredNodes.constructor()
FilteredNodes.isInclusive
FilteredNodes.nodeIds
FloorplanConfig
FloorplanConfig.autoActivate
FloorplanConfig.avatarColor
FloorplanConfig.avatarOpacity
FloorplanConfig.avatarOutlineColor
FloorplanConfig.avatarScale
FloorplanConfig.backgroundColor
FloorplanConfig.backgroundOpacity
FloorplanConfig.borderColor
FloorplanConfig.borderOpacity
FloorplanConfig.customAvatar
FloorplanConfig.fixedAvatarScale
FloorplanConfig.floorplanOrientation
FloorplanConfig.overlayAnchor
FloorplanConfig.overlayFeetPerPixel
FloorplanConfig.overlayHeightUnit
FloorplanConfig.overlayOffset
FloorplanConfig.overlayOffsetXUnit
FloorplanConfig.overlayOffsetYUnit
FloorplanConfig.overlaySize
FloorplanConfig.overlayWidthUnit
FloorplanConfig.trackCameraEnabled
FloorplanConfig.zoomLevel
FloorplanManager
GetNodesBoundingConfig
GetNodesBoundingConfig.bodyInstance
GetNodesBoundingConfig.ignoreInvisible
GetNodesBoundingConfig.pmiBody
GetNodesBoundingConfig.tightBounding
GetNodesBoundingConfig.viewFrame
GroundPlane
GroundPlane.followViewAxes
GroundPlane.normal
GroundPlane.position
IdBooleanMap
IdColorMap
IdNumberMap
IdStringMap
ImageBasedLightingOrientation
ImageBasedLightingOrientation.followViewAxes
ImageBasedLightingOrientation.matrix
ImageOptions
ImageOptions.data
ImageOptions.format
ImageOptions.height
ImageOptions.width
IncrementalPickConfig
IncrementalPickConfig.constructor()
IncrementalPickConfig.allowFaces
IncrementalPickConfig.allowLines
IncrementalPickConfig.allowPoints
IncrementalPickConfig.bimMask
IncrementalPickConfig.forceEffectiveSceneVisibilityMask
IncrementalPickConfig.forceEffectiveVisibilityMask
IncrementalPickConfig.ignoreCuttingSections
IncrementalPickConfig.ignoreUnrequestedInstances
IncrementalPickConfig.mustBeFullyContained
IncrementalPickConfig.onlyStreamedInstances
IncrementalPickConfig.respectVisibility
InternalLogicError
InternalLogicError.constructor()
InternalLogicError.message
InternalLogicError.name
InternalLogicError.stack
InvalidIndexError
InvalidIndexError.constructor()
InvalidIndexError.message
InvalidIndexError.name
InvalidIndexError.stack
InvalidNodeIdError
InvalidNodeIdError.constructor()
InvalidNodeIdError.message
InvalidNodeIdError.name
InvalidNodeIdError.nodeId
InvalidNodeIdError.stack
InvalidNodeTypeError
InvalidNodeTypeError.constructor()
InvalidNodeTypeError.expectedTypes
InvalidNodeTypeError.message
InvalidNodeTypeError.name
InvalidNodeTypeError.nodeId
InvalidNodeTypeError.stack
Light
Light.constructor()
Light.color
Light.position
Light.space
Light.type
LineManager
LoadCancelledError
LoadCancelledError.constructor()
LoadCancelledError.message
LoadCancelledError.name
LoadCancelledError.stack
LoadError
LoadError.constructor()
LoadError.message
LoadError.name
LoadError.stack
LoadSubtreeConfig
LoadSubtreeConfig.additionalMatrix
LoadSubtreeConfig.allowMissingExternalModels
LoadSubtreeConfig.attachInvisibly
LoadSubtreeConfig.ignoreBimRelationships
LoadSubtreeConfig.ignoreCadViews
LoadSubtreeConfig.ignoreFilters
LoadSubtreeConfig.ignoreGenericTypes
LoadSubtreeConfig.ignoreLayers
LoadSubtreeConfig.implicitlyLoadXmlExternalModels
MarkupItem
MarkupRenderer
MarkupView
MarkupData
MarkupManager
MarkupTypeManager
Matrix
Matrix.constructor()
Matrix.m
MeasureManager
MeshData
MeshDataCopy
MeshDataCopy.faces
MeshDataCopy.isManifold
MeshDataCopy.isTwoSided
MeshDataCopy.lines
MeshDataCopy.points
MeshDataCopy.winding
MeshDataCopyElement
MeshDataCopyElement.bits
MeshDataCopyElement.vertexCount
MeshDataCopyElementGroup
MeshDataCopyElementGroup.elementCount
MeshDataCopyElementGroup.hasNormals
MeshDataCopyElementGroup.hasRGBAs
MeshDataCopyElementGroup.hasUVs
MeshDataCopyElementGroup.vertexCount
MeshDataCopyIterator
MeshDataCopyVertex
MeshDataCopyVertex.RGBA
MeshDataCopyVertex.UV
MeshDataCopyVertex.normal
MeshDataCopyVertex.position
MeshInstanceData
MeshInstanceData.constructor()
MetallicRoughnessValue
MetallicRoughnessValue.metallic
MetallicRoughnessValue.roughness
MissingModelError
MissingModelError.constructor()
MissingModelError.message
MissingModelError.name
MissingModelError.stack
Model
NavCube
AreaSelectionOperator
AxisTriadOperator
CameraKeyboardWalkOperator
CameraNavigationOperator
CameraOrbitOperator
CameraPanOperator
CameraTurntableOperator
CameraWalkModeOperator
CameraWalkOperator
CameraWindowZoomOperator
CameraZoomOperator
CuttingPlaneOperator
FloorplanOperator
HandleOperator
MeasureBodyBodyDistanceOperator
MeasureEdgeLengthOperator
MeasureFaceFaceAngleOperator
MeasureFaceFaceDistanceOperator
MeasureLineLineAngleOperator
MeasurePointPointDistanceOperator
MeasurePolygonAreaOperator
MeasurePolylineDistanceOperator
NavCubeOperator
NoteOperator
Operator
RayDrillSelectionOperator
RedlineCircleOperator
RedlinePolylineOperator
RedlineRectangleOperator
RedlineTextOperator
SelectionOperator
SpaceMouseOperator
OperatorManager
OverlayManager
ParseError
ParseError.constructor()
ParseError.message
ParseError.name
ParseError.stack
PickConfig
PickConfig.constructor()
PickConfig.allowFaces
PickConfig.allowLines
PickConfig.allowPoints
PickConfig.bimMask
PickConfig.enableProximityFaces
PickConfig.forceEffectiveSceneVisibilityMask
PickConfig.forceEffectiveVisibilityMask
PickConfig.ignoreCappingGeometry
PickConfig.ignoreOverlays
PickConfig.maxWorldDistance
PickConfig.oneEntityPerTypePerInstance
PickConfig.rejectionBitsAll
PickConfig.rejectionBitsAny
PickConfig.requiredBitsAll
PickConfig.requiredBitsAny
PickConfig.respectDepthRange
PickConfig.respectVisibility
PickConfig.restrictLinesAndPointsToSelectedFaceInstances
PickConfig.restrictToOverlays
PickConfig.selectionMask
PickOutsideCanvasError
PickOutsideCanvasError.constructor()
PickOutsideCanvasError.message
PickOutsideCanvasError.name
PickOutsideCanvasError.stack
Plane
Plane.d
Plane.normal
Point2
Point2.constructor()
Point2.x
Point2.y
Point3
Point3.constructor()
Point3.x
Point3.y
Point3.z
Point4
Point4.constructor()
Point4.w
Point4.x
Point4.y
Point4.z
Ray
Ray.constructor()
Ray.direction
Ray.origin
RefOnTopoItem
RefOnTopoItem.bodyID
RefOnTopoItem.bodyId
RefOnTopoItem.subElementIndex
RefOnTopoItem.subElementType
RelationshipInfo
RelationshipInfo.relateds
RelationshipInfo.relatings
RelationshipInfo.type
CompositeSelectionItem
EntitySelectionItem
FaceEntity
FaceSelectionItem
IncrementalSelectionId
LineEntity
LineSelectionItem
NodeEntitySelectionItem
NodeSelectionItem
PointEntity
PointSelectionItem
SelectionItem
SelectionInvalidatedError
SelectionInvalidatedError.constructor()
SelectionInvalidatedError.message
SelectionInvalidatedError.name
SelectionInvalidatedError.stack
SelectionManager
SelectionManager.ifcSelectionFilter
HiddenLineSettings
SheetManager
SheetManager.constructor()
SnapshotConfig
SnapshotConfig.constructor()
SnapshotConfig.height
SnapshotConfig.layers
SnapshotConfig.width
StaticGenericType.IfcColumn
StaticGenericType.IfcCovering
StaticGenericType.IfcCurtainWall
StaticGenericType.IfcDoor
StaticGenericType.IfcRamp
StaticGenericType.IfcRoof
StaticGenericType.IfcSlab
StaticGenericType.IfcSpace
StaticGenericType.IfcStair
StaticGenericType.IfcStairFlight
StaticGenericType.IfcTransportElement
StaticGenericType.IfcWall
StaticGenericType.IfcWallStandardCase
StaticGenericType.IfcWindow
StringStringMap
SubentityAttributes
SubentityAttributes.constructor()
SubentityAttributes.attributes
Blend01Element
Blend02Element
Blend03Element
CircleElement
ConeElement
CylinderElement
CylindricalElement
ExtrusionElement
FromCurvesElement
LineElement
NurbsElement
OffsetElement
OtherEdgeElement
OtherFaceElement
PipeElement
PlaneElement
RevolutionElement
RuledElement
SphereElement
TorusElement
TransformElement
SvgConfig
SvgConfig.linesClipProximityToPlane
SvgConfig.linesClipZNudgeFactor
SvgConfig.linesCssColor
SvgConfig.linesDrawModelLinesEnabled
SvgConfig.linesStrokeWidth
SvgConfig.logDiagnostics
SvgConfig.logProgress
SvgConfig.polygonsForceDrawCssColor
SvgConfig.silhouettesEnabled
SvgConfig.svgBackgroundCssColor
SvgConfig.svgXmlPrologEnabled
TextureOptions
TextureOptions.imageId
TextureOptions.interpolation
TextureOptions.matrix
TextureOptions.mipMapping
TextureOptions.modifiers
TextureOptions.parameterization
TextureOptions.tiling
UnitElement
UnitElement.basicUnit
UnitElement.exponent
UnitElement.factor
ActionQueue
CurrentAction
CurrentActionSync
IncrementalSelection
Lazy
OpenPromise
StateMachine
Timer
VerticalGradient
VerticalGradient.constructor()
VerticalGradient.bottom
VerticalGradient.top
View
View.axisTriad
View.navCube
ViewAxes
ViewAxes.frontVector
ViewAxes.upVector
VisibilityState
VisibilityState.constructor()
VisibilityState.defaultVisibility
VisibilityState.visibilityExceptions
WebViewer
WebViewer.constructor()
WebViewer.BCFManager
WebViewer.animationManager
WebViewer.cuttingManager
WebViewer.explodeManager
WebViewer.floorplanManager
WebViewer.lineManager
WebViewer.markupManager
WebViewer.measureManager
WebViewer.model
WebViewer.noteTextManager
WebViewer.operatorManager
WebViewer.overlayManager
WebViewer.selectionManager
WebViewer.sheetManager
WebViewer.view
WebViewerConfig
WebViewerConfig.boundingPreviewMode
WebViewerConfig.buffer
WebViewerConfig.calculateDefaultViewAxes
WebViewerConfig.container
WebViewerConfig.containerId
WebViewerConfig.defaultMeshLevel
WebViewerConfig.defaultMetallicFactor
WebViewerConfig.defaultRoughnessFactor
WebViewerConfig.disableAutomaticBackgroundSheets
WebViewerConfig.disableAutomaticFitWorld
WebViewerConfig.disableAutomaticFloorplanOverlay
WebViewerConfig.empty
WebViewerConfig.enableShatteredModelUiViews
WebViewerConfig.endpointUri
WebViewerConfig.enginePath
WebViewerConfig.memoryLimit
WebViewerConfig.model
WebViewerConfig.rendererType
WebViewerConfig.sessionToken
WebViewerConfig.streamCutoffScale
WebViewerConfig.streamingMode
WebViewerConfig.usePointerEvents
XmlParseError
XmlParseError.constructor()
XmlParseError.message
XmlParseError.name
XmlParseError.stack
Communicator.DefaultTransitionDuration
Communicator.EmptyModelName
Communicator.InvalidNodeId
Communicator.MetaDataParseError
Communicator.PMISubType
Communicator.PMITopoRef
Communicator.PMIType
Additional Resources
Enumerated values used when referring to the buttons on a mouse
Enumeration members
Left
Middle
None
Right
Left mouse button
Middle mouse button
No mouse button
Right mouse button
