Qt Location QML Types

Overview

Provided that a position has been obtained, this 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 graphically. Features on the Map 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: drive 100 meters, turn left. The beginning and end of each segment is a waypoint, that is, one part of our journey.

A typical use case for the API is a user looking for a particular type of place, say a restaurant. The user could enter a search string into the map application and respond to a list or display of results for restaurants "near" the device. The application could then be used to navigate to the restaurant using an optimized route that is aware of features in the environment that can help or hinder the journey. The navigation then proceeds with the user's progress monitored by means of the current Location. In the context of this API the map application would be aware of the location and size of various places and the location of the user. Plugins would supply the data required by the application to determine routes and navigation instructions. The Place types would hold information about the destination and surrounding objects including displayable representations. The Map type would enable this information to be displayed, panned, zoomed and so on. The Route would be determined by a plugin with each RouteSegment holding the navigation instructions guided by the updated current Location.

Plugins are a means of specifying which location-based service to use. For example, a plugin may allow connection to a provider's 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 must be created for each required GeoService plugin. Plugins are required for maps, routing and geocoding, and places, however the default plugin handles all four of these services. A plugin may require online access or may support on-board maps and data.

Note: Plugins may not provide features such as paging or relevance hints.

The following links provide more detailed information about maps and places:

Maps and NavigationDisplaying maps and finding routes.
PlacesSearching for and managing points of interest.

Common QML Types

Plugin

Type describes a Location based services plugin

PluginParameter

Type describes a parameter to a Plugin

Maps QML Types

MapCircle

Type displays a geographic circle on a Map

Map

Type displays a map

MapItemView

Used to populate Map from a model

MapQuickItem

Type displays an arbitrary Qt Quick object on a Map

MapType

Type holds information about a map type

MapPolygon

Type displays a polygon on a Map

MapPolyline

Type displays a polyline on a map

MapRectangle

Type displays a rectangle on a Map

MapRoute

Type displays a Route on a Map

MapGestureArea

Type provides Map gesture interaction

MapPinchEvent

Type provides basic information about pinch event

RouteManeuver

Type represents the information relevant to the point at which two RouteSegments meet

Route

Type represents one geographical route

RouteModel

Type provides access to routes

RouteQuery

Type is used to provide query parameters to a RouteModel

RouteSegment

Type represents a segment of a Route

Geocoding QML Types

GeocodeModel

Type provides support for searching operations related to geographic information

Places QML Types

Category

Type represents a category that a Place can be associated with

ContactDetail

Type holds a contact detail such as a phone number or a website address

ContactDetails

Type holds contact details for a Place

Place

Type represents a location that is a position of interest

ExtendedAttributes

Type holds additional data about a Place

PlaceAttribute

Type holds generic place attribute information

EditorialModel

Type provides a model of place editorials

Icon

Type represents an icon image source which can have multiple sizes

ImageModel

Type provides a model of place images

User

Type identifies a user who contributed a particular Place content item

Ratings

Type holds place rating information

ReviewModel

Provides access to reviews of a Place

PlaceSearchModel

Provides access to place search results

PlaceSearchSuggestionModel

Provides access to search term suggestions

Supplier

Holds data regarding the supplier of a place, a place's image, review, or editorial

CategoryModel

Type provides a model of the categories supported by a Plugin

Alphabetical Listing of All QML Types

Category

Type represents a category that a Place can be associated with

ContactDetail

Type holds a contact detail such as a phone number or a website address

ContactDetails

Type holds contact details for a Place

Place

Type represents a location that is a position of interest

ExtendedAttributes

Type holds additional data about a Place

PlaceAttribute

Type holds generic place attribute information

EditorialModel

Type provides a model of place editorials

Icon

Type represents an icon image source which can have multiple sizes

ImageModel

Type provides a model of place images

User

Type identifies a user who contributed a particular Place content item

Ratings

Type holds place rating information

ReviewModel

Provides access to reviews of a Place

PlaceSearchModel

Provides access to place search results

PlaceSearchSuggestionModel

Provides access to search term suggestions

Supplier

Holds data regarding the supplier of a place, a place's image, review, or editorial

CategoryModel

Type provides a model of the categories supported by a Plugin

MapCircle

Type displays a geographic circle on a Map

GeocodeModel

Type provides support for searching operations related to geographic information

RouteManeuver

Type represents the information relevant to the point at which two RouteSegments meet

Map

Type displays a map

MapItemView

Used to populate Map from a model

MapQuickItem

Type displays an arbitrary Qt Quick object on a Map

MapType

Type holds information about a map type

Route

Type represents one geographical route

RouteModel

Type provides access to routes

RouteQuery

Type is used to provide query parameters to a RouteModel

RouteSegment

Type represents a segment of a Route

Plugin

Type describes a Location based services plugin

PluginParameter

Type describes a parameter to a Plugin

MapPolygon

Type displays a polygon on a Map

MapPolyline

Type displays a polyline on a map

MapRectangle

Type displays a rectangle on a Map

MapRoute

Type displays a Route on a Map

MapGestureArea

Type provides Map gesture interaction

MapPinchEvent

Type provides basic information about pinch event

© 2017 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.