LineMarkup

class LineMarkup()

Constructors

constructor()

Properties

override
uniqueId
className

Constructors

LineMarkup.constructor(viewer, firstPoint, secondPoint, firstNodeId, secondNodeId)

Arguments:	viewer (`IWebViewer()`) – None firstPoint (`Point3 \| null()`) – None secondPoint (`Point3 \| null()`) – None firstNodeId (NodeId \| null) – None secondNodeId (NodeId \| null) – None
Return type:	`LineMarkup()`

Properties

LineMarkup.override

Type:	any

LineMarkup.uniqueId

Type:	Uuid

LineMarkup.className

Type:	string

Methods

draw

LineMarkup.draw(_renderer, _view)

Arguments:	_renderer (`MarkupRenderer()`) – None _view (`IView()`) – None
Return type:	void

getClassName

LineMarkup.getClassName()

Return type:	string

getFirstNodeId

LineMarkup.getFirstNodeId()

Return type:	NodeId \| null

getFirstPoint

LineMarkup.getFirstPoint()

Return type:	Point3 \| null

getId

LineMarkup.getId()

Return type:	Uuid

getLineColor

LineMarkup.getLineColor()

Return type:	Color

getLineOpacity

LineMarkup.getLineOpacity()

Return type:	number

getLinePattern

LineMarkup.getLinePattern()

Return type:	LinePattern \| null

getLinePatternLength

LineMarkup.getLinePatternLength()

Return type:	number \| null

getLinePatternLengthUnit

LineMarkup.getLinePatternLengthUnit()

Return type:	LinePatternLengthUnit \| null

getNodeId

LineMarkup.getNodeId()

Return type:	number \| null

getSecondNodeId

LineMarkup.getSecondNodeId()

Return type:	NodeId \| null

getSecondPoint

LineMarkup.getSecondPoint()

Return type:	Point3 \| null

hit

LineMarkup.hit(_point, _view)

Arguments:	_point (`Point2()`) – None _view (`IView()`) – None
Return type:	boolean

hitWithTolerance

LineMarkup.hitWithTolerance(_point, _view, _pickTolerance)

Arguments:	_point (`Point2()`) – None _view (`IView()`) – None _pickTolerance (`number()`) – None
Return type:	boolean

onDeselect

LineMarkup.onDeselect()

Return type:	void

onSelect

LineMarkup.onSelect(_view)

Arguments:	_view (`IView()`) – None
Return type:	void

remove

LineMarkup.remove(_view)

Arguments:	_view (`IView()` \| null) – None
Return type:	void

removeLine

LineMarkup.removeLine()

Return type:	Promise <void>

setFirstNodeId

LineMarkup.setFirstNodeId(nodeId)

Arguments:	nodeId (NodeId \| null) –
Return type:	void

setFirstPoint

LineMarkup.setFirstPoint(firstPoint)

Arguments:	firstPoint (`Point3 \| null()`) –
Return type:	void

setId

LineMarkup.setId(id)

Arguments:	id (Uuid) –
Return type:	void

setLineColor

LineMarkup.setLineColor(color)

Arguments:	color (Color) –
Return type:	void

setLineOpacity

LineMarkup.setLineOpacity(opacity)

Arguments:	opacity (`number()`) –
Return type:	void

setLinePattern

LineMarkup.setLinePattern(pattern, patternLength, patternLengthUnit)

Arguments:	pattern (LinePattern) – patternLength (`number()`) – patternLengthUnit (LinePatternLengthUnit) –
Return type:	void

setSecondNodeId

LineMarkup.setSecondNodeId(nodeId)

Arguments:	nodeId (NodeId \| null) –
Return type:	void

setSecondPoint

LineMarkup.setSecondPoint(secondPoint)

Arguments:	secondPoint (`Point3 \| null()`) –
Return type:	void

toJson

LineMarkup.toJson()

Return type:	object

updateLine

LineMarkup.updateLine()

Return type:	Promise <void>

static fromJson

LineMarkup.fromJson(objData, viewer)

Arguments:	objData (`any()`) – None viewer (`IWebViewer()`) – None
Return type:	Promise <`LineMarkup()`>