Wayfinder Travel Types Database Class
Travel Types are used to describe how (during routing) you move from one node to the next. These types have specific rules, including their accessible nature and so on. Switching between types can cause an transit overlay icon to appear on the map.
This class inherits and therefore includes all the methods and functions defined the standard
wayfinder database base class. This class does not add any extra functions, but does define the following static properties.
|
TravelTypeAlwaysHide |
property (r) |
A number that represents a travel type that is never displayed on the map. This might typically be used for the standard walking (a.k.a "NORMAL") type. |
|
TravelTypeAlwaysShow |
property (r) |
A number that represents a travel type that should always cause an overlay icon to appear on the map where it starts or ends. For example, an elevator. |
|
TravelTypeOnlyRouteShow |
property (r) |
A number that represents a travel type that should only appear if it becomes part of an active route. |
Each record in the WayfinderTravelTypesDatabase contains the following properties:
|
button |
property (r) |
When a route has been generated, and it goes through a node that uses this travel type, a popup is displayed. This is a mapping of the language to text for the Continue button (not currently used) See Special Tags below. |
|
entry_icon |
property (r) |
An object containing {mode, url} describing the icon that could be placed upon entering this travel type, where: Mode: is one of the above TravelType properties. URL: is the URL of the travel/transit icon |
|
exit_icon |
property (r) |
An object containing {mode, url} describing the icon that could be placed upon exiting this travel type, where: |
|
id |
property (r) |
A string that represents the unique ID (name) for this travel type. Example common types include "NORMAL", "LIFT" and "STAIRS". |
|
showline |
property (r) |
If set to 1, then the route line will be displayed for this travel type, else it will be hidden/invisible. |
|
text |
property (r) |
When a route has been generated, and it goes through a node that uses this travel type, a popup is displayed. This is the text to show in this popup, as mapping of the language to text. See Special Tags below. |
|
type |
property (r) |
An alias of id |
Special Tags
The message contained within the button and text fields can contains special tokens which should be substituted with current information when displayed. These tokens are as follows:
|
^ |
The name of the map/floor the route is travelling from |
|
{ |
The short name of the map/floor the route is travelling from |
|
@ |
The name of the map/floor the route is travelling to |
|
} |
The short name of the map/floor the route is travelling to |
|
~ |
The name of the building being travelled to/from |