Geoportal Extension for OpenLayers API Reference

Class: Route

ol.control.Route

Route Control.

new Route(options)

OpenLayers/Controls/Route.js, line 89
Name Type Description
options Object

route control options

Name Type Default Description
apiKey String optional

API key for services call (route and autocomplete services), mandatory if autoconf service has not been charged in advance
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
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:
Example
var route = ol.control.Route({
     "collapsed" : true
     "draggable" : true,
     "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" : {}
 });

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

getCollapsed(){Boolean}

OpenLayers/Controls/Route.js, line 145

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

Returns:
- true if widget is collapsed

getData(){Object}

OpenLayers/Controls/Route.js, line 208

Get route informations

Returns:
- route informations

getLayer(){Object}

OpenLayers/Controls/Route.js, line 175

Get vector layer where geoJson route is drawn

Returns:
- ol.layer.Vector route layer

setCollapsed(collapsed)

OpenLayers/Controls/Route.js, line 154

Collapse or display widget main container

Name Type Description
collapsed Boolean

True to collapse widget, False to display it

setMap(map)

OpenLayers/Controls/Route.js, line 184

Overwrite OpenLayers setMap method

Name Type Description
map ol.Map

Map.