Methods
- activate
Markup View With Promise - add
Markup Element - create
Markup View - delete
Markup View - export
Markup - get
Active Markup View - get
Markup View - get
Markup View Keys - get
Pick Tolerance - get
Renderer - get
Selected Markup - load
Markup Data - pick
Markup Item - refresh
Markup - register
Markup - register
Markup Type Manager - remove
Markup Element - select
Markup - set
Pick Tolerance - unregister
Markup - update
Later
Methods
activateMarkupView
[deprecated]
-
Parameters
-
uniqueId: Uuid
-
Optional duration: number
Returns boolean
-
activateMarkupViewWithPromise
-
Activates a MarkupView.
Parameters
-
uniqueId: Uuid
the handle for the MarkupView object to activate
-
Optional duration: number
the time in milliseconds for the transition to this view
Returns Promise<boolean>
-
addMarkupElement
-
Add an HTML element to the markup element layer. The element will have its ID set to a system generated unique identifier.
Parameters
-
element: HTMLElement
the HTML Element to add
Returns Uuid
system generated unique identifier which is the id of the passed in object
-
createMarkupView
-
Creates a new view based on the current camera, line, and face visibility values.
Parameters
-
Optional name: string
optional name for the view. If omitted or null, the system will generate a default name
-
Optional triggerEvent: boolean
optional parameter indicating whether a CallbackMap.viewCreated event should be triggered. This parameter defaults to true
-
Optional visibilityState: VisibilityState | null
optional parameter
-
Optional colorMap: Map<NodeId, Color> | null
-
Optional snapshotImage: HTMLImageElement | null
Returns Uuid
Unique identifier for the new view
-
deleteMarkupView
-
Deletes a MarkupView object.
Parameters
-
uniqueId: Uuid
the handle for the view object to delete
Returns boolean
true if a MarkupView with the supplied uniqueId was deleted, false otherwise
-
exportMarkup
-
export markup from the viewer
Returns MarkupData
Serialized markup objects
getActiveMarkupView
-
Returns the currently active MarkupView.
Returns MarkupView | null
MarkupView object for the currently active view, or null if no view is active
getMarkupView
-
Gets a MarkupView object from the viewer.
Parameters
-
uniqueId: Uuid
the handle for the view object to retreive
Returns MarkupView | null
MarkupView object for the corresponding ID or null if no view was found
-
getMarkupViewKeys
-
Returns Uuid[]
an array of string keys for all markup views
getPickTolerance
-
Gets the pick tolerance in pixels for picking a MarkupItem
Returns number
Current tolerance
getRenderer
-
Returns a the interface to the MarkupRenderer.
Returns MarkupRenderer
MarkupRenderer interface
getSelectedMarkup
-
Returns the currently selected MarkupItem, or null if nothing is currently selected
Returns MarkupItem | null
selected MarkupItem
loadMarkupData
-
Loads markup data into the viewer.
Parameters
-
json: string | MarkupData
Returns Promise<boolean>
-
pickMarkupItem
-
Picks a MarkupItem. Tests scene based and markup attached to the active view (if any)
Parameters
-
point: Point2
position to pick against
Returns MarkupItem | null
MarkupItem that was selected or null if none was picked
-
refreshMarkup
-
Redraws the markup without rendering the scene. Useful when markup is added or removed but the scene is not affected.
Returns void
registerMarkup
-
Registers a MarkupItem to be rendered with the 3D view.
Parameters
-
markupItem: MarkupItem
the item to register
Returns Uuid
unique handle to this MarkupItem.
-
registerMarkupTypeManager
-
Registers a MarkupTypeManager to add markup to exported data.
Parameters
-
markupType: string
-
markupTypeManager: MarkupTypeManager
Returns void
-
removeMarkupElement
-
Removes a markup element from the markup element layer
Parameters
-
id: Uuid
Returns void
-
selectMarkup
-
Selects a MarkupItem. Pass null to clear the selection.
Parameters
-
markupItem: MarkupItem | null
The MarkupItem to select.
Returns void
-
setPickTolerance
-
Sets the pick tolerance in pixels for picking a MarkupItem
Parameters
-
tolerance: number
The new tolerance
Returns void
-
unregisterMarkup
-
Unregisters a MarkupItem. It will no longer be rendered with the 3D view.
Parameters
-
uniqueId: Uuid
unique handle to the object that was returned from registerMarkup
Returns void
-
updateLater
-
Returns void
This class provides an interface into working with markup in the viewer. More information can be found here.