MeasurePolylineDistanceOperator

class Operators.Measure.MeasurePolylineDistanceOperator()

This operator allows you to create a polyline and measure its distance. Click to add points to the polyline. A cursor will show where the point will be placed. The operator will perform vertex snapping by default. Holding down the alt key will disable this feature. To complete a measurement, double click when placing a point to create an open line measurement, or single click on the first point to create a closed loop. When there is no active measurement being created, click on a text box to drag and reposition it relative to its anchor point. If a measurement is currently being created, pressing the Escape key will discard it, otherwise the last created measurement will be discarded.

Index

Methods

• _clearMeasurement
• _pickExisting
• addMapping
• clearMapping
• setAnchor
• setMapping

Methods

Operators.Measure.MeasurePolylineDistanceOperator._clearMeasurement()

_clearMeasurement(): void

Returns: void

Operators.Measure.MeasurePolylineDistanceOperator._pickExisting()

_pickExisting(selectPoint: Point2): boolean

Parameters

selectPoint: Point2

Returns: boolean

Operators.Measure.MeasurePolylineDistanceOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Measure.MeasurePolylineDistanceOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.Measure.MeasurePolylineDistanceOperator.setAnchor()

setAnchor(anchor: MeasurePolylineDistanceAnchor): void

Sets the anchor type that will be set for markups created by this operator.

Parameters

anchor: MeasurePolylineDistanceAnchor

Returns: void

Operators.Measure.MeasurePolylineDistanceOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void