MeasureManager

class Communicator.MeasureManager(): This class provides an interface to measurement management related functions of the viewer.

Methods

addMeasurement()
exportMarkup()
finalizeMeasurement()
getAllMeasurements()
getMeasurementColor()
getMeasurementEdgeColor()
loadData()
removeAllMeasurements()
removeLastMeasurement()
removeMeasurement()
setMeasurementColor()
setMeasurementEdgeColor()

Methods

addMeasurement

Communicator.MeasureManager.addMeasurement(measureItem)

Adds a new Measurement to the Measure Manager

Arguments

measureItem (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

Communicator.Uuid

exportMarkup

Communicator.MeasureManager.exportMarkup()

Return type: [Object]
Returns: JSON Array with measurement markup

finalizeMeasurement

Communicator.MeasureManager.finalizeMeasurement(measureItem)

Triggers a measurementCreated callback

Arguments

measureItem (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

getAllMeasurements

Communicator.MeasureManager.getAllMeasurements()

Return an array of measurement items.

Return type: [Communicator.Markup.Measure.MeasureMarkup]
Returns: array of all measurement items.

getMeasurementColor

Communicator.MeasureManager.getMeasurementColor()

Gets the current measurement color.

Return type: Communicator.Color
Returns: color current measurement color.

getMeasurementEdgeColor

Communicator.MeasureManager.getMeasurementEdgeColor()

Gets the current measurement edge color.

Return type: Communicator.Color
Returns: color current measurement edge color.

loadData

Communicator.MeasureManager.loadData(measurementDataJson)

Loads JSON markup data

Arguments

measurementDataJson ([any]()) –

Return type

Promise[[boolean]]

removeAllMeasurements

Communicator.MeasureManager.removeAllMeasurements()

Removes all measurement items.

Return type: void

removeLastMeasurement

Communicator.MeasureManager.removeLastMeasurement()

Removes the most recently added measurement item.

Return type: void

removeMeasurement

Communicator.MeasureManager.removeMeasurement(measureItem)

Removes an existing measurement item.

Arguments

measureItem (Communicator.Markup.Measure.MeasureMarkup()) –

Return type

void

setMeasurementColor

Communicator.MeasureManager.setMeasurementColor(color)

Sets the current measurement color.

Arguments

color (Communicator.Color()) – the measurement color to set.

Return type

void

setMeasurementEdgeColor

Communicator.MeasureManager.setMeasurementEdgeColor(color)

Sets the current measurement edge color.

Arguments

color (Communicator.Color()) – the measurement edge color to set.

Return type

void