# LineCollection

class Markup.Shapes.LineCollection()

  This class is useful for specifying multiple lines that all share the same visual appearance.

Constructors

- `constructor()`

Methods

- `addLine()`

- `clear()`

- `getEndEndcapColor()`

- `getEndEndcapSize()`

- `getEndEndcapType()`

- `getEndcapsInverted()`

- `getLines()`

- `getStartEndcapColor()`

- `getStartEndcapSize()`

- `getStartEndcapType()`

- `getStrokeColor()`

- `getStrokeWidth()`

- `setEndEndcapColor()`

- `setEndEndcapSize()`

- `setEndEndcapType()`

- `setEndcapType()`

- `setEndcapsInverted()`

- `setStartEndcapColor()`

- `setStartEndcapSize()`

- `setStartEndcapType()`

- `setStrokeColor()`

- `setStrokeWidth()`

## Constructors

LineCollection.constructor()
  Return type

    LineCollection

## Methods

### addLine

LineCollection.addLine(p1, p2)
  Arguments

    - p1 (`Point2()`) – first point of the line segment

    - p2 (`Point2()`) – second point of the line segment

  Adds a line segment to the collection

  Return type

    void

### clear

LineCollection.clear()

  Removes all line segments from this collection

  Return type

    void

### getEndEndcapColor

LineCollection.getEndEndcapColor()

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

  Returns

    color for the end endcap.

  Return type

    Color

### getEndEndcapSize

LineCollection.getEndEndcapSize()

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

  Returns

    size of the end endcap.

  Return type

    number

### getEndEndcapType

LineCollection.getEndEndcapType()

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

  Returns

    the end endcap type

  Return type

    EndcapType

### getEndcapsInverted

LineCollection.getEndcapsInverted()

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

  Returns

    value indicating whether endcaps are inverted

  Return type

    boolean

### getLines

LineCollection.getLines()

  Gets the lines in the collection

  Return type

    [_MarkupLineData]

### getStartEndcapColor

LineCollection.getStartEndcapColor()

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

  Returns

    color for the start endcap.

  Return type

    Color

### getStartEndcapSize

LineCollection.getStartEndcapSize()

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

  Returns

    size of the start endcap.

  Return type

    number

### getStartEndcapType

LineCollection.getStartEndcapType()

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

  Returns

    the start endcap type

  Return type

    EndcapType

### getStrokeColor

LineCollection.getStrokeColor()

  Gets the stroke color for this shape

  Returns

    the stroke color

  Return type

    Color

### getStrokeWidth

LineCollection.getStrokeWidth()

  Gets the stroke width for this shape in pixels

  Returns

    the stroke width in pixels

  Return type

    number

### setEndEndcapColor

LineCollection.setEndEndcapColor(color)
  Arguments

    - color (`Color()`) – the end endcap color value.

  Sets the color for the end endcap.

  Return type

    void

### setEndEndcapSize

LineCollection.setEndEndcapSize(size)
  Arguments

    - size (`number()`) – the end endcap.

  Sets the size of the end endcap in pixels.

  Return type

    void

### setEndEndcapType

LineCollection.setEndEndcapType(endcapType)
  Arguments

    - endcapType (`EndcapType()`) – the new endcap type

  Sets the end endcap type for this shape

  Return type

    void

### setEndcapType

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

LineCollection.setEndcapsInverted(inverted)
  Arguments

    - inverted (`boolean()`) – value indicated whether endcaps should be inverted

  Sets whether endcapsare inverted for this shape.

  Return type

    void

### setStartEndcapColor

LineCollection.setStartEndcapColor(color)
  Arguments

    - color (`Color()`) – the start endcap color value.

  Sets the color for the start endcap.

  Return type

    void

### setStartEndcapSize

LineCollection.setStartEndcapSize(size)
  Arguments

    - size (`number()`) – the start endcap.

  Sets the size of the start endcap in pixels.

  Return type

    void

### setStartEndcapType

LineCollection.setStartEndcapType(endcapType)
  Arguments

    - endcapType (`EndcapType()`) – the new endcap type

  Sets the start endcap type for this shape

  Return type

    void

### setStrokeColor

LineCollection.setStrokeColor(color)
  Arguments

    - color (`Color()`) – the stroke color

  Sets the stroke color for this shape

  Return type

    void

### setStrokeWidth

LineCollection.setStrokeWidth(strokeWidth)
  Arguments

    - strokeWidth (`number()`) – the stroke width in pixels

  Sets the stroke width for this shape in pixels

  Return type

    void