new cercalia.RouteMap(options)
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
RouteMap options
|
||||||||||||||||||||||
Methods
-
calculateRoute(callback)
-
Calcule the route
Name Type Description callbackfunction is called when route has been calculated
-
getAutoCalculateRoute(){boolean}
-
Returns:
autoCalculateRoute
-
getCenterToRoute(){boolean}
-
Returns:
centerToRoute
-
getClass(){string}
-
Returns:
ClassName.
-
getFeatures(){Array.<Feature>}
-
-
-
getServiceOptions(){cercaliax.service.RoutingOptions}
-
-
-
getWidgetReport(){cercalia.widget.RoutingReport}
-
-
hasDestination(){boolean}
-
Returns:
return true if routeService has Destination, otherwise false.
-
hasOrigin(){boolean}
-
Returns:
return true if routeService has Origin, otherwise false.
-
hideContextMenu(){cercalia.RouteMap}
-
Hide routeMap contextMenu
-
removeRoute()
-
Clear route (Remove route feature and route markers).
-
setAutoCalculateRoute(autoCalculateRoute){cercalia.RouteMap}
-
Name Type Description autoCalculateRouteboolean Returns:
this
-
setCenterToRoute(centerToRoute)
-
Center to the router
Name Type Description centerToRouteboolean -
setDestination(destination, calculateRoute, text)
-
Set destination of route
Name Type Description destinationcercalia.LonLat | Object calculateRouteboolean calculateRoute -> true Calcule route; calculateRoute -> false NO Calcule route; calculateRoute -> undefined depends of autoCalculateRoute
textstring label text for marker
-
setOrigin(origin, calculateRoute, text)
-
Set origin of route
Name Type Description origincercalia.LonLat | Object calculateRouteboolean calculateRoute -> true Calcule route; calculateRoute -> false NO Calcule route; calculateRoute -> undefined depends of autoCalculateRoute
textstring label text for marker
-
setServiceOptions(opt)
-
Name Type Description optName Type Description destinationcercalia.LonLat | cercaliax.service.RoutingStep Destination coordinates.
langstring Report language (only if report=true).
mindistboolean | undefined optional Minimum substage distance, in meters (default value 1000). The larger this distance , the smaller the number of substages.
origincercalia.LonLat | cercaliax.service.RoutingStep Origin coordinates.
reorderboolean | undefined optional Specify if you want to reorder or not the route stops, to get the faster/shorter route. Maximum 10 stop points.
reportboolean | undefined optional Get the textual route report (if not, gets a faster response). Default 0.
stepsArray.<cercalia.LonLat> | Array.<cercaliax.service.RoutingStep> | undefined optional Array with stop points coordinates (optional).
tolerancenumber | undefined optional Route geometry generalization, in meters (if =0, returns the original geometry). Default value, 5 (meters).
tollboolean | undefined optional Specify if you need to get the toll roads cost for the route. Currently only avaliable for Spain, Portugal and Andorra.
weightstring | undefined optional Route type: time (faster), distance (shorter), money (toll free route). Default value: time.
-
setStep(step, calculateRoute, text, position)
-
Set step of route
Name Type Description stepcercalia.LonLat | Object calculateRouteboolean calculateRoute -> true Calcule route; calculateRoute -> false NO Calcule route; calculateRoute -> undefined depends of autoCalculateRoute
textstring label text for marker
positioninteger -
setWidget(widget)
-
Name Type Description widgetcercalia.widget.Routing -
setWidgetReport(widget)
-
Name Type Description widgetcercalia.widget.RoutingReport -
sincronize(widget){cercalia.RouteMap}
-
Syncronize routeMap with widget. Widget fills RouteMap.
Name Type Description widgetcercalia.widget.Routing