MarkupManager

class MarkupManager()

Accessors

viewer

Accessors

Methods

activateMarkupViewWithPromise

MarkupManager.activateMarkupViewWithPromise(uniqueId, view, duration)

Arguments:	uniqueId (Uuid) – view (`IView()`) – duration (`number()`) –
Return type:	Promise <boolean>

addMarkupElement

MarkupManager.addMarkupElement(element, view)

Arguments:	element (`HTMLElement()`) – view (`IView()`) –
Return type:	Uuid

createMarkupView

MarkupManager.createMarkupView(view[, name, triggerEvent, visibilityState, colorMap, snapshotImage])

Arguments:	view (`IView()`) – name (`string()`) – optional triggerEvent (`boolean()`) – visibilityState (`VisibilityState()` \| null) – colorMap (Map <NodeId, Color> \| null) – None snapshotImage (`HTMLImageElement \| null()`) – None
Return type:	Uuid

deleteMarkupView

MarkupManager.deleteMarkupView(uniqueId)

Arguments:	uniqueId (Uuid) –
Return type:	boolean

exportMarkup

MarkupManager.exportMarkup()

Return type:	`MarkupData()`

getActiveMarkupView

MarkupManager.getActiveMarkupView(view)

Arguments:	view (`IView()`) – None
Return type:	`MarkupView()` \| null

getMarkupView

MarkupManager.getMarkupView(uniqueId)

Arguments:	uniqueId (Uuid) –
Return type:	`MarkupView()` \| null

getMarkupViewKeys

MarkupManager.getMarkupViewKeys()

Return type:	[Uuid]

getPickTolerance

MarkupManager.getPickTolerance()

Return type:	number

getRenderer

MarkupManager.getRenderer()

Return type:	`MarkupRenderer()`

getSelectedMarkup

MarkupManager.getSelectedMarkup()

Return type:	`MarkupItem()` \| null

loadMarkupData

MarkupManager.loadMarkupData(json)

Arguments:	json (string \| `MarkupData()`) – None
Return type:	Promise <boolean>

pickMarkupItem

MarkupManager.pickMarkupItem(point, view)

Arguments:	point (`Point2()`) – view (`IView()`) –
Return type:	`MarkupItem()` \| null

refreshMarkup

MarkupManager.refreshMarkup(view)

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

refreshMarkupView

MarkupManager.refreshMarkupView(markupView)

Arguments:	markupView (`MarkupView()`) –
Return type:	void

registerMarkup

MarkupManager.registerMarkup(markupItem, view)

Arguments:	markupItem (`MarkupItem()`) – view (`IView()`) –
Return type:	Uuid

registerMarkupFactory

MarkupManager.registerMarkupFactory(className, factory)

Arguments:	className (`string()`) – factory (`function()`) –
Return type:	void

MarkupManager.factory(obj, viewer)

Arguments:	obj (`any()`) – None viewer (`IWebViewer()`) – None
Return type:	`MarkupItem()`

registerMarkupTypeManager

MarkupManager.registerMarkupTypeManager(markupType, markupTypeManager)

Arguments:	markupType (`string()`) – None markupTypeManager (`MarkupTypeManager()`) –
Return type:	void

removeMarkupElement

MarkupManager.removeMarkupElement(id, view)

Arguments:	id (Uuid) – None view (`IView()`) –
Return type:	void

selectMarkup

MarkupManager.selectMarkup(markupItem, view)

Arguments:	markupItem (`MarkupItem()` \| null) – view (`IView()`) –
Return type:	void

setPickTolerance

MarkupManager.setPickTolerance(tolerance)

Arguments:	tolerance (`number()`) –
Return type:	void

unregisterMarkup

MarkupManager.unregisterMarkup(uniqueId, view)

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

updateLater

MarkupManager.updateLater(view)

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