summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2013-11-25 09:46:24 +0200
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-11-25 12:39:56 +0200
commite7e01ec065d3874d28e9e28d213783c4275d8813 (patch)
treecae322801171a81362477d0a4156f451ae8cc450 /src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
parent8b55f6d7a7d8772553d7d2cc3647fb7465b9dc32 (diff)
Fix documentation related to multiseries changes.
Also fixed some other miscellaneous issues. Task-number: QTRD-2558 Change-Id: I2da3f7e64fbbbb287ddb7845cb0a15006dc4d6f5 Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc21
1 files changed, 10 insertions, 11 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
index 45324b8a..bb99a539 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
@@ -36,7 +36,7 @@
*
* See \l{Qt Quick 2 Bars Example} for more thorough usage example.
*
- * \sa Bar3DSeries, ItemModelBarData, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
+ * \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
*/
/*!
@@ -122,24 +122,23 @@
*/
/*!
- * \qmlproperty point Bars3D::selectedBar
- * Position of the selected bar in data window. Only one bar can be selected at a time.
- * To clear selection, specify an illegal position, e.g. Qt.point(-1.0, -1.0).
- */
-
-/*!
- * \qmlproperty list<QBar3DSeries> seriesList
+ * \qmlproperty list<QBar3DSeries> Bars3D::seriesList
* This property holds the series of the graph.
* By default, this property contains an empty list.
* To set the series, either use the addSeries() function or define them as children of the graph.
*/
/*!
- * \qmlmethod void addSeries(QBar3DSeries *series)
- * Add the \a series to the graph.
+ * \qmlmethod void Bars3D::addSeries(QBar3DSeries *series)
+ * Adds the \a series 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.
*/
/*!
- * \qmlmethod void removeSeries(QBar3DSeries *series)
+ * \qmlmethod void Bars3D::removeSeries(QBar3DSeries *series)
* Remove the \a series from the graph.
*/