<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qhboxplotmodelmapper.cpp --> <title>QHBoxPlotModelMapper Class | Qt Charts 5.9</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.9</td><td ><a href="qtcharts-index.html">Qt Charts</a></td><td ><a href="qt-charts-module.html">C++ Classes</a></td><td >QHBoxPlotModelMapper</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#public-functions">Public Functions</a></li> <li class="level1"><a href="#signals">Signals</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">QHBoxPlotModelMapper Class</h1> <!-- $$$QHBoxPlotModelMapper-brief --> <p>The <a href="qhboxplotmodelmapper.html">QHBoxPlotModelMapper</a> class is a horizontal model mapper for box plot series. <a href="#details">More...</a></p> <!-- @@@QHBoxPlotModelMapper --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QHBoxPlotModelMapper></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-hboxplotmodelmapper.html">HBoxPlotModelMapper</a></td></tr></table></div><ul> <li><a href="qhboxplotmodelmapper-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <div class="table"><table class="propsummary"> <tr><td class="topAlign"><ul> <li class="fn"><b><a href="qhboxplotmodelmapper.html#columnCount-prop">columnCount</a></b> : int</li> <li class="fn"><b><a href="qhboxplotmodelmapper.html#firstBoxSetRow-prop">firstBoxSetRow</a></b> : int</li> <li class="fn"><b><a href="qhboxplotmodelmapper.html#firstColumn-prop">firstColumn</a></b> : int</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qhboxplotmodelmapper.html#lastBoxSetRow-prop">lastBoxSetRow</a></b> : int</li> <li class="fn"><b><a href="qhboxplotmodelmapper.html#model-prop">model</a></b> : QAbstractItemModel *</li> <li class="fn"><b><a href="qhboxplotmodelmapper.html#series-prop">series</a></b> : QBoxPlotSeries *</li> </ul> </td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#QHBoxPlotModelMapper">QHBoxPlotModelMapper</a></b>(QObject *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#columnCount-prop">columnCount</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstBoxSetRow-prop">firstBoxSetRow</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstColumn-prop">firstColumn</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#lastBoxSetRow-prop">lastBoxSetRow</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#model-prop">model</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QBoxPlotSeries *</td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#series-prop">series</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#columnCount-prop">setColumnCount</a></b>(int <i>rowCount</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstBoxSetRow-prop">setFirstBoxSetRow</a></b>(int <i>firstBoxSetRow</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstColumn-prop">setFirstColumn</a></b>(int <i>firstColumn</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#lastBoxSetRow-prop">setLastBoxSetRow</a></b>(int <i>lastBoxSetRow</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#model-prop">setModel</a></b>(QAbstractItemModel *<i>model</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#series-prop">setSeries</a></b>(QBoxPlotSeries *<i>series</i>)</td></tr> </table></div> <a name="signals"></a> <h2 id="signals">Signals</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#columnCountChanged">columnCountChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstBoxSetRowChanged">firstBoxSetRowChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#firstColumnChanged">firstColumnChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#lastBoxSetRowChanged">lastBoxSetRowChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#modelReplaced">modelReplaced</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhboxplotmodelmapper.html#seriesReplaced">seriesReplaced</a></b>()</td></tr> </table></div> <a name="details"></a> <!-- $$$QHBoxPlotModelMapper-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qhboxplotmodelmapper.html">QHBoxPlotModelMapper</a> class is a horizontal model mapper for box plot series.</p> <p>Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A horizontal model mapper is used to create a connection between a data model and <a href="qboxplotseries.html">QBoxPlotSeries</a> object, so that each row in the data model defines a box-and-whiskers item and each column maps to the range and three median values of the box-and-whiskers item.</p> <p>Both model and series properties can be used to manipulate the data. The model mapper keeps the series and the data model in sync.</p> <p>The model mapper ensures that all the box-and-whiskers items in the box plot series have equal sizes. Therefore, adding or removing a value from a box-and-whiskers item causes the same change to be made in all the box-and-whiskers items in the box plot series.</p> </div> <p><b>See also </b><a href="qvboxplotmodelmapper.html">QVBoxPlotModelMapper</a>.</p> <!-- @@@QHBoxPlotModelMapper --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$columnCount-prop$$$columnCount$$$setColumnCountint$$$columnCountChanged --> <h3 class="fn" id="columnCount-prop"><a name="columnCount-prop"></a><span class="name">columnCount</span> : <span class="type">int</span></h3> <p>This property holds the number of columns of the model that are mapped as the data for the box plot series.</p> <p>The minimum and default value is -1 (number limited to the number of columns in the model).</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>columnCount</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setColumnCount</b></span>(int <i>rowCount</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#columnCountChanged">columnCountChanged</a></b></span>()</td></tr> </table></div> <!-- @@@columnCount --> <!-- $$$firstBoxSetRow-prop$$$firstBoxSetRow$$$setFirstBoxSetRowint$$$firstBoxSetRowChanged --> <h3 class="fn" id="firstBoxSetRow-prop"><a name="firstBoxSetRow-prop"></a><span class="name">firstBoxSetRow</span> : <span class="type">int</span></h3> <p>This property holds the row of the model that is used as the data source for the first box-and-whiskers item.</p> <p>The default value is -1 (invalid mapping).</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>firstBoxSetRow</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstBoxSetRow</b></span>(int <i>firstBoxSetRow</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#firstBoxSetRowChanged">firstBoxSetRowChanged</a></b></span>()</td></tr> </table></div> <!-- @@@firstBoxSetRow --> <!-- $$$firstColumn-prop$$$firstColumn$$$setFirstColumnint$$$firstColumnChanged --> <h3 class="fn" id="firstColumn-prop"><a name="firstColumn-prop"></a><span class="name">firstColumn</span> : <span class="type">int</span></h3> <p>This property holds the column of the model that contains the first values of the box-and-whiskers items in the box plot series.</p> <p>The minimum and default value is 0.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>firstColumn</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstColumn</b></span>(int <i>firstColumn</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#firstColumnChanged">firstColumnChanged</a></b></span>()</td></tr> </table></div> <!-- @@@firstColumn --> <!-- $$$lastBoxSetRow-prop$$$lastBoxSetRow$$$setLastBoxSetRowint$$$lastBoxSetRowChanged --> <h3 class="fn" id="lastBoxSetRow-prop"><a name="lastBoxSetRow-prop"></a><span class="name">lastBoxSetRow</span> : <span class="type">int</span></h3> <p>This property holds the row of the model that is used as the data source for the last box-and-whiskers item.</p> <p>The default value is -1 (invalid mapping).</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>lastBoxSetRow</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLastBoxSetRow</b></span>(int <i>lastBoxSetRow</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#lastBoxSetRowChanged">lastBoxSetRowChanged</a></b></span>()</td></tr> </table></div> <!-- @@@lastBoxSetRow --> <!-- $$$model-prop$$$model$$$setModelQAbstractItemModel*$$$modelReplaced --> <h3 class="fn" id="model-prop"><a name="model-prop"></a><span class="name">model</span> : <span class="type">QAbstractItemModel</span> *</h3> <p>This property holds the model that is used by the mapper.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><span class="name"><b>model</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setModel</b></span>(QAbstractItemModel *<i>model</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#modelReplaced">modelReplaced</a></b></span>()</td></tr> </table></div> <!-- @@@model --> <!-- $$$series-prop$$$series$$$setSeriesQBoxPlotSeries*$$$seriesReplaced --> <h3 class="fn" id="series-prop"><a name="series-prop"></a><span class="name">series</span> : <span class="type"><a href="qboxplotseries.html">QBoxPlotSeries</a></span> *</h3> <p>This property holds the box plot series that is used by the mapper.</p> <p>All the data in the series is discarded when it is set to the mapper. When a new series is specified, the old series is disconnected (but it preserves its data).</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QBoxPlotSeries *</td><td class="memItemRight bottomAlign"><span class="name"><b>series</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSeries</b></span>(QBoxPlotSeries *<i>series</i>)</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhboxplotmodelmapper.html#seriesReplaced">seriesReplaced</a></b></span>()</td></tr> </table></div> <!-- @@@series --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QHBoxPlotModelMapper[overload1]$$$QHBoxPlotModelMapperQObject* --> <h3 class="fn" id="QHBoxPlotModelMapper"><a name="QHBoxPlotModelMapper"></a>QHBoxPlotModelMapper::<span class="name">QHBoxPlotModelMapper</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3> <p>Constructs a mapper object that is a child of <i>parent</i>.</p> <!-- @@@QHBoxPlotModelMapper --> <!-- $$$columnCountChanged --> <h3 class="fn" id="columnCountChanged"><a name="columnCountChanged"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">columnCountChanged</span>()</h3> <p>This signal is emitted when the number of columns changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#columnCount-prop">columnCount</a>. </p><!-- @@@columnCountChanged --> <!-- $$$firstBoxSetRowChanged --> <h3 class="fn" id="firstBoxSetRowChanged"><a name="firstBoxSetRowChanged"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">firstBoxSetRowChanged</span>()</h3> <p>This signal is emitted when the first box-and-whiskers item row changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#firstBoxSetRow-prop">firstBoxSetRow</a>. </p><!-- @@@firstBoxSetRowChanged --> <!-- $$$firstColumnChanged --> <h3 class="fn" id="firstColumnChanged"><a name="firstColumnChanged"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">firstColumnChanged</span>()</h3> <p>This signal is emitted when the first column changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#firstColumn-prop">firstColumn</a>. </p><!-- @@@firstColumnChanged --> <!-- $$$lastBoxSetRowChanged --> <h3 class="fn" id="lastBoxSetRowChanged"><a name="lastBoxSetRowChanged"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">lastBoxSetRowChanged</span>()</h3> <p>This signal is emitted when the last box-and-whiskers item row changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#lastBoxSetRow-prop">lastBoxSetRow</a>. </p><!-- @@@lastBoxSetRowChanged --> <!-- $$$modelReplaced --> <h3 class="fn" id="modelReplaced"><a name="modelReplaced"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">modelReplaced</span>()</h3> <p>This signal is emitted when the model that the mapper is connected to changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#model-prop">model</a>. </p><!-- @@@modelReplaced --> <!-- $$$seriesReplaced --> <h3 class="fn" id="seriesReplaced"><a name="seriesReplaced"></a><code>[signal] </code><span class="type">void</span> QHBoxPlotModelMapper::<span class="name">seriesReplaced</span>()</h3> <p>This signal is emitted when the series that the mapper is connected to changes.</p> <p><b>Note:</b> Notifier signal for property <a href="qhboxplotmodelmapper.html#series-prop">series</a>. </p><!-- @@@seriesReplaced --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 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>