- Qt 6.8
- Qt Location
- Qt Location QML Types
- Qt 6.8.0 Reference Documentation

# Qt Location QML Types

## Overview

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

Plugin | Type describes a Location based services plugin
PluginParameter | Type describes a parameter for a plugin

## Maps QML Types

GeoJsonData | A model to represent, load and save GeoJSON documents
Map | Type displays a map
MapCircle | Type displays a geographic circle on a Map
MapCopyrightNotice | Item displays the current valid copyright notice for a Map element
MapItemGroup | Type is a container for map items
MapItemView | Used to populate Map from a model
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
cameraCapabilities | Type holds information about the camera capabilities for a specific map type
mapType | Type holds information about a map type

## Navigation and Routing QML Types

RouteModel | Type provides access to routes
RouteQuery | Type is used to provide query parameters to a RouteModel
route | Type represents one geographical route
routeManeuver | Type represents the information relevant to the point at which two routeSegments meet
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
ContactDetails | Type holds contact details for a Place
EditorialModel | Type provides a model of place editorials
ExtendedAttributes | Type holds additional data about a Place
ImageModel | Type provides a model of place images
Place | Type represents a location that is a position of interest
PlaceSearchModel | Provides access to place search results
PlaceSearchSuggestionModel | Provides access to search term suggestions
ReviewModel | Type provides a model of place reviews
contactDetail | Type holds a contact detail such as a phone number or a website address
icon | Type represents the icon of a place
placeAttribute | Type holds generic place attribute information
ratings | Type holds place rating information
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
ContactDetails | Type holds contact details for a Place
EditorialModel | Type provides a model of place editorials
ExtendedAttributes | Type holds additional data about a Place
GeoJsonData | A model to represent, load and save GeoJSON documents
GeocodeModel | Type provides support for searching operations related to geographic information
ImageModel | Type provides a model of place images
Map | Type displays a map
MapCircle | Type displays a geographic circle on a Map
MapCopyrightNotice | Item displays the current valid copyright notice for a Map element
MapItemGroup | Type is a container for map items
MapItemView | Used to populate Map from a model
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
MapView | An interactive map viewer component
Place | Type represents a location that is a position of interest
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 for a plugin
ReviewModel | Type provides a model of place reviews
RouteModel | Type provides access to routes
RouteQuery | Type is used to provide query parameters to a RouteModel
cameraCapabilities | Type holds information about the camera capabilities for a specific map type
contactDetail | Type holds a contact detail such as a phone number or a website address
icon | Type represents the icon of a place
mapType | Type holds information about a map type
placeAttribute | Type holds generic place attribute information
ratings | Type holds place rating information
route | Type represents one geographical route
routeManeuver | Type represents the information relevant to the point at which two routeSegments meet
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