Polyline

class Communicator.Markup.Shape.Polyline()

This class reprsents a line defined by a list of points.

Methods

clearPoints()

getEndEndcapColor()

getEndEndcapSize()

getEndEndcapType()

getEndcapsInverted()

getPoints()

getStartEndcapColor()

getStartEndcapSize()

getStartEndcapType()

getStrokeColor()

getStrokeWidth()

pushPoint()

setEndEndcapColor()

setEndEndcapSize()

setEndEndcapType()

setEndcapType()

setEndcapsInverted()

setStartEndcapColor()

setStartEndcapSize()

setStartEndcapType()

setStrokeColor()

setStrokeWidth()


Methods

clearPoints

Communicator.Markup.Shape.Polyline.clearPoints()

Removes all points from this polyline

Return type

void

getEndEndcapColor

Communicator.Markup.Shape.Polyline.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.Polyline.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.Polyline.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.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

Communicator.Markup.Shape.Polyline.getPoints()

Gets the points in this polyline

Return type

[Communicator.Point2]

Returns

the points in this polyline

getStartEndcapColor

Communicator.Markup.Shape.Polyline.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.Polyline.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.Polyline.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.Polyline.getStrokeColor()

Gets the stroke color for this shape

Return type

Communicator.Color

Returns

the stroke color

getStrokeWidth

Communicator.Markup.Shape.Polyline.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Communicator.Pixels

Returns

the stroke width in pixels

pushPoint

Communicator.Markup.Shape.Polyline.pushPoint(point)

Adds a point to the polyline

Arguments
  • point (Communicator.Point2()) – the point to add to the line

Return type

void

setEndEndcapColor

Communicator.Markup.Shape.Polyline.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.Polyline.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.Polyline.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.Polyline.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.Polyline.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.Polyline.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.Polyline.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.Polyline.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments
  • endcapType (Communicator.Markup.Shape.EndcapType()) – the new endcap type

Return type

void

setStrokeColor

Communicator.Markup.Shape.Polyline.setStrokeColor(color)

Sets the stroke color for this shape

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

Return type

void

setStrokeWidth

Communicator.Markup.Shape.Polyline.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

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

Return type

void