WebViewer

class Communicator.WebViewer()

Constructors

constructor()

Creates a new Web Viewer instance. You must pass in a…

Properties

BCFManager

animationManager

cuttingManager

explodeManager

floorplanManager

lineManager

markupManager

measureManager

model

noteTextManager

operatorManager

overlayManager

selectionManager

sheetManager

view

Methods

advanceExportToSvg()

beginExportToSvg()

closeConnection()

deactivateSheets()

delayCapping()

endExportToSvg()

endSheetComparison()

exportToSvg()

fitWorld()

focusInput()

getActiveSheetId()

getAllowHighDPI()

getAllowHighDpi()

getBackgroundSelectionEnabled()

getBackgroundSheetEnabled()

getContextMenuStatus()

getCreationParameters()

getCuttingManager()

getExplodeManager()

getFormatVersionString()

getLineManager()

getMarkupManager()

getMeasureManager()

getMinimumFramerate()

getModel()

getOperatorManager()

getOverlayManager()

getRendererType()

getSelectionManager()

getSheetBackgroundColor()

getSheetColor()

getSheetIds()

getSheetShadowColor()

getStatistics()

getStreamCutoffScale()

getStreamingMode()

getView()

getViewElement()

getViewerVersionString()

isDrawingSheetActive()

moveToWindow()

pauseRendering()

redraw()

registerCustomOperator()

reset()

resetClientTimeout()

resizeCanvas()

resumeRendering()

selectPart()

setActiveSheetId()

setAllowHighDPI()

setAllowHighDpi()

setBackgroundSelectionEnabled()

setBackgroundSheetEnabled()

setCallbacks()

setClientTimeout()

setContextMenuStatus()

setMinimumFramerate()

setServerRenderQuality()

setSheetColors()

setStreamCutoffScale()

setViewOrientation()

shutdown()

start()

startSheetComparison()

takeSnapshot()

trigger()

triggerEvent()

unregisterCustomOperator()

unsetCallbacks()

waitForIdle()


Constructors

constructor

Communicator.WebViewer.constructor(inputParams)

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.

Arguments
Return type

Communicator.WebViewer

Properties

Communicator.WebViewer.BCFManager
Communicator.WebViewer.animationManager
Communicator.WebViewer.cuttingManager
Communicator.WebViewer.explodeManager
Communicator.WebViewer.floorplanManager
Communicator.WebViewer.lineManager
Communicator.WebViewer.markupManager
Communicator.WebViewer.measureManager
Communicator.WebViewer.model
Communicator.WebViewer.noteTextManager
Communicator.WebViewer.operatorManager
Communicator.WebViewer.overlayManager
Communicator.WebViewer.selectionManager
Communicator.WebViewer.sheetManager
Communicator.WebViewer.view

Methods

advanceExportToSvg

Communicator.WebViewer.advanceExportToSvg()

Get the next chunk of the SVG code

Return type

Promise[{  }]

Returns

A promise that resolves to a string containing the next chunk or undefined on completed..

beginExportToSvg

Communicator.WebViewer.beginExportToSvg(config)

Setup the env to export the current scene to a two-dimensional SVG representation through stream.

Arguments
Return type

Promise[void]

Returns

A promise that resolves to void when the env is ready.

closeConnection

Communicator.WebViewer.closeConnection()

Disconnects the network connection when in CSR mode.

Return type

void

deactivateSheets

Communicator.WebViewer.deactivateSheets()

Deactivate sheets and only display 3D content

Note

deactivateSheets is deprecated: Use SheetManager.deactivateSheets from sheetManager instead.

Return type

Promise[void]

Returns

promise that resolves when the operation has completed

delayCapping

Communicator.WebViewer.delayCapping()

Delays capping processing by a fixed time interval.

Return type

void

endExportToSvg

Communicator.WebViewer.endExportToSvg()

Reset the env after SVG stream export.

Return type

Promise[void]

Returns

A promise that resolves to void when the env is reset.

endSheetComparison

