HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1859:46904270c5f5

barchart doc review updates

sauimone -

r1859:46904270c5f5

parent child

Context file:

r1859:46904270c5f5

Collapse all files

doc/src/examples-barchart.qdoc +16 -8

                 \image examples_barchart.png
+                The barsets are used in same way in all barcharts.
+            	To illustrate difference between various barcharts, we use same data in examples.
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
-                to them.
+                to them. The data is appended here with << operator. Alternatively the append method could be used.
                 \snippet ../examples/barchart/main.cpp 1
-                We create the series and append the sets to it. The barseries groups the data from sets to categories.
+                We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
             	First value of each set are gropuped together at first category second value to second category and so on.
                 \snippet ../examples/barchart/main.cpp 2
-                Then we create a chart and add the series to it.
+                Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
+            	setAnimationOptions(QChart::SeriesAnimations)
                 \snippet ../examples/barchart/main.cpp 3
-            	We define the categories here and add them to QCategoriesAxis which we then set to be the x-axis of the chart.
+            	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
+            	set it to be the x-axis of the chart. The chart takes ownership of axis. For y-axis we use default axis, which is created and scaled to series data
+            	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
+            	override the category axis.
                 \snippet ../examples/barchart/main.cpp 4
-                And we also want to show the legend.
+                We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
+            	to Qt::AlignBottom.
                 \snippet ../examples/barchart/main.cpp 5
-                Finally we add the chart onto a view.
+                Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
                 \snippet ../examples/barchart/main.cpp 6
-                And it is ready to be shown in a window.
+                Chart is ready to be shown. We set the chart to be central widget of the window.
+            	We also set the size for the chart window and show it.
                 \snippet ../examples/barchart/main.cpp 7
-            */
+            */
  No newline at end of file

doc/src/examples-horizontalbarchart.qdoc +17 -8

                 \title HorizontalBarChart Example
                 \subtitle
-                The example shows how to create a horizontal bar chart. HorizontalBarChart shows the data in sets as separate bars, which are grouped in categories.
+                The example shows how to create a horizontal bar chart. QHorizontalBarChart shows the data in sets as separate bars, which are grouped in categories. QHorizontalBarChart works just like
+            	QBarChart, except that the bars are drawn horizontally on the chart.
                 \image examples_horizontalbarchart.png
+                The barsets are used in same way in all barcharts.
+            	To illustrate difference between various barcharts, we use same data in examples.
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
-                to them.
+                to them. The data is appended here with << operator. Alternatively the append method could be used.
                 \snippet ../examples/horizontalbarchart/main.cpp 1
-                We create the series and append the sets to it. The horizontalbarseries groups the data from sets to categories.
+                We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
             	First value of each set are gropuped together at first category second value to second category and so on.
                 \snippet ../examples/horizontalbarchart/main.cpp 2
-                Then we create a chart and add the series to it.
+                Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
+            	setAnimationOptions(QChart::SeriesAnimations)
                 \snippet ../examples/horizontalbarchart/main.cpp 3
-            	We define the categories here and add them to QCategoriesAxis which we then set to be the x-axis of the chart.
+            	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
+            	set it to be the y-axis of the chart. The chart takes ownership of axis. For x-axis we use default axis, which is created and scaled to series data
+            	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
+            	override the category axis.
                 \snippet ../examples/horizontalbarchart/main.cpp 4
-                And we also want to show the legend.
+                We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
+            	to Qt::AlignBottom.
                 \snippet ../examples/horizontalbarchart/main.cpp 5
-                Finally we add the chart onto a view.
+                Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
                 \snippet ../examples/horizontalbarchart/main.cpp 6
-                And it is ready to be shown in a window.
+                Chart is ready to be shown. We set the chart to be central widget of the window.
+            	We also set the size for the chart window and show it.
                 \snippet ../examples/horizontalbarchart/main.cpp 7
             */

doc/src/examples-horizontalpercentbarchart.qdoc +38 -2

