Class: Route

new Route(options)

Ol3/Controls/Route.js, line 55

Name

Type

Description

options

Object

route control options

Name	Type	Default	Description
apiKey	Sting		optional API key for services call (route and autocomplete services), mandatory if autoconf service has not been charged in advance
collapsed	Boolean	true	optional Specify if widget has to be collapsed (true) or not (false) on map loading. Default is true.
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 http://depot.ign.fr/geoportail/bibacces/develop/doc/module-Services.html#~route to know all route options.
autocompleteOptions	Object	{}	optional autocomplete service options. see http://depot.ign.fr/geoportail/bibacces/develop/doc/module-Services.html#~autoComplete to know all autocomplete options

Example

var route = ol.control.Route({
     collapsed : true
     exclusions : {
        "toll" : true,
        "bridge" : false,
        "tunnel" : true
     },
     graphs : ['Pieton', 'Voiture'],
     autocompleteOptions : {},
     routeOptions : {}
 });

Extends

ol.control.Control

Members

collapsed

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

Methods

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

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

Returns:

- true if widget is collapsed

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

Get vector layer where geoJson route is drawn

Returns:

- ol.layer.Vector route layer

setCollapsed(collapsed) Ol3/Controls/Route.js, line 122

Collapse or display widget main container

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

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

Overwrite OpenLayers setMap method

Name	Type	Description
map	ol.Map	Map.