PolylineCollection

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

Constructors

constructor()

Constructors

PolylineCollection.constructor()

Return type:	PolylineCollection

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

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

getEndcapsInverted

PolylineCollection.getEndcapsInverted()

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

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

getEndEndcapColor

PolylineCollection.getEndEndcapColor()

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

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

getEndEndcapSize

PolylineCollection.getEndEndcapSize()

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

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

getEndEndcapType

PolylineCollection.getEndEndcapType()

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

Returns:	the end endcap type
Return type:	EndcapType

getPolylines

PolylineCollection.getPolylines()

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

getStartEndcapColor

PolylineCollection.getStartEndcapColor()

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

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

getStartEndcapSize

PolylineCollection.getStartEndcapSize()

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

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

getStartEndcapType

PolylineCollection.getStartEndcapType()

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

Returns:	the start endcap type
Return type:	EndcapType

getStrokeColor

PolylineCollection.getStrokeColor()

Gets the stroke color for this shape

Returns:	the stroke color
Return type:	Color

getStrokeWidth

PolylineCollection.getStrokeWidth()

Gets the stroke width for this shape in pixels

Returns:	the stroke width in pixels
Return type:	number

setEndcapsInverted

PolylineCollection.setEndcapsInverted(inverted)

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

Sets whether endcapsare inverted for this shape.

Return type:	void

setEndcapType

PolylineCollection.setEndcapType(endcapType)

Arguments:	endcapType (`EndcapType()`) – the new endcap type

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

Return type:	void

setEndEndcapColor

PolylineCollection.setEndEndcapColor(color)

Arguments:	color (`Color()`) – the end endcap color value.

Sets the color for the end endcap.

Return type:	void

setEndEndcapSize

PolylineCollection.setEndEndcapSize(size)

Arguments:	size (`number()`) – the end endcap.

Sets the size of the end endcap in pixels.

Return type:	void

setEndEndcapType

PolylineCollection.setEndEndcapType(endcapType)

Arguments:	endcapType (`EndcapType()`) – the new endcap type

Sets the end endcap type for this shape

Return type:	void

setStartEndcapColor

PolylineCollection.setStartEndcapColor(color)

Arguments:	color (`Color()`) – the start endcap color value.

Sets the color for the start endcap.

Return type:	void

setStartEndcapSize

PolylineCollection.setStartEndcapSize(size)

Arguments:	size (`number()`) – the start endcap.

Sets the size of the start endcap in pixels.

Return type:	void

setStartEndcapType

PolylineCollection.setStartEndcapType(endcapType)

Arguments:	endcapType (`EndcapType()`) – the new endcap type

Sets the start endcap type for this shape

Return type:	void

setStrokeColor

PolylineCollection.setStrokeColor(color)

Arguments:	color (`Color()`) – the stroke color

Sets the stroke color for this shape

Return type:	void

setStrokeWidth

PolylineCollection.setStrokeWidth(strokeWidth)

Arguments:	strokeWidth (`number()`) – the stroke width in pixels

Sets the stroke width for this shape in pixels

Return type:	void