PolylineCollection

class Markup.Shapes.PolylineCollection()

This class is useful for drawing a number of polylines all of which share the same visual appearance.

Index

Constructors

• constructor

Methods

• clear
• createPolyline
• getEndcapsInverted
• getEndEndcapColor
• getEndEndcapSize
• getEndEndcapType
• getPolylines
• getStartEndcapColor
• getStartEndcapSize
• getStartEndcapType
• getStrokeColor
• getStrokeWidth
• setEndcapsInverted
• setEndcapType
• setEndEndcapColor
• setEndEndcapSize
• setEndEndcapType
• setStartEndcapColor
• setStartEndcapSize
• setStartEndcapType
• setStrokeColor
• setStrokeWidth

Constructors

Markup.Shapes.PolylineCollection.constructor()

PolylineCollection(): PolylineCollection

Returns: PolylineCollection

Methods

Markup.Shapes.PolylineCollection.clear()

clear(): void

Removes all polylines from the collection

Returns: void

Markup.Shapes.PolylineCollection.createPolyline()

createPolyline(): Point2[]

Creates a new array of points that represent a polyline. Add Point2 objects to the array to construct the polyline

Returns: Point2[]

new array which represents a polyline.

Markup.Shapes.PolylineCollection.getEndcapsInverted()

inherited

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.PolylineCollection.getEndEndcapColor()

inherited

getEndEndcapColor(): Color

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

Returns: Color

color for the end endcap.

Markup.Shapes.PolylineCollection.getEndEndcapSize()

inherited

getEndEndcapSize(): number

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

Returns: number

size of the end endcap.

Markup.Shapes.PolylineCollection.getEndEndcapType()

inherited

getEndEndcapType(): EndcapType

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

Returns: EndcapType

the end endcap type

Markup.Shapes.PolylineCollection.getPolylines()

getPolylines(): Point2[][]

Returns: Point2[][]

the polylines in this collection

Markup.Shapes.PolylineCollection.getStartEndcapColor()

inherited

getStartEndcapColor(): Color

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

Returns: Color

color for the start endcap.

Markup.Shapes.PolylineCollection.getStartEndcapSize()

inherited

getStartEndcapSize(): number

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

Returns: number

size of the start endcap.

Markup.Shapes.PolylineCollection.getStartEndcapType()

inherited

getStartEndcapType(): EndcapType

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

Returns: EndcapType

the start endcap type

Markup.Shapes.PolylineCollection.getStrokeColor()

inherited

getStrokeColor(): Color

Gets the stroke color for this shape

Returns: Color

the stroke color

Markup.Shapes.PolylineCollection.getStrokeWidth()

inherited

getStrokeWidth(): number

Gets the stroke width for this shape in pixels

Returns: number

the stroke width in pixels

Markup.Shapes.PolylineCollection.setEndcapsInverted()

inherited

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.PolylineCollection.setEndcapType()

inherited

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.PolylineCollection.setEndEndcapColor()

inherited

setEndEndcapColor(color: Color): void

Sets the color for the end endcap.

Parameters

color: Color

the end endcap color value.

Returns: void

Markup.Shapes.PolylineCollection.setEndEndcapSize()

inherited

setEndEndcapSize(size: number): void

Sets the size of the end endcap in pixels.

Parameters

size: number

the end endcap.

Returns: void

Markup.Shapes.PolylineCollection.setEndEndcapType()

inherited

setEndEndcapType(endcapType: EndcapType): void

Sets the end endcap type for this shape

Parameters

endcapType: EndcapType

the new endcap type

Returns: void

Markup.Shapes.PolylineCollection.setStartEndcapColor()

inherited

setStartEndcapColor(color: Color): void

Sets the color for the start endcap.

Parameters

color: Color

the start endcap color value.

Returns: void

Markup.Shapes.PolylineCollection.setStartEndcapSize()

inherited

setStartEndcapSize(size: number): void

Sets the size of the start endcap in pixels.

Parameters

size: number

the start endcap.

Returns: void

Markup.Shapes.PolylineCollection.setStartEndcapType()

inherited

setStartEndcapType(endcapType: EndcapType): void

Sets the start endcap type for this shape

Parameters

endcapType: EndcapType

the new endcap type

Returns: void

Markup.Shapes.PolylineCollection.setStrokeColor()

inherited

setStrokeColor(color: Color): void

Sets the stroke color for this shape

Parameters

color: Color

the stroke color

Returns: void

Markup.Shapes.PolylineCollection.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