Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-updates > by-pkgid > 845e36bb3ecce380666d628d88446962 > files > 97

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" />
<!-- qbar3dseries.cpp -->
  <title>QBar3DSeries 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 >QBar3DSeries</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QBar3DSeries Class</h1>
<!-- $$$QBar3DSeries-brief -->
<p>The <a href="qbar3dseries.html">QBar3DSeries</a> class represents a data series in a 3D bar graph. <a href="#details">More...</a></p>
<!-- @@@QBar3DSeries -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QBar3DSeries&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-bar3dseries.html">Bar3DSeries</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstract3dseries.html">QAbstract3DSeries</a></td></tr></table></div><ul>
<li><a href="qbar3dseries-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="qbar3dseries.html#dataProxy-prop">dataProxy</a></b> : QBarDataProxy*</li>
<li class="fn"><b><a href="qbar3dseries.html#meshAngle-prop">meshAngle</a></b> : float</li>
<li class="fn"><b><a href="qbar3dseries.html#selectedBar-prop">selectedBar</a></b> : QPoint</li>
</ul>
<ul>
<li class="fn">17 properties inherited from <a href="qabstract3dseries.html#properties">QAbstract3DSeries</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="qbar3dseries.html#QBar3DSeries">QBar3DSeries</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#QBar3DSeries-1">QBar3DSeries</a></b>(QBarDataProxy *<i>dataProxy</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#dtor.QBar3DSeries">~QBar3DSeries</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBarDataProxy *</td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#dataProxy-prop">dataProxy</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#meshAngle-prop">meshAngle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#selectedBar-prop">selectedBar</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#dataProxy-prop">setDataProxy</a></b>(QBarDataProxy *<i>proxy</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#meshAngle-prop">setMeshAngle</a></b>(float <i>angle</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#setSelectedBar">setSelectedBar</a></b>(const QPoint &amp;<i>position</i>)</td></tr>
</table></div>
<ul>
<li class="fn">33 public functions inherited from <a href="qabstract3dseries.html#public-functions">QAbstract3DSeries</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="qbar3dseries.html#dataProxy-prop">dataProxyChanged</a></b>(QBarDataProxy *<i>proxy</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#meshAngle-prop">meshAngleChanged</a></b>(float <i>angle</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#selectedBar-prop">selectedBarChanged</a></b>(const QPoint &amp;<i>position</i>)</td></tr>
</table></div>
<ul>
<li class="fn">16 signals inherited from <a href="qabstract3dseries.html#signals">QAbstract3DSeries</a></li>
</ul>
<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"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#invalidSelectionPosition">invalidSelectionPosition</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qbar3dseries.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QBar3DSeries-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qbar3dseries.html">QBar3DSeries</a> class represents a data series in a 3D bar graph.</p>
<p>This class manages the series specific visual elements, as well as the series data (via a data proxy).</p>
<p>If no data proxy is set explicitly for the series, the series creates a default proxy. Setting another proxy will destroy the existing proxy and all data added to it.</p>
<p><a href="qbar3dseries.html">QBar3DSeries</a> supports the following format tags for <a href="qabstract3dseries.html#itemLabelFormat-prop">QAbstract3DSeries::setItemLabelFormat</a>():</p>
<div class="table"><table class="generic">
 <tr valign="top" class="odd"><td >@rowTitle</td><td >Title from row axis</td></tr>
<tr valign="top" class="even"><td >@colTitle</td><td >Title from column axis</td></tr>
<tr valign="top" class="odd"><td >@valueTitle</td><td >Title from value axis</td></tr>
<tr valign="top" class="even"><td >@rowIdx</td><td >Visible row index. Localized using the graph locale.</td></tr>
<tr valign="top" class="odd"><td >@colIdx</td><td >Visible column index. Localized using the graph locale.</td></tr>
<tr valign="top" class="even"><td >@rowLabel</td><td >Label from row axis</td></tr>
<tr valign="top" class="odd"><td >@colLabel</td><td >Label from column axis</td></tr>
<tr valign="top" class="even"><td >@valueLabel</td><td >Item value formatted using the format of the value axis attached to the graph. For more information, see <a href="qvalue3daxis.html#labelFormat-prop">QValue3DAxis::labelFormat</a>.</td></tr>
<tr valign="top" class="odd"><td >@seriesName</td><td >Name of the series</td></tr>
<tr valign="top" class="even"><td >%&lt;format spec&gt;</td><td >Item value in the specified format. Formatted using the same rules as <a href="qvalue3daxis.html#labelFormat-prop">QValue3DAxis::labelFormat</a>.</td></tr>
</table></div>
<p>For example:</p>
<pre class="cpp">

  proxy<span class="operator">-</span><span class="operator">&gt;</span>setItemLabelFormat(<span class="type">QStringLiteral</span>(<span class="string">&quot;@valueTitle for (@rowLabel, @colLabel): %.1f&quot;</span>));

</pre>
</div>
<p><b>See also </b><a href="qtdatavisualization-data-handling.html">Qt Data Visualization Data Handling</a> and <a href="qabstract3dgraph.html#locale-prop">QAbstract3DGraph::locale</a>.</p>
<!-- @@@QBar3DSeries -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$dataProxy-prop$$$dataProxy$$$setDataProxyQBarDataProxy*$$$dataProxyChangedQBarDataProxy* -->
<h3 class="fn" id="dataProxy-prop"><a name="dataProxy-prop"></a><span class="name">dataProxy</span> : <span class="type"><a href="qbardataproxy.html">QBarDataProxy</a></span>*</h3>
<p>This property holds the active data proxy.</p>
<p>The series assumes ownership of any proxy set to it and deletes any previously set proxy when a new one is added. The proxy cannot be null or set to another series.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QBarDataProxy *</td><td class="memItemRight bottomAlign"><span class="name"><b>dataProxy</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDataProxy</b></span>(QBarDataProxy *<i>proxy</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>dataProxyChanged</b></span>(QBarDataProxy *<i>proxy</i>)</td></tr>
</table></div>
<!-- @@@dataProxy -->
<!-- $$$meshAngle-prop$$$meshAngle$$$setMeshAnglefloat$$$meshAngleChangedfloat -->
<h3 class="fn" id="meshAngle-prop"><a name="meshAngle-prop"></a><span class="name">meshAngle</span> : <span class="type">float</span></h3>
<p>This property holds the series rotation angle in degrees.</p>
<p>Setting this property is equivalent to the following call:</p>
<pre class="cpp">

  setMeshRotation(<span class="type">QQuaternion</span><span class="operator">::</span>fromAxisAndAngle(<span class="number">0.0f</span><span class="operator">,</span> <span class="number">1.0f</span><span class="operator">,</span> <span class="number">0.0f</span><span class="operator">,</span> angle))

</pre>
<p><b>Note: </b>When reading this property, it is calculated from the <a href="qabstract3dseries.html#meshRotation-prop">QAbstract3DSeries::meshRotation</a> value using floating point precision and always returns a value from zero to 360 degrees.</p><p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>meshAngle</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMeshAngle</b></span>(float <i>angle</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>meshAngleChanged</b></span>(float <i>angle</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qabstract3dseries.html#meshRotation-prop">QAbstract3DSeries::meshRotation</a>.</p>
<!-- @@@meshAngle -->
<!-- $$$selectedBar-prop$$$selectedBar$$$setSelectedBarconstQPoint&$$$selectedBarChangedconstQPoint& -->
<h3 class="fn" id="selectedBar-prop"><a name="selectedBar-prop"></a><span class="name">selectedBar</span> : <span class="type">QPoint</span></h3>
<p>This property holds the bar in the series that is selected.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QPoint </td><td class="memItemRight bottomAlign"><span class="name"><b>selectedBar</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qbar3dseries.html#setSelectedBar">setSelectedBar</a></b></span>(const QPoint &amp;<i>position</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>selectedBarChanged</b></span>(const QPoint &amp;<i>position</i>)</td></tr>
</table></div>
<!-- @@@selectedBar -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QBar3DSeries[overload1]$$$QBar3DSeriesQObject* -->
<h3 class="fn" id="QBar3DSeries"><a name="QBar3DSeries"></a>QBar3DSeries::<span class="name">QBar3DSeries</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructsa bar 3D series with the parent <i>parent</i>.</p>
<!-- @@@QBar3DSeries -->
<!-- $$$QBar3DSeries$$$QBar3DSeriesQBarDataProxy*QObject* -->
<h3 class="fn" id="QBar3DSeries-1"><a name="QBar3DSeries-1"></a>QBar3DSeries::<span class="name">QBar3DSeries</span>(<span class="type"><a href="qbardataproxy.html">QBarDataProxy</a></span> *<i>dataProxy</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a bar 3D series with the data proxy <i>dataProxy</i> and the parent <i>parent</i>.</p>
<!-- @@@QBar3DSeries -->
<!-- $$$~QBar3DSeries[overload1]$$$~QBar3DSeries -->
<h3 class="fn" id="dtor.QBar3DSeries"><a name="dtor.QBar3DSeries"></a><code>[virtual] </code>QBar3DSeries::<span class="name">~QBar3DSeries</span>()</h3>
<p>Deletes a bar 3D series.</p>
<!-- @@@~QBar3DSeries -->
<!-- $$$invalidSelectionPosition[overload1]$$$invalidSelectionPosition -->
<h3 class="fn" id="invalidSelectionPosition"><a name="invalidSelectionPosition"></a><code>[static] </code><span class="type">QPoint</span> QBar3DSeries::<span class="name">invalidSelectionPosition</span>()</h3>
<p>Returns an invalid position for selection. This position is set to the <a href="qbar3dseries.html#selectedBar-prop">selectedBar</a> property to clear the selection from this series.</p>
<p><b>See also </b><a href="qabstract3dgraph.html#clearSelection">QAbstract3DGraph::clearSelection</a>().</p>
<!-- @@@invalidSelectionPosition -->
<!-- $$$setSelectedBar -->
<h3 class="fn" id="setSelectedBar"><a name="setSelectedBar"></a><span class="type">void</span> QBar3DSeries::<span class="name">setSelectedBar</span>(const <span class="type">QPoint</span> &amp;<i>position</i>)</h3>
<p>Selects the bar at the <i>position</i> position, specified as a row and column in the data array of the series.</p>
<p>Only one bar can be selected at a time.</p>
<p>To clear selection from this series, <a href="qbar3dseries.html#invalidSelectionPosition">invalidSelectionPosition</a>() is set as <i>position</i>.</p>
<p>If this series is added to a graph, the graph can adjust the selection according to user interaction or if it becomes invalid. Selecting a bar on another added series will also clear the selection.</p>
<p>Removing rows from or inserting rows to the series before the row of the selected bar will adjust the selection so that the same bar will stay selected.</p>
<p><b>Note:</b> Setter function for property <a href="qbar3dseries.html#selectedBar-prop">selectedBar</a>. </p><p><b>See also </b><a href="qbar3dseries.html#selectedBar-prop">selectedBar</a>() and <a href="qabstract3dgraph.html#clearSelection">QAbstract3DGraph::clearSelection</a>().</p>
<!-- @@@setSelectedBar -->
</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>