MeasureMarkup

class Operators.Markup.Measure.MeasureMarkup()

Base class for Measure Markup. It should not be used directly.

Properties

Operators.Markup.Measure.MeasureMarkup.uniqueId

inherited

uniqueId: string

Methods

Operators.Markup.Measure.MeasureMarkup.getClassName()

inherited

getClassName(): string

Gets the fully qualified class name for this markup item. E.g. “Communicator.Markup.Redline.RedlineCircle”

Returns: string

fully qualified class name
Operators.Markup.Measure.MeasureMarkup.getMeasurementText()
getMeasurementText(): string

Gets the text for this measurement. By default this will contain the measurement value and units for the model in the cases where the measurement is a distance. In other cases it will contain the angle in degrees.

Returns: string

Operators.Markup.Measure.MeasureMarkup.getMeasurementValue()
getMeasurementValue(): number

Returns the unit agnostic value for this measurement. In the case where this value represents distance, use [[getUnitMultiplier]] to determine the measurement units. In other cases, this value will be the angle measurement in degrees.

Returns: number

the measurement value
Operators.Markup.Measure.MeasureMarkup.getName()
getName(): string

Gets the name of this measurement.

Returns: string

the measurement name
Operators.Markup.Measure.MeasureMarkup.getUnitMultiplier()
getUnitMultiplier(): number

Returns the unit multiplier incorporated into the measurement value. This number is a multiplier of millimeters (for example inches will be 25.4). The default value is 1.0.

Returns: number

Operators.Markup.Measure.MeasureMarkup.getVisibility()
getVisibility(): boolean

Returns: boolean

Operators.Markup.Measure.MeasureMarkup.hit()

inherited

hit(_point: Point2, _view: IView): boolean

Called when a hit test is performed on this markup item.

Parameters

_point: Point2

_view: IView

Returns: boolean

boolean value indicating whether this item was picked
Operators.Markup.Measure.MeasureMarkup.hitWithTolerance()

inherited

hitWithTolerance(_point: Point2, _view: IView, _pickTolerance: number): boolean

Called when a hit test is performed on this markup item.

Parameters

_point: Point2

_view: IView

_pickTolerance: number

Returns: boolean

boolean value indicating whether this item was picked
Operators.Markup.Measure.MeasureMarkup.isMarkupValid()
isMarkupValid(): boolean

Returns whether the measurement markup is valid. Override in subclasses when needed.

Returns: boolean

Operators.Markup.Measure.MeasureMarkup.onDeselect()

inherited

onDeselect(): void

Called when this markup item is deselected by the system

Returns: void

Operators.Markup.Measure.MeasureMarkup.onSelect()

inherited

onSelect(_view: IView): void

Called when this markup item is selected by the system from a given view.

Parameters

_view: IView

Returns: void

Operators.Markup.Measure.MeasureMarkup.remove()

inherited

remove(_view: (None | IView)): void

Called when the MarkupItem is removed from a view from the system. Any cleanup that needs to be done should be performed in this method.

Parameters

_view: (None | IView)

Returns: void

Operators.Markup.Measure.MeasureMarkup.setMeasurementText()
setMeasurementText(measurementText: string): void

Sets the measurement text that is rendered with this measurement.

Parameters

measurementText: string

the text to render with this measurement

Returns: void

Operators.Markup.Measure.MeasureMarkup.setName()
setName(name: string): void

Sets the name of this measurement

Parameters

name: string

the name to set

Returns: void

Operators.Markup.Measure.MeasureMarkup.setVisibility()
setVisibility(visibility: boolean): void

Parameters

visibility: boolean

Returns: void

Operators.Markup.Measure.MeasureMarkup.toJson()
toJson(): object

Creates an object ready for JSON serialization.

Returns: object

The prepared object.