@@ -6,12 +6,48
6	The example shows how to create simple horizontal percent bar chart. Horizontal percent bar chart shows the data in set as percentage of	6	The example shows how to create simple horizontal percent bar chart. Horizontal percent bar chart shows the data in set as percentage of
7	all sets, per category.	7	all sets, per category.
8		8
9	\image examples_horizontalpercentbarchart.png
10
11	Creating horizontal percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a	9	Creating horizontal percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
12	horizontal percent bar chart, we use QHorizontalPercentBarSeries api instead of QBarSeries. Also, in the	10	horizontal percent bar chart, we use QHorizontalPercentBarSeries api instead of QBarSeries. Also, in the
13	\l {BarChart Example} {bar chart} we used nice numbers algorithm to make the y axis numbering look better. With	11	\l {BarChart Example} {bar chart} we used nice numbers algorithm to make the y axis numbering look better. With
14	percent bar chart there is no need for that, because the maximum y-axis value is always 100.	12	percent bar chart there is no need for that, because the maximum y-axis value is always 100.
		13
		14	\image examples_horizontalpercentbarchart.png
		15
		16	The barsets are used in same way in all barcharts.
		17	To illustrate difference between various barcharts, we use same data in examples.
		18	Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
		19	to them. The data is appended here with << operator. Alternatively the append method could be used.
		20
		21	\snippet ../examples/horizontalpercentbarchart/main.cpp 1
		22
		23	We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
		24	First value of each set are gropuped together at first category second value to second category and so on.
		25
		26	\snippet ../examples/horizontalpercentbarchart/main.cpp 2
		27
		28	Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
		29	setAnimationOptions(QChart::SeriesAnimations)
15		30
16	\snippet ../examples/horizontalpercentbarchart/main.cpp 3	31	\snippet ../examples/horizontalpercentbarchart/main.cpp 3
		32
		33	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
		34	set it to be the y-axis of the chart. The chart takes ownership of axis. For x-axis we use default axis, which is created and scaled to series data
		35	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
		36	override the category axis.
		37
		38	\snippet ../examples/horizontalpercentbarchart/main.cpp 4
		39
		40	We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
		41	to Qt::AlignBottom.
		42
		43	\snippet ../examples/horizontalpercentbarchart/main.cpp 5
		44
		45	Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
		46
		47	\snippet ../examples/horizontalpercentbarchart/main.cpp 6
		48
		49	Chart is ready to be shown. We set the chart to be central widget of the window.
		50	We also set the size for the chart window and show it.
		51
		52	\snippet ../examples/horizontalpercentbarchart/main.cpp 7
17	*/	53	*/

doc/src/examples-horizontalstackedbarchart.qdoc +38 -3

@@ -5,11 +5,46
5		5
6	The example shows how to create simple stacked horizontal bar chart. Stacked bar chart shows the data in sets as bars that are	6	The example shows how to create simple stacked horizontal bar chart. Stacked bar chart shows the data in sets as bars that are
7	stacked on top of each other. The stacking is done per category.	7	stacked on top of each other. The stacking is done per category.
		8	Creating stacked horizontal bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
		9	stacked horizontal bar chart, we use QHorizontalStackedBarSeries api instead of QBarSeries.
8		10
9	\image examples_horizontalstackedbarchart.png	11	\image examples_horizontalstackedbarchart.png
10		12
11	Creating stacked horizontal bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a	13	The barsets are used in same way in all barcharts.
12	stacked horizontal bar chart, we use QHorizontalStackedBarSeries api instead of QBarSeries.	14	To illustrate difference between various barcharts, we use same data in examples.
		15	Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
		16	to them. The data is appended here with << operator. Alternatively the append method could be used.
		17
		18	\snippet ../examples/horizontalstackedbarchart/main.cpp 1
		19
		20	We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
		21	First value of each set are gropuped together at first category second value to second category and so on.
		22
		23	\snippet ../examples/horizontalstackedbarchart/main.cpp 2
		24
		25	Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
		26	setAnimationOptions(QChart::SeriesAnimations)
