Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > 19952c5e751bf7e3108c3c59625b0f35 > files > 513

qtcharts5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qvboxplotmodelmapper.cpp -->
  <title>QVBoxPlotModelMapper 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 >QVBoxPlotModelMapper</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">QVBoxPlotModelMapper Class</h1>
<!-- $$$QVBoxPlotModelMapper-brief -->
<p>The <a href="qvboxplotmodelmapper.html">QVBoxPlotModelMapper</a> is a vertical model mapper for box plot series. <a href="#details">More...</a></p>
<!-- @@@QVBoxPlotModelMapper -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QVBoxPlotModelMapper&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-vboxplotmodelmapper.html">VBoxPlotModelMapper</a></td></tr></table></div><ul>
<li><a href="qvboxplotmodelmapper-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="qvboxplotmodelmapper.html#firstBoxSetColumn-prop">firstBoxSetColumn</a></b> : int</li>
<li class="fn"><b><a href="qvboxplotmodelmapper.html#firstRow-prop">firstRow</a></b> : int</li>
<li class="fn"><b><a href="qvboxplotmodelmapper.html#lastBoxSetColumn-prop">lastBoxSetColumn</a></b> : int</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qvboxplotmodelmapper.html#model-prop">model</a></b> : QAbstractItemModel *</li>
<li class="fn"><b><a href="qvboxplotmodelmapper.html#rowCount-prop">rowCount</a></b> : int</li>
<li class="fn"><b><a href="qvboxplotmodelmapper.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="qvboxplotmodelmapper.html#QVBoxPlotModelMapper">QVBoxPlotModelMapper</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#firstBoxSetColumn-prop">firstBoxSetColumn</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#firstRow-prop">firstRow</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#lastBoxSetColumn-prop">lastBoxSetColumn</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#model-prop">model</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#rowCount-prop">rowCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBoxPlotSeries *</td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#series-prop">series</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#firstBoxSetColumn-prop">setFirstBoxSetColumn</a></b>(int <i>firstBoxSetColumn</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#firstRow-prop">setFirstRow</a></b>(int <i>firstRow</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#lastBoxSetColumn-prop">setLastBoxSetColumn</a></b>(int <i>lastBoxSetColumn</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.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="qvboxplotmodelmapper.html#rowCount-prop">setRowCount</a></b>(int <i>rowCount</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.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="qvboxplotmodelmapper.html#firstBoxSetColumnChanged">firstBoxSetColumnChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#firstRowChanged">firstRowChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#lastBoxSetColumnChanged">lastBoxSetColumnChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#modelReplaced">modelReplaced</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#rowCountChanged">rowCountChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvboxplotmodelmapper.html#seriesReplaced">seriesReplaced</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QVBoxPlotModelMapper-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qvboxplotmodelmapper.html">QVBoxPlotModelMapper</a> is a vertical 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 vertical model mapper is used to create a connection between a data model and a <a href="qboxplotseries.html">QBoxPlotSeries</a> object, so that each column in the data model defines a box-and-whiskers item and each row 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 bar 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="qhboxplotmodelmapper.html">QHBoxPlotModelMapper</a>.</p>
<!-- @@@QVBoxPlotModelMapper -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$firstBoxSetColumn-prop$$$firstBoxSetColumn$$$setFirstBoxSetColumnint$$$firstBoxSetColumnChanged -->
<h3 class="fn" id="firstBoxSetColumn-prop"><a name="firstBoxSetColumn-prop"></a><span class="name">firstBoxSetColumn</span> : <span class="type">int</span></h3>
<p>This property holds the column 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>firstBoxSetColumn</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstBoxSetColumn</b></span>(int <i>firstBoxSetColumn</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="qvboxplotmodelmapper.html#firstBoxSetColumnChanged">firstBoxSetColumnChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@firstBoxSetColumn -->
<!-- $$$firstRow-prop$$$firstRow$$$setFirstRowint$$$firstRowChanged -->
<h3 class="fn" id="firstRow-prop"><a name="firstRow-prop"></a><span class="name">firstRow</span> : <span class="type">int</span></h3>
<p>This property holds the row 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>firstRow</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstRow</b></span>(int <i>firstRow</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="qvboxplotmodelmapper.html#firstRowChanged">firstRowChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@firstRow -->
<!-- $$$lastBoxSetColumn-prop$$$lastBoxSetColumn$$$setLastBoxSetColumnint$$$lastBoxSetColumnChanged -->
<h3 class="fn" id="lastBoxSetColumn-prop"><a name="lastBoxSetColumn-prop"></a><span class="name">lastBoxSetColumn</span> : <span class="type">int</span></h3>
<p>This property holds the column 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>lastBoxSetColumn</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLastBoxSetColumn</b></span>(int <i>lastBoxSetColumn</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="qvboxplotmodelmapper.html#lastBoxSetColumnChanged">lastBoxSetColumnChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@lastBoxSetColumn -->
<!-- $$$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="qvboxplotmodelmapper.html#modelReplaced">modelReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@model -->
<!-- $$$rowCount-prop$$$rowCount$$$setRowCountint$$$rowCountChanged -->
<h3 class="fn" id="rowCount-prop"><a name="rowCount-prop"></a><span class="name">rowCount</span> : <span class="type">int</span></h3>
<p>This property holds the number of rows 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>rowCount</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRowCount</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="qvboxplotmodelmapper.html#rowCountChanged">rowCountChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@rowCount -->
<!-- $$$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="qvboxplotmodelmapper.html#seriesReplaced">seriesReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@series -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVBoxPlotModelMapper[overload1]$$$QVBoxPlotModelMapperQObject* -->
<h3 class="fn" id="QVBoxPlotModelMapper"><a name="QVBoxPlotModelMapper"></a>QVBoxPlotModelMapper::<span class="name">QVBoxPlotModelMapper</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a mapper object that is a child of <i>parent</i>.</p>
<!-- @@@QVBoxPlotModelMapper -->
<!-- $$$firstBoxSetColumnChanged -->
<h3 class="fn" id="firstBoxSetColumnChanged"><a name="firstBoxSetColumnChanged"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<span class="name">firstBoxSetColumnChanged</span>()</h3>
<p>This signal is emitted when the first box-and-whiskers item column changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qvboxplotmodelmapper.html#firstBoxSetColumn-prop">firstBoxSetColumn</a>. </p><!-- @@@firstBoxSetColumnChanged -->
<!-- $$$firstRowChanged -->
<h3 class="fn" id="firstRowChanged"><a name="firstRowChanged"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<span class="name">firstRowChanged</span>()</h3>
<p>This signal is emitted when the first row changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qvboxplotmodelmapper.html#firstRow-prop">firstRow</a>. </p><!-- @@@firstRowChanged -->
<!-- $$$lastBoxSetColumnChanged -->
<h3 class="fn" id="lastBoxSetColumnChanged"><a name="lastBoxSetColumnChanged"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<span class="name">lastBoxSetColumnChanged</span>()</h3>
<p>This signal is emitted when the last box-and-whiskers item column changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qvboxplotmodelmapper.html#lastBoxSetColumn-prop">lastBoxSetColumn</a>. </p><!-- @@@lastBoxSetColumnChanged -->
<!-- $$$modelReplaced -->
<h3 class="fn" id="modelReplaced"><a name="modelReplaced"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<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="qvboxplotmodelmapper.html#model-prop">model</a>. </p><!-- @@@modelReplaced -->
<!-- $$$rowCountChanged -->
<h3 class="fn" id="rowCountChanged"><a name="rowCountChanged"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<span class="name">rowCountChanged</span>()</h3>
<p>This signal is emitted when the number of rows changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qvboxplotmodelmapper.html#rowCount-prop">rowCount</a>. </p><!-- @@@rowCountChanged -->
<!-- $$$seriesReplaced -->
<h3 class="fn" id="seriesReplaced"><a name="seriesReplaced"></a><code>[signal] </code><span class="type">void</span> QVBoxPlotModelMapper::<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="qvboxplotmodelmapper.html#series-prop">series</a>. </p><!-- @@@seriesReplaced -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>