Class: MapRouting

cercaliagl.MapRouting


Useful class to interact with routing, map and menus. Never use constructor. To access to cercaliagl.MapRouting access it with module:cercaliagl/Map~Map#getMapRouting.

Example usage.

const map = new cercaliagl.Map({
  target: 'map',
  zoom: 7,
  center: new cercaliagl.LonLat(-1.8995067857179038, 40.77795650493354),
});

map.whenReady(() => {
  const routingMap = map.getMapRouting();
  const origin = new cercaliagl.LonLat(2.1589900, 41.3887900);
  const destination = new cercaliagl.LonLat(-3.7025600, 40.4165000);

  routingMap.disableAutoZoom(true);
  routingMap.setCustomCallbackFunction(() => {
    const notification = new cercaliagl.Notification('Route calculated', Severity.WARNING, 60000);
    notification.display(map);
  });

  routingMap.setRoutingStep(MarkerType.ORIGIN, origin);
  routingMap.setRoutingStep(MarkerType.DESTINATION, destination);
});

new MapRouting(options)

MapRouting.js, line 355
Name Type Description
options
Name Type Description
routing3d boolean

Draw 3D polyline for calculated route feature. Default true.
tollInfoType module:cercaliagl/service/Routing~TollInfoType

Format of the toll information shown when calculating a route. Default value basic.
net string

Routing net. Default value undefined.
tollCurrency string

Currency of the toll information displayed when calculating a route. Default value undefined.
routeStyle module:cercaliagl/MapRouting~RouteStyleOptions

Route styles.

Members

routeStyle_{module:cercaliagl/MapRouting~RouteStyle}

Formatted address.

Methods

addMarkerStep(marker, position, draggedPoint)

MapRouting.js, line 977

Add step/waypoint marker.

Name Type Description
marker module:cercaliagl/Marker~Marker

Marker
position number

Step position
draggedPoint boolean

true if is a dragged point.

calculateReport(callbackFn)

MapRouting.js, line 1252

Calculate report and handle report in a callback function.

Name Type Description
callbackFn function

Callback function.

cleanRoute()

MapRouting.js, line 1808

Delete route from map and its markers.

disableAutoZoom(autoZoomDisabled)

MapRouting.js, line 1475

Disable auto zoom (center to features) after draw route feature.

Name Type Description
autoZoomDisabled boolean

true disables center to features after calculated route. false active restores default behaviour.

disableRightClickMenu()

MapRouting.js, line 864

Disable right click context menu. It is enabled by default.

enableRightClickMenu()

MapRouting.js, line 854

Enable right click context menu. It is enabled by default.

getFeatures(){Array.<module:cercaliagl/Feature~Feature>}

MapRouting.js, line 994

Get route features.

Returns:
Array feature.

getFeaturesAlts(){Array.<module:cercaliagl/Feature~Feature>}

MapRouting.js, line 1003

Get route alternative features.

Returns:
Array feature.

getRouteStyle(){module:cercaliagl/MapRouting~RouteStyle}

MapRouting.js, line 1453

Get current route styles.

getRoutingOptions(){module:cercaliagl/service/Routing~RoutingOptions}

MapRouting.js, line 1169

Get the current routing options

Returns:
The current routing options configuration

getRoutingService(){module:cercaliagl/service/Routing~Routing}

MapRouting.js, line 2003

Obtain routing service object.

Returns:
Routing service

getWKT(){string|null}

MapRouting.js, line 1861

Obtain WKT

Returns:
WKT.

invert()

MapRouting.js, line 1894

Invert origin and destination.

isActive(){boolean}

MapRouting.js, line 1844

Return if MapRouting is active