Communicator.WebViewer.endSheetComparison()

Disables a visual comparison of two drawing sheets enabled by startSheetComparison The Promise returned by that function should be waited upon before calling endSheetComparison

Note

endSheetComparison is deprecated: Use SheetManager.endComparison from sheetManager instead.

Return type

Promise[void]

exportToSvg

Communicator.WebViewer.exportToSvg(config)

Exports the current scene to a two-dimensional SVG representation.

Arguments
Return type

Promise[string]

Returns

A promise that resolves to the created SVG string.

fitWorld

Communicator.WebViewer.fitWorld(duration)
Arguments
  • duration ({  }()) –

Return type

Promise[void]

focusInput

Communicator.WebViewer.focusInput(focus)

Sets whether keyboard input should be directed to this Web Viewer.

Arguments
  • focus (boolean()) – if true, the Web Viewer will be focused and accept keyboard input, otherwise it will be blurred and not accept keyboard input

Return type

void

getActiveSheetId

Communicator.WebViewer.getActiveSheetId()

Note

getActiveSheetId is deprecated: Use SheetManager.getActiveSheetId from sheetManager instead.

Return type

{  }

Returns

gets the id of the current active sheet. null if none has been set.

getAllowHighDPI

Communicator.WebViewer.getAllowHighDPI()

Note

getAllowHighDPI is deprecated: Use getAllowHighDpi instead.

Return type

boolean

getAllowHighDpi

Communicator.WebViewer.getAllowHighDpi()

Gets the current value for high DPI rendering

Return type

boolean

Returns

current high DPI setting

getBackgroundSelectionEnabled

Communicator.WebViewer.getBackgroundSelectionEnabled()

Gets the current state of the background sheet.

Note

getBackgroundSelectionEnabled is deprecated: Use SheetManager.getBackgroundSelectionEnabled from sheetManager instead.

Return type

boolean

Returns

true if enabled and false otherwise.

getBackgroundSheetEnabled

Communicator.WebViewer.getBackgroundSheetEnabled()

Gets the current state of the background sheet.

Note

getBackgroundSheetEnabled is deprecated: Use SheetManager.getBackgroundSheetEnabled from sheetManager instead.

Return type

boolean

Returns

true if enabled and false otherwise.

getContextMenuStatus

Communicator.WebViewer.getContextMenuStatus()
Return type

boolean

Returns

boolean true if the context menu is active, false otherwise

getCreationParameters

Communicator.WebViewer.getCreationParameters()

Gets the parameters that were used to initialize this instance of the WebViewer

Return type

Communicator.WebViewerConfig

Returns

initial creation parameters

getCuttingManager

Communicator.WebViewer.getCuttingManager()

Note

getCuttingManager is deprecated: Use cuttingManager instead. Returns the CuttingManager interface which contains methods for creating and interacting with cutting planes and sections.

Return type

Communicator.CuttingManager

Returns

Interface containing cutting-related methods.

getExplodeManager

Communicator.WebViewer.getExplodeManager()

Note

getExplodeManager is deprecated: Use explodeManager instead. Returns the model explode interface.

Return type

Communicator.ExplodeManager

Returns

Interface containing model explode-related functionality

getFormatVersionString

Communicator.WebViewer.getFormatVersionString()

Returns the format version string.

Return type

string

Returns

string containing version information for the format.

getLineManager

Communicator.WebViewer.getLineManager()

Note

getLineManager is deprecated: Use lineManager instead. Returns the Line interface.

Return type

Communicator.LineManager

Returns

Interface containing line-related methods.

getMarkupManager

Communicator.WebViewer.getMarkupManager()

Note

getMarkupManager is deprecated: Use markupManager instead. Returns the markup interface.

Return type

Communicator.MarkupManager

Returns

Interface containing markup-related methods.

getMeasureManager

Communicator.WebViewer.getMeasureManager()

Note

getMeasureManager is deprecated: Use measureManager instead. Returns the Measure interface.

Return type

Communicator.MeasureManager

