##// END OF EJS Templates
HG_REPOSITORIES » LPP » INSTRUMENTATION » USERS » JEANDET » qtcharts
RSS

Clone from http://code.qt.io/qt/qtcharts.git

Documenting QML bar model mappers
Tero Ahola -
r1492:26979a8da75e
parent child
Show More
Side by Side Unified
Context file:
r1492:26979a8da75e Loading diff...:
Show file before | Show file after | Hide comments
@@ -36,6 +36,8
36 <li><a href="qml-scatterseries.html">ScatterSeries</a></li>
36 <li><a href="qml-scatterseries.html">ScatterSeries</a></li>
37 <li><a href="qml-splineseries.html">SplineSeries</a></li>
37 <li><a href="qml-splineseries.html">SplineSeries</a></li>
38 <li><a href="qml-xypoint.html">XyPoint</a></li>
38 <li><a href="qml-xypoint.html">XyPoint</a></li>
39 <li><a href="qml-hxymodelmapper.html">HXYModelMapper</a></li>
40 <li><a href="qml-vxymodelmapper.html">VXYModelMapper</a></li>
39 </ul>
41 </ul>
40 </td>
42 </td>
41 </tr>
43 </tr>
@@ -48,6 +50,8
48 <ul>
50 <ul>
49 <li><a href="qml-pieseries.html">PieSeries</a></li>
51 <li><a href="qml-pieseries.html">PieSeries</a></li>
50 <li><a href="qml-pieslice.html">PieSlice</a></li>
52 <li><a href="qml-pieslice.html">PieSlice</a></li>
53 <li><a href="qml-hpiemodelmapper.html">HPieModelMapper</a></li>
54 <li><a href="qml-vpiemodelmapper.html">VPieModelMapper</a></li>
51 </ul>
55 </ul>
52 </td>
56 </td>
53 </tr>
57 </tr>
@@ -63,6 +67,8
63 <li><a href="qml-stackedbarseries.html">StackedBarSeries</a></li>
67 <li><a href="qml-stackedbarseries.html">StackedBarSeries</a></li>
64 <li><a href="qml-percentbarseries.html">PercentBarSeries</a></li>
68 <li><a href="qml-percentbarseries.html">PercentBarSeries</a></li>
65 <li><a href="qml-barset.html">BarSet</a></li>
69 <li><a href="qml-barset.html">BarSet</a></li>
70 <li><a href="qml-hbarmodelmapper.html">HBarModelMapper</a></li>
71 <li><a href="qml-vbarmodelmapper.html">VBarModelMapper</a></li>
66 </ul>
72 </ul>
67 </td>
73 </td>
68 </tr>
74 </tr>
Show file before | Show file after | Hide comments
@@ -39,55 +39,76 QTCOMMERCIALCHART_BEGIN_NAMESPACE
39 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
39 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
40 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
40 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
41 */
41 */
42 /*!
43 \qmlclass BarModelMapper
44 Cannot be created by the user. Base for HBarModelMapper and VBarModelMapper. Model mappers allow you to use
45 QAbstractItemModel derived models as a data source for a chart series. Adding/removing value from the BarSet causes
46 the the same change in the rest of the BarSets added to the same series.
47 */
42
48
43 /*!
49 /*!
44 \property QBarModelMapper::series
50 \property QBarModelMapper::series
45 \brief Defines the QPieSeries object that is used by the mapper.
51 \brief Defines the QPieSeries object that is used by the mapper.
46
47 All the data in the series is discarded when it is set to the mapper.
52 All the data in the series is discarded when it is set to the mapper.
48 When new series is specified the old series is disconnected (it preserves its data)
53 When new series is specified the old series is disconnected (it preserves its data)
49 */
54 */
55 /*!
56 \qmlproperty BarSeries BarModelMapper::series
57 Defines the BarSeries based object that is used by the mapper. All the data in the series is
58 discarded when it is set to the mapper. When new series is specified the old series is
59 disconnected (it preserves its data).
60 */
50
61
51 /*!
62 /*!
52 \property QBarModelMapper::model
63 \property QBarModelMapper::model
53 \brief Defines the model that is used by the mapper.
64 \brief Defines the model that is used by the mapper.
54 */
65 */
66 /*!
67 \qmlproperty Model BarModelMapper::model
68 The QAbstractItemModel based model that is used by the mapper. You need to implement the model and expose it to
69 QML as shown in \l {QML Custom Model} demo application. NOTE: the model has to support adding/removing rows/columns
70 and modifying the data of the cells.
71 */
55
72
56 /*!
73 /*!
57 \property QBarModelMapper::first
74 \property QBarModelMapper::first
58 \brief Defines which item of the model's row/column should be mapped as the value of the first QBarSet in the series.
75 \brief Defines which item of the model's row/column should be mapped as the value of the first QBarSet in the series.
59
60 Minimal and default value is: 0
76 Minimal and default value is: 0
61 */
77 */
78 /*!
79 \qmlproperty int BarModelMapper::first
80 Defines which item of the model's row/column should be mapped as the value of the first QBarSet in the series.
81 The default value is 0.
82 */
62
83
63 /*!
84 /*!
64 \property QBarModelMapper::count
85 \property QBarModelMapper::count
65 \brief Defines the number of rows/columns of the model that are mapped as the data for QBarSeries
86 \brief Defines the number of rows/columns of the model that are mapped as the data for QBarSeries
66
67 Minimal and default value is: -1 (count limited by the number of rows/columns in the model)
87 Minimal and default value is: -1 (count limited by the number of rows/columns in the model)
68 */
88 */
89 /*!
90 \qmlproperty int BarModelMapper::count
91 Defines the number of rows/columns of the model that are mapped as the data for QBarSeries. The default value is
92 -1 (count limited by the number of rows/columns in the model)
93 */
69
94
70 /*!
95 /*!
71 \fn void QBarModelMapper::seriesReplaced()
96 \fn void QBarModelMapper::seriesReplaced()
72
73 Emitted when the series to which mapper is connected to has changed.
97 Emitted when the series to which mapper is connected to has changed.
74 */
98 */
75
99
76 /*!
100 /*!
77 \fn void QBarModelMapper::modelReplaced()
101 \fn void QBarModelMapper::modelReplaced()
78
79 Emitted when the model to which mapper is connected to has changed.
102 Emitted when the model to which mapper is connected to has changed.
80 */
103 */
81
104
82 /*!
105 /*!
83 \fn void QBarModelMapper::firstChanged()
106 \fn void QBarModelMapper::firstChanged()
84
85 Emitted when the value for the first has changed.
107 Emitted when the value for the first has changed.
86 */
108 */
87
109
88 /*!
110 /*!
89 \fn void QBarModelMapper::countChanged()
111 \fn void QBarModelMapper::countChanged()
90
91 Emitted when the value for the count has changed.
112 Emitted when the value for the count has changed.
92 */
113 */
93
114
Show file before | Show file after | Hide comments
@@ -33,6 +33,26 QTCOMMERCIALCHART_BEGIN_NAMESPACE
33 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
33 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
35 */
35 */
36 /*!
37 \qmlclass HBarModelMapper
38 \inherits BarModelMapper
39 \mainclass
40
41 HBarModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source
42 for any bar series. The following QML example would create a bar series with three bar sets (assuming the model has
43 at least four rows). Each bar set would contain data starting from column 1. The name of a set would be defined
44 by the vertical header (of the row).
45 \code
46 BarSeries {
47 HBarModelMapper {
48 model: myCustomModel
49 firstBarSetRow: 1
50 lastBarSetRow: 3
51 first: 1
52 }
53 }
54 \endcode
55 */
36
56
37 /*!
57 /*!
38 \property QHBarModelMapper::firstBarSetRow
58 \property QHBarModelMapper::firstBarSetRow
Show file before | Show file after | Hide comments
@@ -33,30 +33,56 QTCOMMERCIALCHART_BEGIN_NAMESPACE
33 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
33 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
34 NOTE: used model has to support adding/removing rows/columns and modifying the data of the cells.
35 */
35 */
36 /*!
37 \qmlclass VBarModelMapper
38 \inherits BarModelMapper
39 \mainclass
40
41 VBarModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source
42 for any bar series. The following QML example would create a bar series with three bar sets (assuming the model has
43 at least four columns). Each bar set would contain data starting from row 1. The name of a set would be defined
44 by the horizontal header (of the column).
45 \code
46 GroupedBarSeries {
47 VBarModelMapper {
48 model: myCustomModel
49 firstBarSetColumn: 1
50 lastBarSetColumn: 3
51 first: 1
52 }
53 }
54 \endcode
55 */
36
56
37 /*!
57 /*!
38 \property QVBarModelMapper::firstBarSetColumn
58 \property QVBarModelMapper::firstBarSetColumn
39 \brief Defines which column of the model is used as the data source for the first bar set
59 \brief Defines which column of the model is used as the data source for the first bar set
40
41 Default value is: -1 (invalid mapping)
60 Default value is: -1 (invalid mapping)
42 */
61 */
62 /*!
63 \qmlproperty int VBarModelMapper::firstBarSetColumn
64 Defines which column of the model is used as the data source for the first bar set. Default value
65 is: -1 (invalid mapping).
66 */
43
67
44 /*!
68 /*!
45 \property QVBarModelMapper::lastBarSetColumn
69 \property QVBarModelMapper::lastBarSetColumn
46 \brief Defines which column of the model is used as the data source for the last bar set
70 \brief Defines which column of the model is used as the data source for the last bar set
47
48 Default value is: -1 (invalid mapping)
71 Default value is: -1 (invalid mapping)
49 */
72 */
73 /*!
74 \qmlproperty int VBarModelMapper::lastBarSetColumn
75 Defines which column of the model is used as the data source for the last bar set. Default
76 value is: -1 (invalid mapping).
77 */
50
78
51 /*!
79 /*!
52 \fn void QVBarModelMapper::firstBarSetColumnChanged()
80 \fn void QVBarModelMapper::firstBarSetColumnChanged()
53
54 Emitted when the firstBarSetColumn has changed.
81 Emitted when the firstBarSetColumn has changed.
55 */
82 */
56
83
57 /*!
84 /*!
58 \fn void QVBarModelMapper::lastBarSetColumnChanged()
85 \fn void QVBarModelMapper::lastBarSetColumnChanged()
59
60 Emitted when the lastBarSetColumn has changed.
86 Emitted when the lastBarSetColumn has changed.
61 */
87 */
62
88
General Comments 0
You need to be logged in to leave comments. Login now