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

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

Documenting QML bar series API
Tero Ahola -
r1489:ca99ef5d7b00
parent child
Show More
Side by Side Unified
Context file:
r1489:ca99ef5d7b00 Loading diff...:
Show file before | Show file after | Hide comments
@@ -26,62 +26,6
26 26
27 27 QTCOMMERCIALCHART_BEGIN_NAMESPACE
28 28
29 /*!
30 \qmlclass BarSeries QBarSeries
31
32 \section1 Example Usage
33
34 \beginfloatleft
35 \image demos_qmlchart6.png
36 \endfloat
37 \clearfloat
38
39 The following QML shows how to create a simple bar chart:
40 \snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1
41 */
42
43 /*!
44 \qmlclass GroupedBarSeries QGroupedBarSeries
45
46 \section1 Example Usage
47
48 \beginfloatleft
49 \image demos_qmlchart7.png
50 \endfloat
51 \clearfloat
52
53 The following QML shows how to create a simple grouped bar chart:
54 \snippet ../demos/qmlchart/qml/qmlchart/View7.qml 1
55 */
56
57 /*!
58 \qmlclass StackedBarSeries QStackedBarSeries
59
60 \section1 Example Usage
61
62 \beginfloatleft
63 \image demos_qmlchart8.png
64 \endfloat
65 \clearfloat
66
67 The following QML shows how to create a simple stacked bar chart:
68 \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1
69 */
70
71 /*!
72 \qmlclass PercentBarSeries QPercentBarSeries
73
74 \section1 Example Usage
75
76 \beginfloatleft
77 \image demos_qmlchart9.png
78 \endfloat
79 \clearfloat
80
81 The following QML shows how to create a simple percent bar chart:
82 \snippet ../demos/qmlchart/qml/qmlchart/View9.qml 1
83 */
84
85 29 DeclarativeBarSet::DeclarativeBarSet(QObject *parent) :
86 30 QBarSet("", parent)
87 31 {
Show file before | Show file after | Hide comments
@@ -45,26 +45,50 QTCOMMERCIALCHART_BEGIN_NAMESPACE
45 45
46 46 \sa QBarSet, QStackedBarSeries, QPercentBarSeries
47 47 */
48 /*!
49 \qmlclass BarSeries QBarSeries
50
51 \beginfloatleft
52 \image demos_qmlchart6.png
53 \endfloat
54 \clearfloat
55
56 The following QML shows how to create a simple bar chart:
57 \snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1
58 */
48 59
49 60 /*!
50 61 \property QBarSeries::barWidth
51 \brief The width of the bars of the series. The unit of \a width is the unit of x-axis. The minimum width for bars
62 The width of the bars of the series. The unit of \a width is the unit of x-axis. The minimum width for bars
52 63 is zero and negative values are treated as zero. Setting the width to zero means that width of the bar on screen
53 64 is one pixel no matter what the scale of x-axis is. Bars wider than zero are scaled with x-axis.
54 Note that with QGroupedBarSeries this value means the width of one group of bars instead of just one bar. This is
55 because with grouped series it is more logical to set width of whole group and let the chart calculate correct
56 width for bar.
65 Note that with QGroupedBarSeries this value means the width of one group of bars instead of just one bar.
57 66 \sa QGroupedBarSeries
58 67 */
68 /*!
69 \qmlproperty real BarSeries::barWidth
70 The width of the bars of the series. The unit of width is the unit of x-axis. The minimum width for bars
71 is zero and negative values are treated as zero. Setting the width to zero means that width of the bar on screen
72 is one pixel no matter what the scale of x-axis is. Bars wider than zero are scaled with x-axis.
73 Note that with QGroupedBarSeries this value means the width of one group of bars instead of just one bar.
74 */
59 75
60 76 /*!
61 77 \property QBarSeries::count
62 \brief Holds the number of sets in series.
78 Holds the number of sets in series.
79 */
80 /*!
81 \qmlproperty int BarSeries::count
82 Holds the number of sets in series.
63 83 */
64 84
65 85 /*!
66 86 \property QBarSeries::labelsVisible
67 \brief Defines the visibility of the labels in series
87 Defines the visibility of the labels in series
88 */
89 /*!
90 \qmlproperty bool BarSeries::labelsVisible
91 Defines the visibility of the labels in series
68 92 */
69 93
70 94 /*!
@@ -73,6 +97,12 QTCOMMERCIALCHART_BEGIN_NAMESPACE
73 97 The signal is emitted if the user clicks with a mouse on top of QBarSet \a barset.
74 98 Clicked bar inside set is indexed by \a index
75 99 */
100 /*!
101 \qmlsignal BarSeries::onClicked(BarSet barset, int index)
102
103 The signal is emitted if the user clicks with a mouse on top of BarSet.
104 Clicked bar inside set is indexed by \a index
105 */
76 106
77 107 /*!
78 108 \fn void QBarSeries::hovered(QBarSet* barset, bool status)
@@ -81,34 +111,38 QTCOMMERCIALCHART_BEGIN_NAMESPACE
81 111 Parameter \a barset is the pointer of barset, where hover happened.
82 112 Parameter \a status is true, if mouse entered on top of series, false if mouse left from top of series.
83 113 */
114 /*!
115 \qmlsignal BarSeries::onHovered(BarSet barset, bool status)
116
117 The signal is emitted if mouse is hovered on top of series.
118 Parameter \a barset is the pointer of barset, where hover happened.
119 Parameter \a status is true, if mouse entered on top of series, false if mouse left from top of series.
120 */
84 121
85 122 /*!
86 123 \fn void QBarSeries::countChanged()
87
124 This signal is emitted when barset count has been changed, for example by append or remove.
125 */
126 /*!
127 \qmlsignal BarSeries::countChanged()
88 128 This signal is emitted when barset count has been changed, for example by append or remove.
89 129 */
90 130
91 131 /*!
92 132 \fn void QBarSeries::labelsVisibleChanged()
93
94 This signal is emitted when labels visibility have changed.
95
133 This signal is emitted when labels visibility have changed.
96 134 \sa isLabelsVisible(), setLabelsVisible()
97 135 */
98 136
99 137 /*!
100 138 \fn void QBarSeries::barsetsAdded(QList<QBarSet*> sets)
101
102 139 This signal is emitted when \a sets have been added to the series.
103
104 140 \sa append(), insert()
105 141 */
106 142
107 143 /*!
108 144 \fn void QBarSeries::barsetsRemoved(QList<QBarSet*> sets)
109
110 145 This signal is emitted when \a sets have been removed from the series.
111
112 146 \sa remove()
113 147 */
114 148
Show file before | Show file after | Hide comments
@@ -36,10 +36,23 QTCOMMERCIALCHART_BEGIN_NAMESPACE
36 36
37 37 \sa QBarSeries, QGroupedBarSeries, QStackedBarSeries, QPercentBarSeries
38 38 */
39 /*!
40 \qmlclass BarSet QBarSet
41
42 BarSet represents one set of bars. Set of bars contains one data value for each category.
43 First value of set is assumed to belong to first category, second to second category and so on.
44 If set has fewer values than there are categories, then the missing values are assumed to be
45 at the end of set. For missing values in middle of a set, numerical value of zero is used.
46 \sa BarSeries, GroupedBarSeries, StackedBarSeries, PercentBarSeries
47 */
39 48
40 49 /*!
41 50 \property QBarSet::label
42 \brief Defines the label of the barSet.
51 Defines the label of the barSet.
52 */
53 /*!
54 \qmlproperty string BarSet::label
55 Defines the label of the barSet.
43 56 */
44 57
45 58 /*!
@@ -64,56 +77,58 QTCOMMERCIALCHART_BEGIN_NAMESPACE
64 77
65 78 /*!
66 79 \property QBarSet::color
67 \brief The fill (brush) color of the bar set.
80 The fill (brush) color of the bar set.
81 */
82 /*!
83 \qmlproperty color BarSet::color
84 The fill (brush) color of the bar set.
68 85 */
69 86
70 87 /*!
71 88 \property QBarSet::borderColor
72 \brief The line (pen) color of the bar set.
89 The line (pen) color of the bar set.
90 */
91 /*!
92 \qmlproperty color BarSet::borderColor
93 The line (pen) color of the bar set.
73 94 */
74 95
75 96 /*!
76 97 \property QBarSet::labelColor
77 \brief The text (label) color of the bar set.
98 The text (label) color of the bar set.
99 */
100 /*!
101 \qmlproperty color BarSet::labelColor
102 The text (label) color of the bar set.
78 103 */
79 104
80 105 /*!
81 106 \fn void QBarSet::labelChanged()
82
83 107 This signal is emitted when the label of the barSet has changed.
84
85 108 \sa label
86 109 */
87 110
88 111 /*!
89 112 \fn void QBarSet::penChanged()
90
91 113 This signal is emitted when the pen of the barSet has changed.
92
93 114 \sa pen
94 115 */
95 116
96 117 /*!
97 118 \fn void QBarSet::brushChanged()
98
99 119 This signal is emitted when the brush of the barSet has changed.
100
101 120 \sa brush
102 121 */
103 122
104 123 /*!
105 124 \fn void QBarSet::labelBrushChanged()
106
107 125 This signal is emitted when the brush of the barSet's label has changed.
108
109 126 \sa labelBrush
110 127 */
111 128
112 129 /*!
113 130 \fn void QBarSet::labelFontChanged()
114
115 131 This signal is emitted when the font of the barSet's label has changed.
116
117 132 \sa labelBrush
118 133 */
119 134
@@ -121,46 +136,68 QTCOMMERCIALCHART_BEGIN_NAMESPACE
121 136 \fn void QBarSet::colorChanged(QColor)
122 137 This signal is emitted when the fill (brush) color of the set has changed to \a color.
123 138 */
139 /*!
140 \qmlsignal BarSet::onColorChanged(color color)
141 This signal is emitted when the fill (brush) color of the set has changed to \a color.
142 */
124 143
125 144 /*!
126 145 \fn void QBarSet::borderColorChanged(QColor)
127 146 This signal is emitted when the line (pen) color of the set has changed to \a color.
128 147 */
148 /*!
149 \qmlsignal BarSet::onBorderColorChanged(color color)
150 This signal is emitted when the line (pen) color of the set has changed to \a color.
151 */
129 152
130 153 /*!
131 154 \fn void QBarSet::labelColorChanged(QColor)
132 155 This signal is emitted when the text (label) color of the set has changed to \a color.
133 156 */
157 /*!
158 \qmlsignal BarSet::onLabelColorChanged(color color)
159 This signal is emitted when the text (label) color of the set has changed to \a color.
160 */
134 161
135 162 /*!
136 163 \fn void QBarSet::valuesAdded(int index, int count)
137
138 164 This signal is emitted when new values have been added to the set.
139 165 Parameter \a index indicates the position of the first inserted value.
140 166 Parameter \a count is the number of iserted values.
141
142 167 \sa append(), insert()
143 168 */
169 /*!
170 \qmlsignal BarSet::onValuesAdded(int index, int count)
171 This signal is emitted when new values have been added to the set.
172 Parameter \a index indicates the position of the first inserted value.
173 Parameter \a count is the number of iserted values.
174 */
144 175
145 176 /*!
146 177 \fn void QBarSet::valuesRemoved(int index, int count)
147
148 178 This signal is emitted values have been removed from the set.
149 179 Parameter \a index indicates the position of the first removed value.
150 180 Parameter \a count is the number of removed values.
151
152 181 \sa remove()
153 182 */
183 /*!
184 \qmlsignal BarSet::onValuesRemoved(int index, int count)
185 This signal is emitted values have been removed from the set.
186 Parameter \a index indicates the position of the first removed value.
187 Parameter \a count is the number of removed values.
188 */
154 189
155 190 /*!
156 191 \fn void QBarSet::valueChanged(int index)
157
158 192 This signal is emitted values the value in the set has been modified.
159 193 Parameter \a index indicates the position of the modified value.
160
161 194 \sa at()
162 195 */
163 void valueChanged(int index);
196 /*!
197 \qmlsignal BarSet::onValueChanged(int index)
198 This signal is emitted values the value in the set has been modified.
199 Parameter \a index indicates the position of the modified value.
200 */
164 201
165 202 /*!
166 203 Constructs QBarSet with a label of \a label and with parent of \a parent
Show file before | Show file after | Hide comments
@@ -41,6 +41,17 QTCOMMERCIALCHART_BEGIN_NAMESPACE
41 41
42 42 \sa QBarSet, QPercentBarSeries, QBarSeries, QStackedBarSeries
43 43 */
44 /*!
45 \qmlclass GroupedBarSeries QGroupedBarSeries
46 \inherits BarSeries
47
48 The following QML shows how to create a simple grouped bar chart:
49 \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1
50 \beginfloatleft
51 \image demos_qmlchart7.png
52 \endfloat
53 \clearfloat
54 */
44 55
45 56 /*!
46 57 Constructs empty QGroupedBarSeries.
Show file before | Show file after | Hide comments
@@ -41,6 +41,17 QTCOMMERCIALCHART_BEGIN_NAMESPACE
41 41
42 42 \sa QBarSet, QStackedBarSeries, QBarSeries
43 43 */
44 /*!
45 \qmlclass PercentBarSeries QPercentBarSeries
46 \inherits BarSeries
47
48 The following QML shows how to create a simple percent bar chart:
49 \snippet ../demos/qmlchart/qml/qmlchart/View9.qml 1
50 \beginfloatleft
51 \image demos_qmlchart9.png
52 \endfloat
53 \clearfloat
54 */
44 55
45 56 /*!
46 57 Constructs empty QPercentBarSeries.
Show file before | Show file after | Hide comments
@@ -43,6 +43,18 QTCOMMERCIALCHART_BEGIN_NAMESPACE
43 43 */
44 44
45 45 /*!
46 \qmlclass StackedBarSeries QStackedBarSeries
47 \inherits BarSeries
48
49 The following QML shows how to create a simple stacked bar chart:
50 \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1
51 \beginfloatleft
52 \image demos_qmlchart8.png
53 \endfloat
54 \clearfloat
55 */
56
57 /*!
46 58 Constructs empty QStackedBarSeries.
47 59 QStackedBarSeries is QObject which is a child of a \a parent.
48 60 */
Show file before | Show file after | Hide comments
@@ -33,6 +33,8 ChartView {
33 33 BarSeries {
34 34 id: daSeries
35 35 name: "bar"
36 onClicked: console.log("onClicked: " + barset + " " + index);
37 onHovered: console.log("onHovered: " + barset + " " + status);
36 38 BarSet { label: "Bob"; values: [4, 7, 3, 10, 5, 6] }
37 39 BarSet { label: "Susan"; values: [5, 1, 2, 4, 1, 8] }
38 40 BarSet { label: "James"; values: [3, 5, 8, 5, 4, 7] }
Show file before | Show file after | Hide comments
@@ -33,6 +33,8 ChartView {
33 33 GroupedBarSeries {
34 34 id: daSeries
35 35 name: "bar"
36 onClicked: console.log("onClicked: " + barset + " " + index);
37 onHovered: console.log("onHovered: " + barset + " " + status);
36 38 BarSet { label: "Bob"; values: [2, 2, 3, 4, 5, 6] }
37 39 BarSet { label: "Susan"; values: [5, 1, 2, 4, 1, 7] }
38 40 BarSet { label: "James"; values: [3, 5, 8, 13, 5, 8] }
Show file before | Show file after | Hide comments
@@ -33,6 +33,8 ChartView {
33 33 PercentBarSeries {
34 34 id: daSeries
35 35 name: "bar"
36 onClicked: console.log("onClicked: " + barset + " " + index);
37 onHovered: console.log("onHovered: " + barset + " " + status);
36 38 BarSet { label: "Bob"; values: [2, 2, 3, 4, 5, 6] }
37 39 BarSet { label: "Susan"; values: [5, 1, 2, 4, 1, 7] }
38 40 BarSet { label: "James"; values: [3, 5, 8, 13, 5, 8] }
Show file before | Show file after | Hide comments
@@ -31,7 +31,7 ChartView {
31 31 PieSeries {
32 32 id: pieSeries
33 33 name: "pie"
34 PieSlice { id: daSlice; label: "slice1"; value: 11 }
34 PieSlice { label: "slice1"; value: 11 }
35 35 PieSlice { label: "slice2"; value: 22 }
36 36 PieSlice { label: "slice3"; value: 33 }
37 37 }
Show file before | Show file after | Hide comments
@@ -33,6 +33,8 ChartView {
33 33 StackedBarSeries {
34 34 id: daSeries
35 35 name: "bar"
36 onClicked: console.log("onClicked: " + barset + " " + index);
37 onHovered: console.log("onHovered: " + barset + " " + status);
36 38 BarSet { label: "Bob"; values: [2, 2, 3, 4, 5, 6] }
37 39 BarSet { label: "Susan"; values: [5, 1, 2, 4, 1, 7] }
38 40 BarSet { label: "James"; values: [3, 5, 8, 13, 5, 8] }
General Comments 0
You need to be logged in to leave comments. Login now