MarkupView

class Communicator.Markup.MarkupView()

Methods

addMarkupItem

MarkupView.addMarkupItem(markupItem)

Adds a markup item to this view

Arguments
  • markupItem (MarkupItem()) – the markup to be added to this view.

Return type

void

forJson

MarkupView.forJson()
Deprecated

Use toJson instead.

Return type

Object

getCamera

MarkupView.getCamera()

Gets the camera of this view

Return type

Camera()

Returns

the camera of this view

getColorMap

MarkupView.getColorMap()
Return type

Map <NodeId, Color()>

Returns

A color map associating NodeIds to Colors.

getCuttingPlaneData

MarkupView.getCuttingPlaneData()
Return type

Object

Returns

a JSON object with the cutting plane data associated with this view

getDefaultVisibility

MarkupView.getDefaultVisibility()
Return type

boolean

getExplodeMagnitude

MarkupView.getExplodeMagnitude()
Return type

number

Returns

the explode value associated with this view

getFaceVisibility

MarkupView.getFaceVisibility()

Gets face visibility setting for this view

Return type

boolean

Returns

face visibility setting for this view

getLineVisibility

MarkupView.getLineVisibility()

Gets line visibility setting for this view

Return type

boolean

Returns

line visibility setting for this view

getMarkup

MarkupView.getMarkup()

Gets an array of markup items associated with this view

Return type

[MarkupItem()]

Returns

face visibility setting for this view

getName

MarkupView.getName()

Gets the name of this view

Return type

string

Returns

name of this view

getSheetId

MarkupView.getSheetId()

Gets the sheet id for this view

Return type

SheetId | null

Returns

the id of the sheet for this view. If no view was active at the time of creation this function will return null.

getSnapshotImage

MarkupView.getSnapshotImage()
Return type

HTMLImageElement | null

getUniqueId

MarkupView.getUniqueId()

Gets the unique identifier of this view

Return type

Uuid

Returns

unique identifier of this view

getVisibilityExceptions

MarkupView.getVisibilityExceptions()
Return type

Set <NodeId>

removeMarkup

MarkupView.removeMarkup(item)

Removes a markup item from the view

Arguments
Return type

boolean

Returns

result of the removal operation

setColorMap

MarkupView.setColorMap(colorMap)

Takes a color map associating NodeIds to Colors and associates it with this view.

Arguments
Return type

void

setCuttingPlaneData

MarkupView.setCuttingPlaneData(cuttingPlaneData)

Takes a JSON cutting plane data object and associates it with this view

Arguments
  • cuttingPlaneData (Object()) –

Return type

void

setDefaultVisibility

MarkupView.setDefaultVisibility(defaultVisibility)
Arguments
  • defaultVisibility (boolean()) –

Return type

void

setExplodeMagnitude

MarkupView.setExplodeMagnitude(explodeMagnitude)

Takes an explode magnitude and associates it with this view

Arguments
  • explodeMagnitude (number()) –

Return type

void

setFaceVisibility

MarkupView.setFaceVisibility(faceVisibility)

Sets face visibility for this view

Arguments
  • faceVisibility (boolean()) – face visibility setting for this view

Return type

void

setLineVisibility

MarkupView.setLineVisibility(lineVisibility)

Sets line visibility for this view

Arguments
  • lineVisibility (boolean()) – line visibility setting for this view

Return type

void

setName

MarkupView.setName(name)

Sets the name for this view

Arguments
  • name (string()) – name to set

Return type

void

setSnapshotImage

MarkupView.setSnapshotImage(image)
Arguments
  • image (HTMLImageElement()) –

Return type

void

setVisibilityExceptions

MarkupView.setVisibilityExceptions(nodeIds)
Arguments
Return type

void

toJson

MarkupView.toJson()

Creates an object ready for JSON serialization.

Return type

Object

Returns

The prepared object.