<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativegraphicsgeomap.cpp -->
<title>Qt Mobility 1.2: QML Map Element</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="http://qt.nokia.com/doc/4.7/qdeclarativeelements.html">QML Elements</a></li>
<li>QML Map Element</li>
</ul>
</div>
</div>
<div class="content mainContent">
<p class="naviNextPrevious headerNavi">
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QML Map Element</h1>
<span class="subtitle"></span>
<!-- $$$Map-brief -->
<p>The Map element displays a map. <a href="#details">More...</a></p>
<!-- @@@Map -->
<p>This element was introduced in Mobility 1.2.</p>
<ul>
<li><a href="qml-map-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-map.html#center-prop">center</a></b></b> : Coordinate</li>
<li class="fn"><b><b><a href="qml-map.html#connectivityMode-prop">connectivityMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-map.html#mapType-prop">mapType</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-map.html#maximumZoomLevel-prop">maximumZoomLevel</a></b></b> : qreal</li>
<li class="fn"><b><b><a href="qml-map.html#minimumZoomLevel-prop">minimumZoomLevel</a></b></b> : qreal</li>
<li class="fn"><b><b><a href="qml-map.html#plugin-prop">plugin</a></b></b> : Plugin</li>
<li class="fn"><b><b><a href="qml-map.html#size-prop">size</a></b></b> : QSizeF</li>
<li class="fn"><b><b><a href="qml-map.html#zoomLevel-prop">zoomLevel</a></b></b> : qreal</li>
</ul>
<a name="methods"></a>
<h2>Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-map.html#addMapObject-method">addMapObject</a></b></b></li>
<li class="fn"><b><b><a href="qml-map.html#removeMapObject-method">removeMapObject</a></b></b></li>
<li class="fn"><b><b><a href="qml-map.html#toCoordinate-method">toCoordinate</a></b></b></li>
<li class="fn"><b><b><a href="qml-map.html#toScreenPosition-method">toScreenPosition</a></b></b></li>
</ul>
<!-- $$$Map-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>The Map element can be used be used to display a map of the world. The bulk of the functionality is provided by a mapping plugin described by the Plugin element associated with the Map.</p>
<p>Various map objects can be added to the map. These map objects are specified in terms of coordinates and metres.</p>
<p>MapObjects can be directly added to the Map element and it will display them automatically. The various objects that can be added include:</p>
<ul>
<li><a href="qml-maprectangle.html">MapRectangle</a></li>
<li><a href="qml-mapcircle.html">MapCircle</a></li>
<li><a href="qml-maptext.html">MapText</a></li>
<li><a href="qml-mapimage.html">MapImage</a></li>
<li><a href="qml-mappolygon.html">MapPolygon</a></li>
<li><a href="qml-mappolyline.html">MapPolyline</a></li>
<li><a href="qml-mapgroup.html">MapGroup</a></li>
<li><a href="qml-mapobjectview.html">MapObjectView</a></li>
</ul>
<p>Of the above list, <a href="qml-mapobjectview.html">MapObjectView</a> is a special case and not a MapObject as such. Here is a small example to illustrate this:</p>
<pre class="qml"> <span class="type">Map</span> {
<span class="name">id</span>: <span class="name">map</span>
<span class="name">plugin</span> : <span class="name">Plugin</span> {<span class="name">name</span> : <span class="string">"nokia"</span>}
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">size</span>.width: <span class="name">parent</span>.<span class="name">width</span>
<span class="name">size</span>.height: <span class="name">parent</span>.<span class="name">height</span>
<span class="name">zoomLevel</span>: <span class="number">10</span>
<span class="type"><a href="qml-mapobjectview.html">MapObjectView</a></span> {
<span class="name">id</span>: <span class="name">allLandmarks</span>
<span class="name">model</span>: <span class="name">landmarkModelAll</span>
<span class="name">delegate</span>: <span class="name">Component</span> {
<span class="type"><a href="qml-mapcircle.html">MapCircle</a></span> {
<span class="name">color</span>: <span class="string">"green"</span>
<span class="name">radius</span>: <span class="number">1000</span>
<span class="name">center</span>: <span class="name">Coordinate</span> {
<span class="name">latitude</span>: <span class="name">landmark</span>.<span class="name">coordinate</span>.<span class="name">latitude</span>
<span class="name">longitude</span>: <span class="name">landmark</span>.<span class="name">coordinate</span>.<span class="name">longitude</span>
}
}
}
}
<span class="type"><a href="qml-mapcircle.html">MapCircle</a></span> {
<span class="name">id</span>: <span class="name">myPosition</span>
<span class="name">color</span>: <span class="string">"yellow"</span>
<span class="name">radius</span>: <span class="number">1000</span>
<span class="name">center</span>: <span class="name">myPositionSource</span>.<span class="name">position</span>.<span class="name">coordinate</span>
}</pre>
<p>Mouse handling is done by adding <a href="qml-mapmousearea.html">MapMouseArea</a> items as children of either MapObjects or the Map item itself.</p>
<p>The Map element is part of the <b>QtMobility.location 1.2</b> module.</p>
<p><b>API break notice:</b> compared to preliminary 1.1 API version, the 1.2 API does not have the objects -property.</p>
<!-- @@@Map -->
<h2>Property Documentation</h2>
<!-- $$$center -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="center-prop"></a><span class="name">center</span> : <span class="type"><a href="qml-coordinate.html">Coordinate</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the coordinate which occupies the center of the mapping viewport.</p>
<p>The default value is an arbitrary valid coordinate.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@center -->
<br/>
<!-- $$$connectivityMode -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="connectivityMode-prop"></a><span class="name">connectivityMode</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the connectivity mode used to fetch the map data.</p>
<p>The mode can be one of:</p>
<ul>
<li>Map.OfflineMode</li>
<li>Map.OnlineMode</li>
<li>Map.HybridMode</li>
</ul>
<p>The default value is determined by the plugin.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@connectivityMode -->
<br/>
<!-- $$$mapType -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="mapType-prop"></a><span class="name">mapType</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-enumeration.html">enumeration</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the type of map to display.</p>
<p>The type can be one of:</p>
<ul>
<li>Map.StreetMap</li>
<li>Map.SatelliteMapDay</li>
<li>Map.SatelliteMapNight</li>
<li>Map.TerrainMap</li>
<li>Map.HybridMap</li>
<li>Map.TransitMap</li>
<li>Map.GrayStreetMap</li>
<li>Map.MobileStreetMap</li>
<li>Map.MobileTerrainMap</li>
<li>Map.MobileHybridMap</li>
<li>Map.MobileTransitMap</li>
<li>Map.MobileGrayStreetMap</li>
</ul>
<p>The default value is determined by the plugin.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@mapType -->
<br/>
<!-- $$$maximumZoomLevel -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="maximumZoomLevel-prop"></a><span class="name">maximumZoomLevel</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the maximum valid zoom level for the map.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@maximumZoomLevel -->
<br/>
<!-- $$$minimumZoomLevel -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="minimumZoomLevel-prop"></a><span class="name">minimumZoomLevel</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the minimum valid zoom level for the map.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@minimumZoomLevel -->
<br/>
<!-- $$$plugin -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="plugin-prop"></a><span class="name">plugin</span> : <span class="type"><a href="qml-plugin.html">Plugin</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the plugin which provides the mapping functionality.</p>
<p>This is write-once property. Once the map has a plugin associated with it any attempted modifications of the plugin will be ignored.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@plugin -->
<br/>
<!-- $$$size -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="size-prop"></a><span class="name">size</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qsizef.html">QSizeF</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the size of the map viewport.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@size -->
<br/>
<!-- $$$zoomLevel -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="zoomLevel-prop"></a><span class="name">zoomLevel</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the zoom level for the map.</p>
<p>Larger values for the zoom level provide more detail.</p>
<p>The default value is 8.0.</p>
<p>This property group was introduced in Mobility 1.2.</p>
</div></div><!-- @@@zoomLevel -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$addMapObject -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="addMapObject-method"></a>Map::<span class="name">addMapObject</span> ( <span class="type">MapObject</span> )</p></td></tr></table></div><div class="qmldoc"><p>Adds the given MapOject to the Map. If the object already is on the Map, it will not be added again.</p>
<p>As an example, consider you have a <a href="qml-mapcircle.html">MapCircle</a> presenting your current position:</p>
<pre class="qml"> <span class="type"><a href="qml-mapcircle.html">MapCircle</a></span> {
<span class="name">id</span>: <span class="name">myPositionMarker</span>
<span class="name">center</span>: <span class="name">myPositionSource</span>.<span class="name">position</span>.<span class="name">coordinate</span>
<span class="name">radius</span>: <span class="number">100</span>
<span class="name">color</span>: <span class="string">"yellow"</span>
}</pre>
<p>You can add it to Map (alterntively it can be defined as a child element of the Map):</p>
<pre class="qml"> <span class="name">onButton2Clicked</span>: {
<span class="name">map</span>.<span class="name">addMapObject</span>(<span class="name">myPositionMarker</span>)
}</pre>
<p>Note: MapObjectViews can not be added with this method.</p>
<p>This documentation was introduced in Mobility 1.2.</p>
</div></div><!-- @@@addMapObject -->
<br/>
<!-- $$$removeMapObject -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="removeMapObject-method"></a>Map::<span class="name">removeMapObject</span> ( <span class="type">MapObject</span> )</p></td></tr></table></div><div class="qmldoc"><p>Removes the given MapObject from the Map. If the MapObject does not exist, function does nothing.</p>
<p>As an example, consider you have a <a href="qml-mapcircle.html">MapCircle</a> presenting your current position:</p>
<pre class="qml"> <span class="type"><a href="qml-mapcircle.html">MapCircle</a></span> {
<span class="name">id</span>: <span class="name">myPositionMarker</span>
<span class="name">center</span>: <span class="name">myPositionSource</span>.<span class="name">position</span>.<span class="name">coordinate</span>
<span class="name">radius</span>: <span class="number">100</span>
<span class="name">color</span>: <span class="string">"yellow"</span>
}</pre>
<p>You can remove it from the Map element:</p>
<pre class="qml"> <span class="name">onButton1Clicked</span>: {
<span class="name">map</span>.<span class="name">removeMapObject</span>(<span class="name">myPositionMarker</span>)
}</pre>
<p>This documentation was introduced in Mobility 1.2.</p>
</div></div><!-- @@@removeMapObject -->
<br/>
<!-- $$$toCoordinate -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="toCoordinate-method"></a>Map::<span class="name">toCoordinate</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qpointf.html">QPointF</a></span> <i>screenPosition</i> )</p></td></tr></table></div><div class="qmldoc"><p>Returns the coordinate which corresponds to the screen position <i>screenPosition</i>.</p>
<p>Returns an invalid coordinate if <i>screenPosition</i> is not within the current viewport.</p>
<p>An example to constraint landmarks of a model to just those currently on Map:</p>
<pre class="qml"> <span class="type"><a href="qml-landmarkboxfilter.html">LandmarkBoxFilter</a></span> {
<span class="name">id</span>: <span class="name">boxFilter</span>
<span class="name">topLeft</span>: <span class="name">map</span>.<span class="name">toCoordinate</span>(<span class="name">Qt</span>.<span class="name">point</span>(<span class="number">0</span>,<span class="number">0</span>))
<span class="name">bottomRight</span>: <span class="name">map</span>.<span class="name">toCoordinate</span>(<span class="name">Qt</span>.<span class="name">point</span>(<span class="name">map</span>.<span class="name">width</span>, <span class="name">map</span>.<span class="name">height</span>))
}</pre>
<p>This documentation was introduced in Mobility 1.2.</p>
</div></div><!-- @@@toCoordinate -->
<br/>
<!-- $$$toScreenPosition -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="toScreenPosition-method"></a>Map::<span class="name">toScreenPosition</span> ( <span class="type"><a href="qml-coordinate.html">Coordinate</a></span> <i>coordinate</i> )</p></td></tr></table></div><div class="qmldoc"><p>Returns the screen position which corresponds to the coordinate <i>coordinate</i>.</p>
<p>Returns an invalid <a href="http://qt.nokia.com/doc/4.7/qpointf.html">QPointF</a> if <i>coordinate</i> is not within the current viewport.</p>
<p>This documentation was introduced in Mobility 1.2.</p>
</div></div><!-- @@@toScreenPosition -->
<br/>
<p class="naviNextPrevious footerNavi">
</p>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
Free Documentation License version 1.3</a>
as published by the Free Software Foundation.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1322
