LineCollection

class Communicator.Markup.Shape.LineCollection(): This class is useful for specifying multiple lines that all share the same visual appearance.

Methods

addLine

Communicator.Markup.Shape.LineCollection.addLine(p1, p2)

Adds a line segment to the collection

Arguments

p1 (Communicator.Point2()) – first point of the line segment
p2 (Communicator.Point2()) – second point of the line segment

Return type

void

clear

Communicator.Markup.Shape.LineCollection.clear()

Removes all line segments from this collection

Return type: void

getEndEndcapColor

Communicator.Markup.Shape.LineCollection.getEndEndcapColor()

Gets the color of the end endcap. Default value is black.

Return type: Communicator.Color
Returns: color for the end endcap.

getEndEndcapSize

Communicator.Markup.Shape.LineCollection.getEndEndcapSize()

Gets the size of the end endcap in pixels. Default value is 9.

Return type: Communicator.Pixels
Returns: size of the end endcap.

getEndEndcapType

Communicator.Markup.Shape.LineCollection.getEndEndcapType()

Gets the end endcap type for this shape. The default value is none.

Return type: Communicator.Markup.Shape.EndcapType
Returns: the end endcap type

getEndcapsInverted

Communicator.Markup.Shape.LineCollection.getEndcapsInverted()

Gets whether endcaps are inverted for this shape. The default value is false.

Return type: boolean
Returns: value indicating whether endcaps are inverted

getLines

Communicator.Markup.Shape.LineCollection.getLines()

Gets the lines in the collection

Return type: [_MarkupLineData]

getStartEndcapColor

Communicator.Markup.Shape.LineCollection.getStartEndcapColor()

Gets the color of the start endcap. Default value is black.

Return type: Communicator.Color
Returns: color for the start endcap.

getStartEndcapSize

Communicator.Markup.Shape.LineCollection.getStartEndcapSize()

Gets the size of the start endcap in pixels. Default value is 9.

Return type: Communicator.Pixels
Returns: size of the start endcap.

getStartEndcapType

Communicator.Markup.Shape.LineCollection.getStartEndcapType()

Gets the start endcap type for this shape. The default Value is none.

Return type: Communicator.Markup.Shape.EndcapType
Returns: the start endcap type

getStrokeColor

Communicator.Markup.Shape.LineCollection.getStrokeColor()

Gets the stroke color for this shape

Return type: Communicator.Color
Returns: the stroke color

getStrokeWidth

Communicator.Markup.Shape.LineCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type: Communicator.Pixels
Returns: the stroke width in pixels

setEndEndcapColor

Communicator.Markup.Shape.LineCollection.setEndEndcapColor(color)

Sets the color for the end endcap.

Arguments

color (Communicator.Color()) – the end endcap color value.

Return type

void

setEndEndcapSize

Communicator.Markup.Shape.LineCollection.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments

size (Communicator.Pixels()) – the end endcap.

Return type

void

setEndEndcapType

Communicator.Markup.Shape.LineCollection.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments

endcapType (Communicator.Markup.Shape.EndcapType()) – the new endcap type

Return type

void

setEndcapType

Communicator.Markup.Shape.LineCollection.setEndcapType(endcapType)

Convenience for setting the start and eend endcap type for this shape

Arguments

endcapType (Communicator.Markup.Shape.EndcapType()) – the new endcap type

Return type

void

setEndcapsInverted

Communicator.Markup.Shape.LineCollection.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

Arguments

inverted (boolean()) – value indicated whether endcaps should be inverted

Return type

void

setStartEndcapColor

Communicator.Markup.Shape.LineCollection.setStartEndcapColor(color)

Sets the color for the start endcap.

Arguments

color (Communicator.Color()) – the start endcap color value.

Return type

void

setStartEndcapSize

Communicator.Markup.Shape.LineCollection.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments

size (Communicator.Pixels()) – the start endcap.

Return type

void

setStartEndcapType

Communicator.Markup.Shape.LineCollection.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments

endcapType (Communicator.Markup.Shape.EndcapType()) – the new endcap type

Return type

void

setStrokeColor

Communicator.Markup.Shape.LineCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

color (Communicator.Color()) – the stroke color

Return type

void

setStrokeWidth

Communicator.Markup.Shape.LineCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

strokeWidth (Communicator.Pixels()) – the stroke width in pixels

Return type

void