Returns

Interface containing measure-related methods.

getMinimumFramerate

Communicator.WebViewer.getMinimumFramerate()

Gets the minimum framerate that will be maintained by the viewer. The viewer will use various culling techniques in order to maintain the value returned.

Return type

Promise[number]

Returns

Promise that is resolved when the operation has completed.

getModel

Communicator.WebViewer.getModel()

Note

getModel is deprecated: Use model instead. Returns the model interface.

Return type

Communicator.Model

Returns

Interface containing model-related methods.

getOperatorManager

Communicator.WebViewer.getOperatorManager()

Note

getOperatorManager is deprecated: Use operatorManager instead.

Return type

Communicator.OperatorManager

getOverlayManager

Communicator.WebViewer.getOverlayManager()

Note

getOverlayManager is deprecated: Use overlayManager instead. Returns the overlay interface.

Return type

Communicator.OverlayManager

Returns

Interface containting overlay-related methods

getRendererType

Communicator.WebViewer.getRendererType()

Gets the RendererType this viewer was created with.

Return type

Communicator.RendererType

Returns

the render mode.

getSelectionManager

Communicator.WebViewer.getSelectionManager()

Note

getSelectionManager is deprecated: Use selectionManager instead. Returns the selection interface

Return type

Communicator.SelectionManager

Returns

Interface containing selection-related methods.

getSheetBackgroundColor

Communicator.WebViewer.getSheetBackgroundColor()

Gets the sheet Background Color.

Note

getSheetBackgroundColor is deprecated: Use SheetManager.getSheetBackgroundColor from sheetManager instead.

Return type

Communicator.Color

getSheetColor

Communicator.WebViewer.getSheetColor()

Gets the Sheet Color.

Note

getSheetColor is deprecated: Use SheetManager.getSheetBackgroundColor from sheetManager instead.

Return type

Communicator.Color

getSheetIds

Communicator.WebViewer.getSheetIds()

Note

getSheetIds is deprecated: Use SheetManager.getSheetIds from sheetManager instead.

Return type

[Communicator.SheetId]

Returns

an array of 2D SheetId

getSheetShadowColor

Communicator.WebViewer.getSheetShadowColor()

Gets the Sheet Shadow Color.

Note

getSheetShadowColor is deprecated: Use SheetManager.getSheetBackgroundColor from sheetManager instead.

Return type

Communicator.Color

getStatistics

Communicator.WebViewer.getStatistics(calculateTotals)

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.

Arguments
  • calculateTotals ({  }()) – Forces an update of the total count elements. Please note that repeatedly calculating these items can cause a performance impact.

Return type

Promise[Object]

Returns

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

getStreamCutoffScale

Communicator.WebViewer.getStreamCutoffScale()

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.

Return type

number

getStreamingMode

Communicator.WebViewer.getStreamingMode()

Gets the streaming mode this viewer was created with.

Return type

Communicator.StreamingMode

Returns

the streaming mode.

getView

Communicator.WebViewer.getView()

Note

getView is deprecated: Use view instead. Returns the view interface.

Return type

Communicator.View

Returns

Interface containing view-related methods.

getViewElement

Communicator.WebViewer.getViewElement()

Gets the view element for this viewer. This element contains the canvas

Return type

HTMLDivElement

Returns

the view element

getViewerVersionString

Communicator.WebViewer.getViewerVersionString()

Returns the viewer version string.

Return type

string

Returns

string containing version information for the viewer.

isDrawingSheetActive

Communicator.WebViewer.isDrawingSheetActive()

Note

isDrawingSheetActive is deprecated: Use SheetManager.isDrawingSheetActive from sheetManager instead.

Return type

boolean

Returns

true if a drawing sheet is activated, false otherwise

moveToWindow

Communicator.WebViewer.moveToWindow(win)

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.

Arguments
  • win (Window()) – the new document that this viewer will be associated with.

Return type

void

pauseRendering

Communicator.WebViewer.pauseRendering(callback)

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.

