Class Polyline

A polyline with an optional colour.

Hierarchy (View Summary)

Shape
- Polyline
  - Circle

Index

Constructors

Properties

Accessors

Methods

append join prepend reverse

Constructors

constructor

new Polyline(vertices: Fix[], color?: Color | RGB): Polyline
Parameters
- vertices: Fix[]
  Ordered vertices comprising the polyline.
- Optionalcolor: Color | RGB = Polyline.Color.AIRSPACE
  The color of the polyline.
Returns Polyline
Overrides Shape.constructor
- Defined in src/shapes/Polyline.ts:12

Properties

`Readonly`color

color: Color | RGB = Polyline.Color.AIRSPACE

The color of the polyline.

Accessors

vertices

get vertices(): readonly Fix[]
The vertices that define this shape.

Returns readonly Fix[]
Inherited from Shape.vertices
- Defined in src/shapes/Shape.ts:19

Methods

append

append(...vertices: Fix[]): Polyline
Add vertices to the end of this shape.
Parameters
- ...vertices: Fix[]
  Vertices to add.
Returns Polyline
Inherited from Shape.append
- Defined in src/shapes/Shape.ts:38

join

join(shape: Shape): Polyline
Join another shape to the end of this shape.
Parameters
- shape: Shape
  The shape to join.
Returns Polyline
Inherited from Shape.join
- Defined in src/shapes/Shape.ts:48

prepend

prepend(...vertices: Fix[]): Polyline
Add vertices to the beginning of this shape.
Parameters
- ...vertices: Fix[]
  Vertices to add.
Returns Polyline
Inherited from Shape.prepend
- Defined in src/shapes/Shape.ts:28

reverse

reverse(): Polyline
Reverse the order of the vertices in this shape.

Returns Polyline
Inherited from Shape.reverse
- Defined in src/shapes/Shape.ts:56