PolylineCollection

class Communicator.Markup.Shape.PolylineCollection(): This class is useful for drawing a number of polylines all of which share the same visual appearance.

Methods

clear

PolylineCollection.clear()

Removes all polylines from the collection

Return type: void

createPolyline

PolylineCollection.createPolyline()

Creates a new array of points that represent a polyline. Add Point2 objects to the array to construct the polyline

Return type: [Point2()]
Returns: new array which represents a polyline.

getEndEndcapColor

PolylineCollection.getEndEndcapColor()

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

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

getEndEndcapSize

PolylineCollection.getEndEndcapSize()

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

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

getEndEndcapType

PolylineCollection.getEndEndcapType()

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

Return type: EndcapType
Returns: the end endcap type

getEndcapsInverted

PolylineCollection.getEndcapsInverted()

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

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

getPolylines

PolylineCollection.getPolylines()

Return type: [[Point2()]]
Returns: the polylines in this collection

getStartEndcapColor

PolylineCollection.getStartEndcapColor()

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

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

getStartEndcapSize

PolylineCollection.getStartEndcapSize()

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

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

getStartEndcapType

PolylineCollection.getStartEndcapType()

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

Return type: EndcapType
Returns: the start endcap type

getStrokeColor

PolylineCollection.getStrokeColor()

Gets the stroke color for this shape

Return type: Color()
Returns: the stroke color

getStrokeWidth

PolylineCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type: Pixels
Returns: the stroke width in pixels

setEndEndcapColor

PolylineCollection.setEndEndcapColor(color)

Sets the color for the end endcap.

Arguments

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

Return type

void

setEndEndcapSize

PolylineCollection.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments

size (Pixels) – the end endcap.

Return type

void

setEndEndcapType

PolylineCollection.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments

endcapType (EndcapType) – the new endcap type

Return type

void

setEndcapType

PolylineCollection.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

PolylineCollection.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

Arguments

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

Return type

void

setStartEndcapColor

PolylineCollection.setStartEndcapColor(color)

Sets the color for the start endcap.

Arguments

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

Return type

void

setStartEndcapSize

PolylineCollection.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments

size (Pixels) – the start endcap.

Return type

void

setStartEndcapType

PolylineCollection.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments

endcapType (EndcapType) – the new endcap type

Return type

void

setStrokeColor

PolylineCollection.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

color (Color()) – the stroke color

Return type

void

setStrokeWidth

PolylineCollection.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

strokeWidth (Pixels) – the stroke width in pixels

Return type

void