Route QML Type | Qt Location 5.13.2

Qt 5.13 | Qt Location | QML Types | Route QML Type

Qt 5.13.2 Reference Documentation

# Route QML Type

The Route type represents one geographical route. More...

Import Statement: | import QtLocation 5.13
Since: | QtLocation 5.5

- List of all members, including inherited members

## Properties

- bounds : georectangle
- distance : real
- extendedAttributes : Object
- legs : list<Route>
- path : list<coordinate>
- routeQuery : RouteQuery
- segments : list<RouteSegment>
- travelTime : int

## Methods

- bool equals(other)
- int segmentsCount()

## Detailed Description

A Route type contains high level information about a route, such as the length the route, the estimated travel time for the route, and enough information to render a basic image of the route on a map.

The QGeoRoute object also contains a list of RouteSegment objects which describe subsections of the route in greater detail.

The primary means of acquiring Route objects is RouteModel.

## Example

This example shows how to display a route's maneuvers in a ListView:

      import QtQuick 2.3
      import QtPositioning 5.5
      import QtLocation 5.6

      RouteModel {
          id: routeModel
          // model initialization
      }

      ListView {
          id: listview
          anchors.fill: parent
          spacing: 10
          model: routeModel.status == RouteModel.Ready ? routeModel.get(0).segments : null
          visible: model ? true : false
          delegate: Row {
              width: parent.width
              spacing: 10
              property bool hasManeuver : modelData.maneuver && modelData.maneuver.valid
              visible: hasManeuver
              Text { text: (1 + index) + "." }
              Text { text: hasManeuver ? modelData.maneuver.instructionText : "" }
          }
      }

## Property Documentation

bounds : georectangle

Read-only property which holds a bounding box which encompasses the entire route.

distance : real

Read-only property which holds distance covered by this route, in meters.

extendedAttributes : Object

This property holds the extended attributes of the route and is a map. These attributes are plugin specific, and can be empty.

Consult the plugin documentation for what attributes are supported and how they should be used.

Note, due to limitations of the QQmlPropertyMap, it is not possible to declaratively specify the attributes in QML, assignment of attributes keys and values can only be accomplished by JavaScript.

This property was introduced in QtLocation 5.13.

legs : list<Route>

Returns the route legs associated with this route. Route legs are the sub-routes between each two adjacent waypoints. The result may be empty, if this level of detail is not supported by the backend.

This property was introduced in QtLocation 5.12.

path : list<coordinate>

Read-only property which holds the geographical coordinates of this route. Coordinates are listed in the order in which they would be traversed by someone traveling along this segment of the route.

To access individual segments you can use standard list accessors: 'path.length' indicates the number of objects and 'path[index starting from zero]' gives the actual object.

See also QtPositioning::coordinate.

routeQuery : RouteQuery

Returns the route query associated with this route.

This property was introduced in Qt 5.11.

segments : list<RouteSegment>

Read-only property which holds the list of RouteSegment objects of this route.

To access individual segments you can use standard list accessors: 'segments.length' indicates the number of objects and 'segments[index starting from zero]' gives the actual objects.

See also RouteSegment.

travelTime : int

Read-only property which holds the estimated amount of time it will take to traverse this route, in seconds.

## Method Documentation

bool equals(other)

This method performs deep comparison if the present route is identical to the other route. Returns `true` if the routes are equal.

This method was introduced in Qt 5.12.

int segmentsCount()

Returns the number of segments in the route

This method was introduced in Qt 5.11.

See also RouteSegment.