<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qdeclarativeratings.cpp --> <title>Ratings 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 >Ratings 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> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">Ratings QML Type</h1> <span class="subtitle"></span> <!-- $$$Ratings-brief --> <p>The Ratings type holds place rating information. <a href="#details">More...</a></p> <!-- @@@Ratings --> <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-ratings-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-ratings.html#average-prop">average</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtlocation-ratings.html#count-prop">count</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-qtlocation-ratings.html#maximum-prop">maximum</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtlocation-ratings.html#ratings-prop">ratings</a></b></b> : QPlaceRatings</li> </ul> <!-- $$$Ratings-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>Rating information is used to describe how <i>good</i> a place is conceived to be. Typically this information is visualized as a number of stars. The <a href="qml-qtlocation-ratings.html#average-prop">average</a> property gives an aggregated ratings value out of a possible maximum as given by the <a href="qml-qtlocation-ratings.html#maximum-prop">maximum</a> property.</p> <pre class="qml"> import QtQuick 2.0 import QtPositioning 5.5 import QtLocation 5.6 <span class="type"><a href="../qtquick/qml-qtquick-text.html">Text</a></span> { <span class="name">text</span>: <span class="string">"This place is rated "</span> <span class="operator">+</span> <span class="name">place</span>.<span class="name">ratings</span>.<span class="name">average</span> <span class="operator">+</span> <span class="string">" out of "</span> <span class="operator">+</span> <span class="name">place</span>.<span class="name">ratings</span>.<span class="name">maximum</span> <span class="operator">+</span> <span class="string">" stars."</span> } </pre> <!-- @@@Ratings --> <h2>Property Documentation</h2> <!-- $$$average --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="average-prop"> <td class="tblQmlPropNode"><p> <a name="average-prop"></a><span class="name">average</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 average of the individual ratings.</p> <p><b>See also </b><a href="qml-qtlocation-ratings.html#maximum-prop">maximum</a>.</p> </div></div><!-- @@@average --> <br/> <!-- $$$count --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="count-prop"> <td class="tblQmlPropNode"><p> <a name="count-prop"></a><span class="name">count</span> : <span class="type"><a href="../qtqml/qml-int.html">int</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the total number of individual user ratings used in determining the overall ratings <a href="qml-qtlocation-ratings.html#average-prop">average</a>.</p> </div></div><!-- @@@count --> <br/> <!-- $$$maximum --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="maximum-prop"> <td class="tblQmlPropNode"><p> <a name="maximum-prop"></a><span class="name">maximum</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 maximum rating value.</p> </div></div><!-- @@@maximum --> <br/> <!-- $$$ratings --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="ratings-prop"> <td class="tblQmlPropNode"><p> <a name="ratings-prop"></a><span class="name">ratings</span> : <span class="type">QPlaceRatings</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>For details on how to use this property to interface between C++ and QML see "<a href="location-cpp-qml.html#ratings-qplaceratings">Interfaces between C++ and QML Code</a>".</p> </div></div><!-- @@@ratings --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>