object containing key-value pairs for viewer to set
Disconnects the network connection when in CSR mode.
Deactivate sheets and only display 3D content
promise that resolves when the operation has completed
Delays capping processing by a fixed time interval.
Disables a visual comparison of two drawing sheets enabled by
startSheetComparison. The Promise returned by that function
should be waited upon before calling endSheetComparison.
Exports the current scene to a two-dimensional SVG representation.
Allows customization of the resultant SVG.
A promise that resolves to the created SVG string.
Sets whether keyboard input should be directed to this Web Viewer.
if true, the Web Viewer will be focused and accept keyboard input, otherwise it will be blurred and not accept keyboard input
gets the id of the current active sheet. null if none has been set.
Gets the current value for high DPI rendering
current high DPI setting
Gets the current state of the background sheet.
true if enabled and false otherwise.
Gets the current state of the background sheet.
true if enabled and false otherwise.
boolean true if the context menu is active, false otherwise
Gets the parameters that were used to initialize this instance of the WebViewer
initial creation parameters
Interface containing cutting-related methods.
Interface containing model explode-related functionality
Returns the format version string.
string containing version information for the format.
Interface containing line-related methods.
Interface containing markup-related methods.
Interface containing measure-related methods.
Gets the minimum framerate that will be maintained by the viewer. The viewer will use varius culling techniques in order to maintain the value returned.
Promise that is resolved when the operation has completed.
Interface containing model-related methods.
Interface containting overlay-related methods
Gets the RendererType this viewer was created with.
the render mode.
Interface containing selection-related methods.
Gets the sheet Background Color.
Gets the Sheet Color.
an array of 2D SheetIds.
Gets the Sheet Shadow Color.
Gets viewer statistics for the current rendered frame. Statistics marked with a (*) below must be calculated and will not be included in the results unless the calculateTotals parameter is true. The values of these items will be cached and only updated during the next call to this method with calculateTotals set to true.
Forces an update of the total count elements. Please note that repeatedly calculating these items can cause a performance impact.
an object containing informational key/value pairs
| Statistic Name | Description |
|---|---|
| draw_call_count | number of draw calls made when rendering the frame |
| frames_per_second | frames per second estimation |
| triangle_count | the number of triangles rendered |
| line_segment_count | the number of line segments rendered |
| point_count | the number of points rendered |
| total_element_count(*) | the total number of elements in the scene |
| total_triangle_count(*) | the total number of triangles in the scene |
Returns the scale factor that will be applied to the streaming size cutoff. An object whose projected size is lower than the cutoff will not be streamed until its projected size reaches the cutoff. A value of 0 disables the cutoff.
Gets the streaming mode this viewer was created with.
the streaming mode.
Interface containing view-related methods.
Gets the view element for this viewer. This element contains the canvas
the view element
Returns the viewer version string.
string containing version information for the viewer.
true if a drawing sheet is activated, false otherwise
This method should be called when the viewer is being moved to a new window. An example use case would be opening a new pop up window.
the new document that this viewer will be associated with.
Pauses rendering updates for the viewer. This function is useful when performing large batches of updates and you would like the result to appear all at once.
Promise that is resolved when the operation has completed.
Forces the viewer to perform a full redraw.
A function to be called once the draw is complete.
This is provided instead of a Promise to ensure the callback is
called before the start of another redraw.
Associates a custom operator object with a system generated operatorId.
an operatorId to be used for this operator.
Reset the camera, visibility, and transforms to their default state
Promise that resolves when the operation has completed.
Resets the client timeout to the duration set with setClientTimeout.
This method should be called after the container element is moved or resized.
Resumes rendering in the viewer.
Selects a part with the given Id.
nodeId of the part to select. Pass null to clear the selection.
Sets the id of the current active sheet
promise that resolves when the operation has completed
Controls rendering on high DPI displays. If true, the image will be rendered at full resolution when a high-DPI display is detected. If false, the image may be rendered at a lower resolution. The default value is false. This method may be called any time during or after the sceneReady callback has triggered.
controls the high DPI Setting.
Sets whether the background for 2D drawings is selectable. By default it is not. 2D drawings have an invisible selection plane with a single face. Note that this setting is unaffected by the background-sheet enable setting.
Enables or disables the background sheet used for 2D drawings.
Registers callbacks that will be called when their corresponding events occur.
object with property names set to corresponding functions to be called when the event occurs.
Sets the parameters for client driven timeout monitoring.
If no input is recorded for the the duration, the viewer will disconnect and free server resources.
Calling this method will reset any pending timeout duration.
No timeout will occur when viewing SCS Files.
The default value is to disconnect after 15 minutes, with a warning issued after 14 minutes of inactivity.
Please note: Both parameters are required.
the total time in minutes of inactivity that is allowed before a timeout event occurs
the number of minutes before issuing a timeoutWarning event
boolean value indicating whether the timeout values were sucessfully updated
Sets a boolean with the status of the context menu
Sets a minimum frame rate that will be maintained by the viewer. The viewer will use various culling techniques in order to maintain the value passed in.
Passing 0 will cause the entire scene to be drawn for every frame.
The frame rate for the viewer to maintain.
Promise that is resolved when the operation has completed.
Sets the image quality settings for the high quality and low quality server side render. The low quality settings will be applied during model interaction (camera changes, selection, etc)
The JPEG quality of the low quality render frame
The JPEG quality of the high quality render frame
The scale factor for the low quality render frame
The scale factor for the high quality render frame
Specifies a scale factor that will be applied to the streaming size cutoff. An object whose projected size is lower than the cutoff will not be streamed until its projected size reaches the cutoff. A value of 0 disables the cutoff.
Sets the orientation of the current model view.
a ViewOrientation object specifying back, front, top, etc.
the time in milliseconds for the model to transition to the new view orientation.
Releases the resources used by the viewer. This method should be called when the viewer is no longer needed but the page is not being reloaded.
Starts the viewer and begins the loading process
Enables a visual comparison of two drawing sheets. The nodes specified
by sheetId1 are filled with one color, the nodes specified by
sheetId2 with another color, and overlapping areas are filled
with a third color.
the drawing sheet to compare against sheetId2
the drawing sheet to compare against sheetId1
settings controlling the behavior of the comparison
Creates an Image of the current canvas
Triggers a web viewer event
the name of the event to trigger
Removes a previously registered custom operator from the system.
the ID of the operator that is to be unregistered
Unregisters callbacks from the system. Note the actual function object passed in must be the same as the one that was registered using setCallbacks.
object with property names set to corresponding functions to be unregistered.
Returns a Promise that will resolve after streaming and associated asynchronous operations complete and the scene is fully drawn.
Creates a new Web Viewer instance. You must pass in a containerId key with the ID of an element or a container element to use for your viewer. The system will create any required elements inside the supplied container.