IWebViewer

class core.IWebViewer()

Properties

• config
• cuttingManager
• explodeManager
• lineManager
• markupManager
• measureManager
• model
• noteTextManager
• overlayManager
• selectionManager
• sheetManager
• view
• views

Methods

• _debug_log()
• _debug_stateFailure()
• _debug_sync()
• _getCallbackManager()
• _getScEngine()
• _loseWebGlContext()
• _setStreamIdleMarker()
• addView()
• advanceExportToSvg()
• applyFilter()
• beginExportToSvg()
• closeConnection()
• delayCapping()
• endExportToSvg()
• exportToSvg()
• fitWorld()
• focusInput()
• getAllowHighDpi()
• getContextMenuStatus()
• getFormatVersionString()
• getMinimumFramerate()
• getModelReady()
• getRendererType()
• getSceneReady()
• getStatistics()
• getStreamCutoffScale()
• getStreamingMode()
• getView()
• getViewElement()
• getViewerVersionString()
• moveToWindow()
• pauseRendering()
• redraw()
• registerCustomOperator()
• removeView()
• reset()
• resetClientTimeout()
• resizeCanvas()
• resumeRendering()
• selectPart()
• setAllowHighDpi()
• setCallbacks()
• setClientTimeout()
• setContextMenuStatus()
• setMinimumFramerate()
• setServerRenderQuality()
• setStreamCutoffScale()
• setViewOrientation()
• shutdown()
• start()
• takeSnapshot()
• trigger()
• unregisterCustomOperator()
• unsetCallbacks()
• waitForIdle()

---

Properties

IWebViewer.config

Type:WebViewerConfig

IWebViewer.cuttingManager

Type:ICuttingManager

IWebViewer.explodeManager

Type:ExplodeManager

IWebViewer.lineManager

Type:LineManager

IWebViewer.markupManager

Type:MarkupManager

IWebViewer.measureManager

Type:MeasureManager

IWebViewer.model

Type:IModel

IWebViewer.noteTextManager

Type:NoteTextManager

IWebViewer.overlayManager

Type:OverlayManager

IWebViewer.selectionManager

Type:SelectionManager

IWebViewer.sheetManager

Type:SheetManager

IWebViewer.view

Type:IView

IWebViewer.views

Type:[IView]

Methods

_debug_log

IWebViewer._debug_log(message)

Arguments:

• message (string()) – None

Return type:

Promise <void>

_debug_stateFailure

IWebViewer._debug_stateFailure(value)

Arguments:

• value (StateFailure()) – None

Return type:

Promise <void>

_debug_sync

IWebViewer._debug_sync()

Return type:Promise <void>

_getCallbackManager

IWebViewer._getCallbackManager()

Return type:ICallbackManager

_getScEngine

IWebViewer._getScEngine()

Return type:IScEngine

_loseWebGlContext

IWebViewer._loseWebGlContext()

Return type:boolean

_setStreamIdleMarker

IWebViewer._setStreamIdleMarker()

Return type:Promise <void>

addView

IWebViewer.addView(config)

Arguments:

• config (ViewConfig()) – None

Return type:

Promise <IView>

advanceExportToSvg

IWebViewer.advanceExportToSvg()

Return type:Promise <undefined | string>

applyFilter

IWebViewer.applyFilter(filterId)

Arguments:

• filterId (FilterId()) – None

Return type:

void

beginExportToSvg

IWebViewer.beginExportToSvg([config])

Arguments:

• config (SvgConfig()) – optional None

Return type:

Promise <void>

closeConnection

IWebViewer.closeConnection()

Return type:void

delayCapping

IWebViewer.delayCapping()

Return type:void

endExportToSvg

IWebViewer.endExportToSvg()

Return type:Promise <void>

exportToSvg

IWebViewer.exportToSvg([config])

Arguments:

• config (SvgConfig()) – optional None

Return type:

Promise <string>

fitWorld

IWebViewer.fitWorld([duration])

Arguments:

• duration (number()) – optional None

Return type:

Promise <void>

focusInput

IWebViewer.focusInput(focus)

Arguments:

• focus (boolean()) – None

Return type:

void

getAllowHighDpi

IWebViewer.getAllowHighDpi()

Return type:boolean

getContextMenuStatus

IWebViewer.getContextMenuStatus()

Return type:boolean

getFormatVersionString

IWebViewer.getFormatVersionString()

Return type:string

getMinimumFramerate

IWebViewer.getMinimumFramerate()

Return type:Promise <number>

