Sophie

Sophie

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

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" />
<!-- qbarset.cpp -->
  <title>BarSet QML Type | 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="qtcharts-qmlmodule.html">QML Types</a></td><td >BarSet QML Type</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="#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">BarSet QML Type</h1>
<span class="subtitle"></span>
<!-- $$$BarSet-brief -->
<p>Represents one set of bars in a bar chart. <a href="#details">More...</a></p>
<!-- @@@BarSet -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtCharts 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-barset.html"><a href="qbarset.html">QBarSet</a></td></tr></table></div><ul>
<li><a href="qml-qtcharts-barset-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-barset.html#borderColor-prop">borderColor</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#borderWidth-prop">borderWidth</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#brushFilename-prop">brushFilename</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#color-prop">color</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#label-prop">label</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#labelColor-prop">labelColor</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#labelFont-prop">labelFont</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#values-prop">values</a></b></b> : QVariantList</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#valueChanged-signal">valueChanged</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#valuesAdded-signal">valuesAdded</a></b></b>(int <i>index</i>, int <i>count</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#valuesRemoved-signal">valuesRemoved</a></b></b>(int <i>index</i>, int <i>count</i>)</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#append-method">append</a></b></b>(real <i>value</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#at-method">at</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#clicked-method">clicked</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#doubleClicked-method">doubleClicked</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#pressed-method">pressed</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#released-method">released</a></b></b>(int <i>index</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#remove-method">remove</a></b></b>(int <i>index</i>, int <i>count</i>)</li>
<li class="fn"><b><b><a href="qml-qtcharts-barset.html#replace-method">replace</a></b></b>(int <i>index</i>, real <i>value</i>)</li>
</ul>
<!-- $$$BarSet-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A bar set contains one data value for each category. The first value of a set is assumed to belong to the first category, the second one to the second category, and so on. If the set has fewer values than there are categories, the missing values are assumed to be located at the end of the set. For missing values in the middle of a set, the numerical value of zero is used. Labels for zero value sets are not shown.</p>
<p><b>See also </b><a href="qml-qtcharts-abstractbarseries.html">AbstractBarSeries</a>, <a href="qml-qtcharts-barseries.html">BarSeries</a>, <a href="qml-qtcharts-stackedbarseries.html">StackedBarSeries</a>, <a href="qml-qtcharts-percentbarseries.html">PercentBarSeries</a>, <a href="qml-qtcharts-horizontalbarseries.html">HorizontalBarSeries</a>, <a href="qml-qtcharts-horizontalstackedbarseries.html">HorizontalStackedBarSeries</a>, and <a href="qml-qtcharts-horizontalpercentbarseries.html">HorizontalPercentBarSeries</a>.</p>
<!-- @@@BarSet -->
<h2>Property Documentation</h2>
<!-- $$$borderColor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="borderColor-prop">
<td class="tblQmlPropNode"><p>
<a name="borderColor-prop"></a><span class="name">borderColor</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The line (pen) color of the bar set.</p>
</div></div><!-- @@@borderColor -->
<br/>
<!-- $$$borderWidth -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="borderWidth-prop">
<td class="tblQmlPropNode"><p>
<a name="borderWidth-prop"></a><span class="name">borderWidth</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The width of the border line. By default, the width is 2.0&#x2e;</p>
</div></div><!-- @@@borderWidth -->
<br/>
<!-- $$$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 set.</p>
</div></div><!-- @@@brushFilename -->
<br/>
<!-- $$$color -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="color-prop">
<td class="tblQmlPropNode"><p>
<a name="color-prop"></a><span class="name">color</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The fill (brush) color of the bar set.</p>
</div></div><!-- @@@color -->
<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 in the bar set.</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 bar set.</p>
</div></div><!-- @@@label -->
<br/>
<!-- $$$labelColor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="labelColor-prop">
<td class="tblQmlPropNode"><p>
<a name="labelColor-prop"></a><span class="name">labelColor</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The text (label) color of the bar set.</p>
</div></div><!-- @@@labelColor -->
<br/>
<!-- $$$labelFont -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="labelFont-prop">
<td class="tblQmlPropNode"><p>
<a name="labelFont-prop"></a><span class="name">labelFont</span> : <span class="type">font</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The font used to draw the bar set's label.</p>
<p>For more information, see font.</p>
</div></div><!-- @@@labelFont -->
<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">QVariantList</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The values of the bar set. You can set a list of either real or point types as values.</p>
<p>If you set a list of real types as values, they directly define the bar set values.</p>
<p>If you set a list of point types as values, the x-coordinate of the point specifies its zero-based index in the bar set. The size of the bar set is the highest x-coordinate value + 1. If a point is missing for any x-coordinate between zero and the highest value, it gets the value zero.</p>
<p>For example, the following bar sets have equal values:</p>
<pre class="cpp">

  myBarSet1<span class="operator">.</span>values <span class="operator">=</span> <span class="operator">[</span><span class="number">5</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> <span class="number">5</span><span class="operator">]</span>;
  myBarSet2<span class="operator">.</span>values <span class="operator">=</span> <span class="operator">[</span><span class="type">Qt</span><span class="operator">.</span>point(<span class="number">0</span><span class="operator">,</span> <span class="number">5</span>)<span class="operator">,</span> <span class="type">Qt</span><span class="operator">.</span>point(<span class="number">2</span><span class="operator">,</span> <span class="number">1</span>)<span class="operator">,</span> <span class="type">Qt</span><span class="operator">.</span>point(<span class="number">3</span><span class="operator">,</span> <span class="number">5</span>)<span class="operator">]</span>;

