WebViewerConfig

class Communicator.WebViewerConfig()

Properties

WebViewerConfig.boundingPreviewMode

Type: BoundingPreviewMode optional

Specifies what types of bounding previews should be rendered. DefaultValue is BoundingPreviewMode.All

WebViewerConfig.buffer

Type: Uint8Array optional

Specifies a buffer containing a binary representation of an SCS file to load.

WebViewerConfig.calculateDefaultViewAxes

Type: boolean optional

If true, the default view axes will be calculated from the initial camera unless explicitly set during authoring time. Default value is true.

WebViewerConfig.container

Type: HTMLElement optional

A HTML element to use for the Web Viewer.

WebViewerConfig.containerId

Type: HtmlId optional

The ID of the div element to use for the Web Viewer.

WebViewerConfig.defaultMeshLevel

Type: number optional

Specifies which mesh detail level will be used to initially stream the model. The default value is 0.

WebViewerConfig.defaultMetallicFactor

Type: number optional

WebViewerConfig.defaultRoughnessFactor

Type: number optional

WebViewerConfig.disableAutomaticBackgroundSheets

Type: boolean optional

If true, then automatic generation of background sheets for drawings is not performed when the drawing is loaded.

WebViewerConfig.disableAutomaticFitWorld

Type: boolean optional

If true, disable automatic fitworld on camera activation when there is no camera on view

WebViewerConfig.disableAutomaticFloorplanOverlay

Type: boolean optional

If true, then the floorplan overlay capability will not be displayed automatically for BIM enabled models

WebViewerConfig.empty

Type: boolean optional

Whether the viewer should be started without connecting to a server or loading a model.

WebViewerConfig.enableShatteredModelUiViews

Type: boolean optional

If true, then CAD views contained within external models will populate the model tree UI.

WebViewerConfig.endpointUri

Type: string optional

Specifies the endpoint to be used by the viewer. This can be of type: http, https or ws.

WebViewerConfig.enginePath

Type: string optional

Path containing the graphics engine .js and .wasm files. Follows the same rules as the src attribute of an HTML script tag.

WebViewerConfig.memoryLimit

Type: number optional

Controls the amount of mesh data present on the client machine at given time. This value is expressed in Mebibytes. Default value is 0 indicating no limit.

WebViewerConfig.model

Type: ScModelName | null optional

Specifies the instance name to be loaded. This option is required if you specify an enpdointUri of type ws:// or wss://.

WebViewerConfig.rendererType

Type: RendererType optional

Specifies the renderer type to be used. Default value is RendererType.Client

WebViewerConfig.sessionToken

Type: string optional

An arbitrary value used for authentication. If used, it must match the token expected by the server for connection to proceed.

WebViewerConfig.streamCutoffScale

Type: number optional

Specifies a scale factor that will be applied to the streaming size cutoff.

In streaming sessions, an object whose projected size is lower than the cutoff will not be streamed until its projected size reaches the cutoff.

In file sessions, when loading a tree via XML, a file whose projected size is lower than the cutoff will not be requested until its projected size reaches the cutoff.

A value of 0 will disable the cutoff. The value should be in the interval of [0.0, 2.0]. If unspecified, this value will default to 1.0 for streaming sessions and 0.0 (disabled) for file based sessions.

WebViewerConfig.streamingMode

Type: StreamingMode optional

Sets the streaming mode that the viewer will use. Default value is StreamingMode.Interactive

WebViewerConfig.usePointerEvents

Type: boolean optional

Specifies whether pointer events should be used when available. Setting this option to false can be useful when using web views in GUI toolkits that rely on Internet Explorer. Default value is true.