Line

class Communicator.Markup.Shape.Line()

This class represents a single line consisting of two points. P1 is considered the start and P2 is considered the end of the line. Each Point may have its endcap settings adjusted independently.

Constructors


Constructors

Line.constructor([p1[, p2]])

Creates a new Line Shape

Arguments
Return type

Line()

Returns

new Line object.

Methods

getEndEndcapColor

Line.getEndEndcapColor()

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

Return type

Color()

Returns

color for the end endcap.

getEndEndcapSize

Line.getEndEndcapSize()

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

Return type

Pixels

Returns

size of the end endcap.

getEndEndcapType

Line.getEndEndcapType()

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

Return type

EndcapType

Returns

the end endcap type

getEndcapsInverted

Line.getEndcapsInverted()

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

Return type

boolean

Returns

value indicating whether endcaps are inverted

getP1

Line.getP1()

Gets the first point of the line segment

Return type

Point2()

Returns

the first point of the line segment

getP2

Line.getP2()

Gets the second point of the line segment

Return type

Point2()

Returns

the second point of the line segment

getStartEndcapColor

Line.getStartEndcapColor()

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

Return type

Color()

Returns

color for the start endcap.

getStartEndcapSize

Line.getStartEndcapSize()

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

Return type

Pixels

Returns

size of the start endcap.

getStartEndcapType

Line.getStartEndcapType()

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

Return type

EndcapType

Returns

the start endcap type

getStrokeColor

Line.getStrokeColor()

Gets the stroke color for this shape

Return type

Color()

Returns

the stroke color

getStrokeWidth

Line.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Pixels

Returns

the stroke width in pixels

set

Line.set(p1, p2)

Sets the points that define the line segment

Arguments
  • p1 (Point2()) – first point of the line segment

  • p2 (Point2()) – second point of the line segment

Return type

void

setEndEndcapColor

Line.setEndEndcapColor(color)

Sets the color for the end endcap.

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

Return type

void

setEndEndcapSize

Line.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments
  • size (Pixels) – the end endcap.

Return type

void

setEndEndcapType

Line.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments
Return type

void

setEndcapType

Line.setEndcapType(endcapType)

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

Arguments
Return type

void

setEndcapsInverted

Line.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

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

Return type

void

setP1

Line.setP1(p1)

Sets the first point of the line segment

Arguments
  • p1 (Point2()) – first point of the line segment

Return type

void

setP2

Line.setP2(p2)

sets the first point of the line segment

Arguments
  • p2 (Point2()) – second point of the line segment

Return type

void

setStartEndcapColor

Line.setStartEndcapColor(color)

Sets the color for the start endcap.

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

Return type

void

setStartEndcapSize

Line.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments
  • size (Pixels) – the start endcap.

Return type

void

setStartEndcapType

Line.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments
Return type

void

setStrokeColor

Line.setStrokeColor(color)

Sets the stroke color for this shape

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

Return type

void

setStrokeWidth

Line.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

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

Return type

void