Routes

designInterfaces_routes included in the Core module.

Description

Implemented by all route designs

Properties

Property	Value
Name	Routes
Code	designInterfaces_routes
Type	Design interface
Context	Core
Title	{{attributes_routesName}}
Subtitle	-
Icon	icon-route
Colour	#690095

Implements

This interface does not implement any interfaces.

Applied to designs/interfaces

This interface is not added to any designs or interfaces when this module is installed.

Attributes

This interface directly creates the following attributes.

Name

Implemented by all route designs

Property	Value
Name	Name
Code	attributes_routesName
Type	String
Required	true
Unique	false
Readonly	false
Options	{ "max": 128 }

Waypoints

Route waypoints either generated by the routing service or user specified

Property	Value
Name	Waypoints
Code	attributes_routesWaypoints
Type	Link
Required	true
Unique	false
Readonly	false
Links to	Waypoints
Options	{ "code": "designInterfaces_waypoints", "graph": "Route" }

Distance m

Optional distance traveled by the route, in float meters (returned by the routing service)

Property	Value
Name	Distance m
Code	attributes_routesDistance
Type	Number
Required	false
Unique	false
Readonly	false
Options	{ "decimalPlaces": 2 }

Duration s

Optional estimated travel time, in float number of seconds (returned by the routing service)

Property	Value
Name	Duration s
Code	attributes_routesDuration
Type	Number
Required	false
Unique	false
Readonly	false
Options	{ "decimalPlaces": 2 }

Current Route Type

The current route representation. Can be either 'Fastest' or 'Shortest'.

Property	Value
Name	Current Route Type
Code	attributes_routesCurrentRouteType
Type	String
Required	false
Unique	false
Readonly	false
Options	{ "max": 128 }

Shortest Route

Optional trip (shortest route) geometry, as generated by OSRM trip service

Property	Value
Name	Shortest Route
Code	attributes_routesShortestRoute
Type	GeoJson
Required	false
Unique	false
Readonly	false
Options	{ "allows": [ "Linestring" ] }

Shortest Route Distance

Trip (shortest route) distance traveled in float meters (returned by the routing service)

Property	Value
Name	Shortest Route Distance
Code	attributes_routesShortestRouteDistance
Type	Number
Required	false
Unique	false
Readonly	false
Options	{ "decimalPlaces": 2 }

Shortest Route Duration

Trip (shortest route) estimated travel time in float number of seconds (returned by the routing service)

Property	Value
Name	Shortest Route Duration
Code	attributes_routesShortestRouteDuration
Type	Number
Required	false
Unique	false
Readonly	false
Options	{ "decimalPlaces": 2 }

Default attribute permissions

This interface applies the following default permissions to all attributes against each user group.

Allows	Name	Code
ReadOnly	Project Viewers	userGroups_projectViewers
ReadWrite	Project Managers	userGroups_projectManagers

Permissions

User Group	Allows
Project Viewers	Read
Project Managers	Read, Create, Edit, Delete