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
Methods
clear
- Communicator.Markup.Shape.PolylineCollection.clear()
Removes all polylines from the collection
- Return type
void
createPolyline
- Communicator.Markup.Shape.PolylineCollection.createPolyline()
Creates a new array of points that represent a polyline. Add Point2 objects to the array to construct the polyline
- Return type
[Communicator.Point2]- Returns
new array which represents a polyline.
getEndEndcapColor
- Communicator.Markup.Shape.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.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
- Communicator.Markup.Shape.PolylineCollection.getPolylines()
- Return type
[[Communicator.Point2]]- Returns
the polylines in this collection
getStartEndcapColor
- Communicator.Markup.Shape.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.getStrokeColor()
Gets the stroke color for this shape
- Return type
Communicator.Color- Returns
the stroke color
getStrokeWidth
- Communicator.Markup.Shape.PolylineCollection.getStrokeWidth()
Gets the stroke width for this shape in pixels
- Return type
Communicator.Pixels- Returns
the stroke width in pixels
setEndEndcapColor
- Communicator.Markup.Shape.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.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.PolylineCollection.setStartEndcapType(endcapType)
Sets the start endcap type for this shape
- Arguments
endcapType (
Communicator.Markup.Shape.EndcapType()) – the new endcap type
- Return type
void