Arguments
  • callback ({  }()) – If provided, rendering will be paused, the callback will be called, and then rendering will be resumed once the callback returns or throws an exception.

Return type

Communicator.DeprecatedPromise

redraw

Communicator.WebViewer.redraw(callback)

Forces the viewer to perform a full redraw.

Arguments
  • callback ({  }()) – 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.

Return type

void

registerCustomOperator

Communicator.WebViewer.registerCustomOperator(operator)

Associates a custom operator object with a system generated operatorId.

Arguments
  • operator (Communicator.Operator.Operator()) –

Return type

Communicator.OperatorId

Returns

an operatorId to be used for this operator.

reset

Communicator.WebViewer.reset(durationCameraTransition)

Reset the camera, visibility, and transforms to their default state

Arguments
  • durationCameraTransition ({  }()) –

Return type

Promise[void]

Returns

Promise that resolves when the operation has completed.

resetClientTimeout

Communicator.WebViewer.resetClientTimeout()

Resets the client timeout to the duration set with setClientTimeout.

Return type

void

resizeCanvas

Communicator.WebViewer.resizeCanvas()

This method should be called after the container element is moved or resized.

Return type

void

resumeRendering

Communicator.WebViewer.resumeRendering()

Resumes rendering in the viewer.

Return type

Communicator.DeprecatedPromise

selectPart

Communicator.WebViewer.selectPart(nodeId, selectionMode)

Selects a part with the given Id.

Arguments
  • nodeId ({  }()) – nodeId of the part to select. Pass null to clear the selection.

  • selectionMode (Communicator.SelectionMode()) –

Return type

Communicator.SelectionType

setActiveSheetId

Communicator.WebViewer.setActiveSheetId(activeSheetId)

Sets the id of the current active sheet. This method will also isolate and fit the nodes contained in the sheet.

Note

setActiveSheetId is deprecated: Use SheetManager.setActiveSheetId from sheetManager instead.

Arguments
  • activeSheetId (Communicator.SheetId()) – id of the sheet which will be activated.

Return type

Promise[void]

Returns

promise that resolves when the operation has completed

setAllowHighDPI

Communicator.WebViewer.setAllowHighDPI(allow)

Note

setAllowHighDPI is deprecated: Use setAllowHighDpi instead.

Arguments
  • allow (boolean()) –

Return type

void

setAllowHighDpi

Communicator.WebViewer.setAllowHighDpi(allow)

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.

Arguments
  • allow (boolean()) – controls the high DPI Setting.

Return type

void

setBackgroundSelectionEnabled

Communicator.WebViewer.setBackgroundSelectionEnabled(enabled)

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.

Note

setBackgroundSelectionEnabled is deprecated: Use SheetManager.setBackgroundSelectionEnabled from sheetManager instead.

Arguments
  • enabled (boolean()) –

Return type

Promise[void]

setBackgroundSheetEnabled

Communicator.WebViewer.setBackgroundSheetEnabled(enabled)

Note

setBackgroundSheetEnabled is deprecated: Use SheetManager.setBackgroundSheetEnabled from sheetManager instead. Enables or disables the background sheet used for 2D drawings.

Arguments
  • enabled (boolean()) –

Return type

Promise[void]

setCallbacks

Communicator.WebViewer.setCallbacks(callbacks)

Registers callbacks that will be called when their corresponding events occur.

Arguments
  • callbacks (Communicator.CallbackMap()) – object with property names set to corresponding functions to be called when the event occurs.

Return type

void

setClientTimeout

Communicator.WebViewer.setClientTimeout(timeoutDuration, warningTime)

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.

Arguments
  • timeoutDuration (number()) – the total time in minutes of inactivity that is allowed before a timeout event occurs

  • warningTime (number()) – the number of minutes before issuing a timeoutWarning event

Return type

boolean

Returns

boolean value indicating whether the timeout values were sucessfully updated

setContextMenuStatus

Communicator.WebViewer.setContextMenuStatus(isActive)

