Waypoints

This interface is included in the Core module.

Implemented by all waypoints designs.

This interface has the following properties.

Property	Value
Name	Waypoints
Code	`designInterfaces_waypoints`
Type	Interface
Context	`Core`
AI agent enabled	`true`
AI agent description	Shared interface for waypoint designs, providing position and ordering fields.
Icon	`icon-marker-circle`
Colour	`#690095`
Title	`{{attributes_waypointsName}}`
Subtitle	-

This interface doesn't implement any other interfaces.

This interface has the following attributes.

User specified or name of the street the coordinate snapped to (returned by the routing service).

Property	Value
Name	Name
Code	`attributes_waypointsName`
Type	String
Required	`true`
Unique	`false`
Read-only	`false`
AI agent enabled	`true`
AI agent description	The name or label for this waypoint.
Options	`{ "max": 128 }`

Optional distance of the snapped point from the original (returned by the routing service).

Property	Value
Name	Distance
Code	`attributes_waypointsDistance`
Type	Number
Required	`false`
Unique	`false`
Read-only	`false`
AI agent enabled	`true`
AI agent description	The cumulative distance from the route start to this waypoint in metres.
Options	`{ "decimalPlaces": 2 }`

Only available for OSRM trip object. Index of the point in the trip.

Property	Value
Name	Index
Code	`attributes_waypointsIndex`
Type	Number
Required	`false`
Unique	`false`
Read-only	`false`
AI agent enabled	`true`
AI agent description	The sequential position of this waypoint in the route order.
Options	`{ "decimalPlaces": 0 }`

This interface doesn't have any standard paths of its own.

This interface defines the following permissions.

User group	Allowed
Project Viewers	Read
Project Managers	Read, Create, Edit, Delete

This interface applies the following default permissions to all attributes for the following user groups.

Allowed	User group	Code
`ReadOnly`	Project Viewers	`userGroups_projectViewers`
`ReadWrite`	Project Managers	`userGroups_projectManagers`