Sophie

Sophie

distrib > Mageia > 7 > i586 > by-pkgid > 845e36bb3ecce380666d628d88446962 > files > 195

qtdatavis3d5-doc-5.12.6-1.mga7.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" />
<!-- qscatterdataproxy.cpp -->
  <title>QScatterDataProxy Class | Qt Data Visualization 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="qtdatavisualization-index.html">Qt Data Visualization</a></td><td ><a href="qtdatavisualization-module.html">C++ Classes</a></td><td >QScatterDataProxy</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtdatavisualization-index.html">Qt Data Visualization | 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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</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">QScatterDataProxy Class</h1>
<!-- $$$QScatterDataProxy-brief -->
<p>The <a href="qscatterdataproxy.html">QScatterDataProxy</a> class is the data proxy for 3D scatter graphs. <a href="#details">More...</a></p>
<!-- @@@QScatterDataProxy -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QScatterDataProxy&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  QtDataVisualization 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-scatterdataproxy.html">ScatterDataProxy</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstractdataproxy.html">QAbstractDataProxy</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qitemmodelscatterdataproxy.html">QItemModelScatterDataProxy</a></p>
</td></tr></table></div><ul>
<li><a href="qscatterdataproxy-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><a href="qscatterdataproxy.html#itemCount-prop">itemCount</a></b> : const int</li>
<li class="fn"><b><a href="qscatterdataproxy.html#series-prop">series</a></b> : QScatter3DSeries* const</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qabstractdataproxy.html#properties">QAbstractDataProxy</a></li>
</ul>
<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="qscatterdataproxy.html#QScatterDataProxy">QScatterDataProxy</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#dtor.QScatterDataProxy">~QScatterDataProxy</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#addItem">addItem</a></b>(const QScatterDataItem &amp;<i>item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#addItems">addItems</a></b>(const QScatterDataArray &amp;<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QScatterDataArray *</td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#array">array</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#insertItem">insertItem</a></b>(int <i>index</i>, const QScatterDataItem &amp;<i>item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#insertItems">insertItems</a></b>(int <i>index</i>, const QScatterDataArray &amp;<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QScatterDataItem *</td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemAt">itemAt</a></b>(int <i>index</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemCount-prop">itemCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#removeItems">removeItems</a></b>(int <i>index</i>, int <i>removeCount</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#resetArray">resetArray</a></b>(QScatterDataArray *<i>newArray</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScatter3DSeries *</td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#series-prop">series</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#setItem">setItem</a></b>(int <i>index</i>, const QScatterDataItem &amp;<i>item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#setItems">setItems</a></b>(int <i>index</i>, const QScatterDataArray &amp;<i>items</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qabstractdataproxy.html#public-functions">QAbstractDataProxy</a></li>
</ul>
<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="qscatterdataproxy.html#arrayReset">arrayReset</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemCount-prop">itemCountChanged</a></b>(int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemsAdded">itemsAdded</a></b>(int <i>startIndex</i>, int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemsChanged">itemsChanged</a></b>(int <i>startIndex</i>, int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemsInserted">itemsInserted</a></b>(int <i>startIndex</i>, int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#itemsRemoved">itemsRemoved</a></b>(int <i>startIndex</i>, int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#series-prop">seriesChanged</a></b>(QScatter3DSeries *<i>series</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="related-non-members"></a>
<h2 id="related-non-members">Related Non-Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QScatterDataProxy-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qscatterdataproxy.html">QScatterDataProxy</a> class is the data proxy for 3D scatter graphs.</p>
<p>A scatter data proxy handles adding, inserting, changing, and removing data items.</p>
<p><a href="qscatterdataproxy.html">QScatterDataProxy</a> takes ownership of all QtDataVisualization::QScatterDataArray and <a href="qscatterdataitem.html">QScatterDataItem</a> objects passed to it.</p>
</div>
<p><b>See also </b><a href="qtdatavisualization-data-handling.html">Qt Data Visualization Data Handling</a>.</p>
<!-- @@@QScatterDataProxy -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$itemCount-prop$$$itemCount$$$itemCountChangedint -->
<h3 class="fn" id="itemCount-prop"><a name="itemCount-prop"></a><span class="name">itemCount</span> : const <span class="type">int</span></h3>
<p>This property holds the number of items in the array.</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>itemCount</b></span>() const</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>itemCountChanged</b></span>(int <i>count</i>)</td></tr>
</table></div>
<!-- @@@itemCount -->
<!-- $$$series-prop$$$series$$$seriesChangedQScatter3DSeries* -->
<h3 class="fn" id="series-prop"><a name="series-prop"></a><span class="name">series</span> : <span class="type"><a href="qscatter3dseries.html">QScatter3DSeries</a></span>* const</h3>
<p>This property holds the series this proxy is attached to.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QScatter3DSeries *</td><td class="memItemRight bottomAlign"><span class="name"><b>series</b></span>() const</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>seriesChanged</b></span>(QScatter3DSeries *<i>series</i>)</td></tr>
</table></div>
<!-- @@@series -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QScatterDataProxy[overload1]$$$QScatterDataProxyQObject* -->
<h3 class="fn" id="QScatterDataProxy"><a name="QScatterDataProxy"></a>QScatterDataProxy::<span class="name">QScatterDataProxy</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs <a href="qscatterdataproxy.html">QScatterDataProxy</a> with the given <i>parent</i>.</p>
<!-- @@@QScatterDataProxy -->
<!-- $$$~QScatterDataProxy[overload1]$$$~QScatterDataProxy -->
<h3 class="fn" id="dtor.QScatterDataProxy"><a name="dtor.QScatterDataProxy"></a><code>[virtual] </code>QScatterDataProxy::<span class="name">~QScatterDataProxy</span>()</h3>
<p>Deletes the scatter data proxy.</p>
<!-- @@@~QScatterDataProxy -->
<!-- $$$addItem[overload1]$$$addItemconstQScatterDataItem& -->
<h3 class="fn" id="addItem"><a name="addItem"></a><span class="type">int</span> QScatterDataProxy::<span class="name">addItem</span>(const <span class="type"><a href="qscatterdataitem.html">QScatterDataItem</a></span> &amp;<i>item</i>)</h3>
<p>Adds the item <i>item</i> to the end of the array.</p>
<p>Returns the index of the added item.</p>
<!-- @@@addItem -->
<!-- $$$addItems[overload1]$$$addItemsconstQScatterDataArray& -->
<h3 class="fn" id="addItems"><a name="addItems"></a><span class="type">int</span> QScatterDataProxy::<span class="name">addItems</span>(const <span class="type"><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></span> &amp;<i>items</i>)</h3>
<p>Adds the items specified by <i>items</i> to the end of the array.</p>
<p>Returns the index of the first added item.</p>
<!-- @@@addItems -->
<!-- $$$array[overload1]$$$array -->
<h3 class="fn" id="array"><a name="array"></a>const <span class="type"><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></span> *QScatterDataProxy::<span class="name">array</span>() const</h3>
<p>Returns the pointer to the data array.</p>
<!-- @@@array -->
<!-- $$$arrayReset[overload1]$$$arrayReset -->
<h3 class="fn" id="arrayReset"><a name="arrayReset"></a><code>[signal] </code><span class="type">void</span> QScatterDataProxy::<span class="name">arrayReset</span>()</h3>
<p>This signal is emitted when the data array is reset. If the contents of the whole array are changed without calling <a href="qscatterdataproxy.html#resetArray">resetArray</a>(), this signal needs to be emitted to update the graph.</p>
<!-- @@@arrayReset -->
<!-- $$$insertItem[overload1]$$$insertItemintconstQScatterDataItem& -->
<h3 class="fn" id="insertItem"><a name="insertItem"></a><span class="type">void</span> QScatterDataProxy::<span class="name">insertItem</span>(<span class="type">int</span> <i>index</i>, const <span class="type"><a href="qscatterdataitem.html">QScatterDataItem</a></span> &amp;<i>item</i>)</h3>
<p>Inserts the item <i>item</i> to the position <i>index</i>. If the index is equal to the data array size, the item is added to the array.</p>
<!-- @@@insertItem -->
<!-- $$$insertItems[overload1]$$$insertItemsintconstQScatterDataArray& -->
<h3 class="fn" id="insertItems"><a name="insertItems"></a><span class="type">void</span> QScatterDataProxy::<span class="name">insertItems</span>(<span class="type">int</span> <i>index</i>, const <span class="type"><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></span> &amp;<i>items</i>)</h3>
<p>Inserts the items specified by <i>items</i> to the position <i>index</i>. If the index is equal to data array size, the items are added to the array.</p>
<!-- @@@insertItems -->
<!-- $$$itemAt[overload1]$$$itemAtint -->
<h3 class="fn" id="itemAt"><a name="itemAt"></a>const <span class="type"><a href="qscatterdataitem.html">QScatterDataItem</a></span> *QScatterDataProxy::<span class="name">itemAt</span>(<span class="type">int</span> <i>index</i>) const</h3>
<p>Returns the pointer to the item at the index <i>index</i>. It is guaranteed to be valid only until the next call that modifies data.</p>
<!-- @@@itemAt -->
<!-- $$$itemsAdded[overload1]$$$itemsAddedintint -->
<h3 class="fn" id="itemsAdded"><a name="itemsAdded"></a><code>[signal] </code><span class="type">void</span> QScatterDataProxy::<span class="name">itemsAdded</span>(<span class="type">int</span> <i>startIndex</i>, <span class="type">int</span> <i>count</i>)</h3>
<p>This signal is emitted when the number of items specified by <i>count</i> is added starting at the position <i>startIndex</i>. If items are added to the array without calling <a href="qscatterdataproxy.html#addItem">addItem</a>() or <a href="qscatterdataproxy.html#addItems">addItems</a>(), this signal needs to be emitted to update the graph.</p>
<!-- @@@itemsAdded -->
<!-- $$$itemsChanged[overload1]$$$itemsChangedintint -->
<h3 class="fn" id="itemsChanged"><a name="itemsChanged"></a><code>[signal] </code><span class="type">void</span> QScatterDataProxy::<span class="name">itemsChanged</span>(<span class="type">int</span> <i>startIndex</i>, <span class="type">int</span> <i>count</i>)</h3>
<p>This signal is emitted when the number of items specified by <i>count</i> is changed starting at the position <i>startIndex</i>. If items are changed in the array without calling <a href="qscatterdataproxy.html#setItem">setItem</a>() or <a href="qscatterdataproxy.html#setItems">setItems</a>(), this signal needs to be emitted to update the graph.</p>
<!-- @@@itemsChanged -->
<!-- $$$itemsInserted[overload1]$$$itemsInsertedintint -->
<h3 class="fn" id="itemsInserted"><a name="itemsInserted"></a><code>[signal] </code><span class="type">void</span> QScatterDataProxy::<span class="name">itemsInserted</span>(<span class="type">int</span> <i>startIndex</i>, <span class="type">int</span> <i>count</i>)</h3>
<p>This signal is emitted when the number of items specified by <i>count</i> is inserted starting at the position <i>startIndex</i>. If items are inserted into the array without calling <a href="qscatterdataproxy.html#insertItem">insertItem</a>() or <a href="qscatterdataproxy.html#insertItems">insertItems</a>(), this signal needs to be emitted to update the graph.</p>
<!-- @@@itemsInserted -->
<!-- $$$itemsRemoved[overload1]$$$itemsRemovedintint -->
<h3 class="fn" id="itemsRemoved"><a name="itemsRemoved"></a><code>[signal] </code><span class="type">void</span> QScatterDataProxy::<span class="name">itemsRemoved</span>(<span class="type">int</span> <i>startIndex</i>, <span class="type">int</span> <i>count</i>)</h3>
<p>This signal is emitted when the number of rows specified by <i>count</i> is removed starting at the position <i>startIndex</i>. The index may be larger than the current array size if items are removed from the end. If items are removed from the array without calling <a href="qscatterdataproxy.html#removeItems">removeItems</a>(), this signal needs to be emitted to update the graph.</p>
<!-- @@@itemsRemoved -->
<!-- $$$removeItems[overload1]$$$removeItemsintint -->
<h3 class="fn" id="removeItems"><a name="removeItems"></a><span class="type">void</span> QScatterDataProxy::<span class="name">removeItems</span>(<span class="type">int</span> <i>index</i>, <span class="type">int</span> <i>removeCount</i>)</h3>
<p>Removes the number of items specified by <i>removeCount</i> starting at the position <i>index</i>. Attempting to remove items past the end of the array does nothing.</p>
<!-- @@@removeItems -->
<!-- $$$resetArray[overload1]$$$resetArrayQScatterDataArray* -->
<h3 class="fn" id="resetArray"><a name="resetArray"></a><span class="type">void</span> QScatterDataProxy::<span class="name">resetArray</span>(<span class="type"><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></span> *<i>newArray</i>)</h3>
<p>Takes ownership of the array <i>newArray</i>. Clears the existing array if the new array differs from it. If the arrays are the same, this function just triggers the <a href="qscatterdataproxy.html#arrayReset">arrayReset</a>() signal.</p>
<p>Passing a null array deletes the old array and creates a new empty array.</p>
<!-- @@@resetArray -->
<!-- $$$setItem[overload1]$$$setItemintconstQScatterDataItem& -->
<h3 class="fn" id="setItem"><a name="setItem"></a><span class="type">void</span> QScatterDataProxy::<span class="name">setItem</span>(<span class="type">int</span> <i>index</i>, const <span class="type"><a href="qscatterdataitem.html">QScatterDataItem</a></span> &amp;<i>item</i>)</h3>
<p>Replaces the item at the position <i>index</i> with the item <i>item</i>.</p>
<!-- @@@setItem -->
<!-- $$$setItems[overload1]$$$setItemsintconstQScatterDataArray& -->
<h3 class="fn" id="setItems"><a name="setItems"></a><span class="type">void</span> QScatterDataProxy::<span class="name">setItems</span>(<span class="type">int</span> <i>index</i>, const <span class="type"><a href="qscatterdataproxy.html#QScatterDataArray-typedef">QScatterDataArray</a></span> &amp;<i>items</i>)</h3>
<p>Replaces the items starting from the position <i>index</i> with the items specified by <i>items</i>.</p>
<!-- @@@setItems -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$QScatterDataArray -->
<h3 class="fn" id="QScatterDataArray-typedef"><a name="QScatterDataArray-typedef"></a>typedef <span class="name">QScatterDataArray</span></h3>
<p>A vector of <a href="qscatterdataitem.html">QScatterDataItem</a> objects.</p>
<!-- @@@QScatterDataArray -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>