qml-qtlocation-maprectangle.html 10.7 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativerectanglemapitem.cpp -->
  <title>MapRectangle QML Type | Qt Location 5.11</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtlocation-index.html">Qt Location</a></td><td ><a href="qtlocation-qmlmodule.html">QML Types</a></td><td >MapRectangle QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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="#details">Detailed Description</a></li>
<li class="level2"><a href="#performance">Performance</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">MapRectangle QML Type</h1>
<span class="subtitle"></span>
<!-- $$$MapRectangle-brief -->
<p>The <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> type displays a rectangle on a Map. <a href="#details">More...</a></p>
<!-- @@@MapRectangle -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtLocation 5.11</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  QtLocation 5.5</td></tr></table></div><ul>
<li><a href="qml-qtlocation-maprectangle-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#border-prop">border</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#border.width-prop">border.width</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#border.color-prop">border.color</a></b></b> : color</li>
</ul>
</li>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#bottomRight-prop">bottomRight</a></b></b> : coordinate</li>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#color-prop">color</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#opacity-prop">opacity</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-maprectangle.html#topLeft-prop">topLeft</a></b></b> : coordinate</li>
</ul>
<!-- $$$MapRectangle-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> type displays a rectangle on a Map. Rectangles are a special case of Polygon with exactly 4 vertices and 4 &quot;straight&quot; edges. In this case, &quot;straight&quot; means that the top-left point has the same latitude as the top-right point (the top edge), and the bottom-left point has the same latitude as the bottom-right point (the bottom edge). Similarly, the points on the left side have the same longitude, and the points on the right side have the same longitude.</p>
<p>To specify the rectangle, it requires a <a href="qml-qtlocation-maprectangle.html#topLeft-prop">topLeft</a> and <a href="qml-qtlocation-maprectangle.html#bottomRight-prop">bottomRight</a> point, both given by a <a href="../qtpositioning/qml-coordinate.html">coordinate</a>.</p>
<p>By default, the rectangle is displayed with transparent fill and a 1-pixel thick black border. This can be changed using the <a href="qml-qtlocation-maprectangle.html#color-prop">color</a>, <a href="qml-qtlocation-maprectangle.html#border.color-prop">border.color</a> and <a href="qml-qtlocation-maprectangle.html#border.width-prop">border.width</a> properties.</p>
<p><b>Note: </b>Similar to the <a href="qml-qtlocation-mappolygon.html">MapPolygon</a> type, MapRectangles are geographic items, thus dragging a <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> causes its vertices to be recalculated in the geographic coordinate space. Apparent stretching of the item occurs when dragged to the a different latitude, however, its edges remain straight.</p><a name="performance"></a>
<h3 >Performance</h3>
<p>MapRectangles have a rendering cost identical to a <a href="qml-qtlocation-mappolygon.html">MapPolygon</a> with 4 vertices.</p>
<p>Like the other map objects, <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> is normally drawn without a smooth appearance. Setting the <a href="qml-qtlocation-maprectangle.html#opacity-prop">opacity</a> property will force the object to be blended, which decreases performance considerably depending on the hardware in use.</p>
<a name="example-usage"></a>
<h3 >Example Usage</h3>
<p>The following snippet shows a map containing a <a href="qml-qtlocation-maprectangle.html">MapRectangle</a>, spanning from (-27, 153) to (-28, 153.5), near Brisbane, Australia. The rectangle is filled in green, with a 2 pixel black border.</p>
<pre class="cpp">

  Map {
      MapRectangle {
          color: <span class="char">'green'</span>
          border<span class="operator">.</span>width: <span class="number">2</span>
          topLeft {
              latitude: <span class="operator">-</span><span class="number">27</span>
              longitude: <span class="number">153</span>
          }
          bottomRight {
              latitude: <span class="operator">-</span><span class="number">28</span>
              longitude: <span class="number">153.5</span>
          }
      }
  }

</pre>
<p class="centerAlign"><img src="images/api-maprectangle.png" alt="" /></p><!-- @@@MapRectangle -->
<h2>Property Documentation</h2>
<!-- $$$border -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="border-prop"><th class="centerAlign"><p><a name="border-prop"></a><b>border group</b></p></th></tr><tr valign="top" class="odd" id="border.width-prop"><td class="tblQmlPropNode"><p><a name="border.width-prop"></a><span class="name">border.width</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr><tr valign="top" class="odd" id="border.color-prop"><td class="tblQmlPropNode"><p><a name="border.color-prop"></a><span class="name">border.color</span> : <span class="type"><a href="../qtquick/qml-color.html">color</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property is part of the border property group. The border property group holds the width and color used to draw the border of the rectangle. The width is in pixels and is independent of the zoom level of the map.</p>
<p>The default values correspond to a black border with a width of 1 pixel. For no line, use a width of 0 or a transparent color.</p>
</div></div><!-- @@@border -->
<br/>
<!-- $$$bottomRight -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="bottomRight-prop">
<td class="tblQmlPropNode"><p>
<a name="bottomRight-prop"></a><span class="name">bottomRight</span> : <span class="type"><a href="../qtpositioning/qml-coordinate.html">coordinate</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the bottom-right coordinate of the <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> which can be used to retrieve its longitude, latitude and altitude.</p>
</div></div><!-- @@@bottomRight -->
<br/>
<!-- $$$color -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="color-prop">
<td class="tblQmlPropNode"><p>
<a name="color-prop"></a><span class="name">color</span> : <span class="type"><a href="../qtquick/qml-color.html">color</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the fill color of the rectangle. For no fill, use a transparent color.</p>
</div></div><!-- @@@color -->
<br/>
<!-- $$$opacity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="opacity-prop">
<td class="tblQmlPropNode"><p>
<a name="opacity-prop"></a><span class="name">opacity</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the opacity of the item. Opacity is specified as a number between 0 (fully transparent) and 1 (fully opaque). The default is 1.</p>
<p>An item with 0 opacity will still receive mouse events. To stop mouse events, set the visible property of the item to false.</p>
</div></div><!-- @@@opacity -->
<br/>
<!-- $$$topLeft -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="topLeft-prop">
<td class="tblQmlPropNode"><p>
<a name="topLeft-prop"></a><span class="name">topLeft</span> : <span class="type"><a href="../qtpositioning/qml-coordinate.html">coordinate</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the top-left coordinate of the <a href="qml-qtlocation-maprectangle.html">MapRectangle</a> which can be used to retrieve its longitude, latitude and altitude.</p>
</div></div><!-- @@@topLeft -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed 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.<br/>    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. </p>
</div>
</body>
</html>