WebViewer

class WebViewer()

Constructors

constructor()

Properties

BCFManager
_views
animationManager
cuttingManager
explodeManager
lineManager
markupManager
measureManager
model
noteTextManager
selectionManager
sheetManager

Accessors

floorplanManager
operatorManager
overlayManager
view
views
defaultEngineBinary
defaultEnginePath

Constructors

WebViewer.constructor(inputParams)

Arguments:	inputParams (`WebViewerConfig()`) –
Return type:	`WebViewer()`

Properties

WebViewer.BCFManager

Type:	`BCFManager()`

WebViewer._views

Type:	[`IView()`]

WebViewer.animationManager

Type:	AnimationManager

WebViewer.cuttingManager

Type:	`ICuttingManager()`

WebViewer.explodeManager

Type:	`ExplodeManager()`

WebViewer.lineManager

Type:	`LineManager()`

WebViewer.markupManager

Type:	`MarkupManager()`

WebViewer.measureManager

Type:	`MeasureManager()`

WebViewer.model

Type:	`IModel()`

WebViewer.noteTextManager

Type:	`NoteTextManager()`

WebViewer.selectionManager

Type:	`SelectionManager()`

WebViewer.sheetManager

Type:	`SheetManager()`

Accessors

Methods

addView

WebViewer.addView(config)

Arguments:	config (`ViewConfig()`) –
Return type:	Promise <`IView()`>

advanceExportToSvg

WebViewer.advanceExportToSvg()

Return type:	Promise <string \| undefined>

applyFilter

WebViewer.applyFilter(filterId)

Arguments:	filterId (FilterId) – None
Return type:	void

beginExportToSvg

WebViewer.beginExportToSvg(config)

Arguments:	config (`SvgConfig()`) –
Return type:	Promise <void>

closeConnection

WebViewer.closeConnection()

Return type:	void

delayCapping

WebViewer.delayCapping()

Return type:	void

endExportToSvg

WebViewer.endExportToSvg()

Return type:	Promise <void>

exportToSvg

WebViewer.exportToSvg(config)

Arguments:	config (`SvgConfig()`) –
Return type:	Promise <string>

fitWorld

WebViewer.fitWorld(duration)

Arguments:	duration (`number()`) – None
Return type:	Promise <void>

focusInput

WebViewer.focusInput(focus)

Arguments:	focus (`boolean()`) –
Return type:	void

getAllowHighDpi

WebViewer.getAllowHighDpi()

Return type:	boolean

getContextMenuStatus

WebViewer.getContextMenuStatus()

Return type:	boolean

getFormatVersionString

WebViewer.getFormatVersionString()

Return type:	string

getMinimumFramerate

WebViewer.getMinimumFramerate()

Return type:	Promise <number>

getModelReady

WebViewer.getModelReady()

Return type:	boolean

getRendererType

WebViewer.getRendererType()

Return type:	RendererType

getSceneReady

WebViewer.getSceneReady()

Return type:	boolean

getStatistics

WebViewer.getStatistics(calculateTotals)

Arguments:	calculateTotals (`boolean()`) –
Return type:	Promise <object>

getStreamCutoffScale

WebViewer.getStreamCutoffScale()

Return type:	number

getStreamingMode

WebViewer.getStreamingMode()

Return type:	StreamingMode

getView

WebViewer.getView(viewKey)

Arguments:	viewKey (`ViewKey()`) –
Return type:	`IView()` \| undefined

getViewElement

WebViewer.getViewElement()

Return type:	HTMLDivElement

getViewerVersionString

WebViewer.getViewerVersionString()

Return type:	string

moveToWindow

WebViewer.moveToWindow(win)

Arguments:	win (`Window()`) –
Return type:	void

pauseRendering

WebViewer.pauseRendering([callback])

Arguments:	callback (`function()`) – optional
Return type:	Promise <void>

WebViewer.callback()

Return type:	void

redraw

WebViewer.redraw([callback])

