Communicator

Modules

`Animation`
`Event`	The Event module exposes UI event listeners for the…
`GUID`
`Markup`	The Markup module factilitates interactions with markup…
`Operator`	Operators provide hooks into various events provided by…
`Selection`	A set of Classes and Interfaces to facilitate Selection…
`Settings`
`StaticGenericType`	This contains constants for commonly known GenericType…
`SubentityProperties`	Properties returned from Model.getFaceProperty and…
`UUID`
`Util`

Enumerations

AntiAliasingMode	Enumerates anti-aliasing modes available in the viewer
AttributeType
Axis	Enumerated values used when referring to an axis
BCFFileType
BCFVersion
BasicUnit
BimMask
BlurIntervalUnit	Specifies the units in which the interval between samples…
BoundingPreviewMode
BranchVisibility	Visibity of a node’s branch, including all children of…
BuiltinOverlayIndex
Button	Enumerated values used when referring to the buttons on a…
Buttons	Bitmask for buttons being pressed when referring to the…
CullingVectorSpace	The space in which a culling vector is defined.
DrawMode	Enumerates drawing modes available in the viewer. More…
ElementType
EventType	Enumerates EventTypes for Operators
FaceWinding	Enumerates face winding for use with geometry. Face…
FileType	FileType
FilterId	Type used to denote Filter IDs.
FloorplanAutoActivation	Different conditions on which the floorplan can be…
FloorplanOrientation	Used to allow different orientations of the floorplan…
HandleEventType	Enumerated values for types of handle events for…
HandleType	Enumerated values for types of handles for…
ImageFormat	Formats accepted when specifying texture images.
InfoType	Enumerates the type of message passed via an info…
InstanceModifier	Enumerates instance modifier modes. More information can…
KeyCode	Enumerates JavaScript Key Codes. We recommend using this…
KeyInputType	Enumerates types of keyboard input
KeyModifiers	Enumerates Modifier Keys. Note this enumeration may not…
LayerId	Type used to denote Layer IDs.
LightSpace	Specifies the space in which a light’s position is…
LightType	Specifies how a light affects the scene. See Light
LinePatternLengthUnit	Specifies the units in which the length of a LinePattern…
MeshInstanceCreationFlags	Flags used when creating a mesh instance
MouseInputType	Enumerates types of mouse input
NodeSource
NodeType	Enumerates of the types returned by Model.getNodeType()
OperatorId	Enumerates IDs for operators. For more information see…
OrbitFallbackMode	Enumerates Camera Orbit Fallback Modes
OverlayAnchor
OverlayUnit	Enumerates the unit types that an overlay viewport value…
PmiSubType	PMI subtype
PmiTopoRef	PMI reference to topology (brep)
PmiType	PMI type
PointShape	Specifies the appearance of points.
PointSizeUnit	Specifies how point size is interpreted.
Projection	Enumerated values used for setting camera projection.
RelationshipType	Define the IFC relationships type
RendererType	Enumerates the mode that is used for rendering
ScreenConfiguration
SelectionHighlightMode	Enumerates the visual indications for selected objects
SelectionMask	Bitmask for allowed selection types
SelectionMode	Enumerates the modes to be used when performing…
SelectionType	Enumerates a type of selection
SimpleReflectionAttenuationUnit	Units in which attenuation distances are specified for…
SnapshotLayer	Specifies which layers to include in a snapshot. These…
StreamingMode	Enumerates the mode the viewer will use when streaming…
TextureModifier	Flags that control how textures are applied.
TextureParameterization	Indicates how texture coordinates are specified or…
TextureTiling	Controls how UV coordinates are interpreted outside the…
TouchInputType	Enumerates types of touch input
TransparencyMode	Enumerates ways of displaying transparent geometry
TreeWalkMode	Possible modes to use when performing operations which…
ViewOrientation	Enumerated values used when setting pre-defined view…
WalkDirection	Enumerates directions for the walk operator
WalkMode	Enumerates Walk Modes
XRayGroup	Specifies a category of nodes in x-ray mode. See…
XRayTransparencyMode	Enumerates ways of displaying transparent (unselected)…

