Class RoutingService

Hierarchy

RoutingService

Index

Properties

Methods

Properties

$http_

$http_: IHttpService

ngeoOsrmBackendUrl_

ngeoOsrmBackendUrl_: string

URL for OSRM backend API. Defaults to demo backend.

protocolVersion_

protocolVersion_: string

Version of the protocol implemented by the service. see: https://github.com/Project-OSRM/osrm-backend/blob/master/docs/http.md

routingOptions_

routingOptions_: ngeoRoutingOptions

Methods

getNearest

getNearest(coordinate: Coordinate, config: Config): IHttpPromise<Object>

- Defined in src/routing/RoutingService.js:165
Snaps a coordinate to the street network and returns the nearest match

see
https://github.com/Project-OSRM/osrm-backend/blob/master/docs/http.md#nearest-service

Parameters
- coordinate: Coordinate
  
  coordinate to query
- config: Config
  
  optional configuration
Returns IHttpPromise<Object>
promise of the OSRM API request

getRoute

getRoute(coordinates: Coordinate[], config: Config): IHttpPromise<Routes>

- Defined in src/routing/RoutingService.js:108
Route request

Parameters
- coordinates: Coordinate[]
  
  coordinates of the route (at least two!)
- config: Config
  
  optional configuration
Returns IHttpPromise<Routes>
promise of the OSRM API request

Generated using TypeDoc