Modules
Enumerations
- Anti
Aliasing Mode - Attribute
Type - Axis
- BCFFile
Type - BCFVersion
- Basic
Unit - Bim
Mask - Blur
Interval Unit - Bounding
Preview Mode - Branch
Visibility - Builtin
Overlay Index - Button
- Buttons
- Culling
Vector Space - Cutting
Section Index - Draw
Mode - Element
Type - Event
Type - Face
Winding - File
Type - Filter
Id - Floorplan
Auto Activation - Floorplan
Orientation - Handle
Event Type - Handle
Type - Image
Format - Info
Type - Instance
Modifier - Key
Code - Key
Input Type - Key
Modifiers - Layer
Id - Light
Space - Light
Type - Line
Pattern Length Unit - Mesh
Instance Creation Flags - Mouse
Input Type - Node
Source - Node
Type - Operator
Id - Orbit
Fallback Mode - Overlay
Anchor - Overlay
Unit - Pmi
Sub Type - Pmi
Topo Ref - Pmi
Type - Point
Shape - Point
Size Unit - Projection
- Relationship
Type - Renderer
Type - Screen
Configuration - Selection
Highlight Mode - Selection
Mask - Selection
Mode - Selection
Type - Simple
Reflection Attenuation Unit - Snapshot
Layer - Streaming
Mode - Texture
Modifier - Texture
Parameterization - Texture
Tiling - Touch
Input Type - Transparency
Mode - Tree
Walk Mode - View
Orientation - Walk
Direction - Walk
Mode - XRay
Group - XRay
Transparency Mode
Classes
- Assembly
Data Parse Error - Axis
Triad - BCFComment
- BCFData
- BCFManager
- BCFMarkup
- BCFMarkup
Header File - BCFMarkup
Viewpoint - BCFSnapshot
- BCFTopic
- BCFViewpoint
- Box
- Camera
- Color
- Communicator
Error - Cutting
Manager - Cutting
Section - Explode
Manager - Face
Face Distance Item - Filtered
Nodes - Floorplan
Config - Floorplan
Manager - Incremental
Pick Config - Internal
Logic Error - Invalid
Index Error - Invalid
Node IdError - Invalid
Node Type Error - Light
- Line
Manager - Load
Cancelled Error - Load
Error - Load
Subtree Config - Markup
Manager - Markup
Type Manager - Matrix
- Measure
Manager - Mesh
Data - Mesh
Instance Data - Missing
Model Error - Model
- Nav
Cube - Operator
Manager - Overlay
Manager - Parse
Error - Pick
Config - Pick
Outside Canvas Error - Plane
- Point2
- Point3
- Point4
- Ray
- Ref
OnTopo Item - Selection
Invalidated Error - Selection
Manager - Sheet
Manager - Snapshot
Config - Subentity
Attributes - Svg
Config - Vertical
Gradient - View
- View
Axes - Visibility
State - Web
Viewer - Xml
Parse Error
Interfaces
- Attribute
- Bloom
Layer Info - Callback
Map - Comparison
Config - Culling
Vector - Deprecated
Promise - Get
Nodes Bounding Config - Ground
Plane - Id
Boolean Map - Id
Color Map - Id
Number Map - Id
String Map - Image
Based Lighting Orientation - Image
Options - Markup
Data - Mesh
Data Copy - Mesh
Data Copy Element - Mesh
Data Copy Element Group - Mesh
Data Copy Iterator - Mesh
Data Copy Vertex - Metallic
Roughness Value - Relationship
Info - String
String Map - Texture
Options - Unit
Element - Web
Viewer Config
Type aliases
- BCFComment
Id - BCFMarkup
Name - BCFName
- BCFTopic
Id - BCFViewpoint
Name - Bim
Id - Body
Id - Built
InOperator Id - Cad
View Id - Degrees
- Exchange
Id - External
Model Name - Filter
Name - Generic
Id - Generic
Type - Html
Id - Image
Id - Layer
Name - Light
Key - Line
Pattern - Massage
Model Name Func - Mesh
Id - Milliseconds
- Model
Name ToScs File Func - Node
Id - Node
IdOffset - Overlay
Index - Part
Id - Pixels
- Pmi
Id - Radians
- Sc
Model Name - Scs
Buffer - Scs
Uri - Selection
Filter - Sheet
Id - Unreferenced
- User
Data Index - Uuid
- Xml
Filename
Variables
Type aliases
BCFCommentId
BCFMarkupName
BCFName
BCFTopicId
BCFViewpointName
BimId
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 [deprecated]
HtmlId
Type used to denote HTML IDs.
IfcGuid
[deprecated]
IfcType
[deprecated]
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).
Type declaration
-
-
Parameters
-
modelName: ExternalModelName
Returns Promise<ScModelName | null> | string
-
-
MeshId
A pair of numbers identifying a mesh.
MetaDataParseError
[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).
Type declaration
-
-
Parameters
-
modelName: ExternalModelName
Returns Promise<ScsUri | ScsBuffer | null> | string | Uint8Array
-
-
NodeId
Type used to denote assembly tree node IDs.
NodeIdOffset
OverlayIndex
Type used to denote overlay indices.
PMISubType
[deprecated]
PMITopoRef
[deprecated]
PMIType [deprecated]
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
[deprecated]
XmlFilename
Type used to denote an XML filename.
Variables
Let DefaultTransitionDuration
The default duration in milliseconds of camera transitions.
Type for the relationships ID