Classes

`AssemblyDataParseError()`	Error object that is thrown when assembly tree data could…
`AxisTriad()`	This class provides an interface to the axis triad which…
`BCFComment()`
`BCFData()`	This class contains data corresponding to the BCF file…
`BCFManager()`	This class provides an interface to the BIM Collaboration…
`BCFMarkup()`
`BCFMarkupHeaderFile()`
`BCFMarkupViewpoint()`
`BCFSnapshot()`
`BCFTopic()`	This class contains data corresponding to a BCF file…
`BCFViewpoint()`
`Box()`	Represents an axis-aligned bounding box. A box is…
`Camera()`	Object representing a viewpoint from which the scene can…
`Color()`	An object representing an RGB Color. Values are specified…
`CommunicatorError()`	Base error class for all Communicator errors. Extends…
`CuttingManager()`	Main interface into the cutting functionality of the…
`CuttingSection()`	Object representing an individual cutting section, more…
`ExplodeManager()`	This class provides an interface to the explode related…
`FaceFaceDistanceItem()`
`FilteredNodes()`
`FloorplanConfig()`	Allows customization of the FloorplanManager user…
`FloorplanManager()`	Main interface into the 2D floorplan functionality for…
`IncrementalPickConfig()`
`InternalLogicError()`	Error object that is thrown when the viewer has entered…
`InvalidIndexError()`	Error object that is thrown when a user supplies an…
`InvalidNodeIdError()`	Error object that is thrown when the user passes an non…
`InvalidNodeTypeError()`	Error object that is thrown when the user passes a node…
`Light()`	Contains properties of a light. More information can be…
`LineManager()`	This class provides an interface to 3D line management…
`LoadCancelledError()`	Error object that is thrown when a model load is…
`LoadError()`	Error object that is thrown when a model could not be…
`LoadSubtreeConfig()`	Configuration for all loadSubtree functions in the Model…
`MarkupManager()`	This class provides an interface into working with markup…
`MarkupTypeManager()`	The markup manager exports JSON data for markup in the…
`Matrix()`	Object representing the 4x4 Matrix. More information can…
`MeasureManager()`	This class provides an interface to measurement…
`MeshData()`	Object which represents geometry data which will be…
`MeshInstanceData()`	Object representing a Mesh instance that will be created…
`MissingModelError()`	Error object that is thrown when an invalid model path is…
`Model()`	Object representing the model geometry and its associated…
`NavCube()`	This class provides an interface to the navigational cube…
`OperatorManager()`	Main interface into the Operator functionality of the…
`OverlayManager()`	The OverlayManager exposes functionality for creating…
`ParseError()`	Error object that is thrown when invalid data is supplied…
`PickConfig()`	Configuration for all pick functions in the View class.
`PickOutsideCanvasError()`	Error object that is thrown when a user attempts to pick…
`Plane()`	Object representing a Plane.
`Point2()`
`Point3()`
`Point4()`
`Ray()`	Object representing a Ray.
`RefOnTopoItem()`	Object which identifies a reference to an element on a…
`SelectionInvalidatedError()`	Error object that is thrown when an asynchronous…
`SelectionManager()`	This class provides the main interface into the selection…
`SheetManager()`
`SnapshotConfig()`	This class contains configuration properties for creating…
`SubentityAttributes()`	Properties returned from Model’s getEdgeAttributes and…
`SvgConfig()`	Allows customization of an exported SVG.
`VerticalGradient()`
`View()`	Object representing the view associated to a model. All…
`ViewAxes()`	Object representing the up and front vectors for the…
`VisibilityState()`	Contains a defaultVisibility boolean and…
`WebViewer()`
`XmlParseError()`	Error object that is thrown when attempting to parse XML…

Interfaces

