MarkupView

class Markup.MarkupView()

Methods

Methods

addMarkupItem

MarkupView.addMarkupItem(markupItem)
Arguments

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

Adds a markup item to this view

Return type

void

getCamera

MarkupView.getCamera()

Gets the camera of this view

Returns

the camera of this view

Return type

Camera

getColorMap

MarkupView.getColorMap()
Returns

A color map associating NodeIds to Colors.

Return type

Map <number, Color>

getCuttingPlaneData

MarkupView.getCuttingPlaneData()
Returns

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

Return type

object

getDefaultVisibility

MarkupView.getDefaultVisibility()
Return type

boolean

getExplodeMagnitude

MarkupView.getExplodeMagnitude()
Returns

the explode value associated with this view

Return type

number

getFaceVisibility

MarkupView.getFaceVisibility()

Gets face visibility setting for this view

Returns

face visibility setting for this view

Return type

boolean

getLineVisibility

MarkupView.getLineVisibility()

Gets line visibility setting for this view

Returns

line visibility setting for this view

Return type

boolean

getMarkup

MarkupView.getMarkup()

Gets an array of markup items associated with this view

Returns

face visibility setting for this view

Return type

[MarkupItem]

getName

MarkupView.getName()

Gets the name of this view

Returns

name of this view

Return type

string

getSheetId

MarkupView.getSheetId()

Gets the sheet id for this view

Returns

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

Return type

null | number

getSnapshotImage

MarkupView.getSnapshotImage()
Return type

null | HTMLImageElement

getUniqueId

MarkupView.getUniqueId()

Gets the unique identifier of this view

Returns

unique identifier of this view

Return type

string

getVisibilityExceptions

MarkupView.getVisibilityExceptions()
Return type

Set <number>

removeMarkup

MarkupView.removeMarkup(item)
Arguments

Removes a markup item from the view

Returns

result of the removal operation

Return type

boolean

setColorMap

MarkupView.setColorMap(colorMap)
Arguments

  • colorMap (Map) – None

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

Return type

void

setCuttingPlaneData

MarkupView.setCuttingPlaneData(cuttingPlaneData)
Arguments

  • cuttingPlaneData (object()) – None

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

Return type

void

setDefaultVisibility

MarkupView.setDefaultVisibility(defaultVisibility)
Arguments

  • defaultVisibility (boolean()) – None

Return type

void

setExplodeMagnitude

MarkupView.setExplodeMagnitude(explodeMagnitude)
Arguments

  • explodeMagnitude (number()) – None

Takes an explode magnitude and associates it with this view

Return type

void

setFaceVisibility

MarkupView.setFaceVisibility(faceVisibility)
Arguments

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

Sets face visibility for this view

Return type

void

setLineVisibility

MarkupView.setLineVisibility(lineVisibility)
Arguments

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

Sets line visibility for this view

Return type

void

setName

MarkupView.setName(name)
Arguments

  • name (string()) – name to set

Sets the name for this view

Return type

void

setSnapshotImage

MarkupView.setSnapshotImage(image)
Arguments

  • image (HTMLImageElement()) – None

Return type

void

setVisibilityExceptions

MarkupView.setVisibilityExceptions(nodeIds)
Arguments

  • nodeIds (Set) – None

Return type

void

toJson

MarkupView.toJson()

Creates an object ready for JSON serialization.

Returns

The prepared object.

Return type

object