Sets a boolean with the status of the context menu

Arguments
  • isActive (boolean()) –

Return type

void

setMinimumFramerate

Communicator.WebViewer.setMinimumFramerate(value)

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.

Arguments
  • value (number()) – The frame rate for the viewer to maintain.

Return type

Communicator.DeprecatedPromise

Returns

Promise that is resolved when the operation has completed.

Passing 0 will cause the entire scene to be drawn for every frame.

setServerRenderQuality

Communicator.WebViewer.setServerRenderQuality(jpegQualityLow, jpegQualityHigh, scaleLow, scaleHigh)

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)

Arguments
  • jpegQualityLow (number()) – The JPEG quality of the low quality render frame

  • jpegQualityHigh (number()) – The JPEG quality of the high quality render frame

  • scaleLow (number()) – The scale factor for the low quality render frame

  • scaleHigh (number()) – The scale factor for the high quality render frame

Return type

void

setSheetColors

Communicator.WebViewer.setSheetColors(backgroundColor, sheetColor, sheetShadowColor)

Sets custom sheet colors.

Note

setSheetColors is deprecated: Use SheetManager.setSheetColors from sheetManager instead.

Arguments
Return type

Promise[void]

setStreamCutoffScale

Communicator.WebViewer.setStreamCutoffScale(value)

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.

Arguments
  • value (number()) –

Return type

Communicator.DeprecatedPromise

This value may also be set for file-based sessions. In that case, when loading an SCS file based assembly via XML, projected size will be calculated on a per-file basis using the bounding information provided in the XML. For additional information, refer to Model.loadSubtreeFromXmlBuffer

A value of 0 will disable the cutoff. The value should be in the interval of [0.0, 2.0].

setViewOrientation

Communicator.WebViewer.setViewOrientation(orientation, duration)

Sets the orientation of the current model view.

Arguments
  • orientation (Communicator.ViewOrientation()) – a ViewOrientation object specifying back, front, top, etc.

  • duration ({  }()) – the time in milliseconds for the model to transition to the new view orientation.

Return type

Promise[void]

shutdown

Communicator.WebViewer.shutdown()

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.

Return type

void

start

Communicator.WebViewer.start()

Starts the viewer and begins the loading process

Return type

boolean

startSheetComparison

Communicator.WebViewer.startSheetComparison(sheetId1, sheetId2, config)

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.

Note

startSheetComparison is deprecated: Use SheetManager.startComparison from sheetManager instead.

Arguments
  • sheetId1 (Communicator.SheetId()) – the drawing sheet to compare against sheetId2

  • sheetId2 (Communicator.SheetId()) – the drawing sheet to compare against sheetId1

  • config (Communicator.ComparisonConfig()) – settings controlling the behavior of the comparison

Return type

Promise[void]

See endSheetComparison View.startComparison

takeSnapshot

Communicator.WebViewer.takeSnapshot(config)

Creates an Image of the current canvas

Arguments
Return type

Promise[HTMLImageElement]

trigger

Communicator.WebViewer.trigger(name, id, filename)
Arguments
  • name (unknown()) –

  • id (number()) –

  • filename (Communicator.BCFName()) –

Return type

void

Communicator.WebViewer.trigger(name, id)
Arguments
  • name (unknown()) –

  • id (number()) –

Return type

void

Communicator.WebViewer.trigger(name, eventType, nodeIds, initialMatrices, newMatrices)
Arguments
  • name (unknown()) –

  • eventType (Communicator.HandleEventType()) –

  • nodeIds ([Communicator.NodeId]()) –

  • initialMatrices ([Communicator.Matrix]()) –

  • newMatrices ([Communicator.Matrix]()) –

Return type

void

Communicator.WebViewer.trigger(name, eventType, nodeIds, initialMatrices, newMatrices)
Arguments
  • name (unknown()) –

  • eventType (Communicator.HandleEventType()) –

  • nodeIds ([Communicator.NodeId]()) –

  • initialMatrices ([Communicator.Matrix]()) –

  • newMatrices ([Communicator.Matrix]()) –

