LineCollection

class Communicator.Markup.Shape.LineCollection()

This class is useful for specifying multiple lines that all share the same visual appearance.


Methods

addLine

LineCollection.addLine(p1, p2)

Adds a line segment to the collection

Arguments
  • p1 (Point2()) – first point of the line segment

  • p2 (Point2()) – second point of the line segment

Return type

void

clear

LineCollection.clear()

Removes all line segments from this collection

Return type

void

getEndEndcapColor

LineCollection.getEndEndcapColor()

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

Return type

Color()

Returns

color for the end endcap.

getEndEndcapSize

LineCollection.getEndEndcapSize()

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

Return type

Pixels

Returns

size of the end endcap.

getEndEndcapType

LineCollection.getEndEndcapType()

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

Return type

EndcapType

Returns

the end endcap type

getEndcapsInverted

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

LineCollection.getLines()

Gets the lines in the collection

Return type

[_MarkupLineData]

getStartEndcapColor

LineCollection.getStartEndcapColor()

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

Return type

Color()

Returns

color for the start endcap.

getStartEndcapSize

LineCollection.getStartEndcapSize()

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

Return type

Pixels

Returns

size of the start endcap.

getStartEndcapType

LineCollection.getStartEndcapType()

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

Return type

EndcapType

Returns

the start endcap type

getStrokeColor

LineCollection.getStrokeColor()

Gets the stroke color for this shape

Return type

Color()

Returns

the stroke color

getStrokeWidth

LineCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Pixels

Returns

the stroke width in pixels

setEndEndcapColor

LineCollection.setEndEndcapColor(color)

Sets the color for the end endcap.

Arguments
  • color (Color()) – the end endcap color value.

Return type

void

setEndEndcapSize

LineCollection.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments
  • size (Pixels) – the end endcap.

Return type

void

setEndEndcapType

LineCollection.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments
Return type

void

setEndcapType

LineCollection.setEndcapType(endcapType)

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

Arguments
Return type

void

setEndcapsInverted

LineCollection.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

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

Return type

void

setStartEndcapColor

LineCollection.setStartEndcapColor(color)

Sets the color for the start endcap.

Arguments
  • color (Color()) – the start endcap color value.

Return type

void

setStartEndcapSize

LineCollection.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments
  • size (Pixels) – the start endcap.

Return type

void

setStartEndcapType

LineCollection.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments
Return type

void

setStrokeColor

LineCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments
  • color (Color()) – the stroke color

Return type

void

setStrokeWidth

LineCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments
  • strokeWidth (Pixels) – the stroke width in pixels

Return type

void