Class Route

Hierarchy (View Summary)

ControlExtended
- Route

Constructors

constructor

new Route(
    options: {
        apiKey?: string;
        autocompleteOptions?: any;
        collapsed?: boolean;
        draggable?: boolean;
        exclusions?: any;
        export?: any;
        graphs?: any[];
        id?: number;
        layerDescription?: { description?: string; title?: string };
        markersOpts?: { offset?: any[]; url?: string };
        routeOptions?: any;
        ssl?: boolean;
    },
): Route
Parameters
- options: {
      apiKey?: string;
      autocompleteOptions?: any;
      collapsed?: boolean;
      draggable?: boolean;
      exclusions?: any;
      export?: any;
      graphs?: any[];
      id?: number;
      layerDescription?: { description?: string; title?: string };
      markersOpts?: { offset?: any[]; url?: string };
      routeOptions?: any;
      ssl?: boolean;
  }
  route control options
  - OptionalapiKey?: string
    API key for services call (route and autocomplete services). The key "calcul" is used by default.
  - OptionalautocompleteOptions?: any
    autocomplete service options. see Gp.Services.autoComplete() to know all autocomplete options
  - Optionalcollapsed?: boolean
    Specify if widget has to be collapsed (true) or not (false) on map loading. Default is true.
  - Optionaldraggable?: boolean
    Specify if widget is draggable
  - Optionalexclusions?: any
    list of exclusions with status (true = checked). By default : no exclusions checked.
  - Optionalexport?: any
    Specify if button "Export" is displayed. For the use of the options of the "Export" control, see packages/Controls/Export/Export.default
  - Optionalgraphs?: any[]
    list of resources, by default : ["Voiture", "Pieton"]. The first element is selected.
  - Optionalid?: number
    Ability to add an identifier on the widget (advanced option)
  - OptionallayerDescription?: { description?: string; title?: string }
    Layer informations to be displayed in LayerSwitcher widget (only if a LayerSwitcher is also added to the map)
    
    Optionaldescription?: string
    Layer description to be displayed in LayerSwitcher
    
    Optionaltitle?: string
    Layer title to be displayed in LayerSwitcher
  - OptionalmarkersOpts?: { offset?: any[]; url?: string }
    options to use your own markers. Object properties can be "departure", "stages" or "arrival". Corresponding value is an object with following properties :
    
    Optionaloffset?: any[]
    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)
    
    Optionalurl?: string
    marker base64 encoded url (ex "data:image/png;base64,...""). Mandatory for a custom marker
  - OptionalrouteOptions?: any
    route service options. see Gp.Services.route() to know all route options.
  - Optionalssl?: boolean
    use of ssl or not (default true, service requested using https protocol)
Returns Route
Fires
route:drawstart

Fires
route:drawend

Fires
route:compute

Fires
route:compute

Fires
route:newresults
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
   }
 });
