MeasureManager

class wv.MeasureManager()

This class provides an interface to measurement management related functions of the viewer.

Index

Accessors

• viewer

Methods

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

Accessors

wv.MeasureManager.viewer()

get viewer(): IWebViewer

Returns: IWebViewer

Methods

wv.MeasureManager.addMeasurement()

addMeasurement(measureItem: MeasureMarkup): string

Adds a new Measurement to the Measure Manager

Parameters

measureItem: MeasureMarkup

MeasureMarkup Object that will be added

Returns: string

wv.MeasureManager.exportMarkup()

exportMarkup(): object[]

Returns: object[]

JSON Array with measurement markup

wv.MeasureManager.finalizeMeasurement()

finalizeMeasurement(measureItem: MeasureMarkup): void

Triggers a measurementCreated callback

Parameters

measureItem: MeasureMarkup

measureItem passed to the callback

Returns: void

wv.MeasureManager.getAllMeasurements()

getAllMeasurements(): MeasureMarkup[]

Return an array of measurement items.

Returns: MeasureMarkup[]

array of all measurement items.

wv.MeasureManager.getMeasurementColor()

getMeasurementColor(): Color

Gets the current measurement color.

Returns: Color

color current measurement color.

wv.MeasureManager.getMeasurementEdgeColor()

getMeasurementEdgeColor(): Color

Gets the current measurement edge color.

Returns: Color

color current measurement edge color.

wv.MeasureManager.loadData()

loadData(measurementDataJson: any[]): Promise

Loads JSON markup data

Parameters

measurementDataJson: any[]

Measurement Data object (JSON)

Returns: Promise

wv.MeasureManager.removeAllMeasurements()

removeAllMeasurements(): void

Removes all measurement items.

Returns: void

wv.MeasureManager.removeLastMeasurement()

removeLastMeasurement(): void

Removes the most recently added measurement item.

Returns: void

wv.MeasureManager.removeMeasurement()

removeMeasurement(measureItem: MeasureMarkup): void

Removes an existing measurement item.

Parameters

measureItem: MeasureMarkup

the measurement item to remove.

Returns: void

wv.MeasureManager.setMeasurementColor()

setMeasurementColor(color: Color): void

Sets the current measurement color.

Parameters

color: Color

the measurement color to set.

Returns: void

wv.MeasureManager.setMeasurementEdgeColor()

setMeasurementEdgeColor(color: Color): void

Sets the current measurement edge color.

Parameters

color: Color

the measurement edge color to set.

Returns: void