HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r971:29cedae3d4be

Updated bar chart documentation

Tero Ahola -

r971:29cedae3d4be

parent child

Context file:

r971:29cedae3d4be

Collapse all files

doc/images/examples_barchart.png created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

doc/images/examples_percentbarchart.png created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

doc/images/examples_stackedbarchart.png created 644 binary 0 0

NO CONTENT: new file 100644, binary diff hidden

doc/images/examples_zoomlinechart1.png ~~doc/images/example_zoomlinechart1.png~~ renamed 0 0

NO CONTENT: file renamed from doc/images/example_zoomlinechart1.png to doc/images/examples_zoomlinechart1.png

doc/images/examples_zoomlinechart2.png ~~doc/images/example_zoomlinechart2.png~~ renamed 0 0

NO CONTENT: file renamed from doc/images/example_zoomlinechart2.png to doc/images/examples_zoomlinechart2.png

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

             /*!
                 \example examples/barchart
                 \title BarChart Example
                 \subtitle
                 The example shows how to create simple bar chart. Barchart shows the data in sets as separate bars, which are grouped in categories.
-            	\image barchart.png
+                \image examples_barchart.png
                 First we define categories.
                 \snippet ../examples/barchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
-            	we want to visulaize to them.
+                we want to visualize to them.
                 \snippet ../examples/barchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
                 \snippet ../examples/barchart/main.cpp 3
-                We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
+                Then we create a chart and add the series to it.
-            	represents is shown as tooltip.
-            	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
-            	that are drawn on top of bars.
                 \snippet ../examples/barchart/main.cpp 4
-                Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
+                And we also want to show the legend, so that the data is easier to read.
                 \snippet ../examples/barchart/main.cpp 5
-                For barchart, we don't need X-axis to be visible, so it can be disabled.
+                Finally we add the chart onto a view.
                 \snippet ../examples/barchart/main.cpp 6
+                And it is ready to be shown in a window.
+                \snippet ../examples/percentbarchart/main.cpp 7
             */

doc/src/examples-percentbarchart.qdoc +7 -29

@@ -1,39 +1,17
1	/*!	1	/*!
2	\example examples/percentbarchart	2	\example examples/percentbarchart
3	\title PercentBarChart Example	3	\title PercentBarChart Example
4	\subtitle	4	\subtitle
5		5
6	The example shows how to create simple percent bar chart. Percent bar chart shows the data in set as percentage of ~~all sets, per category.~~	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		8
8	\image percentbarchart.png	9	\image examples_percentbarchart.png
9		10
10	First we define categories.	11	Creating percent bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
11		12	percent bar chart, we use QPercentBarSeries api instead of QBarSeries. Also, in the
12	\snippet ../examples/percentbarchart/main.cpp 1	13	\l {BarChart Example} {bar chart} we used nice numbers algorithm to make the y axis numbering look better. With
13		14	percent bar chart there is no need for that, because the maximum y-axis value is always 100.
14	Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
15	we want to visulaize to them.
16
17	\snippet ../examples/percentbarchart/main.cpp 2
18
19	To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
20	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
21	are added to series here.
22		15
23	\snippet ../examples/percentbarchart/main.cpp 3	16	\snippet ../examples/percentbarchart/main.cpp 3
24
25	We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
26	represents is shown as tooltip.
27	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
28	that are drawn on top of bars.
29
30	\snippet ../examples/percentbarchart/main.cpp 4
31
32	Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
33
34	\snippet ../examples/percentbarchart/main.cpp 5
35
36	For barchart, we don't need X-axis to be visible, so it can be disabled.
37
38	\snippet ../examples/percentbarchart/main.cpp 6
39	*/	17	*/

doc/src/examples-stackedbarchart.qdoc +5 -29

@@ -1,39 +1,15
1	/*!	1	/*!
2	\example examples/stackedbarchart	2	\example examples/stackedbarchart
3	\title StackedBarChart Example	3	\title StackedBarChart Example
4	\subtitle	4	\subtitle
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 ~~stacked on top of each other. The stacking is done per category.~~	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		8
8	\image stackedbarchart.png	9	\image examples_stackedbarchart.png
9		10
10	First we define categories.	11	Creating stacked bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
11		12	stacked bar chart, we use QStackedBarSeries api instead of QBarSeries.
12	\snippet ../examples/stackedbarchart/main.cpp 1
13
14	Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
15	we want to visulaize to them.
16
17	\snippet ../examples/stackedbarchart/main.cpp 2
18
19	To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
20	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
21	are added to series here.
22		13
23	\snippet ../examples/stackedbarchart/main.cpp 3	14	\snippet ../examples/stackedbarchart/main.cpp 3
24
25	We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
26	represents is shown as tooltip.
27	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
28	that are drawn on top of bars.
29
30	\snippet ../examples/stackedbarchart/main.cpp 4
31
32	Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
33
34	\snippet ../examples/stackedbarchart/main.cpp 5
35
36	For barchart, we don't need X-axis to be visible, so it can be disabled.
37
38	\snippet ../examples/stackedbarchart/main.cpp 6
39	*/	15	*/