```
Overrides ControlExtended.constructor
- Defined in src/packages/Controls/Route/Route.js:115

Properties

_container

_container: any

_defaultFeatureStyle

_defaultFeatureStyle: undefined | Style

_selectedFeatureStyle

_selectedFeatureStyle: undefined | Style

collapsed

collapsed: undefined | boolean

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

element

element: any

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        autocompleteOptions: {};
        collapsed: boolean;
        draggable: boolean;
        exclusions: { bridge: boolean; toll: boolean; tunnel: boolean };
        export: boolean;
        graphs: string[];
        layerDescription: { description: string; title: string };
        routeOptions: {};
    }

un

un: ObjectOnSignature<void>

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addChangeListener
- Defined in node_modules/ol/Object.d.ts:146

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from ControlExtended.applyProperties
- Defined in node_modules/ol/Object.d.ts:175

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void
Api
Inherited from ControlExtended.changed
- Defined in node_modules/ol/Observable.d.ts:65

clean

clean(): void
Clean UI : reinit control

Returns void
- Defined in src/packages/Controls/Route/Route.js:464

dispatchEvent

dispatchEvent(event: string | BaseEvent): undefined | boolean
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.
Parameters
- event: string | BaseEvent
  Event object.
Returns undefined | boolean
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from ControlExtended.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from ControlExtended.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from ControlExtended.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from ControlExtended.get
- Defined in node_modules/ol/Object.d.ts:111

getCollapsed

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

Returns boolean
collapsed - true if widget is collapsed
- Defined in src/packages/Controls/Route/Route.js:204

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/Route/Route.js:356

getData

getData(): any
Get route informations

Returns any
data - route informations
- Defined in src/packages/Controls/Route/Route.js:287

getGeoJSON

getGeoJSON(): string
Get vector layer

Returns string
geojson - GeoJSON format layer
- Defined in src/packages/Controls/Route/Route.js:265

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from ControlExtended.getKeys
- Defined in node_modules/ol/Object.d.ts:117

getLayer

getLayer(): VectorLayer<VectorSource<any>, any>
Get vector layer where geoJson route is drawn

Returns VectorLayer<VectorSource<any>, any>
layer - ol.layer.Vector route layer
- Defined in src/packages/Controls/Route/Route.js:234

getListeners

getListeners(type: string): undefined | Listener[]
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Parameters
- type: string
  Type.
Returns undefined | Listener[]
Listeners.
Inherited from ControlExtended.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

getMap(): null | Map
Get the map associated with this control.

Returns null | Map
Map.

Api
Inherited from ControlExtended.getMap
- Defined in node_modules/ol/control/Control.d.ts:92

getProperties

getProperties(): { [x: string]: any }
Get an object of all property names and values.

Returns { [x: string]: any }
Object.

Api
Inherited from ControlExtended.getProperties
- Defined in node_modules/ol/Object.d.ts:123

getPropertiesInternal

getPropertiesInternal(): null | { [x: string]: any }
Get an object of all property names and values.

Returns null | { [x: string]: any }
Object.
Inherited from ControlExtended.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:130

getRevision

getRevision(): number
Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns number
Revision.

Api
Inherited from ControlExtended.getRevision
- Defined in node_modules/ol/Observable.d.ts:72

getStyle

getStyle(): Style
Get default style

Returns Style
style
- Defined in src/packages/Controls/Route/Route.js:365

hasListener

hasListener(type?: string): boolean
Parameters
- Optionaltype: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from ControlExtended.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from ControlExtended.hasProperties
- Defined in node_modules/ol/Object.d.ts:136

init

init(): void
This method is public. It allows to init the control.

Returns void
- Defined in src/packages/Controls/Route/Route.js:373

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from ControlExtended.notify
- Defined in node_modules/ol/Object.d.ts:141

`Protected`onceInternal

onceInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from ControlExtended.onceInternal
- Defined in node_modules/ol/Observable.d.ts:86

`Protected`onInternal

onInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from ControlExtended.onInternal
- Defined in node_modules/ol/Observable.d.ts:79

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:151

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

render

render(mapEvent: MapEvent): void
Renders the control.
Parameters
- mapEvent: MapEvent
  Map event.
Returns void
Api
Inherited from ControlExtended.render
- Defined in node_modules/ol/control/Control.d.ts:86

set

set(key: string, value: any, silent?: boolean): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from ControlExtended.set
- Defined in node_modules/ol/Object.d.ts:159

setCollapsed

setCollapsed(collapsed: boolean): void
Collapse or display widget main container
Parameters
- collapsed: boolean
  True to collapse widget, False to display it
Returns void
- Defined in src/packages/Controls/Route/Route.js:213

setData

setData(
    data: {
        computation: string;
        exclusions: any[];
        points: any[];
        results: any;
        transport: string;
    },
): void
Set route data
Parameters
- data: {
      computation: string;
      exclusions: any[];
      points: any[];
      results: any;
      transport: string;
  }
  control informations
  - computation: string
    computation type
  - exclusions: any[]
    list of exclusions
  - points: any[]
    list of points : [[lon, lat]]
  - results: any
    service response
  - transport: string
    transport type
Returns void
- Defined in src/packages/Controls/Route/Route.js:315

setGeoJSON

setGeoJSON(geojson: string): void
Set vector layer
Parameters
- geojson: string
  GeoJSON format layer
Returns void
- Defined in src/packages/Controls/Route/Route.js:274

setLayer

setLayer(layer: VectorLayer<VectorSource<any>, any>): void
Set vector layer where route geometry is drawn
Parameters
- layer: VectorLayer<VectorSource<any>, any>
  ol.layer.Vector route layer
Returns void
- Defined in src/packages/Controls/Route/Route.js:243

setMap

setMap(map: Map): void
Overwrite OpenLayers setMap method
Parameters
- map: Map
  Map.
Returns void
Overrides ControlExtended.setMap
- Defined in src/packages/Controls/Route/Route.js:146

setPosition

setPosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.setPosition
- Defined in src/packages/Controls/Control.js:27

setProperties

setProperties(values: { [x: string]: any }, silent?: boolean): void
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Parameters
- values: { [x: string]: any }
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from ControlExtended.setProperties
- Defined in node_modules/ol/Object.d.ts:167

setTarget

setTarget(target: string | HTMLElement): void
This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.
Parameters
- target: string | HTMLElement
  Target.
Returns void
Api
Inherited from ControlExtended.setTarget
- Defined in node_modules/ol/control/Control.d.ts:111

`Protected`unInternal

unInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns void
Inherited from ControlExtended.unInternal
- Defined in node_modules/ol/Observable.d.ts:93

unset

unset(key: string, silent?: boolean): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optionalsilent: boolean
  Unset without triggering an event.
Returns void
Api
Inherited from ControlExtended.unset
- Defined in node_modules/ol/Object.d.ts:182

updatePosition

updatePosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.updatePosition
- Defined in src/packages/Controls/Control.js:34

Class Route

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalapiKey?: string

OptionalautocompleteOptions?: any

Optionalcollapsed?: boolean

Optionaldraggable?: boolean

Optionalexclusions?: any

Optionalexport?: any

Optionalgraphs?: any[]

Optionalid?: number

OptionallayerDescription?: { description?: string; title?: string }

Optionaldescription?: string

Optionaltitle?: string

OptionalmarkersOpts?: { offset?: any[]; url?: string }

Optionaloffset?: any[]

Optionalurl?: string

OptionalrouteOptions?: any

Optionalssl?: boolean

Returns Route

Fires

Fires

Fires

Fires

Fires

Example

Properties

_container

_defaultFeatureStyle

_selectedFeatureStyle

collapsed

description

Protecteddisposed

draggable

element

listable

ProtectedlistenerKeys

on

once

options

un

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

clean

Returns void

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getCollapsed

Returns boolean

getContainer

Returns HTMLElement

getData

Returns any

`Optional`apiKey?: string

`Optional`autocompleteOptions?: any

`Optional`collapsed?: boolean

`Optional`draggable?: boolean

`Optional`exclusions?: any

`Optional`export?: any

`Optional`graphs?: any[]

`Optional`id?: number

`Optional`layerDescription?: { description?: string; title?: string }

`Optional`description?: string

`Optional`title?: string

`Optional`markersOpts?: { offset?: any[]; url?: string }

`Optional`offset?: any[]

`Optional`url?: string

`Optional`routeOptions?: any

`Optional`ssl?: boolean

`Protected`disposed

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal