Qt Location QML Types | Qt Location 5.4

- Qt 5.4
- Qt Location
- Qt Location QML Types
- Qt 5.4.2 Reference Documentation

# Qt Location QML Types

#### Overview

The identifying string for this module is QtLocation. To use include the following import statement in the QML file.

    import QtLocation 5.3

##### Location QML Concepts

Provided that a position has been obtained this module can add a Map with positions of interest and Places. The user can be made aware of nearby features and related information, displayed graphically. Features on the Map may be places of business, entertainment and so on. They may include paths, roads, or forms of transport leading so that navigation optimization and assistance are possible.

To perform navigation we need Routes from start to destination. These routes are made up of segments. Each RouteSegment can be considered a navigation sub-task: 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 used 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 handles geocoding and routing that the API and application can use. There may be various GeoServices plugins for various tasks with some plugins providing more than one service. One QML Plugin should be created for each required GeoService plugin. Plugins are required for maps, routing and geocoding, however the default plugin handles all three of these services. A plugin may require online access or may support on-board maps and data. The default "nokia" plugin only supports online use. The connection would be managed by QNetworkInfo and QNetworkConfigurationManager.

Note: : Plugins may not provide various features such as paging or relevance hints. Since plugins may be supplied by other providers, support for these aspects is dependent on the provider's implementation.

The following table provides links to more detailed information on sections of the Qt Location QML API.

Maps and Navigation | Displaying maps and finding routes.
Places | Searching 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

Map | Type displays a map
MapCircle | Type displays a geographic circle on a Map
MapGestureArea | Type provides Map gesture interaction
MapItemView | Used to populate Map from a model
MapPinchEvent | Type provides basic information about pinch event
MapPolygon | Type displays a polygon on a Map
MapPolyline | Type displays a polyline on a map
MapQuickItem | Type displays an arbitrary Qt Quick object on a Map
MapRectangle | Type displays a rectangle on a Map
MapRoute | Type displays a Route on a Map
MapType | Type holds information about a map type

#### Navigation and Routing QML Types

Route | Type represents one geographical route
RouteManeuver | Type represents the information relevant to the point at which two RouteSegments meet
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
CategoryModel | Type provides a model of the categories supported by a Plugin
ContactDetail | Type holds a contact detail such as a phone number or a website address
ContactDetails | Type holds contact details for a Place
EditorialModel | Type provides a model of place editorials
ExtendedAttributes | Type holds additional data about a Place
Icon | Type represents an icon image source which can have multiple sizes
ImageModel | Type provides a model of place images
Place | Type represents a location that is a position of interest
PlaceAttribute | Type holds generic place attribute information
PlaceSearchModel | Provides access to place search results
PlaceSearchSuggestionModel | Provides access to search term suggestions
Ratings | Type holds place rating information
ReviewModel | Provides access to reviews of a Place
Supplier | Holds data regarding the supplier of a place, a place's image, review, or editorial
User | Type identifies a user who contributed a particular Place content item

#### Alphabetical Listing of All QML Types

Category | Type represents a category that a Place can be associated with
CategoryModel | Type provides a model of the categories supported by a Plugin
ContactDetail | Type holds a contact detail such as a phone number or a website address
ContactDetails | Type holds contact details for a Place
EditorialModel | Type provides a model of place editorials
ExtendedAttributes | Type holds additional data about a Place
GeocodeModel | Type provides support for searching operations related to geographic information
Icon | Type represents an icon image source which can have multiple sizes
ImageModel | Type provides a model of place images
Map | Type displays a map
MapCircle | Type displays a geographic circle on a Map
MapGestureArea | Type provides Map gesture interaction
MapItemView | Used to populate Map from a model
MapPinchEvent | Type provides basic information about pinch event
MapPolygon | Type displays a polygon on a Map
MapPolyline | Type displays a polyline on a map
MapQuickItem | Type displays an arbitrary Qt Quick object on a Map
MapRectangle | Type displays a rectangle on a Map
MapRoute | Type displays a Route on a Map
MapType | Type holds information about a map type
Place | Type represents a location that is a position of interest
PlaceAttribute | Type holds generic place attribute information
PlaceSearchModel | Provides access to place search results
PlaceSearchSuggestionModel | Provides access to search term suggestions
Plugin | Type describes a Location based services plugin
PluginParameter | Type describes a parameter to a Plugin
Ratings | Type holds place rating information
ReviewModel | Provides access to reviews of a Place
Route | Type represents one geographical route
RouteManeuver | Type represents the information relevant to the point at which two RouteSegments meet
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
Supplier | Holds data regarding the supplier of a place, a place's image, review, or editorial
User | Type identifies a user who contributed a particular Place content item