Properties
- XHRonerror
- XHRonloadend
- XHRonprogress
- add
Cutting Section - assembly
Tree Ready - bcf
Loaded - bcf
Removed - begin
Interaction - cad
View Created - camera
- capping
Idle - configuration
Activated - context
Menu - cutting
Plane Drag - cutting
Plane Drag End - cutting
Plane Drag Start - cutting
Sections Loaded - deprecated
- end
Interaction - explode
- first
Model Loaded - frame
Drawn - handle
Event - handle
Event End - handle
Event Start - hwf
Parse Complete - incremental
Selection Batch Begin - incremental
Selection Batch End - incremental
Selection End - info
- line
Created - line
Deleted - line
Loaded - measurement
Begin - measurement
Created - measurement
Deleted - measurement
Hidden - measurement
Loaded - measurement
Shown - measurement
Value Set - missing
Model - model
Load Begin - model
Load Failure - model
Structure Header Parsed - model
Structure Ready - model
Switch Start - model
Switched - note
Text Created - note
Text Hidden - note
Text Shown - overlay
Viewport Set - redline
Created - redline
Deleted - redline
Updated - remove
Cutting Section - scene
Ready - selection
Array - sheet
Activated - sheet
Deactivated - streaming
Activated - streaming
Deactivated - subtree
Deleted - subtree
Loaded - timeout
- timeout
Warning - transition
Begin - transition
End - view
Axes - view
Created - view
Deactivated - view
Deleted - view
Loaded - view
Orientation - visibility
Changed - walk
Operator Activated - walk
Operator Deactivated - web
GlContext Lost - websocket
Connection Closed
Properties
Optional XHRonerror
Triggered during load progress of HTTP requests.
Happens when an error occurs during the loading of a model via an HTTP request. For some errors (e.g. 404) make sure to check the status of XHRonloadend instead.
Type declaration
-
-
Parameters
-
errorEvent: ErrorEvent
Returns void
-
-
Optional XHRonloadend
Triggered when an HTTP request completes.
A completed HTTP request does not necessarily indicate success. Make sure to check the return status.
Type declaration
-
-
Parameters
-
progressEvent: ProgressEvent
-
status: number
-
uri: string
Returns void
-
-
Optional XHRonprogress
Triggered during load progress of HTTP requests.
Happens when loading a model via an HTTP request.
Type declaration
-
-
Parameters
-
progressEvent: ProgressEvent
Returns void
-
-
Optional addCuttingSection
Triggered when a cutting section is added to the scene.
Type declaration
-
-
Parameters
-
cuttingSection: CuttingSection
Returns void
-
-
Optional assemblyTreeReady
Triggered when methods on the Model class are allowed to be called.
Type declaration
-
-
Returns void
-
Optional bcfLoaded
Triggered after a BCF file has been loaded.
Type declaration
-
-
Parameters
-
id: number
-
filename: BCFName
Returns void
-
-
Optional bcfRemoved
Triggered after a BCF file has been removed.
Type declaration
-
-
Parameters
-
id: number
Returns void
-
-
Optional beginInteraction
Triggered on the start of a mouse drag from any of the built-in Communicator operators.
Type declaration
-
-
Returns void
-
Optional cadViewCreated
Triggered when a CAD View is created.
Type declaration
-
-
Parameters
-
cadViewId: CadViewId
-
cadViewName: string
Returns void
-
-
Optional camera
Triggered when the camera changes.
Type declaration
-
-
The changed camera.
Parameters
-
camera: Camera
Returns void
-
-
Optional cappingIdle
Triggered when capping geometry generation becomes idle or active.
Type declaration
-
-
Parameters
-
isIdle: boolean
-
cappedInstanceCount: number
Returns void
-
-
Optional configurationActivated
Triggered when a Configuration is activated.
Type declaration
-
-
Parameters
-
nodeId: NodeId
Returns void
-
-
Optional contextMenu
Triggered when Ui.Context.ContextMenu
menu is shown or hidden.
By default, this function is called on right mouse-click events.
Type declaration
-
-
Parameters
-
position: Point2
-
modifiers: KeyModifiers
Returns void
-
-
Optional cuttingPlaneDrag
Triggered when a cutting plane is dragged.
Type declaration
-
-
Parameters
-
cuttingSection: CuttingSection
-
planeIndex: number
Returns void
-
-
Optional cuttingPlaneDragEnd
Triggered when a cutting plane drag event stops.
Type declaration
-
-
Parameters
-
cuttingSection: CuttingSection
-
planeIndex: number
Returns void
-
-
Optional cuttingPlaneDragStart
Triggered when a cutting plane drag event starts.
Type declaration
-
-
Parameters
-
cuttingSection: CuttingSection
-
planeIndex: number
Returns void
-
-
Optional cuttingSectionsLoaded
Triggered after a batch update to cutting sections, such as when deserializing from JSON data.
This event may be triggered manually after modifying cutting sections to cause the UI state to be updated.
Type declaration
-
-
Returns void
-
Optional deprecated
Triggered when a function marked (@deprecated) is called.
Type declaration
-
-
Parameters
-
classNameOfDeprecatedFunction: string
-
deprecatedFunctionName: string
Returns void
-
-
Optional endInteraction
Triggered at the end of a mouse drag from any of the built-in Communicator operators or if Operator.stopInteraction gets called for a given operator.
Type declaration
-
-
Returns void
-
Optional explode
Triggered when the expode magnitude of ExplodeManager changes.
Type declaration
-
-
Parameters
-
magnitude: number
Returns void
-
-
Optional firstModelLoaded
Triggered when the first model of a scene gets loaded.
Clearing or switching models allows this to be triggered again.
Type declaration
-
-
Parameters
-
modelRootIds: NodeId[]
-
isHwf: boolean
Returns void
-
-
Optional frameDrawn
Triggered when a frame has been drawn.
Type declaration
-
-
Parameters
-
camera: Camera
-
visiblePoints: number[]
Returns void
-
-
Optional handleEvent
Triggered when a geometry handle is moved.
Type declaration
-
-
Parameters
-
eventType: HandleEventType
-
nodeIds: NodeId[]
-
initialMatrices: Matrix[]
-
newMatrices: Matrix[]
Returns void
-
-
Optional handleEventEnd
Triggered when a geometry handle is no longer selected.
Type declaration
-
-
Parameters
-
eventType: HandleEventType
-
nodeIds: NodeId[]
-
initialMatrices: Matrix[]
-
newMatrices: Matrix[]
Returns void
-
-
Optional handleEventStart
Triggered when a geometry handle is selected.
Type declaration
-
-
Parameters
-
eventType: HandleEventType
-
nodeIds: NodeId[]
-
initialMatrices: Matrix[]
Returns void
-
-
Optional hwfParseComplete
Triggered when HWF parsing becomes completed.
Type declaration
-
-
Returns void
-
Optional incrementalSelectionBatchBegin
Triggered before a batch of incrementally selected entities is put into the SelectionManager.
See also:
Type declaration
-
-
Returns void
-
Optional incrementalSelectionBatchEnd
Triggered after a batch of incrementally selected entities is put into the SelectionManager.
See also:
Type declaration
-
-
Returns void
-
Optional incrementalSelectionEnd
Triggered after all batches of incrementally selected entities have been put into the SelectionManager.
See also:
Type declaration
-
-
Returns void
-
Optional info
Triggered when an info message is generated by the viewer.
Type declaration
-
-
Parameters
-
infoType: InfoType
-
message: string
Returns void
-
-
Optional lineCreated
Triggered when a markup line is created.
Type declaration
-
-
Parameters
-
line: LineMarkup
Returns void
-
-
Optional lineDeleted
Triggered when a markup line is deleted.
Type declaration
-
-
Parameters
-
line: LineMarkup
Returns void
-
-
Optional lineLoaded
Triggered when a markup line is loaded.
Type declaration
-
-
Parameters
-
line: LineMarkup
Returns void
-
-
Optional measurement [deprecated]
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementBegin
Triggered when a measurement operator has begun measuring.
Type declaration
-
-
Returns void
-
Optional measurementCreated
Triggered when a measurement is fully created.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementDeleted
Triggered when a measurement is deleted by its MeasureManager.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementHidden
Triggered when a measurement is hidden by a call to its setVisibility
method.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementLoaded
Triggered when a measurement loaded by its MeasureManager.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementShown
Triggered when a measurement is shown by a call to its setVisibility
method.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional measurementValueSet
Triggered when the measurement value is set but before it is displayed to the user.
This callback is useful for customizing the display of measurement text by using
its getMeasurementValue
and setMeasurementText
methods.
Type declaration
-
-
Parameters
-
measurement: MeasureMarkup
Returns void
-
-
Optional missingModel
Triggered when a missing model is discovered during a load.
Type declaration
-
-
Parameters
-
modelPath: string
Returns void
-
-
Optional modelLoadBegin
Triggered immediately when Model.switchToModel is called.
Type declaration
-
-
Returns void
-
Optional modelLoadFailure
Triggered when a model could not be loaded.
Type declaration
-
-
Parameters
-
modelName: ScModelName
-
reason: string
-
Optional error: any
Returns void
-
-
Optional modelLoaded
[deprecated]
Type declaration
-
-
Parameters
-
modelRootIds: NodeId[]
-
source: NodeSource
Returns void
-
-
Optional modelStructureHeaderParsed
Triggered when a model header has been parsed.
Type declaration
-
-
Parameters
-
filename: string
-
fileType: FileType
Returns void
-
-
Optional modelStructureLoadBegin
[deprecated]
Type declaration
-
-
Returns void
-
Optional modelStructureLoadEnd
[deprecated]
Type declaration
-
-
Returns void
-
Optional modelStructureParseBegin
[deprecated]
Type declaration
-
-
Returns void
-
Optional modelStructureReady
Triggered when the model structure has been loaded and is ready to be queried.
This callback will only be called after the assemblyTreeReady callback gets triggered.
Type declaration
-
-
Returns void
-
Optional modelSwitchStart
Triggered when Model.switchToModel or Model.clear is called. This gets triggered after any of the above methods begin.
Type declaration
-
-
Parameters
-
clearOnly: boolean
Returns void
-
-
Optional modelSwitched
Triggered when Model.switchToModel or Model.clear is called. This gets triggered after any of the above methods complete.
Type declaration
-
-
Parameters
-
clearOnly: boolean
-
modelRootIds: NodeId[]
Returns void
-
-
Optional noteTextCreated
Triggered when note text is created, especially via the note operator.
Type declaration
-
-
Parameters
-
noteText: NoteText
Returns void
-
-
Optional noteTextHidden
Triggered when note text is hidden, especially via the note operator.
Type declaration
-
-
Parameters
-
noteText: NoteText
Returns void
-
-
Optional noteTextShown
Triggered when note text is shown, especially via the note operator.
Type declaration
-
-
Parameters
-
noteText: NoteText
Returns void
-
-
Optional overlayViewportSet
Triggered when an overlay viewport is set.
Type declaration
-
-
Parameters
-
overlayIndex: OverlayIndex
Returns void
-
-
Optional partsVisibilityHidden
[deprecated]
Triggered when parts are hidden.
Type declaration
-
-
Parameters
-
nodeIds: NodeId[]
Returns void
-
-
Optional partsVisibilityShown
[deprecated]
Triggered when parts are shown.
Type declaration
-
-
Parameters
-
nodeIds: NodeId[]
Returns void
-
-
Optional redlineCreated
Triggered when a redline markup item is created.
Type declaration
-
-
Parameters
-
redlineMarkup: RedlineItem
Returns void
-
-
Optional redlineDeleted
Triggered when a redline markup item is deleted.
Type declaration
-
-
Parameters
-
redlineMarkup: RedlineItem
Returns void
-
-
Optional redlineUpdated
Triggered when a redline markup item is updated.
An update is triggered by changes in a redline markup item's position, size, or text.
Type declaration
-
-
Parameters
-
redlineMarkup: RedlineItem
Returns void
-
-
Optional removeCuttingSection
Triggered when a cutting section is removed.
Type declaration
-
-
Returns void
-
Optional sceneReady
Triggered when the scene is ready to be interacted with.
View-related operations such as moving the camera may be invoked. However, operations requiring node IDs should not be called at this time.
Type declaration
-
-
Returns void
-
Optional sceneRendered
[deprecated]
Type declaration
-
-
Returns void
-
Optional selection [deprecated]
Type declaration
-
-
Parameters
-
Rest ...selectionEvents: NodeSelectionEvent[]
Returns void
-
-
Optional selectionArray
Triggered when a selection event occurs.
Type declaration
-
-
Parameters
-
selectionEvents: NodeSelectionEvent[]
-
removed: boolean
Returns void
-
-
Optional shatteredXmlStructureReady
[deprecated]
Type declaration
-
-
Parameters
-
nodeId: NodeId
Returns void
-
-
Optional sheetActivated
Triggered when a drawing sheet has been activated.
Type declaration
-
-
Parameters
-
nodeId: SheetId
Returns void
-
-
Optional sheetDeactivated
Triggered when drawing sheets have been deactivated.
Type declaration
-
-
Returns void
-
Optional streamingActivated
Triggered when the client begins streaming data from the server.
Type declaration
-
-
Returns void
-
Optional streamingDeactivated
Triggered when streaming from the client has stopped.
Type declaration
-
-
Returns void
-
Optional subtreeDeleted
Triggered when a subtree has been deleted.
Type declaration
-
-
Parameters
-
modelRootIds: NodeId[]
Returns void
-
-
Optional subtreeLoaded
Triggered when a subtree has been loaded. This includes loading a model as well as directly creating nodes.
Type declaration
-
-
Parameters
-
modelRootIds: NodeId[]
-
source: NodeSource
Returns void
-
-
Optional timeout
Triggered when a timeout due to inactivity occurs.
Type declaration
-
-
Returns void
-
Optional timeoutWarning
Triggered when a timeout due to inactivity is about to occur.
Type declaration
-
-
Parameters
-
minutesRemaining: number
Returns void
-
-
Optional transitionBegin
Triggered when a camera transition begins.
Type declaration
-
-
Parameters
-
duration: number
Returns void
-
-
Optional transitionEnd
Triggered when a camera transition ends.
Type declaration
-
-
Returns void
-
Optional viewAxes
Triggered after the view axes have been set.
Optional viewCreated
Triggered when a view is created or by creating a redline item when no view is active.
Type declaration
-
-
Parameters
-
view: MarkupView
Returns void
-
-
Optional viewDeactivated
Triggered when a view is deactivated.
Type declaration
-
-
Parameters
-
view: MarkupView
Returns void
-
-
Optional viewDeleted
Triggered when a view is deleted.
Type declaration
-
-
Parameters
-
view: MarkupView
Returns void
-
-
Optional viewLoaded
Triggered when a view is loaded from data.
Type declaration
-
-
Parameters
-
view: MarkupView
Returns void
-
-
Optional viewOrientation
Triggered after the view orientation has changed.
Type declaration
-
-
Parameters
-
orientation: ViewOrientation
Returns void
-
-
Optional visibilityChanged
Triggered when nodes are shown or hidden. If shownBodyIds
and hiddenBodyIds
are both
empty, only the visibility of structural nodes (nodes that do not directly contain
geometry) changed.
Type declaration
-
-
Parameters
-
shownBodyIds: BodyId[]
-
hiddenBodyIds: BodyId[]
Returns void
-
-
Optional volumeSelectionBatchBegin
[deprecated]
Type declaration
-
-
Returns void
-
Optional volumeSelectionBatchEnd
[deprecated]
Type declaration
-
-
Returns void
-
Optional volumeSelectionEnd
[deprecated]
Type declaration
-
-
Returns void
-
Optional walkOperatorActivated
Triggered when the Operator.CameraWalkOperator becomes active.
Type declaration
-
-
Returns void
-
Optional walkOperatorDeactivated
triggered when the Operator.CameraWalkOperator is deactivated.
Type declaration
-
-
Returns void
-
Optional webGlContextLost
Triggered when the browser causes the WebGL context to be lost and rendering cannot continue.
Type declaration
-
-
Returns void
-
Optional websocketConnectionClosed
Triggered when the browser stream websocket connection is closed.
Type declaration
-
-
Returns void
-
Object which maps callback names to functions. Used by WebViewer.setCallbacks.