Class Route extends TravelObject

This class represent a route

Source : file data/Route.js at line 40

Constructor

new Route ( )

The constructor

Source : file data/Route.js at line 173

Public getters and setters

get chainedDistance : Number

The distance betwween the starting point of the travel and the starting point of the route if the route is chained, otherwise DISTANCE.defaultValue

Source : file data/Route.js at line 290

set chainedDistance

Source : file data/Route.js at line 292

get chain : Boolean

A boolean indicating if the route is chained

Source : file data/Route.js at line 280

set chain

Source : file data/Route.js at line 282

get color : String

The color of the Leaflet polyline used to represent the Route on the map using the css format '#rrggbb'

Source : file data/Route.js at line 234

set color

Source : file data/Route.js at line 236

readonly get computedName : String

A name computed from the starting WayPoint and ending WayPoint names and addresses

Source : file data/Route.js at line 352

get dashIndex : Number

The index of the dash in the array Config.route.dashChoices

Source : file data/Route.js at line 250

set dashIndex

Source : file data/Route.js at line 252

readonly get dashString : String

The string used by Leaflet for the dash to display the route

Source : file data/Route.js at line 266

get distance : Number

The length of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

Source : file data/Route.js at line 301

set distance

Source : file data/Route.js at line 303

get duration : Number

The duration of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

Source : file data/Route.js at line 312

set duration

Source : file data/Route.js at line 314

get editionStatus : Number

A number indicating the status of the route. See ROUTE_EDITION_STATUS for possible values

Source : file data/Route.js at line 325

set editionStatus

Source : file data/Route.js at line 327

get hidden : Boolean

A boolean set to true when the route is hidden on the map

Source : file data/Route.js at line 341

set hidden

Source : file data/Route.js at line 343

readonly get itinerary : Itinerary

The Route Itinerary

Source : file data/Route.js at line 215

get jsonObject : JsonObject

An object literal with the WayPoint properties and without any methods. This object can be used with the JSON object

Source : file data/Route.js at line 405

set jsonObject

Source : file data/Route.js at line 425

get name : String

The name of the Route

Source : file data/Route.js at line 185

set name

Source : file data/Route.js at line 187

readonly get notes : Collection of Note

A Collection of Notes

Source : file data/Route.js at line 208

readonly get objId : Number

The objId of the Route. objId are unique identifier given by the code

Source : file data/Route.js at line 369

readonly get objType : ObjType

The ObjType of the Route.

Source : file data/Route.js at line 376

readonly get wayPoints : Collection of WayPoint

A Collection of WayPoints

Source : file data/Route.js at line 201

get width : Number

The width of the Leaflet polyline used to represent the Route on the map

Source : file data/Route.js at line 222

set width

Source : file data/Route.js at line 224

Public methods

haveValidWayPoints ( )

This method verify that all waypoints have valid coordinates ( reminder: a route have always a startpoint and an endpoint!)

Source : file data/Route.js at line 384

Returns

True when all waypoints have valid coordinates
Type : Boolean

Private properties

#chain : Boolean

Boolean indicates if the route is chained

Source : file data/Route.js at line 123

#chainedDistance : Number

The distance between the starting point of the travel and the starting point of the route if the route is chained, otherwise DISTANCE.defaultValue

Source : file data/Route.js at line 131

#color : String

The color of the Leaflet polyline used to represent the Route on the map using the css format '#rrggbb'

Source : file data/Route.js at line 108

#dashIndex : Number

The dash of the Leaflet polyline used to represent the Route on the map. It's the index of the dash in the array Config.route.dashChoices

Source : file data/Route.js at line 116

#distance : Number

The length of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

Source : file data/Route.js at line 138

#duration : Number

The duration of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

Source : file data/Route.js at line 145

#editionStatus : Number

A number indicating the status of the route. See ROUTE_EDITION_STATUS for possible values

Source : file data/Route.js at line 153

#hidden : Boolean

A boolean set to true when the route is hidden on the map

Source : file data/Route.js at line 160

#itinerary : Itinerary

The Route Itinerary

Source : file data/Route.js at line 93

#name : String

The name of the Route

Source : file data/Route.js at line 72

#notes : Collection of Note

A Collection of Notes

Source : file data/Route.js at line 86

#objId : Number

The objId of the route

Source : file data/Route.js at line 167

static #objType : ObjType

The object type for routes

Source : file data/Route.js at line 47

#wayPoints : Collection of WayPoint

A Collection of WayPoints

Source : file data/Route.js at line 79

#width : Number

The width of the Leaflet polyline used to represent the Route on the map

Source : file data/Route.js at line 100