EndcapShape

class Markup.Shapes.EndcapShape()

Constructors

Methods

Constructors

EndcapShape.constructor()
Return type:EndcapShape

Methods

getEndEndcapColor

EndcapShape.getEndEndcapColor()

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

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

getEndEndcapSize

EndcapShape.getEndEndcapSize()

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

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

getEndEndcapType

EndcapShape.getEndEndcapType()

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

Returns:the end endcap type
Return type:EndcapType

getEndcapsInverted

EndcapShape.getEndcapsInverted()

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

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

getStartEndcapColor

EndcapShape.getStartEndcapColor()

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

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

getStartEndcapSize

EndcapShape.getStartEndcapSize()

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

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

getStartEndcapType

EndcapShape.getStartEndcapType()

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

Returns:the start endcap type
Return type:EndcapType

getStrokeColor

EndcapShape.getStrokeColor()

Gets the stroke color for this shape

Returns:the stroke color
Return type:Color

getStrokeWidth

EndcapShape.getStrokeWidth()

Gets the stroke width for this shape in pixels

Returns:the stroke width in pixels
Return type:number

setEndEndcapColor

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

Sets the color for the end endcap.

Return type:void

setEndEndcapSize

EndcapShape.setEndEndcapSize(size)
Arguments:
  • size (number()) – the end endcap.

Sets the size of the end endcap in pixels.

Return type:void

setEndEndcapType

EndcapShape.setEndEndcapType(endcapType)
Arguments:
  • endcapType (EndcapType()) – the new endcap type

Sets the end endcap type for this shape

Return type:void

setEndcapType

EndcapShape.setEndcapType(endcapType)
Arguments:
  • endcapType (EndcapType()) – the new endcap type

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

Return type:void

setEndcapsInverted

EndcapShape.setEndcapsInverted(inverted)
Arguments:
  • inverted (boolean()) – value indicated whether endcaps should be inverted

Sets whether endcapsare inverted for this shape.

Return type:void

setStartEndcapColor

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

Sets the color for the start endcap.

Return type:void

setStartEndcapSize

EndcapShape.setStartEndcapSize(size)
Arguments:
  • size (number()) – the start endcap.

Sets the size of the start endcap in pixels.

Return type:void

setStartEndcapType

EndcapShape.setStartEndcapType(endcapType)
Arguments:
  • endcapType (EndcapType()) – the new endcap type

Sets the start endcap type for this shape

Return type:void

setStrokeColor

EndcapShape.setStrokeColor(color)
Arguments:
  • color (Color()) – the stroke color

Sets the stroke color for this shape

Return type:void

setStrokeWidth

EndcapShape.setStrokeWidth(strokeWidth)
Arguments:
  • strokeWidth (number()) – the stroke width in pixels

Sets the stroke width for this shape in pixels

Return type:void