CursorMarkup

class Operators.Markup.CursorMarkup()

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

Index

Constructors

• constructor

Properties

• uniqueId

Methods

• destroy
• enable
• getClassName
• getMeasurementText
• getMeasurementValue
• getName
• getUnitMultiplier
• getVisibility
• hit
• hitWithTolerance
• isEnabled
• isMarkupValid
• onDeselect
• onSelect
• remove
• setMeasurementText
• setName
• setPosition
• setVisibility
• toJson

Constructors

Operators.Markup.CursorMarkup.constructor()

CursorMarkup(viewer: IWebViewer, view: IView): CursorMarkup

Parameters

viewer: IWebViewer

view: IView

Returns: CursorMarkup

Properties

Operators.Markup.CursorMarkup.uniqueId

inherited

uniqueId: string

Methods

Operators.Markup.CursorMarkup.destroy()

destroy(): void

Returns: void

Operators.Markup.CursorMarkup.enable()

enable(enable: boolean): void

Parameters

enable: boolean

Returns: void

Operators.Markup.CursorMarkup.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.CursorMarkup.getMeasurementText()

inherited

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.CursorMarkup.getMeasurementValue()

inherited

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.CursorMarkup.getName()

inherited

getName(): string

Gets the name of this measurement.

Returns: string

the measurement name

Operators.Markup.CursorMarkup.getUnitMultiplier()

inherited

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.CursorMarkup.getVisibility()

inherited

getVisibility(): boolean

Returns: boolean

Operators.Markup.CursorMarkup.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.CursorMarkup.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.CursorMarkup.isEnabled()

isEnabled(): boolean

Returns: boolean

Operators.Markup.CursorMarkup.isMarkupValid()

inherited

isMarkupValid(): boolean

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

Returns: boolean

Operators.Markup.CursorMarkup.onDeselect()

inherited

onDeselect(): void

Called when this markup item is deselected by the system

Returns: void

Operators.Markup.CursorMarkup.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.CursorMarkup.remove()

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.CursorMarkup.setMeasurementText()

inherited

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.CursorMarkup.setName()

inherited

setName(name: string): void

Sets the name of this measurement

Parameters

name: string

the name to set

Returns: void

Operators.Markup.CursorMarkup.setPosition()

setPosition(point: Point2): void

Parameters

point: Point2

Returns: void

Operators.Markup.CursorMarkup.setVisibility()

inherited

setVisibility(visibility: boolean): void

Parameters

visibility: boolean

Returns: void

Operators.Markup.CursorMarkup.toJson()

inherited

toJson(): object

Creates an object ready for JSON serialization.

Returns: object

The prepared object.