Skip to main content

Waypoints

designInterfaces_waypoints included in the Core module.

Description

Implemented by all waypoints designs

Properties

PropertyValue
NameWaypoints
CodedesignInterfaces_waypoints
TypeDesign interface
ContextCore
Title{{attributes_waypointsName}}
Subtitle-
Iconicon-marker-circle
Colour#25aae1

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

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

PropertyValue
NameName
Codeattributes_waypointsName
TypeString
Requiredtrue
Uniquefalse
Readonlyfalse
Options
{
"max": 128
}

Distance

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

PropertyValue
NameDistance
Codeattributes_waypointsDistance
TypeNumber
Requiredfalse
Uniquefalse
Readonlyfalse
Options
{
"decimalPlaces": 2
}

Index

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

PropertyValue
NameIndex
Codeattributes_waypointsIndex
TypeNumber
Requiredfalse
Uniquefalse
Readonlyfalse
Options
{
"decimalPlaces": 0
}

Default attribute permissions

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

AllowsNameCode
ReadOnlyProject ViewersuserGroups_projectViewers
ReadWriteProject ManagersuserGroups_projectManagers

Permissions

User GroupAllows
Project ViewersRead
Project ManagersRead, Create, Edit, Delete