IWebViewer

class IWebViewer()

Properties

BCFManager
_views
animationManager
cuttingManager
explodeManager
floorplanManager
lineManager
markupManager
measureManager
model
noteTextManager
operatorManager
overlayManager
selectionManager
sheetManager
view
views

Properties

IWebViewer.BCFManager

Type:	`BCFManager()`

IWebViewer._views

Type:	[`IView()`]

IWebViewer.animationManager

Type:	AnimationManager

IWebViewer.cuttingManager

Type:	`ICuttingManager()`

IWebViewer.explodeManager

Type:	`ExplodeManager()`

IWebViewer.floorplanManager

Type:	`FloorplanManager()`

IWebViewer.lineManager

Type:	`LineManager()`

IWebViewer.markupManager

Type:	`MarkupManager()`

IWebViewer.measureManager

Type:	`MeasureManager()`

IWebViewer.model

Type:	`IModel()`

IWebViewer.noteTextManager

Type:	`NoteTextManager()`

IWebViewer.operatorManager

Type:	`OperatorManager()`

IWebViewer.overlayManager

Type:	`OverlayManager()`

IWebViewer.selectionManager

Type:	`SelectionManager()`

IWebViewer.sheetManager

Type:	`SheetManager()`

IWebViewer.view

Type:	`IView()`

IWebViewer.views

Type:	[`IView()`]

Methods

addView

IWebViewer.addView(config)

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

advanceExportToSvg

IWebViewer.advanceExportToSvg()

Return type:	Promise <string \| undefined>

applyFilter

IWebViewer.applyFilter(filterId)

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

beginExportToSvg

IWebViewer.beginExportToSvg([config])

Arguments:	config (`SvgConfig()`) – optional
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
Return type:	Promise <string>

fitWorld

IWebViewer.fitWorld([duration])

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

focusInput

IWebViewer.focusInput(focus)

Arguments:	focus (`boolean()`) –
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
Return type:	Promise <object>

getStreamCutoffScale

IWebViewer.getStreamCutoffScale()

Return type:	number

getStreamingMode

IWebViewer.getStreamingMode()

Return type:	StreamingMode

getView

IWebViewer.getView(viewKey)

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

getViewElement

IWebViewer.getViewElement()

Return type:	HTMLDivElement

getViewerVersionString

IWebViewer.getViewerVersionString()

Return type:	string

moveToWindow

IWebViewer.moveToWindow(win)

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

pauseRendering

IWebViewer.pauseRendering([callback])

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

IWebViewer.callback()

Return type:	void

redraw

IWebViewer.redraw([callback])

Arguments:	callback (`function()`) – optional
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()`) –
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 (PartId \| null) – selectionMode (SelectionMode) – optional None
Return type:	SelectionType

setAllowHighDpi

IWebViewer.setAllowHighDpi(allow)

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

setCallbacks

IWebViewer.setCallbacks(callbacks)

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

setClientTimeout

IWebViewer.setClientTimeout(timeoutDuration, warningTime)

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

setContextMenuStatus

IWebViewer.setContextMenuStatus(isActive)

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

setMinimumFramerate

IWebViewer.setMinimumFramerate(value)

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

setServerRenderQuality

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

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

setStreamCutoffScale

IWebViewer.setStreamCutoffScale(value)

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

setViewOrientation

IWebViewer.setViewOrientation(orientation[, duration])

Arguments:	orientation (ViewOrientation) – duration (`number()`) – optional
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, id, filename)

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

IWebViewer.trigger(name, id)

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

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

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

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

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

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

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

IWebViewer.trigger(name, cuttingSection, planeIndex)

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

IWebViewer.trigger(name, cuttingSection, planeIndex)

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

IWebViewer.trigger(name, cuttingSection, planeIndex)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name, redlineMarkup)

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

IWebViewer.trigger(name, redlineMarkup)

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

IWebViewer.trigger(name, redlineMarkup)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name, measurement)

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

IWebViewer.trigger(name, measurement)

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

IWebViewer.trigger(name, measurement)

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

IWebViewer.trigger(name, measurement)

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

IWebViewer.trigger(name, measurement)

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

IWebViewer.trigger(name, noteText)

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

IWebViewer.trigger(name, noteText)

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

IWebViewer.trigger(name, noteText)

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

IWebViewer.trigger(name, noteText)

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

IWebViewer.trigger(name, noteText)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name, view)

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

IWebViewer.trigger(name, view)

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

IWebViewer.trigger(name, view)

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

IWebViewer.trigger(name, position, modifiers)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name)

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

IWebViewer.trigger(name, args)

Arguments:	name (`unknown()`) – args (`[any]()`) –
Return type:	void

unregisterCustomOperator

IWebViewer.unregisterCustomOperator(operatorId)

Arguments:	operatorId (OperatorId) –
Return type:	void

unsetCallbacks

IWebViewer.unsetCallbacks(callbacks)

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

waitForIdle

IWebViewer.waitForIdle(config)

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