doc/src/examples-zoomlinechart.qdoc +2 -2

             /*!
                 \example examples/zoomlinechart
                 \title Zoom line example
                 \subtitle
                 The example shows how to create your own custom zooming effect with QRubberBand.
-                \image example_zoomlinechart1.png
+                \image examples_zoomlinechart1.png
-                \image example_zoomlinechart2.png
+                \image examples_zoomlinechart2.png
                 Let's first create a line series with some example data.
                 \snippet ../examples/zoomlinechart/main.cpp 1
                 Then we create a custom chart view by deriving from QChartView:
                 \snippet ../examples/zoomlinechart/chartview.h 1
                 We override mouse and key event handling
                 \snippet ../examples/zoomlinechart/chartview.h 2
                 Then we implement a custom logic for mouse and key events. For example pressing '+' key will zoom in and pressing
                 the '-' key will zoom out.
                 \snippet ../examples/zoomlinechart/chartview.cpp 1
             */

examples/percentbarchart/main.cpp +1 -1

             /****************************************************************************
             **
             ** Copyright (C) 2012 Digia Plc
             ** All rights reserved.
             ** For any questions to Digia, please use contact form at http://qt.digia.com
             **
             ** This file is part of the Qt Commercial Charts Add-on.
             **
             ** $QT_BEGIN_LICENSE$
             ** Licensees holding valid Qt Commercial licenses may use this file in
             ** accordance with the Qt Commercial License Agreement provided with the
             ** Software or, alternatively, in accordance with the terms contained in
             ** a written agreement between you and Digia.
             **
             ** If you have questions regarding the use of this file, please use
             ** contact form at http://qt.digia.com
             ** $QT_END_LICENSE$
             **
             ****************************************************************************/
             #include <QApplication>
             #include <QMainWindow>
             #include <QChartView>
             #include <QPercentBarSeries>
             #include <QBarSet>
             #include <QLegend>
             QTCOMMERCIALCHART_USE_NAMESPACE
             int main(int argc, char *argv[])
             {
                 QApplication a(argc, argv);
             //![1]
                 QBarCategories categories;
                 categories << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "Jun";
             //![1]
             //![2]
                 QBarSet *set0 = new QBarSet("Jane");
                 QBarSet *set1 = new QBarSet("John");
                 QBarSet *set2 = new QBarSet("Axel");
                 QBarSet *set3 = new QBarSet("Mary");
                 QBarSet *set4 = new QBarSet("Samantha");
                 *set0 << 1 << 2 << 3 << 4 << 5 << 6;
                 *set1 << 5 << 0 << 0 << 4 << 0 << 7;
                 *set2 << 3 << 5 << 8 << 13 << 8 << 5;
                 *set3 << 5 << 6 << 7 << 3 << 4 << 5;
                 *set4 << 9 << 7 << 5 << 3 << 1 << 2;
             //![2]
             //![3]
                 QPercentBarSeries* series = new QPercentBarSeries(categories);
                 series->appendBarSet(set0);
                 series->appendBarSet(set1);
                 series->appendBarSet(set2);
                 series->appendBarSet(set3);
                 series->appendBarSet(set4);
             //![3]
             //![4]
                 QChart* chart = new QChart();
                 chart->addSeries(series);
-                chart->setTitle("Simple precentbarchart example");
+                chart->setTitle("Simple percentbarchart example");
             //![4]
             //![5]
                 chart->legend()->setVisible(true);
                 chart->legend()->setAlignment(QLegend::AlignmentBottom);
             //![5]
             //![6]
                 QChartView* chartView = new QChartView(chart);
                 chartView->setRenderHint(QPainter::Antialiasing);
             //![6]
             //![7]
                 QMainWindow window;
                 window.setCentralWidget(chartView);
                 window.resize(400, 300);
                 window.show();
             //![7]
                 return a.exec();
             }

doc/images/barchart.png removed binary 0 0

NO CONTENT: file was removed, binary diff hidden

doc/images/percentbarchart.png removed binary 0 0

NO CONTENT: file was removed, binary diff hidden

doc/images/stackedbarchart.png removed binary 0 0

NO CONTENT: file was removed, binary diff hidden

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