Arguments:	callback (`function()`) – optional
Return type:	void

WebViewer.callback()

Return type:	void

registerCustomOperator

WebViewer.registerCustomOperator(operator)

Arguments:	operator (`Operator()`) – None
Return type:	OperatorId

removeView

WebViewer.removeView(view)

Arguments:	view (`IView()`) –
Return type:	void

reset

WebViewer.reset(durationCameraTransition)

Arguments:	durationCameraTransition (`number()`) – None
Return type:	Promise <void>

resetClientTimeout

WebViewer.resetClientTimeout()

Return type:	void

resizeCanvas

WebViewer.resizeCanvas()

Return type:	void

resumeRendering

WebViewer.resumeRendering()

Return type:	Promise <void>

selectPart

WebViewer.selectPart(nodeId, selectionMode)

Arguments:	nodeId (PartId \| null) – selectionMode (SelectionMode) – None
Return type:	SelectionType

setAllowHighDpi

WebViewer.setAllowHighDpi(allow)

Arguments:	allow (`boolean()`) –
Return type:	void

setCallbacks

WebViewer.setCallbacks(callbacks)

Arguments:	callbacks (`CallbackMap()`) –
Return type:	void

setClientTimeout

WebViewer.setClientTimeout(timeoutDuration, warningTime)

Arguments:	timeoutDuration (`number()`) – warningTime (`number()`) –
Return type:	boolean

setContextMenuStatus

WebViewer.setContextMenuStatus(isActive)

Arguments:	isActive (`boolean()`) –
Return type:	void

setMinimumFramerate

WebViewer.setMinimumFramerate(value)

Arguments:	value (`number()`) –
Return type:	Promise <void>

setServerRenderQuality

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

Arguments:	jpegQualityLow (`number()`) – jpegQualityHigh (`number()`) – scaleLow (`number()`) – scaleHigh (`number()`) –
Return type:	void

setStreamCutoffScale

WebViewer.setStreamCutoffScale(value)

Arguments:	value (`number()`) – None
Return type:	Promise <void>

setViewOrientation

WebViewer.setViewOrientation(orientation, duration)

Arguments:	orientation (ViewOrientation) – duration (`number()`) –
Return type:	Promise <void>

shutdown

WebViewer.shutdown()

Return type:	void

start

WebViewer.start()

Return type:	boolean

takeSnapshot

WebViewer.takeSnapshot(config)

Arguments:	config (`SnapshotConfig()`) – None
Return type:	Promise <HTMLImageElement>

trigger

WebViewer.trigger(name, id, filename)

Arguments:	name (`'bcfLoaded'()`) – id (`number()`) – None filename (BCFName) – None
Return type:	void

WebViewer.trigger(name, id)

Arguments:	name (`'bcfRemoved'()`) – id (`number()`) – None
Return type:	void

WebViewer.trigger(name, eventType, nodeIds, initialMatrices, newMatrices)

Arguments:	name (`'handleEvent'()`) – eventType (HandleEventType) – None nodeIds ([NodeId]) – None initialMatrices (`[Matrix]()`) – None newMatrices (`[Matrix]()`) – None
Return type:	void

WebViewer.trigger(name, eventType, nodeIds, initialMatrices, newMatrices)

Arguments:	name (`'handleEventEnd'()`) – eventType (HandleEventType) – None nodeIds ([NodeId]) – None initialMatrices (`[Matrix]()`) – None newMatrices (`[Matrix]()`) – None
Return type:	void

WebViewer.trigger(name, eventType, nodeIds, initialMatrices)

Arguments:	name (`'handleEventStart'()`) – eventType (HandleEventType) – None nodeIds ([NodeId]) – None initialMatrices (`[Matrix]()`) – None
Return type:	void

WebViewer.trigger(name, cuttingSection, planeIndex)

Arguments:	name (`'cuttingPlaneDragStart'()`) – cuttingSection (`ICuttingSection()`) – None planeIndex (`number()`) – None
Return type:	void