13		27
14	\snippet ../examples/horizontalstackedbarchart/main.cpp 3	28	\snippet ../examples/horizontalstackedbarchart/main.cpp 3
15	*/	29
		30	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
		31	set it to be the y-axis of the chart. The chart takes ownership of axis. For x-axis we use default axis, which is created and scaled to series data
		32	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
		33	override the category axis.
		34
		35	\snippet ../examples/horizontalstackedbarchart/main.cpp 4
		36
		37	We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
		38	to Qt::AlignBottom.
		39
		40	\snippet ../examples/horizontalstackedbarchart/main.cpp 5
		41
		42	Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
		43
		44	\snippet ../examples/horizontalstackedbarchart/main.cpp 6
		45
		46	Chart is ready to be shown. We set the chart to be central widget of the window.
		47	We also set the size for the chart window and show it.
		48
		49	\snippet ../examples/horizontalstackedbarchart/main.cpp 7
		50	*/ No newline at end of file

doc/src/examples-percentbarchart.qdoc +38 -2

@@ -6,12 +6,48
6	The example shows how to create simple percent bar chart. Percent bar chart shows the data in set as percentage of	6	The example shows how to create simple percent bar chart. Percent bar chart shows the data in set as percentage of
7	all sets, per category.	7	all sets, per category.
8		8
9	\image examples_percentbarchart.png
10
11	Creating percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a	9	Creating percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
12	percent bar chart, we use QPercentBarSeries api instead of QBarSeries. Also, in the	10	percent bar chart, we use QPercentBarSeries api instead of QBarSeries. Also, in the
13	\l {BarChart Example} {bar chart} we used nice numbers algorithm to make the y axis numbering look better. With	11	\l {BarChart Example} {bar chart} we used nice numbers algorithm to make the y axis numbering look better. With
14	percent bar chart there is no need for that, because the maximum y-axis value is always 100.	12	percent bar chart there is no need for that, because the maximum y-axis value is always 100.
		13
		14	\image examples_percentbarchart.png
		15
		16	The barsets are used in same way in all barcharts.
		17	To illustrate difference between various barcharts, we use same data in examples.
		18	Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
		19	to them. The data is appended here with << operator. Alternatively the append method could be used.
		20
		21	\snippet ../examples/percentbarchart/main.cpp 1
		22
		23	We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
		24	First value of each set are gropuped together at first category second value to second category and so on.
		25
		26	\snippet ../examples/percentbarchart/main.cpp 2
		27
		28	Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
		29	setAnimationOptions(QChart::SeriesAnimations)
15		30
16	\snippet ../examples/percentbarchart/main.cpp 3	31	\snippet ../examples/percentbarchart/main.cpp 3
		32
		33	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
		34	set it to be the x-axis of the chart. The chart takes ownership of axis. For y-axis we use default axis, which is created and scaled to series data
		35	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
		36	override the category axis.
		37
		38	\snippet ../examples/percentbarchart/main.cpp 4
		39
		40	We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
		41	to Qt::AlignBottom.
		42
		43	\snippet ../examples/percentbarchart/main.cpp 5
		44
		45	Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
		46
		47	\snippet ../examples/percentbarchart/main.cpp 6
		48
		49	Chart is ready to be shown. We set the chart to be central widget of the window.
		50	We also set the size for the chart window and show it.
		51
		52	\snippet ../examples/percentbarchart/main.cpp 7
17	*/	53	*/

doc/src/examples-stackedbarchart.qdoc +41 -2

@@ -5,11 +5,50
5		5
6	The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are	6	The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are
7	stacked on top of each other. The stacking is done per category.	7	stacked on top of each other. The stacking is done per category.
		8	The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are
		9	stacked on top of each other. The stacking is done per category.
		10	Creating stacked bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
		11	stacked bar chart, we use QStackedBarSeries api instead of QBarSeries.