`Attribute()`
`BcfNode()`
`BloomLayerInfo()`	Describes a single layer in the bloom effect.
`CallbackMap()`	Object which maps callback names to functions. Used by…
`ComparisonConfig()`	Settings that control the behavior of visual node…
`CullingVector()`	A vector and angle used to determine an object’s…
`DeprecatedPromise()`	A promise that can be safely ignored. Functions that…
`GetNodesBoundingConfig()`
`GroundPlane()`	Defines the invisible ground plane onto which simple…
`IdBooleanMap()`	Object which maps an Id to a boolean value
`IdColorMap()`	Object which maps an Id to a color value
`IdNumberMap()`	Object which maps an Id to a number value
`IdStringMap()`	Object which maps an Id to a string value
`ImageBasedLightingOrientation()`	Defines the orientation of the image-based lighting…
`ImageOptions()`	Parameters that describe an image to be used as a texture…
`MarkupData()`
`MeshDataCopy()`	A self-contained copy of the data of a single mesh. The…
`MeshDataCopyElement()`	Provides access to mesh data of a single face, line, or…
`MeshDataCopyElementGroup()`	Provides access to all data of a particular type (faces,…
`MeshDataCopyIterator()`	An iterator over the vertices of a MeshDataCopyElement or…
`MeshDataCopyVertex()`	The data for a single vertex in a MeshDataCopy returned…
`MetallicRoughnessValue()`	Represents a node’s metallic and roughness values when…
`RelationshipInfo()`
`StringStringMap()`	Object which maps a string to a string
`TextureOptions()`	Parameters that describe a texture and control how it is…
`UnitElement()`
`WebViewerConfig()`

Type aliases

BCFCommentId
BCFMarkupName
BCFName
BCFTopicId
BCFViewpointName
BimId	Type for the relationships ID
BodyId	Type used to denote assembly tree body IDs. All BodyIds…
BuiltInOperatorId	Enumerates IDs for built-in operators
CadViewId	Type used to denote assembly tree CAD view IDs. All…
Degrees	Type used to denote the degrees of angles.
ExchangeId	Type used to denote Exchange IDs.
ExternalModelName	Type used to denote an XML ExternalModel name.
FilterName	Type used to denote Filter names.
GenericId	Type used to denote generic id
GenericType	Type used to denote generic types
Guid
HtmlId	Type used to denote HTML IDs.
IfcGuid
IfcType
ImageId	A pair of numbers identifying an image.
LayerName	Type used to denote Layer names.
LightKey	Type used to denote light keys
LinePattern	Specifies the appearance of a single repetion of a line…
MassageModelNameFunc	Callback to massage ExternalModel names within an XML…
MeshId	A pair of numbers identifying a mesh.
MetaDataParseError
Milliseconds	A number typed in millisecond units.
ModelNameToScsFileFunc	Callback to map ExternalModel names within an XML load…
NodeId	Type used to denote assembly tree node IDs.
NodeIdOffset
OverlayIndex	Type used to denote overlay indices.
PMISubType
PMITopoRef
PMIType
PartId	Type used to denote assembly tree part IDs. All PartIds…
Pixels	A number typed in pixel units.
PmiId	Type used to denote assembly tree PMI IDs. All PmiIds are…
Radians	Type used to denote the radians of angles.
ScModelName	Type used to denote an SC model name.
ScsBuffer	Type used to denote an SCS model’s byte buffer.
ScsUri	Type used to denote an SCS model’s URI.
SelectionFilter
SheetId	Type used to denote assembly tree sheet IDs. All SheetIds…
Unreferenced	Used to silence TypeScript unused variable warnings.
UserDataIndex	This is the User Data Index for a node.
Uuid	Type used to denote GUIDs.
VolumePickConfig
XmlFilename	Type used to denote an XML filename.

Variables

`DefaultTransitionDuration`	The default duration in milliseconds of camera…
`EmptyModelName`
`InvalidNodeId`
`MetaDataParseError`
`PMISubType`
`PMITopoRef`
`PMIType`

Type aliases

BCFCommentId

BCFMarkupName

BCFName

BCFTopicId

BCFViewpointName

BimId

Type for the relationships ID

BodyId

Type used to denote assembly tree body IDs. All BodyIds are NodeIds.

BuiltInOperatorId

Enumerates IDs for built-in operators

CadViewId

Type used to denote assembly tree CAD view IDs. All CadViewIds are NodeIds.

Degrees

Type used to denote the degrees of angles.

ExchangeId

Type used to denote Exchange IDs.

ExternalModelName

Type used to denote an XML ExternalModel name.

FilterName

Type used to denote Filter names.

GenericId

Type used to denote generic id

GenericType

Type used to denote generic types

Guid

Note

Guid is deprecated: Use uuid instead.

HtmlId

Type used to denote HTML IDs.

IfcGuid

Note

IfcGuid is deprecated: Use GenericId instead.

IfcType

Note

IfcType is deprecated: Use GenericType instead.

ImageId

A pair of numbers identifying an image.

LayerName

Type used to denote Layer names.

LightKey

Type used to denote light keys

LinePattern

Specifies the appearance of a single repetion of a line pattern. The format is an arbitrary-length array of 1s and 0s, where pixels covered by a 1 in the pattern are visible and pixels covered by a 0 are invisible.

Examples: - [1,0]: a dashed line with equal-length dashes and gaps - [1,1,1,1,1,1,1,1,1,0,0,0,0,1,0,0,0,0]: a dash followed by a gap of equal length with a dot in the center

MassageModelNameFunc

Callback to massage ExternalModel names within an XML load file to SC model names. Return null to skip the model. Returned value can be synchronous (non-Promise) or asynchronous (Promise).

MeshId

A pair of numbers identifying a mesh.

MetaDataParseError

Note

MetaDataParseError is deprecated

Milliseconds

A number typed in millisecond units.

ModelNameToScsFileFunc

Callback to map ExternalModel names within an XML load file to SCS file URis or SCS file buffers. Return null to skip the model. Returned value can be synchronous (non-Promise) or asynchronous (Promise).

NodeId

Type used to denote assembly tree node IDs.

NodeIdOffset

OverlayIndex

Type used to denote overlay indices.

PMISubType

Note

PMISubType is deprecated: Use PmiSubType instead.

PMITopoRef

Note

PMITopoRef is deprecated: Use PmiTopoRef instead.

PMIType

Note

PMIType is deprecated: Use PmiType instead.

PartId

Type used to denote assembly tree part IDs. All PartIds are NodeIds.

Pixels

A number typed in pixel units.

PmiId

Type used to denote assembly tree PMI IDs. All PmiIds are NodeIds.

Radians

Type used to denote the radians of angles.

ScModelName

Type used to denote an SC model name.

ScsBuffer

Type used to denote an SCS model’s byte buffer.

ScsUri

Type used to denote an SCS model’s URI.

SelectionFilter

SheetId

Type used to denote assembly tree sheet IDs. All SheetIds are NodeIds.

Unreferenced

Used to silence TypeScript unused variable warnings.

Usage:

x as Unreferenced;

UserDataIndex

This is the User Data Index for a node.

Values of this type are unsigned 64 bit numbers.

A value is of type number when it can be represented precisely as such.

Otherwise a value is of type string, where the string is the hex encoding of the index. The hex representation is in uppercase and does not have a leading 0x.

Uuid

Type used to denote GUIDs.

VolumePickConfig

Note

VolumePickConfig is deprecated: Use IncrementalPickConfig instead.

XmlFilename

Type used to denote an XML filename.

Variables

Communicator.DefaultTransitionDuration: The default duration in milliseconds of camera transitions.

Communicator.EmptyModelName

Communicator.InvalidNodeId

Communicator.MetaDataParseError: Note

MetaDataParseError is deprecated

Communicator.PMISubType: Note

PMISubType is deprecated: Use PmiSubType instead.

Communicator.PMITopoRef: Note

PMITopoRef is deprecated: Use PmiTopoRef instead.

Communicator.PMIType: Note

PMIType is deprecated: Use PmiType instead.