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.
Plugins may not provide features such as paging or relevance hints.
Related Information▲
Displaying maps and finding routes |
|
Searching for and managing points of interest |
Common QML Types▲
-
Plugin: The Plugin type describes a Location based services plugin.
-
PluginParameter: The PluginParameter type describes a parameter to a Plugin.
Maps QML Types▲
-
CameraCapabilities: The CameraCapabilities type holds information about the camera capabilities for a specific map type.
-
DynamicParameter: The DynamicParameter (previously MapParameter ) type represents a parameter for a Map element, or other elements used in a Map (such as map items, etc.). This type provides a mean to specify plugin-dependent optional dynamic parameters that allow a plugin to extend the runtime API of the module.
-
Map: The Map type displays a map.
-
MapCircle: The MapCircle type displays a geographic circle on a Map.
-
MapCircleObject: The MapCircleObject displays a circle on a Map.
-
MapCopyrightNotice: The MapCopyrightNotice item displays the current valid copyright notice for a Map element.
-
MapGestureArea: The MapGestureArea type provides Map gesture interaction.
-
MapIconObject: The MapIconObject displays an icon on a Map.
-
MapItemGroup: The MapItemGroup type is a container for map items.
-
MapItemView: The MapItemView is used to populate Map from a model.
-
MapObjectView: The MapObjectView is used to populate Map with map objects from a model.
-
MapPinchEvent: MapPinchEvent type provides basic information about pinch event.
-
MapPolygon: The MapPolygon type displays a polygon on a Map.
-
MapPolygonObject: The MapPolygonObject displays a polygon on a Map.
-
MapPolyline: The MapPolyline type displays a polyline on a map.
-
MapPolylineObject: The MapPolylineObject displays a polyline on a Map.
-
MapQuickItem: The MapQuickItem type displays an arbitrary Qt Quick object on a Map.
-
MapRectangle: The MapRectangle type displays a rectangle on a Map.
-
MapRoute: The MapRoute type displays a Route on a Map.
-
MapRouteObject: The MapRouteObject displays a geographical route on a Map.
-
MapType: The MapType type holds information about a map type.
-
Navigator: The Navigator type offers functionalities to perform turn-by-turn navigation.
Navigation and Routing QML Types▲
Geocoding QML Types▲
-
GeocodeModel: The GeocodeModel type provides support for searching operations related to geographic information.
Places QML Types▲
-
Category: The Category type represents a category that a Place can be associated with.
-
CategoryModel: The CategoryModel type provides a model of the categories supported by a Plugin.
-
ContactDetail: The ContactDetail type holds a contact detail such as a phone number or a website address.
-
ContactDetails: The ContactDetails type holds contact details for a Place.
-
EditorialModel: The EditorialModel type provides a model of place editorials.
-
ExtendedAttributes: The ExtendedAttributes type holds additional data about a Place.
-
Icon: The Icon type represents an icon image source which can have multiple sizes.
-
ImageModel: The ImageModel type provides a model of place images.
-
Place: The Place type represents a location that is a position of interest.
-
PlaceAttribute: The PlaceAttribute type holds generic place attribute information.
-
PlaceSearchModel: Provides access to place search results.
-
PlaceSearchSuggestionModel: Provides access to search term suggestions.
-
Ratings: The 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: The User type identifies a user who contributed a particular Place content item.
Alphabetical Listing of All QML Types▲
Contents▲
-
CameraCapabilities: The CameraCapabilities type holds information about the camera capabilities for a specific map type.
-
Category: The Category type represents a category that a Place can be associated with.
-
CategoryModel: The CategoryModel type provides a model of the categories supported by a Plugin.
-
ContactDetail: The ContactDetail type holds a contact detail such as a phone number or a website address.
-
ContactDetails: The ContactDetails type holds contact details for a Place.
-
DynamicParameter: The DynamicParameter (previously MapParameter ) type represents a parameter for a Map element, or other elements used in a Map (such as map items, etc.). This type provides a mean to specify plugin-dependent optional dynamic parameters that allow a plugin to extend the runtime API of the module.
-
EditorialModel: The EditorialModel type provides a model of place editorials.
-
ExtendedAttributes: The ExtendedAttributes type holds additional data about a Place.
-
GeocodeModel: The GeocodeModel type provides support for searching operations related to geographic information.
-
Icon: The Icon type represents an icon image source which can have multiple sizes.
-
ImageModel: The ImageModel type provides a model of place images.
-
Map: The Map type displays a map.
-
MapCircle: The MapCircle type displays a geographic circle on a Map.
-
MapCopyrightNotice: The MapCopyrightNotice item displays the current valid copyright notice for a Map element.
-
MapGestureArea: The MapGestureArea type provides Map gesture interaction.
-
MapItemGroup: The MapItemGroup type is a container for map items.
-
MapItemView: The MapItemView is used to populate Map from a model.
-
MapPinchEvent: MapPinchEvent type provides basic information about pinch event.
-
MapPolygon: The MapPolygon type displays a polygon on a Map.
-
MapPolyline: The MapPolyline type displays a polyline on a map.
-
MapQuickItem: The MapQuickItem type displays an arbitrary Qt Quick object on a Map.
-
MapRectangle: The MapRectangle type displays a rectangle on a Map.
-
MapRoute: The MapRoute type displays a Route on a Map.
-
MapType: The MapType type holds information about a map type.
-
Place: The Place type represents a location that is a position of interest.
-
PlaceAttribute: The PlaceAttribute type holds generic place attribute information.
-
PlaceSearchModel: Provides access to place search results.
-
PlaceSearchSuggestionModel: Provides access to search term suggestions.
-
Plugin: The Plugin type describes a Location based services plugin.
-
PluginParameter: The PluginParameter type describes a parameter to a Plugin.
-
Ratings: The Ratings type holds place rating information.
-
ReviewModel: Provides access to reviews of a Place.
-
Route: The Route type represents one geographical route.
-
RouteLeg: The RouteLeg type represents a leg of a Route, that is the portion of a route between one waypoint and the next.
-
RouteManeuver: The RouteManeuver type represents the information relevant to the point at which two RouteSegments meet.
-
RouteModel: The RouteModel type provides access to routes.
-
RouteQuery: The RouteQuery type is used to provide query parameters to a RouteModel.
-
RouteSegment: The 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: The User type identifies a user who contributed a particular Place content item.
-
Waypoint: The Waypoint type provides a mean to specify a waypoint in a RouteQuery in a more detailed way than by using a simple coordinate.