WebViewer.trigger(name, cuttingSection, planeIndex)

Arguments:	name (`'cuttingPlaneDrag'()`) – cuttingSection (`ICuttingSection()`) – None planeIndex (`number()`) – None
Return type:	void

WebViewer.trigger(name, cuttingSection, planeIndex)

Arguments:	name (`'cuttingPlaneDragEnd'()`) – cuttingSection (`ICuttingSection()`) – None planeIndex (`number()`) – None
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'cuttingSectionsLoaded'()`) –
Return type:	void

WebViewer.trigger(name, redlineMarkup)

Arguments:	name (`'redlineCreated'()`) – redlineMarkup (`RedlineItem()`) – None
Return type:	void

WebViewer.trigger(name, redlineMarkup)

Arguments:	name (`'redlineDeleted'()`) – redlineMarkup (`RedlineItem()`) – None
Return type:	void

WebViewer.trigger(name, redlineMarkup)

Arguments:	name (`'redlineUpdated'()`) – redlineMarkup (`RedlineItem()`) – None
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'measurementBegin'()`) –
Return type:	void

WebViewer.trigger(name, measurement)

Arguments:	name (`'measurementCreated'()`) – measurement (`MeasureMarkup()`) – None
Return type:	void

WebViewer.trigger(name, measurement)

Arguments:	name (`'measurementDeleted'()`) – measurement (`MeasureMarkup()`) – None
Return type:	void

WebViewer.trigger(name, measurement)

Arguments:	name (`'measurementValueSet'()`) – measurement (`MeasureMarkup()`) – None
Return type:	void

WebViewer.trigger(name, measurement)

Arguments:	name (`'measurementShown'()`) – measurement (`MeasureMarkup()`) – None
Return type:	void

WebViewer.trigger(name, measurement)

Arguments:	name (`'measurementHidden'()`) – measurement (`MeasureMarkup()`) – None
Return type:	void

WebViewer.trigger(name, noteText)

Arguments:	name (`'noteTextCreated'()`) – noteText (`NoteText()`) – None
Return type:	void

WebViewer.trigger(name, noteText)

Arguments:	name (`'noteTextDeleted'()`) – noteText (`NoteText()`) – None
Return type:	void

WebViewer.trigger(name, noteText)

Arguments:	name (`'noteTextUpdated'()`) – noteText (`NoteText()`) – None
Return type:	void

WebViewer.trigger(name, noteText)

Arguments:	name (`'noteTextHidden'()`) – noteText (`NoteText()`) – None
Return type:	void

WebViewer.trigger(name, noteText)

Arguments:	name (`'noteTextShown'()`) – noteText (`NoteText()`) – None
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'walkOperatorActivated'()`) –
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'walkOperatorDeactivated'()`) –
Return type:	void

WebViewer.trigger(name, view)

Arguments:	name (`'viewCreated'()`) – view (`MarkupView()`) – None
Return type:	void

WebViewer.trigger(name, view)

Arguments:	name (`'viewDeleted'()`) – view (`MarkupView()`) – None
Return type:	void

WebViewer.trigger(name, view)

Arguments:	name (`'viewLoaded'()`) – view (`MarkupView()`) – None
Return type:	void

WebViewer.trigger(name, position, modifiers)

Arguments:	name (`'contextMenu'()`) – position (`Point2()`) – None modifiers (KeyModifiers) – None
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'beginInteraction'()`) –
Return type:	void

WebViewer.trigger(name)

Arguments:	name (`'endInteraction'()`) –
Return type:	void

unregisterCustomOperator

WebViewer.unregisterCustomOperator(operatorId)

Arguments:	operatorId (OperatorId) –
Return type:	void

unsetCallbacks

WebViewer.unsetCallbacks(callbacks)

Arguments:	callbacks (`CallbackMap()`) –
Return type:	void

waitForIdle

WebViewer.waitForIdle(config)

Arguments:	config (`function()`) – None
Return type:	Promise <void>