Returns:
`truè if map routing is actived.

isLogistics(){boolean}

MapRouting.js, line 1994

Obtain if logistics service mode is enabled.

Returns:
true if route is logistics.

removeFeatures()

MapRouting.js, line 1103

Clear route features from map.

removeMarkers()

MapRouting.js, line 1072

Clear route markers from map.

removeStepIndex(index)

MapRouting.js, line 893
Name Type Description
index number

Index.

selectAlternativeRoute(routeIndex)

MapRouting.js, line 1561

Select active an alternative route by index.

Name Type Description
routeIndex number

Route index

set3DRouting(enable)

MapRouting.js, line 678

EXPERIMENTAL. Enable or not to draw 3D routes.

Name Type Description
enable boolean

Enable or disable to draw 3D features

setAddedCosts(consumption, gasType, gasPrice)

MapRouting.js, line 1423

Update Routing widget costs.

Name Type Description
consumption number

Consumption L/100 km. Example: 8.2.
gasType string | undefined

Gas Type. Available values: gas95|gas98|diesel|biodiosel.
gasPrice number | undefined

Gasoline price. €/L. Example: 1.51.

setCustomCallbackErrorFunction(func)

MapRouting.js, line 1444

Set custom callback error function. This function is called after route with errors.

Name Type Description
func function

Custom callback function to handle error

setCustomCallbackFunction(func)

MapRouting.js, line 1435

Set custom callback function. This function is called after route calculation. Setting null, it disables previous custom function.

Name Type Description
func function

Custom callback function.

setDraggable(draggable)

MapRouting.js, line 658

Set route draggable and its steps

Name Type Description
draggable boolean

Draggable

setReorder(reorder){boolean}

MapRouting.js, line 1365

Update route parameter option weight. Use this instead setWeight from cercalia.service.Routing.

Name Type Description
reorder boolean

Reorder
Returns:
Return true if route options has been modified

setRouteStyle(routeStyle)

MapRouting.js, line 1462

Set custom route styles.

Name Type Description
routeStyle

Custom route styles

Name Type Description
strokeColor string

Route stroke colour.
outlineColor string

Route outline colour.
logisticsStrokeColor string

Logistic route stroke colour.
logisticsOutlineColor string

Logistic route outline colour.
alternativeStrokeColor string

Alternative route stroke colour.
alternativeOutlineColor string

Alternative route outline colour.

setRoutingOptions(options)

MapRouting.js, line 1153
Name Type Description
options

Routing options

Name Type Description
destination module:cercaliagl/LonLat~LonLat | module:cercaliagl/service/Routing~RoutingStep

Destination coordinates.
edges boolean

Get edges IDs
infoedges boolean

Adds specific information for each section to the route report.
An infoedges tag is added to each substage with specific information of each section.
The following attributes are reported for each section:
height: height from sea level in meters.
gradient: slope of the section
geometry: Stretch geometry
meters: Length of the section
maxkph: Legal maximum speed.
lang string

Report language (only if report parameter is true).
mindist number

Minimum substage distance, in meters. The larger this distance , the smaller the number of substages. Default value 1000.
origin module:cercaliagl/LonLat~LonLat | module:cercaliagl/service/Routing~RoutingStep

Origin coordinates.
reorder boolean

Specify if you want to reorder or not the route stops, to get the faster/shorter route. Maximum 10 stop points.
report boolean

Get the textual route report (if not, gets a faster response). Default 0.
steps Array.<module:cercaliagl/LonLat~LonLat> | Array.<module:cercaliagl/service/Routing~RoutingStep>

Array with stop points coordinates.
tolerance number

Route geometry generalization, in meters (if =0, returns the original geometry). Default value 5 (meters).
toll boolean

Specify if you need to get the toll roads cost for the route. Currently only avaliable for Spain, Portugal and Andorra. Default false.
weight string

Route type: time (faster), distance (shorter), money (toll free route). Default value: time.
vweight number

Route logistics parameter. Total maximum vehicle weight.
vaxleweight number

Route logistics parameter. Maximum vehicle axle weight.
vheight number

Route logistics parameter. Maximum vehicle height.
vlength number

Route logistics parameter. Maximum vehicle length.
vwidth number

Route logistics parameter. Maximum vehicle width.
vmaxvel number

Route logistics parameter. Maximum vehicle speed.
rimp boolean

Route logistics parameter. Dangerous goods
trinfodate string

Route logistics parameter. Number days to consecutives to show restrictions. Info date format YYYYMMDD.
trinfodays number

Route logistics parameter. Avoid route restrictions. In timestamp format.
trstart number

Route logistics parameter. Avoid route restrictions. In timestamp format.
originIsDepot boolean

This parameter only works if REORDER parameter is used. Values:
true (default): origin cannot be reordered (default).
false: origin is one more stop and can be reordered. Useful when you cannot choose the starting point of the vehicle.
destinationIsDepot boolean

This parameter only works if REORDER parameter is used. Values:
true (default): Destination cannot be reordered (default).
false: Destination is one more stop and can be reordered. Useful when after attending some services you don’t have to return to a base.
concurrency boolean | undefined

Default true. Multiple requests at same time. If false it cancel previous pending requests.
departuretime string

Departure time in format ISO8601.
adrTunnel string

ADR tunnel category.
intoll_x string

Calculating route using roads with tolls
showBreaktimes boolean

Show break times.
twoDrivers boolean

Calculate break times with two drivers.
poicats Array.<string>

Array of POI categories.
alternatives boolean

Enable alternatives routing calculation.
isLogistics boolean

Route calculation for logistics.
tollInfoType module:cercaliagl/service/Routing~TollInfoType

Format of the toll information shown when calculating a route. Default value basic.
tollCurrency string

Currency of the toll information displayed when calculating a route. Default value undefined.
net string

Custom routing net. Default value undefined.

setRoutingStep(stepType, position, formattedAddress, keepDirection)

MapRouting.js, line 1181

Set a routing step. It can be origin, destination or a step/waypoint.

Name Type Description
stepType module:cercaliagl/MapRouting~RouteMarkerType

Step type. One of ORIGIN, DESTINATION, or STEP
position module:cercaliagl/LonLat~LonLat

Geographic position coordinate
formattedAddress string

Human-readable formatted address for the position
keepDirection boolean (defaults to false)

When true, maintains the vehicle's direction on exit. Only applicable for steps

setWeight(weight){boolean}

MapRouting.js, line 1347

Update route parameter option weight. Use this instead setWeight from cercalia.service.Routing.

Name Type Description
weight string

Weight
Returns:
Return true if route options has been modified

updateOptions(weight, reorder, logisticsEnabled, logisticsParams, departuretime)

MapRouting.js, line 1392
Name Type Description
weight string

Weight.
reorder boolean

Optimized route.
logisticsEnabled boolean

Enable or disable logistics params.
logisticsParams module:cercaliagl/MapRouting~LogisticsParams

Logistics params.
departuretime string (defaults to null)

Departure time
logisticsParams.vweight number

Vehicle max wegiht
logisticsParams.vaxleweight number

Vehicle max axle weight
logisticsParams.vheight number

Vehicle max height
logisticsParams.vlength number

Vehicle max length
logisticsParams.vwidth number

Vehicle max width
logisticsParams.vmaxvel number

Vehicle max speed
logisticsParams.rimp boolean

Dangerous goods
logisticsParams.trinfodate string

YYYYMMDD
logisticsParams.trinfodays number

Number days to consecutives to show restrictions.
logisticsParams.trstart number

Avoid route restrictions. In timestamp format.
logisticsParams.adrtunnel string

Set tunnel category