EndcapShape

class Communicator.Markup.Shape.EndcapShape()

Methods

• getEndEndcapColor()

• getEndEndcapSize()

• getEndEndcapType()

• getEndcapsInverted()

• getStartEndcapColor()

• getStartEndcapSize()

• getStartEndcapType()

• getStrokeColor()

• getStrokeWidth()

• setEndEndcapColor()

• setEndEndcapSize()

• setEndEndcapType()

• setEndcapType()

• setEndcapsInverted()

• setStartEndcapColor()

• setStartEndcapSize()

• setStartEndcapType()

• setStrokeColor()

• setStrokeWidth()

---

Methods

getEndEndcapColor

EndcapShape.getEndEndcapColor()

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

Return type

Color()

Returns

color for the end endcap.

getEndEndcapSize

EndcapShape.getEndEndcapSize()

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

Return type

Pixels

Returns

size of the end endcap.

getEndEndcapType

EndcapShape.getEndEndcapType()

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

Return type

EndcapType

Returns

the end endcap type

getEndcapsInverted

EndcapShape.getEndcapsInverted()

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

Return type

boolean

Returns

value indicating whether endcaps are inverted

getStartEndcapColor

EndcapShape.getStartEndcapColor()

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

Return type

Color()

Returns

color for the start endcap.

getStartEndcapSize

EndcapShape.getStartEndcapSize()

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

Return type

Pixels

Returns

size of the start endcap.

getStartEndcapType

EndcapShape.getStartEndcapType()

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

Return type

EndcapType

Returns

the start endcap type

getStrokeColor

EndcapShape.getStrokeColor()

Gets the stroke color for this shape

Return type

Color()

Returns

the stroke color

getStrokeWidth

EndcapShape.getStrokeWidth()

Gets the stroke width for this shape in pixels

Return type

Pixels

Returns

the stroke width in pixels

setEndEndcapColor

EndcapShape.setEndEndcapColor(color)

Sets the color for the end endcap.

Arguments

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

Return type

void

setEndEndcapSize

EndcapShape.setEndEndcapSize(size)

Sets the size of the end endcap in pixels.

Arguments

• size (Pixels) – the end endcap.

Return type

void

setEndEndcapType

EndcapShape.setEndEndcapType(endcapType)

Sets the end endcap type for this shape

Arguments

• endcapType (EndcapType) – the new endcap type

Return type

void

setEndcapType

EndcapShape.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

EndcapShape.setEndcapsInverted(inverted)

Sets whether endcapsare inverted for this shape.

Arguments

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

Return type

void

setStartEndcapColor

EndcapShape.setStartEndcapColor(color)

Sets the color for the start endcap.

Arguments

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

Return type

void

setStartEndcapSize

EndcapShape.setStartEndcapSize(size)

Sets the size of the start endcap in pixels.

Arguments

• size (Pixels) – the start endcap.

Return type

void

setStartEndcapType

EndcapShape.setStartEndcapType(endcapType)

Sets the start endcap type for this shape

Arguments

• endcapType (EndcapType) – the new endcap type

Return type

void

setStrokeColor

EndcapShape.setStrokeColor(color)

Sets the stroke color for this shape

Arguments

• color (Color()) – the stroke color

Return type

void

setStrokeWidth

EndcapShape.setStrokeWidth(strokeWidth)

Sets the stroke width for this shape in pixels

Arguments

• strokeWidth (Pixels) – the stroke width in pixels

Return type

void