Interface IPaths

Interface defining the controls and actions for paths (Path) on the map.

Hierarchy

IPaths

Index

Properties

add remove removeAll

Properties

add

add: ((coordinate, options?) => Path)

Type declaration

- (coordinate, options?): Path
- Adds a path to the map.
  Parameters
  - coordinate: Coordinate[]
    
    Array of coordinates (Coordinate) to form the path.
  - Optional options: TAddPathOptions
    
    Optional additional option
  Returns Path
  Example
```
// Add a red path to the map
map.Paths.add(coordinate,  { color: '#ff0000' });
```

remove

remove: ((path) => void)

Type declaration

- (path): void
- Removes a specific path from the map.
  Parameters
  - path: Path
    
    The path to be removed.
  Returns void
  Example
```
map.Paths.remove(path);
```

removeAll

removeAll: (() => void)

Type declaration

- (): void
- Removes all paths from the map.
  
  Returns void
  Example
```
map.Paths.removeAll();
```