summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2013-11-11 13:22:54 +0200
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-11-15 08:24:15 +0200
commit999ffa01d20f75a457da62d41c0fabfc32e5e1bb (patch)
treec5267f6831d5ff61444f85b2110f7150e20d3451 /src/datavisualization/doc/src
parentbbb874d0591215164b2030db60dc9d6a95f4c8fe (diff)
Basic multiseries support
Task-number: QTRD-2548 Change-Id: Iba324c0e8be56f2b3f8f6c6a992883c134a51a9d Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com> Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc5
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc27
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc27
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc30
4 files changed, 56 insertions, 33 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
index 59331bf9..989bcc9b 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
@@ -70,8 +70,3 @@
\qmlproperty bool AbstractGraph3D::backgroundVisible
Background visibility. If false, background is not drawn.
*/
-
-/*!
- \qmlproperty string AbstractGraph3D::itemLabelFormat
- Label format of single item labels, e.g. a selected datapoint.
- */
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
index c81e5aac..45324b8a 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 ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
+ * \sa Bar3DSeries, ItemModelBarData, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes}
*/
/*!
@@ -53,14 +53,6 @@
*/
/*!
- * \qmlproperty BarDataProxy Bars3D::dataProxy
- * The active data proxy.
- *
- * If a proxy is not given, a temporary default proxy is created and activated.
- * This temporary proxy is destroyed if another proxy is explicitly set active via this property.
- */
-
-/*!
* \qmlproperty CategoryAxis3D Bars3D::rowAxis
* A user-defined row axis.
*
@@ -134,3 +126,20 @@
* 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
+ * 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 removeSeries(QBar3DSeries *series)
+ * Remove the \a series from the graph.
+ */
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
index e9661b60..7ad9d470 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
@@ -36,7 +36,7 @@
See \l{Qt Quick 2 Scatter Example} for more thorough usage example.
- \sa ItemModelScatterDataProxy, Bars3D, Surface3D, {Qt Data Visualization C++ Classes}
+ \sa Scatter3DSeries, ScatterDataProxy, Bars3D, Surface3D, {Qt Data Visualization C++ Classes}
*/
/*!
@@ -53,14 +53,6 @@
*/
/*!
- \qmlproperty ScatterDataProxy Scatter3D::dataProxy
- The active data proxy.
-
- If a proxy is not given, a temporary default proxy is created and activated.
- This temporary proxy is destroyed if another proxy is explicitly set active via this property.
- */
-
-/*!
\qmlproperty ValueAxis3D Scatter3D::axisX
A user-defined X axis.
@@ -109,3 +101,20 @@
Selects an item in the \a index. Only one item can be selected at a time.
To clear selection, specify an illegal \a index, e.g. -1.
*/
+
+/*!
+ * \qmlproperty list<QScatter3DSeries> 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(QScatter3DSeries *series)
+ * Add the \a series to the graph.
+ */
+
+/*!
+ * \qmlmethod void removeSeries(QScatter3DSeries *series)
+ * Remove the \a series from the graph.
+ */
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
index 55a0d1d1..d1422b10 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
@@ -36,15 +36,7 @@
See \l{Qt Quick 2 Surface Example} for more thorough usage example.
- \sa ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes}
- */
-
-/*!
- \qmlproperty SurfaceDataProxy Surface3D::dataProxy
- The active data proxy.
-
- If a proxy is not given, a temporary default proxy is created and activated.
- This temporary proxy is destroyed if another proxy is explicitly set active via this property.
+ \sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes}
*/
/*!
@@ -99,7 +91,25 @@
\qmlproperty point Surface3D::selectedPoint
Selects a surface grid point in a \a position. The position is the (row, column) position in
- the data array of the active data proxy.
+ the data array of the series.
Only one point can be selected at a time.
To clear selection, specify an illegal \a position, e.g. (-1, -1).
*/
+
+/*!
+ * \qmlproperty list<QSurface3DSeries> 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.
+ * \note The surface graph currently supports only a single series at a time.
+ */
+
+/*!
+ * \qmlmethod void addSeries(QSurface3DSeries *series)
+ * Add the \a series to the graph.
+ */
+
+/*!
+ * \qmlmethod void removeSeries(QSurface3DSeries *series)
+ * Remove the \a series from the graph.
+ */