# Polyline

class `Markup.Shapes.``Polyline`()

  This class reprsents a line defined by a list of points.

  ## Index

  Constructors

  - `constructor`

  Methods

  - `clearPoints`
  - `getEndcapsInverted`
  - `getEndEndcapColor`
  - `getEndEndcapSize`
  - `getEndEndcapType`
  - `getPoints`
  - `getStartEndcapColor`
  - `getStartEndcapSize`
  - `getStartEndcapType`
  - `getStrokeColor`
  - `getStrokeWidth`
  - `pushPoint`
  - `setEndcapsInverted`
  - `setEndcapType`
  - `setEndEndcapColor`
  - `setEndEndcapSize`
  - `setEndEndcapType`
  - `setStartEndcapColor`
  - `setStartEndcapSize`
  - `setStartEndcapType`
  - `setStrokeColor`
  - `setStrokeWidth`

## Constructors

`Markup.Shapes.Polyline.``constructor`()
  Polyline(): `Polyline`

  Returns: `Polyline`

## Methods

`Markup.Shapes.Polyline.``clearPoints`()
  clearPoints(): void

  Removes all points from this polyline

  Returns: void

`Markup.Shapes.Polyline.``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.Polyline.``getEndEndcapColor`()

  inherited

  getEndEndcapColor(): `Color`

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

  Returns: `Color`

  > color for the end endcap.

`Markup.Shapes.Polyline.``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.Polyline.``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.Polyline.``getPoints`()
  getPoints(): `Point2`[]

  Gets the points in this polyline

  Returns: `Point2`[]

  > the points in this polyline

`Markup.Shapes.Polyline.``getStartEndcapColor`()

  inherited

  getStartEndcapColor(): `Color`

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

  Returns: `Color`

  > color for the start endcap.

`Markup.Shapes.Polyline.``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.Polyline.``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.Polyline.``getStrokeColor`()

  inherited

  getStrokeColor(): `Color`

  Gets the stroke color for this shape

  Returns: `Color`

  > the stroke color

`Markup.Shapes.Polyline.``getStrokeWidth`()

  inherited

  getStrokeWidth(): number

  Gets the stroke width for this shape in pixels

  Returns: number

  > the stroke width in pixels

`Markup.Shapes.Polyline.``pushPoint`()
  pushPoint(point: `Point2`): void

  Adds a point to the polyline

  Parameters

  > point: `Point2`

  > > the point to add to the line

  Returns: void

`Markup.Shapes.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``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.Polyline.``setStrokeColor`()

  inherited

  setStrokeColor(color: `Color`): void

  Sets the stroke color for this shape

  Parameters

  > color: `Color`

  > > the stroke color

  Returns: void

`Markup.Shapes.Polyline.``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

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...