Class: Route

ol.control.Route

Route Control.

new Route(options)

Controls/Route/Route.js, line 109

Name

Type

Description

options

Object

route control options

Name

Type

Default

Description

Number

optional

Ability to add an identifier on the widget (advanced option)

apiKey

String

optional

API key for services call (route and autocomplete services). The key "calcul" is used by default.

ssl

Boolean

true

optional

use of ssl or not (default true, service requested using https protocol)

collapsed

Boolean

true

optional

Specify if widget has to be collapsed (true) or not (false) on map loading. Default is true.

draggable

Boolean

false

optional

Specify if widget is draggable

export

Boolean | Object

false

optional

Specify if button "Export" is displayed. For the use of the options of the "Export" control, see ol.control.Export

exclusions

Object

{"toll" : false, "tunnel" : false, "bridge" : false}

optional

list of exclusions with status (true = checked). By default : no exclusions checked.

graphs

Array

["Voiture", "Pieton"]

optional

list of resources, by default : ["Voiture", "Pieton"]. The first element is selected.

routeOptions

Object

{}

optional

route service options. see Gp.Services.route() to know all route options.

autocompleteOptions

Object

{}

optional

autocomplete service options. see Gp.Services.autoComplete() to know all autocomplete options

markersOpts

Object

optional

options to use your own markers. Object properties can be "departure", "stages" or "arrival". Corresponding value is an object with following properties :

Name	Type	Description
url	String	optional marker base64 encoded url (ex "data:image/png;base64,...""). Mandatory for a custom marker
offset	Array	optional Offsets in pixels used when positioning the overlay. The first element in the array is the horizontal offset. A positive value shifts the overlay right. The second element in the array is the vertical offset. A positive value shifts the overlay down. Default is [0, 0]. (see http://openlayers.org/en/latest/apidoc/ol.Overlay.html)

layerDescription

Object

{}

optional

Layer informations to be displayed in LayerSwitcher widget (only if a LayerSwitcher is also added to the map)

Name	Type	Default	Description
title	String	"Itinéraire"	optional Layer title to be displayed in LayerSwitcher
description	String	"Itinéraire basé sur un graphe"	optional Layer description to be displayed in LayerSwitcher

Fires:

route:drawstart
route:drawend
route:compute
export:compute

Example

var route = ol.control.Route({
     "collapsed" : true
     "draggable" : true,
     "export"    : false,
     "exclusions" : {
        "toll" : true,
        "bridge" : false,
        "tunnel" : true
     },
     "graphs" : ['Pieton', 'Voiture'],
     "markersOpts" : {
         "departure" : {
             "url" : "...",
             "offset" : [0,0]
         },
         "stages" : {
             "url" : "...",
             "offset" : [0,0]
         },
         "arrival" : {
             "url" : "...",
             "offset" : [0,0]
         }
     }
     "autocompleteOptions" : {},
     "routeOptions" : {}
 });

 // if you want to pluggued the control Export with options :
 var route = new ol.control.Route({
   export : {
     name : "export",
     format : "geojson",
     title : "Exporter",
     menu : false
   }
 });

Extends

ol.control.Control

Members

collapsed

{Boolean} specify if Route control is collapsed (true) or not (false)

draggable

{Boolean} specify if Route control is draggable (true) or not (false)

Methods

clean() Controls/Route/Route.js, line 470

Clean UI : reinit control

getCollapsed(){Boolean} Controls/Route/Route.js, line 210

Returns true if widget is collapsed (minimized), false otherwise

Returns:

- true if widget is collapsed

getContainer(){DOMElement} Controls/Route/Route.js, line 362

Get container

getData(){Object} Controls/Route/Route.js, line 293

Get route informations

Returns:

- route informations

getGeoJSON(){String} Controls/Route/Route.js, line 271

Get vector layer

Returns:

- GeoJSON format layer

getLayer(){Object} Controls/Route/Route.js, line 240

Get vector layer where geoJson route is drawn

Returns:

- ol.layer.Vector route layer

getStyle(){ol.style} Controls/Route/Route.js, line 371

Get default style

init() Controls/Route/Route.js, line 379

This method is public.
It allows to init the control.

setCollapsed(collapsed) Controls/Route/Route.js, line 219

Collapse or display widget main container

Name	Type	Description
collapsed	Boolean	True to collapse widget, False to display it

setData(data) Controls/Route/Route.js, line 321

Set route data

Name

Type

Description

data

Object

control informations

Name	Type	Description
transport	String	transport type
computation	String	computation type
exclusions	Array	list of exclusions
points	Array	list of points : [[lon, lat]]
results	Object	service response

setGeoJSON(geojson) Controls/Route/Route.js, line 280

Set vector layer

Name	Type	Description
geojson	String	GeoJSON format layer

setLayer(layer) Controls/Route/Route.js, line 249

Set vector layer where route geometry is drawn

Name	Type	Description
layer	Object	ol.layer.Vector route layer

setMap(map) Controls/Route/Route.js, line 152

Overwrite OpenLayers setMap method

Name	Type	Description
map	ol.Map	Map.