</pre>
</div></div><!-- @@@values -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$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 at the position specified by <i>index</i> is modified.</p>
<p>The corresponding signal handler is <code>onValueChanged</code>.</p>
</div></div><!-- @@@valueChanged -->
<br/>
<!-- $$$valuesAdded -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valuesAdded-signal">
<td class="tblQmlFuncNode"><p>
<a name="valuesAdded-signal"></a><span class="name">valuesAdded</span>(<span class="type">int</span> <i>index</i>, <span class="type">int</span> <i>count</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when new values are added to the bar set. <i>index</i> indicates the position of the first inserted value, and <i>count</i> is the number of inserted values.</p>
<p>The corresponding signal handler is <code>onValuesAdded</code>.</p>
</div></div><!-- @@@valuesAdded -->
<br/>
<!-- $$$valuesRemoved -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valuesRemoved-signal">
<td class="tblQmlFuncNode"><p>
<a name="valuesRemoved-signal"></a><span class="name">valuesRemoved</span>(<span class="type">int</span> <i>index</i>, <span class="type">int</span> <i>count</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when values are removed from the bar set. <i>index</i> indicates the position of the first removed value, and <i>count</i> is the number of removed values.</p>
<p>The corresponding signal handler is <code>onValuesRemoved</code>.</p>
</div></div><!-- @@@valuesRemoved -->
<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="name">append</span>(<span class="type">real</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 bar set.</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="name">at</span>(<span class="type">int</span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the value specified by <i>index</i> from the bar set. If the index is out of bounds, 0.0 is returned.</p>
</div></div><!-- @@@at -->
<br/>
<!-- $$$clicked -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="clicked-method">
<td class="tblQmlFuncNode"><p>
<a name="clicked-method"></a><span class="name">clicked</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 user clicks the bar specified by <i>index</i> in a bar set.</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-method">
<td class="tblQmlFuncNode"><p>
<a name="doubleClicked-method"></a><span class="name">doubleClicked</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 user double-clicks the bar specified by <i>index</i> in a bar set.</p>
<p>The corresponding signal handler is <code>onDoubleClicked</code>.</p>
</div></div><!-- @@@doubleClicked -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressed-method">
<td class="tblQmlFuncNode"><p>
<a name="pressed-method"></a><span class="name">pressed</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 user clicks the bar specified by <i>index</i> in a bar set 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-method">
<td class="tblQmlFuncNode"><p>
<a name="released-method"></a><span class="name">released</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 user releases the mouse press on the bar specified by <i>index</i> in a bar set.</p>
<p>The corresponding signal handler is <code>onReleased</code>.</p>
</div></div><!-- @@@released -->
<br/>
<!-- $$$remove -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="remove-method">
<td class="tblQmlFuncNode"><p>
<a name="remove-method"></a><span class="name">remove</span>(<span class="type">int</span> <i>index</i>, <span class="type">int</span> <i>count</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Removes the number of values specified by <i>count</i> from the bar set starting with the value specified by <i>index</i>.</p>
<p>If you leave out <i>count</i>, only the value specified by <i>index</i> is removed.</p>
</div></div><!-- @@@remove -->
<br/>
<!-- $$$replace -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="replace-method">
<td class="tblQmlFuncNode"><p>
<a name="replace-method"></a><span class="name">replace</span>(<span class="type">int</span> <i>index</i>, <span class="type">real</span> <i>value</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Adds the value specified by <i>value</i> to the bar set at the position specified by <i>index</i>.</p>
</div></div><!-- @@@replace -->
<br/>
        </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>