Qt Location QML Types
Overview
Provided that a position has been obtained, the Qt Location module can add a Map with Places of Interest (POI) and Places. The user can be made aware of nearby features and related information, displayed on the map. These features can be places of business, entertainment, and so on. They may include paths, roads, or forms of transport, enabling navigation optimization and assistance.
To perform navigation we need routes from start to destination. These routes are made up of segments, where each routeSegment can be considered a navigation subtask; for example, "drive 100 meters", or "turn left". The beginning and end of each segment is a waypoint, that is, one part of the journey.
A typical use case for the API is a user looking for a particular type of place, such as a restaurant; the user enters a search string into the map application and is presented with a list of results for restaurants "near" the device. The application can then be used to navigate to the chosen destination using a route that is optimized according to features in the environment that may help or hinder the journey. The navigation then proceeds with the user's progress monitored by means of the current location.
In short, the main QML types and their roles are as follows:
- The Place instances hold information about the destination and surrounding objects, including displayable representations.
- The Map enables the information contained in Place objects to be displayed, panned, zoomed, and so on.
- The route is be determined by a plugin, with each routeSegment holding the navigation instructions, guided by the continuously updated current Location.
Plugins
Plugins supply the data required to calculate routes and navigation instructions, and they are typically tied to a specific location-based service. For example, a plugin may allow connecting to a service that provides geocoding and routing information, which can be consumed by the application.
There may be various GeoServices plugins for various tasks, with some plugins providing more than one service. One QML Plugin instance must be created for each GeoService plugin. Plugins are required for routing and geocoding, maps, and places, however the default plugin handles all four of these services. A plugin may require online access or it may support on-board maps and data.
Note: Plugins may not provide features such as paging or relevance hints.
Related Information
The following links provide more information about maps and places:
| Maps and Navigation | Displaying maps and finding routes |
| Places | Searching for and managing points of interest |
Common QML Types
Type describes a Location based services plugin | |
Type describes a parameter for a plugin |
Maps QML Types
Type displays a map | |
Type displays a geographic circle on a Map | |
Item displays the current valid copyright notice for a Map element | |
Type is a container for map items | |
Used to populate Map from a model | |
Type displays a polygon on a Map | |
Type displays a polyline on a map | |
Type displays an arbitrary Qt Quick object on a Map | |
Type displays a rectangle on a Map | |
Type displays a Route on a Map | |
Type holds information about the camera capabilities for a specific map type | |
Type holds information about a map type |
Navigation and Routing QML Types
Type provides access to routes | |
Type is used to provide query parameters to a RouteModel | |
Type represents one geographical route | |
Type represents the information relevant to the point at which two routeSegments meet | |
Type represents a segment of a Route |
Geocoding QML Types
Type provides support for searching operations related to geographic information |
Places QML Types
Type represents a category that a Place can be associated with | |
Type provides a model of the categories supported by a Plugin | |
Type holds contact details for a Place | |
Type provides a model of place editorials | |
Type holds additional data about a Place | |
Type provides a model of place images | |
Type represents a location that is a position of interest | |
Provides access to place search results | |
Provides access to search term suggestions | |
Type provides a model of place reviews | |
Type holds a contact detail such as a phone number or a website address | |
Type represents the icon of a place | |
Type holds generic place attribute information | |
Type holds place rating information | |
Holds data regarding the supplier of a place, a place's image, review, or editorial | |
Type identifies a user who contributed a particular Place content item |
Alphabetical Listing of All QML Types
Type represents a category that a Place can be associated with | |
Type provides a model of the categories supported by a Plugin | |
Type holds contact details for a Place | |
Type provides a model of place editorials | |
Type holds additional data about a Place | |
Type provides support for searching operations related to geographic information | |
Type provides a model of place images | |
Type displays a map | |
Type displays a geographic circle on a Map | |
Item displays the current valid copyright notice for a Map element | |
Type is a container for map items | |
Used to populate Map from a model | |
Type displays a polygon on a Map | |
Type displays a polyline on a map | |
Type displays an arbitrary Qt Quick object on a Map | |
Type displays a rectangle on a Map | |
Type displays a Route on a Map | |
An interactive map viewer component | |
Type represents a location that is a position of interest | |
Provides access to place search results | |
Provides access to search term suggestions | |
Type describes a Location based services plugin | |
Type describes a parameter for a plugin | |
Type provides a model of place reviews | |
Type provides access to routes | |
Type is used to provide query parameters to a RouteModel | |
Type holds information about the camera capabilities for a specific map type | |
Type holds a contact detail such as a phone number or a website address | |
Type represents the icon of a place | |
Type holds information about a map type | |
Type holds generic place attribute information | |
Type holds place rating information | |
Type represents one geographical route | |
Type represents the information relevant to the point at which two routeSegments meet | |
Type represents a segment of a Route | |
Holds data regarding the supplier of a place, a place's image, review, or editorial | |
Type identifies a user who contributed a particular Place content item |
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.