<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtdatavisualization-qml-bars3d.qdoc -->
<title>Bars3D QML Type | 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-qmlmodule.html">QML Types</a></td><td >Bars3D QML Type</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="#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">Bars3D QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Bars3D-brief -->
<p>3D bar graph. <a href="#details">More...</a></p>
<!-- @@@Bars3D -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtDataVisualization 1.2</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"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtdatavisualization-abstractgraph3d.html">AbstractGraph3D</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtdatavisualization-bars3d-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-qtdatavisualization-bars3d.html#barSpacing-prop">barSpacing</a></b></b> : size</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#barSpacingRelative-prop">barSpacingRelative</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#barThickness-prop">barThickness</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#columnAxis-prop">columnAxis</a></b></b> : CategoryAxis3D</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#floorLevel-prop">floorLevel</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#multiSeriesUniform-prop">multiSeriesUniform</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#primarySeries-prop">primarySeries</a></b></b> : Bar3DSeries</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#rowAxis-prop">rowAxis</a></b></b> : CategoryAxis3D</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#selectedSeries-prop">selectedSeries</a></b></b> : Bar3DSeries</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#seriesList-prop">seriesList</a></b></b> : list<Bar3DSeries></li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-bars3d.html#valueAxis-prop">valueAxis</a></b></b> : ValueAxis3D</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtdatavisualization-bars3d.html#addSeries-method">addSeries</a></b></b>(Bar3DSeries <i>series</i>)</li>
<li class="fn">void <b><b><a href="qml-qtdatavisualization-bars3d.html#insertSeries-method">insertSeries</a></b></b>(int <i>index</i>, Bar3DSeries <i>series</i>)</li>
<li class="fn">void <b><b><a href="qml-qtdatavisualization-bars3d.html#removeSeries-method">removeSeries</a></b></b>(Bar3DSeries <i>series</i>)</li>
</ul>
<!-- $$$Bars3D-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This type enables developers to render bar graphs in 3D with Qt Quick 2.</p>
<p>You will need to import data visualization module to use this type:</p>
<pre class="cpp">
import <span class="type">QtDataVisualization</span> <span class="number">1.2</span>
</pre>
<p>After that you can use <a href="qml-qtdatavisualization-bars3d.html">Bars3D</a> in your qml files:</p>
<pre class="cpp">
import <span class="type">QtQuick</span> <span class="number">2.0</span>
import <span class="type">QtDataVisualization</span> <span class="number">1.2</span>
Item {
width: <span class="number">640</span>
height: <span class="number">480</span>
Bars3D {
width: parent<span class="operator">.</span>width
height: parent<span class="operator">.</span>height
Bar3DSeries {
itemLabelFormat: <span class="string">"@colLabel, @rowLabel: @valueLabel"</span>
ItemModelBarDataProxy {
itemModel: dataModel
<span class="comment">// Mapping model roles to bar series rows, columns, and values.</span>
rowRole: <span class="string">"year"</span>
columnRole: <span class="string">"city"</span>
valueRole: <span class="string">"expenses"</span>
}
}
}
ListModel {
id: dataModel
ListElement{ year: <span class="string">"2012"</span>; city: <span class="string">"Oulu"</span>; expenses: <span class="string">"4200"</span>; }
ListElement{ year: <span class="string">"2012"</span>; city: <span class="string">"Rauma"</span>; expenses: <span class="string">"2100"</span>; }
ListElement{ year: <span class="string">"2012"</span>; city: <span class="string">"Helsinki"</span>; expenses: <span class="string">"7040"</span>; }
ListElement{ year: <span class="string">"2012"</span>; city: <span class="string">"Tampere"</span>; expenses: <span class="string">"4330"</span>; }
ListElement{ year: <span class="string">"2013"</span>; city: <span class="string">"Oulu"</span>; expenses: <span class="string">"3960"</span>; }
ListElement{ year: <span class="string">"2013"</span>; city: <span class="string">"Rauma"</span>; expenses: <span class="string">"1990"</span>; }
ListElement{ year: <span class="string">"2013"</span>; city: <span class="string">"Helsinki"</span>; expenses: <span class="string">"7230"</span>; }
ListElement{ year: <span class="string">"2013"</span>; city: <span class="string">"Tampere"</span>; expenses: <span class="string">"4650"</span>; }
}
}
</pre>
<p>See <a href="qtdatavisualization-qmlbars-example.html">Qt Quick 2 Bars Example</a> for more thorough usage example.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a>, <a href="qml-qtdatavisualization-itemmodelbardataproxy.html">ItemModelBarDataProxy</a>, <a href="qml-qtdatavisualization-scatter3d.html">Scatter3D</a>, <a href="qml-qtdatavisualization-surface3d.html">Surface3D</a>, and <a href="qtdatavisualization-module.html">Qt Data Visualization C++ Classes</a>.</p>
<!-- @@@Bars3D -->
<h2>Property Documentation</h2>
<!-- $$$barSpacing -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="barSpacing-prop">
<td class="tblQmlPropNode"><p>
<a name="barSpacing-prop"></a><span class="name">barSpacing</span> : <span class="type">size</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Bar spacing in X and Z dimensions.</p>
<p>Preset to <code>(1.0, 1.0)</code> by default. Spacing is affected by the <a href="qml-qtdatavisualization-bars3d.html#barSpacingRelative-prop">barSpacingRelative</a> property.</p>
</div></div><!-- @@@barSpacing -->
<br/>
<!-- $$$barSpacingRelative -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="barSpacingRelative-prop">
<td class="tblQmlPropNode"><p>
<a name="barSpacingRelative-prop"></a><span class="name">barSpacingRelative</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Whether spacing is absolute or relative to bar thickness.</p>
<p>If <code>true</code>, the value of <code>0.0</code> means that the bars are placed side-to-side, <code>1.0</code> means that a space as wide as the thickness of one bar is left between the bars, and so on. Preset to <code>true</code>.</p>
</div></div><!-- @@@barSpacingRelative -->
<br/>
<!-- $$$barThickness -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="barThickness-prop">
<td class="tblQmlPropNode"><p>
<a name="barThickness-prop"></a><span class="name">barThickness</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The bar thickness ratio between the X and Z dimensions. The value <code>1.0</code> means that the bars are as wide as they are deep, whereas <code>0.5</code> makes them twice as deep as they are wide.</p>
</div></div><!-- @@@barThickness -->
<br/>
<!-- $$$columnAxis -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="columnAxis-prop">
<td class="tblQmlPropNode"><p>
<a name="columnAxis-prop"></a><span class="name">columnAxis</span> : <span class="type"><a href="qml-qtdatavisualization-categoryaxis3d.html">CategoryAxis3D</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The active column axis.</p>
<p>If an axis is not given, a temporary default axis with no labels is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.</p>
</div></div><!-- @@@columnAxis -->
<br/>
<!-- $$$floorLevel -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="floorLevel-prop">
<td class="tblQmlPropNode"><p>
<a name="floorLevel-prop"></a><span class="name">floorLevel</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The floor level for the bar graph in Y-axis data coordinates.</p>
<p>The actual floor level will be restricted by the Y-axis minimum and maximum values. Defaults to zero.</p>
</div></div><!-- @@@floorLevel -->
<br/>
<!-- $$$multiSeriesUniform -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="multiSeriesUniform-prop">
<td class="tblQmlPropNode"><p>
<a name="multiSeriesUniform-prop"></a><span class="name">multiSeriesUniform</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Defines whether bars are to be scaled with proportions set to a single series bar even if there are multiple series displayed. If set to <code>true</code>, <a href="qml-qtdatavisualization-bars3d.html#barSpacing-prop">bar spacing</a> will be correctly applied only to the X-axis. Preset to <code>false</code> by default.</p>
</div></div><!-- @@@multiSeriesUniform -->
<br/>
<!-- $$$primarySeries -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="primarySeries-prop">
<td class="tblQmlPropNode"><p>
<a name="primarySeries-prop"></a><span class="name">primarySeries</span> : <span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The primary series of the graph. It is used to determine the row and column axis labels when the labels are not explicitly set to the axes.</p>
<p>If the specified series is not yet added to the graph, setting it as the primary series will also implicitly add it to the graph.</p>
<p>If the primary series itself is removed from the graph, this property resets to default.</p>
<p>If the series is null, this property resets to default. Defaults to the first added series or zero if no series are added to the graph.</p>
</div></div><!-- @@@primarySeries -->
<br/>
<!-- $$$rowAxis -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rowAxis-prop">
<td class="tblQmlPropNode"><p>
<a name="rowAxis-prop"></a><span class="name">rowAxis</span> : <span class="type"><a href="qml-qtdatavisualization-categoryaxis3d.html">CategoryAxis3D</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The active row axis.</p>
<p>If an axis is not given, a temporary default axis with no labels is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.</p>
</div></div><!-- @@@rowAxis -->
<br/>
<!-- $$$selectedSeries -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="selectedSeries-prop">
<td class="tblQmlPropNode"><p>
<a name="selectedSeries-prop"></a><span class="name">selectedSeries</span> : <span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The selected series or <code>null</code>. If <a href="qabstract3dgraph.html#selectionMode-prop">selectionMode</a> has the <code>SelectionMultiSeries</code> flag set, this property holds the series that owns the selected bar.</p>
</div></div><!-- @@@selectedSeries -->
<br/>
<!-- $$$seriesList -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="seriesList-prop">
<td class="tblQmlPropNode"><p>
<a name="seriesList-prop"></a><span class="qmldefault">[default] </span><span class="name">seriesList</span> : <span class="type">list</span><<span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The series of the graph. By default, this property contains an empty list. To set the series, either use the <a href="qml-qtdatavisualization-bars3d.html#addSeries-method">addSeries()</a> function or define them as children of the graph.</p>
</div></div><!-- @@@seriesList -->
<br/>
<!-- $$$valueAxis -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valueAxis-prop">
<td class="tblQmlPropNode"><p>
<a name="valueAxis-prop"></a><span class="name">valueAxis</span> : <span class="type"><a href="qml-qtdatavisualization-valueaxis3d.html">ValueAxis3D</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The active value axis.</p>
<p>If an axis is not given, a temporary default axis with no labels and an automatically adjusting range is created. This temporary axis is destroyed if another axis is explicitly set to the same orientation.</p>
</div></div><!-- @@@valueAxis -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$addSeries -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="addSeries-method">
<td class="tblQmlFuncNode"><p>
<a name="addSeries-method"></a><span class="type">void</span> <span class="name">addSeries</span>(<span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span> <i>series</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Adds the <i>series</i> to the graph. A graph can contain multiple series, but only one set of axes, so the rows and columns of all series must match for the visualized data to be meaningful. If the graph has multiple visible series, only the first one added will generate the row or column labels on the axes in cases where the labels are not explicitly set to the axes. If the newly added series has specified a selected bar, it will be highlighted and any existing selection will be cleared. Only one added series can have an active selection.</p>
</div></div><!-- @@@addSeries -->
<br/>
<!-- $$$insertSeries -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="insertSeries-method">
<td class="tblQmlFuncNode"><p>
<a name="insertSeries-method"></a><span class="type">void</span> <span class="name">insertSeries</span>(<span class="type">int</span> <i>index</i>, <span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span> <i>series</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Inserts the <i>series</i> into the position <i>index</i> in the series list. If the <i>series</i> has already been added to the list, it is moved to the new <i>index</i>.</p>
<p><b>Note: </b>When moving a series to a new <i>index</i> that is after its old index, the new position in list is calculated as if the series was still in its old index, so the final index is actually the <i>index</i> decremented by one.</p></div></div><!-- @@@insertSeries -->
<br/>
<!-- $$$removeSeries -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="removeSeries-method">
<td class="tblQmlFuncNode"><p>
<a name="removeSeries-method"></a><span class="type">void</span> <span class="name">removeSeries</span>(<span class="type"><a href="qml-qtdatavisualization-bar3dseries.html">Bar3DSeries</a></span> <i>series</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Remove the <i>series</i> from the graph.</p>
</div></div><!-- @@@removeSeries -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
845e36bb3ecce380666d628d88446962
>
files
>
135