getModelReady

IWebViewer.getModelReady()

Return type:boolean

getRendererType

IWebViewer.getRendererType()

Return type:RendererType

getSceneReady

IWebViewer.getSceneReady()

Return type:boolean

getStatistics

IWebViewer.getStatistics([calculateTotals])

Arguments:

• calculateTotals (boolean()) – optional None

Return type:

Promise <object>

getStreamCutoffScale

IWebViewer.getStreamCutoffScale()

Return type:number

getStreamingMode

IWebViewer.getStreamingMode()

Return type:StreamingMode

getView

IWebViewer.getView(viewKey)

Arguments:

• viewKey (ViewKey()) – None

Return type:

undefined | IView

getViewElement

IWebViewer.getViewElement()

Return type:HTMLDivElement

getViewerVersionString

IWebViewer.getViewerVersionString()

Return type:string

moveToWindow

IWebViewer.moveToWindow(win)

Arguments:

• win (Window()) – None

Return type:

void

pauseRendering

IWebViewer.pauseRendering([callback])

Arguments:

• callback (function()) – optional None

Return type:

Promise <void>

IWebViewer.callback()

Return type:void

redraw

IWebViewer.redraw([callback])

Arguments:

• callback (function()) – optional None

Return type:

void

IWebViewer.callback()

Return type:void

registerCustomOperator

IWebViewer.registerCustomOperator(operator)

Arguments:

• operator (Operator()) – None

Return type:

OperatorId

removeView

IWebViewer.removeView(view)

Arguments:

• view (IView()) – None

Return type:

void

reset

IWebViewer.reset([durationCameraTransition])

Arguments:

• durationCameraTransition (number()) – optional None

Return type:

Promise <void>

resetClientTimeout

IWebViewer.resetClientTimeout()

Return type:void

resizeCanvas

IWebViewer.resizeCanvas()

Return type:void

resumeRendering

IWebViewer.resumeRendering()

Return type:Promise <void>

selectPart

IWebViewer.selectPart(nodeId[, selectionMode])

Arguments:

• nodeId (null | number()) – None
• selectionMode (SelectionMode()) – optional None

Return type:

SelectionType

setAllowHighDpi

IWebViewer.setAllowHighDpi(allow)

Arguments:

• allow (boolean()) – None

Return type:

void

setCallbacks

IWebViewer.setCallbacks(callbacks)

Arguments:

• callbacks (CallbackMap()) – None

Return type:

void

setClientTimeout

IWebViewer.setClientTimeout(timeoutDuration, warningTime)

Arguments:

• timeoutDuration (number()) – None
• warningTime (number()) – None

Return type:

boolean

setContextMenuStatus

IWebViewer.setContextMenuStatus(isActive)

Arguments:

• isActive (boolean()) – None

Return type:

void

setMinimumFramerate

IWebViewer.setMinimumFramerate(value)

Arguments:

• value (number()) – None

Return type:

Promise <void>

setServerRenderQuality

IWebViewer.setServerRenderQuality(jpegQualityLow, jpegQualityHigh, scaleLow, scaleHigh)

Arguments:

• jpegQualityLow (number()) – None
• jpegQualityHigh (number()) – None
• scaleLow (number()) – None
• scaleHigh (number()) – None

Return type:

void

setStreamCutoffScale

IWebViewer.setStreamCutoffScale(value)

Arguments:

• value (number()) – None

Return type:

Promise <void>

setViewOrientation

IWebViewer.setViewOrientation(orientation[, duration])

Arguments:

• orientation (ViewOrientation()) – None
• duration (number()) – optional None

Return type:

Promise <void>

shutdown

IWebViewer.shutdown()

Return type:void

start

IWebViewer.start()

Return type:boolean

takeSnapshot

IWebViewer.takeSnapshot([config])

Arguments:

• config (SnapshotConfig()) – optional None

Return type:

Promise <HTMLImageElement>

trigger

IWebViewer.trigger(name, args)

Arguments:

• name (string()) – None
• args ([any]()) – None

Return type:

void

unregisterCustomOperator

IWebViewer.unregisterCustomOperator(operatorId)

Arguments:

• operatorId (OperatorId()) – None

Return type:

void

unsetCallbacks

IWebViewer.unsetCallbacks(callbacks)

Arguments:

• callbacks (CallbackMap()) – None

Return type:

void

waitForIdle

IWebViewer.waitForIdle([config])

Arguments:

• config (function()) – optional None

Return type:

Promise <void>