8		12
9	\image examples_stackedbarchart.png	13	\image examples_stackedbarchart.png
10		14
11	Creating stacked bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a	15	The barsets are used in same way in all barcharts.
12	stacked bar chart, we use QStackedBarSeries api instead of QBarSeries.	16	To illustrate difference between various barcharts, we use same data in examples.
		17	Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
		18	to them. The data is appended here with << operator. Alternatively the append method could be used.
		19
		20	\snippet ../examples/stackedbarchart/main.cpp 1
		21
		22	We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
		23	First value of each set are gropuped together at first category second value to second category and so on.
		24
		25	\snippet ../examples/stackedbarchart/main.cpp 2
		26
		27	Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
		28	setAnimationOptions(QChart::SeriesAnimations)
13		29
14	\snippet ../examples/stackedbarchart/main.cpp 3	30	\snippet ../examples/stackedbarchart/main.cpp 3
		31
		32	To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
		33	set it to be the x-axis of the chart. The chart takes ownership of axis. For y-axis we use default axis, which is created and scaled to series data
		34	by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
		35	override the category axis.
		36
		37	\snippet ../examples/stackedbarchart/main.cpp 4
		38
		39	We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting it's alignment
		40	to Qt::AlignBottom.
		41
		42	\snippet ../examples/stackedbarchart/main.cpp 5
		43
		44	Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
		45
		46	\snippet ../examples/stackedbarchart/main.cpp 6
		47
		48	Chart is ready to be shown. We set the chart to be central widget of the window.
		49	We also set the size for the chart window and show it.
		50
		51	\snippet ../examples/stackedbarchart/main.cpp 7
15	*/	52	*/
		53
		54

examples/barchart/main.cpp +1 -1

                 QChart* chart = new QChart();
                 chart->addSeries(series);
                 chart->setTitle("Simple barchart example");
-                chart->createDefaultAxes();
             //![3]
             //![4]
                 categories << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "Jun";
                 QBarCategoryAxis* axis = new QBarCategoryAxis();
                 axis->append(categories);
+                chart->createDefaultAxes();
                 chart->setAxisX(axis,series);
             //![4]

examples/horizontalbarchart/main.cpp +1 -2

                 series->append(set2);
                 series->append(set3);
                 series->append(set4);
             //![2]
             //![3]
                 QChart* chart = new QChart();
                 chart->addSeries(series);
                 chart->setTitle("Simple horizontal barchart example");
-                chart->createDefaultAxes();
                 chart->setAnimationOptions(QChart::SeriesAnimations);
             //![3]
                 categories << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "Jun";
                 QBarCategoryAxis* axis = new QBarCategoryAxis();
                 axis->append(categories);
+                chart->createDefaultAxes();
                 chart->setAxisY(axis,series);
             //![4]

examples/horizontalpercentbarchart/main.cpp 0 -1

                 QChart* chart = new QChart();
                 chart->addSeries(series);
                 chart->setTitle("Simple horizontal percent barchart example");
-                chart->createDefaultAxes();
                 chart->setAnimationOptions(QChart::SeriesAnimations);
             //![3]

examples/horizontalstackedbarchart/main.cpp 0 -1

                 QChart* chart = new QChart();
                 chart->addSeries(series);
                 chart->setTitle("Simple horizontal stacked barchart example");
-                chart->createDefaultAxes();
                 chart->setAnimationOptions(QChart::SeriesAnimations);
             //![3]

examples/stackedbarchart/main.cpp +1 -1

                 QChart* chart = new QChart();
                 chart->addSeries(series);
                 chart->setTitle("Simple stackedbarchart example");
-                chart->createDefaultAxes();
             //![3]
             //![4]
                 categories << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "Jun";
                 QBarCategoryAxis* axis = new QBarCategoryAxis();
                 axis->append(categories);
+                chart->createDefaultAxes();
                 chart->setAxisX(axis,series);
             //![4]

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages