Polyline

class Communicator.Markup.Shape.Polyline(): This class reprsents a line defined by a list of points.

Methods

clearPoints

Polyline.clearPoints()

Removes all points from this polyline

Return type: void

getEndEndcapColor

Polyline.getEndEndcapColor()

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

Return type: Color()
Returns: color for the end endcap.

getEndEndcapSize

Polyline.getEndEndcapSize()

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

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

getEndEndcapType

Polyline.getEndEndcapType()

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

Return type: EndcapType
Returns: the end endcap type

getEndcapsInverted

Polyline.getEndcapsInverted()

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

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

getPoints

Polyline.getPoints()

Gets the points in this polyline

Return type: [Point2()]
Returns: the points in this polyline

getStartEndcapColor

Polyline.getStartEndcapColor()

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

Return type: Color()
Returns: color for the start endcap.

getStartEndcapSize

Polyline.getStartEndcapSize()

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

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

getStartEndcapType

Polyline.getStartEndcapType()

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

Return type: EndcapType
Returns: the start endcap type

getStrokeColor

Polyline.getStrokeColor()

Gets the stroke color for this shape

Return type: Color()
Returns: the stroke color

getStrokeWidth

Polyline.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type: Pixels
Returns: the stroke width in pixels

pushPoint

Polyline.pushPoint(point)

Adds a point to the polyline

Arguments

point (Point2()) – the point to add to the line

Return type

void

setEndEndcapColor

Polyline.setEndEndcapColor(color)

Sets the color for the end endcap.

Arguments

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

Return type

void

setEndEndcapSize

Polyline.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments

size (Pixels) – the end endcap.

Return type

void

setEndEndcapType

Polyline.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments

endcapType (EndcapType) – the new endcap type

Return type

void

setEndcapType

Polyline.setEndcapType(endcapType)

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

Arguments

endcapType (EndcapType) – the new endcap type

Return type

void

setEndcapsInverted

Polyline.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

Arguments

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

Return type

void

setStartEndcapColor

Polyline.setStartEndcapColor(color)

Sets the color for the start endcap.

Arguments

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

Return type

void

setStartEndcapSize

Polyline.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments

size (Pixels) – the start endcap.

Return type

void

setStartEndcapType

Polyline.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments

endcapType (EndcapType) – the new endcap type

Return type

void

setStrokeColor

Polyline.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

color (Color()) – the stroke color

Return type

void

setStrokeWidth

Polyline.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

strokeWidth (Pixels) – the stroke width in pixels

Return type

void