<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- declarativeboxplotseries.cpp --> <title>BoxSet QML Type | Qt Charts 5.12.6</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 >Qt 5.12</td><td ><a href="qtcharts-index.html">Qt Charts</a></td><td ><a href="qtcharts-qmlmodule.html">QML Types</a></td><td >BoxSet QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtcharts-index.html">Qt Charts | Commercial or GPLv3</a></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="#signals">Signals</a></li> <li class="level1"><a href="#methods">Methods</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">BoxSet QML Type</h1> <span class="subtitle"></span> <!-- $$$BoxSet-brief --> <p>Represents one item in a box-and-whiskers chart. <a href="#details">More...</a></p> <!-- @@@BoxSet --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtCharts 2.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-boxset.html"><a href="qboxset.html">QBoxSet</a></td></tr></table></div><ul> <li><a href="qml-qtcharts-boxset-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-qtcharts-boxset.html#brushFilename-prop">brushFilename</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#count-prop">count</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#label-prop">label</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#values-prop">values</a></b></b> : list</li> </ul> <a name="signals"></a> <h2 id="signals">Signals</h2> <ul> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#cleared-signal">cleared</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#clicked-signal">clicked</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#doubleClicked-signal">doubleClicked</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#hovered-signal">hovered</a></b></b>(bool <i>status</i>)</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#pressed-signal">pressed</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#released-signal">released</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#valueChanged-signal">valueChanged</a></b></b>(int <i>index</i>)</li> <li class="fn"><b><b><a href="qml-qtcharts-boxset.html#valuesChanged-signal">valuesChanged</a></b></b>()</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">void <b><b><a href="qml-qtcharts-boxset.html#append-method">append</a></b></b>(qreal <i>value</i>)</li> <li class="fn">void <b><b><a href="qml-qtcharts-boxset.html#at-method">at</a></b></b>(int <i>index</i>)</li> <li class="fn">void <b><b><a href="qml-qtcharts-boxset.html#clear-method">clear</a></b></b>()</li> <li class="fn">void <b><b><a href="qml-qtcharts-boxset.html#setValue-method">setValue</a></b></b>(int <i>index</i>, qreal <i>value</i>)</li> </ul> <!-- $$$BoxSet-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>A box-and-whiskers item is a graphical representation of a range and three median values that is constructed from five different values. There are two ways to specify the values. The first one is by using a constructor or the <a href="qml-qtcharts-boxset.html#append-method">append()</a> method. The values have to be specified in the following order: lower extreme, lower quartile, median, upper quartile, and upper extreme.</p> <p>The second way is to create an empty <a href="qml-qtcharts-boxset.html">BoxSet</a> instance and specify the values using the <a href="qml-qtcharts-boxset.html#setValue-method">setValue()</a> method.</p> <p><b>See also </b><a href="qml-qtcharts-boxplotseries.html">BoxPlotSeries</a>.</p> <!-- @@@BoxSet --> <h2>Property Documentation</h2> <!-- $$$brushFilename --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="brushFilename-prop"> <td class="tblQmlPropNode"><p> <a name="brushFilename-prop"></a><span class="name">brushFilename</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The name of the file used as a brush for the box-and-whiskers item.</p> </div></div><!-- @@@brushFilename --> <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">int</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The number of values of the box-and-whiskers item.</p> </div></div><!-- @@@count --> <br/> <!-- $$$label --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="label-prop"> <td class="tblQmlPropNode"><p> <a name="label-prop"></a><span class="name">label</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The label of the category of the box-and-whiskers item.</p> </div></div><!-- @@@label --> <br/> <!-- $$$values --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="values-prop"> <td class="tblQmlPropNode"><p> <a name="values-prop"></a><span class="name">values</span> : <span class="type">list</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The values of the box-and-whiskers item. The following enumerations can be used as indexes when accessing the list of values:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>BoxSet.LowerExtreme</code></td><td class="topAlign">The smallest value of the box-and-whiskers item.</td></tr> <tr><td class="topAlign"><code>BoxSet.LowerQuartile</code></td><td class="topAlign">The median value of the lower half of the box-and-whiskers item.</td></tr> <tr><td class="topAlign"><code>BoxSet.Median</code></td><td class="topAlign">The median value of the box-and-whiskers item.</td></tr> <tr><td class="topAlign"><code>BoxSet.UpperQuartile</code></td><td class="topAlign">The median value of the upper half of the box-and-whiskers item.</td></tr> <tr><td class="topAlign"><code>BoxSet.UpperExtreme</code></td><td class="topAlign">The largest value of the box-and-whiskers item.</td></tr> </table></div> <p><b>See also </b><a href="qml-qtcharts-boxset.html#at-method">at()</a> and <a href="qml-qtcharts-boxset.html#setValue-method">setValue()</a>.</p> </div></div><!-- @@@values --> <br/> <h2>Signal Documentation</h2> <!-- $$$cleared --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="cleared-signal"> <td class="tblQmlFuncNode"><p> <a name="cleared-signal"></a><span class="name">cleared</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when all the values of the box-and-whiskers item are set to 0.</p> <p>The corresponding signal handler is <code>onCleared()</code>.</p> </div></div><!-- @@@cleared --> <br/> <!-- $$$clicked --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="clicked-signal"> <td class="tblQmlFuncNode"><p> <a name="clicked-signal"></a><span class="name">clicked</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the user clicks a box-and-whiskers item in the chart.</p> <p>The corresponding signal handler is <code>onClicked()</code>.</p> </div></div><!-- @@@clicked --> <br/> <!-- $$$doubleClicked --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="doubleClicked-signal"> <td class="tblQmlFuncNode"><p> <a name="doubleClicked-signal"></a><span class="name">doubleClicked</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the user double-clicks a box-and-whiskers item.</p> <p>The corresponding signal handler is <code>onDoubleClicked()</code>.</p> </div></div><!-- @@@doubleClicked --> <br/> <!-- $$$hovered --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="hovered-signal"> <td class="tblQmlFuncNode"><p> <a name="hovered-signal"></a><span class="name">hovered</span>(<span class="type">bool</span> <i>status</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse is hovered over a box-and-whiskers item in a chart. When the mouse moves over the item, <i>status</i> turns <code>true</code>, and when the mouse moves away again, it turns <code>false</code>.</p> <p>The corresponding signal handler is <code>onHovered()</code>.</p> </div></div><!-- @@@hovered --> <br/> <!-- $$$pressed --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pressed-signal"> <td class="tblQmlFuncNode"><p> <a name="pressed-signal"></a><span class="name">pressed</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the user clicks a box-and-whiskers item in the chart and holds down the mouse button.</p> <p>The corresponding signal handler is <code>onPressed</code>.</p> </div></div><!-- @@@pressed --> <br/> <!-- $$$released --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="released-signal"> <td class="tblQmlFuncNode"><p> <a name="released-signal"></a><span class="name">released</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the user releases the mouse press on a box-and-whiskers item.</p> <p>The corresponding signal handler is <code>onReleased()</code>.</p> </div></div><!-- @@@released --> <br/> <!-- $$$valueChanged --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="valueChanged-signal"> <td class="tblQmlFuncNode"><p> <a name="valueChanged-signal"></a><span class="name">valueChanged</span>(<span class="type">int</span> <i>index</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the value of the box-and-whiskers item specified by <i>index</i> changes.</p> <p>The corresponding signal handler is <code>onValueChanged()</code>.</p> </div></div><!-- @@@valueChanged --> <br/> <!-- $$$valuesChanged --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="valuesChanged-signal"> <td class="tblQmlFuncNode"><p> <a name="valuesChanged-signal"></a><span class="name">valuesChanged</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when multiple values of the box-and-whiskers item change.</p> <p>The corresponding signal handler is <code>onValuesChanged()</code>.</p> </div></div><!-- @@@valuesChanged --> <br/> <h2>Method Documentation</h2> <!-- $$$append --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="append-method"> <td class="tblQmlFuncNode"><p> <a name="append-method"></a><span class="type">void</span> <span class="name">append</span>(<span class="type">qreal</span> <i>value</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Appends the new value specified by <i>value</i> to the end of the box-and-whiskers item.</p> </div></div><!-- @@@append --> <br/> <!-- $$$at --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="at-method"> <td class="tblQmlFuncNode"><p> <a name="at-method"></a><span class="type">void</span> <span class="name">at</span>(<span class="type">int</span> <i>index</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Returns the value in the position specified by <i>index</i>.</p> </div></div><!-- @@@at --> <br/> <!-- $$$clear --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="clear-method"> <td class="tblQmlFuncNode"><p> <a name="clear-method"></a><span class="type">void</span> <span class="name">clear</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Sets all the values of the box-and-whiskers item to 0.</p> </div></div><!-- @@@clear --> <br/> <!-- $$$setValue --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="setValue-method"> <td class="tblQmlFuncNode"><p> <a name="setValue-method"></a><span class="type">void</span> <span class="name">setValue</span>(<span class="type">int</span> <i>index</i>, <span class="type">qreal</span> <i>value</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Sets the value specified by <i>value</i> in the position specified by <i>index</i>.</p> </div></div><!-- @@@setValue --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 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>