RedlineItem

class Markup.Redline.RedlineItem()

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

Index

Constructors

• constructor

Properties

• _viewer
• uniqueId

Methods

• draw
• getClassName
• hit
• hitWithTolerance
• onDeselect
• onDragEnd
• onDragMove
• onDragStart
• onSelect
• remove
• toJson

Constructors

Markup.Redline.RedlineItem.constructor()

RedlineItem(viewer: IWebViewer): RedlineItem

Parameters

viewer: IWebViewer

Returns: RedlineItem

Properties

Markup.Redline.RedlineItem._viewer

_viewer: IWebViewer

Markup.Redline.RedlineItem.uniqueId

inherited

uniqueId: string

Methods

Markup.Redline.RedlineItem.draw()

inherited

draw(_renderer: MarkupRenderer, _view: IView): void

Called when the markup item should be redrawn on a specific view. This most typically happens when the scene is rendered.

Parameters

_renderer: MarkupRenderer

_view: IView

Returns: void

Markup.Redline.RedlineItem.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

Markup.Redline.RedlineItem.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

Markup.Redline.RedlineItem.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

Markup.Redline.RedlineItem.onDeselect()

inherited

onDeselect(): void

Called when this markup item is deselected by the system

Returns: void

Markup.Redline.RedlineItem.onDragEnd()

onDragEnd(_position: Point2, _view: IView): boolean

Parameters

_position: Point2

_view: IView

Returns: boolean

Markup.Redline.RedlineItem.onDragMove()

onDragMove(_position: Point2, _view: IView): boolean

Parameters

_position: Point2

_view: IView

Returns: boolean

Markup.Redline.RedlineItem.onDragStart()

onDragStart(_position: Point2, _view: IView): boolean

Parameters

_position: Point2

_view: IView

Returns: boolean

Markup.Redline.RedlineItem.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

Markup.Redline.RedlineItem.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

Markup.Redline.RedlineItem.toJson()

inherited

toJson(): object

Creates an object ready for JSON serialization.

Returns: object

The prepared object.