Return type

void

Communicator.WebViewer.trigger(name, eventType, nodeIds, initialMatrices)
Arguments
  • name (unknown()) –

  • eventType (Communicator.HandleEventType()) –

  • nodeIds ([Communicator.NodeId]()) –

  • initialMatrices ([Communicator.Matrix]()) –

Return type

void

Communicator.WebViewer.trigger(name, cuttingSection, planeIndex)
Arguments
Return type

void

Communicator.WebViewer.trigger(name, cuttingSection, planeIndex)
Arguments
Return type

void

Communicator.WebViewer.trigger(name, cuttingSection, planeIndex)
Arguments
Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

Communicator.WebViewer.trigger(name, redlineMarkup)
Arguments
  • name (unknown()) –

  • redlineMarkup (Communicator.Markup.Redline.RedlineItem()) –

Return type

void

Communicator.WebViewer.trigger(name, redlineMarkup)
Arguments
  • name (unknown()) –

  • redlineMarkup (Communicator.Markup.Redline.RedlineItem()) –

Return type

void

Communicator.WebViewer.trigger(name, redlineMarkup)
Arguments
  • name (unknown()) –

  • redlineMarkup (Communicator.Markup.Redline.RedlineItem()) –

Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

Communicator.WebViewer.trigger(name, measurement)
Arguments
  • name (unknown()) –

  • measurement (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

Communicator.WebViewer.trigger(name, measurement)
Arguments
  • name (unknown()) –

  • measurement (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

Communicator.WebViewer.trigger(name, measurement)
Arguments
  • name (unknown()) –

  • measurement (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

Communicator.WebViewer.trigger(name, measurement)
Arguments
  • name (unknown()) –

  • measurement (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

Communicator.WebViewer.trigger(name, measurement)
Arguments
  • name (unknown()) –

  • measurement (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

Communicator.WebViewer.trigger(name, noteText)
Arguments
  • name (unknown()) –

  • noteText (NoteText()) –

Return type

void

Communicator.WebViewer.trigger(name, noteText)
Arguments
  • name (unknown()) –

  • noteText (NoteText()) –

Return type

void

Communicator.WebViewer.trigger(name, noteText)
Arguments
  • name (unknown()) –

  • noteText (NoteText()) –

Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

Communicator.WebViewer.trigger(name, view)
Arguments
  • name (unknown()) –

  • view (Communicator.Markup.MarkupView()) –

Return type

void

Communicator.WebViewer.trigger(name, view)
Arguments
  • name (unknown()) –

  • view (Communicator.Markup.MarkupView()) –

Return type

void

Communicator.WebViewer.trigger(name, view)
Arguments
  • name (unknown()) –

  • view (Communicator.Markup.MarkupView()) –

Return type

void

Communicator.WebViewer.trigger(name, position, modifiers)
Arguments
Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

Communicator.WebViewer.trigger(name)
Arguments
  • name (unknown()) –

Return type

void

triggerEvent

Communicator.WebViewer.triggerEvent(eventName, args)

Triggers a web viewer event

Note

triggerEvent is deprecated: Use trigger instead

Arguments
  • eventName (string()) – the name of the event to trigger

  • args ([any]()) –

Return type

void

unregisterCustomOperator

Communicator.WebViewer.unregisterCustomOperator(operatorId)

Removes a previously registered custom operator from the system.

Arguments
  • operatorId (Communicator.OperatorId()) – the ID of the operator that is to be unregistered

Return type

void

unsetCallbacks

Communicator.WebViewer.unsetCallbacks(callbacks)

Unregisters callbacks from the system. Note the actual function object passed in must be the same as the one that was registered using setCallbacks.

Arguments
Return type

void

waitForIdle

Communicator.WebViewer.waitForIdle(config)

Returns a Promise that will resolve after streaming and associated asynchronous operations complete and the scene is fully drawn.

Arguments
  • config ({  }()) –

Return type

Promise[void]