Class Paths

Add and remove paths from maps.

Hierarchy

Paths

Index

Constructors

constructor

Accessors

paths

Methods

Constructors

constructor

new Paths(pathsController: PathsController): Paths

Parameters
- pathsController: PathsController
Returns Paths

Accessors

paths

get paths(): Path[]

An array of all paths that are currently drawn.

Returns Path[]

Methods

add

add(nodes: MappedinNode[], options?: TPathOptions): Path

Takes an array of nodes and draws path segments on each map for the nodes on that map.

Parameters
- nodes: MappedinNode[]
  
  A MappedinNode array, probably from a MappedinDirections instance.
- Optional options: TPathOptions
  
  A optional TPathOptions object.
Returns Path

remove

remove(path: Path): void

Remove a path from all maps it exists on.

Parameters
- path: Path
  
  A Path instance returned from Paths.add.
Returns void

removeAll

removeAll(): void

Remove all paths from all maps.

Returns void