EndcapShape

class Markup.Shapes.EndcapShape()

Constructors

Markup.Shapes.EndcapShape.constructor()
EndcapShape(): EndcapShape

Returns: EndcapShape

Methods

Markup.Shapes.EndcapShape.getEndcapsInverted()
getEndcapsInverted(): boolean

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

Returns: boolean

value indicating whether endcaps are inverted
Markup.Shapes.EndcapShape.getEndEndcapColor()
getEndEndcapColor(): Color

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

Returns: Color

color for the end endcap.
Markup.Shapes.EndcapShape.getEndEndcapSize()
getEndEndcapSize(): number

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

Returns: number

size of the end endcap.
Markup.Shapes.EndcapShape.getEndEndcapType()
getEndEndcapType(): EndcapType

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

Returns: EndcapType

the end endcap type
Markup.Shapes.EndcapShape.getStartEndcapColor()
getStartEndcapColor(): Color

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

Returns: Color

color for the start endcap.
Markup.Shapes.EndcapShape.getStartEndcapSize()
getStartEndcapSize(): number

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

Returns: number

size of the start endcap.
Markup.Shapes.EndcapShape.getStartEndcapType()
getStartEndcapType(): EndcapType

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

Returns: EndcapType

the start endcap type
Markup.Shapes.EndcapShape.getStrokeColor()

inherited

getStrokeColor(): Color

Gets the stroke color for this shape

Returns: Color

the stroke color
Markup.Shapes.EndcapShape.getStrokeWidth()

inherited

getStrokeWidth(): number

Gets the stroke width for this shape in pixels

Returns: number

the stroke width in pixels
Markup.Shapes.EndcapShape.setEndcapsInverted()
setEndcapsInverted(inverted: boolean): void

Sets whether endcapsare inverted for this shape.

Parameters

inverted: boolean

value indicated whether endcaps should be inverted

Returns: void

Markup.Shapes.EndcapShape.setEndcapType()
setEndcapType(endcapType: EndcapType): void

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

Parameters

endcapType: EndcapType

the new endcap type

Returns: void

Markup.Shapes.EndcapShape.setEndEndcapColor()
setEndEndcapColor(color: Color): void

Sets the color for the end endcap.

Parameters

color: Color

the end endcap color value.

Returns: void

Markup.Shapes.EndcapShape.setEndEndcapSize()
setEndEndcapSize(size: number): void

Sets the size of the end endcap in pixels.

Parameters

size: number

the end endcap.

Returns: void

Markup.Shapes.EndcapShape.setEndEndcapType()
setEndEndcapType(endcapType: EndcapType): void

Sets the end endcap type for this shape

Parameters

endcapType: EndcapType

the new endcap type

Returns: void

Markup.Shapes.EndcapShape.setStartEndcapColor()
setStartEndcapColor(color: Color): void

Sets the color for the start endcap.

Parameters

color: Color

the start endcap color value.

Returns: void

Markup.Shapes.EndcapShape.setStartEndcapSize()
setStartEndcapSize(size: number): void

Sets the size of the start endcap in pixels.

Parameters

size: number

the start endcap.

Returns: void

Markup.Shapes.EndcapShape.setStartEndcapType()
setStartEndcapType(endcapType: EndcapType): void

Sets the start endcap type for this shape

Parameters

endcapType: EndcapType

the new endcap type

Returns: void

Markup.Shapes.EndcapShape.setStrokeColor()

inherited

setStrokeColor(color: Color): void

Sets the stroke color for this shape

Parameters

color: Color

the stroke color

Returns: void

Markup.Shapes.EndcapShape.setStrokeWidth()

inherited

setStrokeWidth(strokeWidth: number): void

Sets the stroke width for this shape in pixels

Parameters

strokeWidth: number

the stroke width in pixels

Returns: void