HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1369:0f97f496fd67

Added documentation for BarModelMapper example

Marek Rosa -

r1369:0f97f496fd67

parent child

Context file:

r1369:0f97f496fd67

Collapse all files

doc/src/examples-barmodelmapper.qdoc created 644 +55 0

@@ -0,0 +1,55
	1	/*!
	2	\example examples/barmodelmapper
	3	\title BarModelMapper example
	4	\subtitle
	5
	6	This example shows how to use QAbstractItemModel derived model as the data for the bar series.
	7
	8	Let's start by creating an instance of CustomTableModel class.
	9	CustomTableModel class is derived from QAbstractTableModel and it was created for the purpose of this example.
	10	The constructor of this class populates the internal data store of the model with the data that is good for our chart example.
	11
	12	\snippet ../examples/barmodelmapper/tablewidget.cpp 1
	13
	14	We now have a model with data that we would like to display both on the chart and in a QTableView.
	15	First, we create QTableView and tell it use the model as a data source. To make the data cells fill the table view we also change headers resize mode.
	16
	17	\snippet ../examples/barmodelmapper/tablewidget.cpp 2
	18
	19	Now we need QChart instance to display the same data on the chart.
	20	We also enable animations. It makes it easier to see how modifying the model's data affect the chart.
	21
	22	\snippet ../examples/barmodelmapper/tablewidget.cpp 3
	23
	24	First line of the code below creates new grouped bar series. Variables firstRow and rowCount are used to define a custom model mapping.
	25	Custom mapping allows to take only part of the data from the model. In this case data from 5 rows starting with the row with the index 3.
	26	Following three lines create an instance of QVBarModelMapper class and specifie that data for the bar sets should be taken from the model's columns(Qt::Vertical) with indexes from 1 to 4(inclusive).
	27	To create a connection between the series and the model we set both of those objects to QVBarModelMapper.
	28
	29	Finally the series is added to the chart.
	30
	31	\snippet ../examples/barmodelmapper/tablewidget.cpp 4
	32
	33	To show in QTableView which data coresponds with which series this example uses table coloring.
	34	When series is added to the chart it is assigned a color beased on the currently selected theme.
	35	Code below extracts that color from the series and uses it to create colored QTableView.
	36	Coloring of the view is not a part of the QChart functionality.
	37
	38	\snippet ../examples/barmodelmapper/tablewidget.cpp 5
	39
	40	We would like to have categories placed on the chart's axis that describe what the data means.
	41	Next snippet shows how to do that.
	42
	43	\snippet ../examples/barmodelmapper/tablewidget.cpp 6
	44
	45	To avoid setting up the QGraphicsScene we use QChartView class that does it for us. QChart object pointer is used as a parameter of the QChartView constructor.
	46	To make the render look nicer Antialiasing is turned on and the minimum size of the chartView widget is set.
	47
	48	\snippet ../examples/barmodelmapper/tablewidget.cpp 7
	49
	50	Finally we place both widgets in a layout and use the layout as the application layout.
	51
	52	\snippet ../examples/barmodelmapper/tablewidget.cpp 8
	53
	54	Application is ready. Try modifying the data in the table view and see how it affects the chart.
	55	*/

doc/src/examples.qdoc +1 0

                         <li><a href="examples-legend.html">Legend</a></li>
                         <li><a href="examples-linechart.html">Line chart</a></li>
                         <li><a href="examples-modeldata.html">Model data</a></li>
+                        <li><a href="examples-barmodelmapper.html">Bar chart from model</a></li>
                         <li><a href="examples-percentbarchart.html">Percent bar chart</a></li>
                         <li><a href="examples-piechart.html">Pie chart</a></li>
                         <li><a href="examples-piechartdrilldown.html">Pie chart drilldown</a></li>

examples/barmodelmapper/customtablemodel.cpp +2 -2

                 qsrand(QTime(0,0,0).secsTo(QTime::currentTime()));
                 m_columnCount = 6;
-                m_rowCount = 10;
+                m_rowCount = 12;
                 // m_data
                 for (int i = 0; i < m_rowCount; i++)
                     return QString("201%1").arg(section);
                 }
                 else
-                    return QString("%1").arg(section);
+                    return QString("%1").arg(section + 1);
             }
             QVariant CustomTableModel::data(const QModelIndex & index, int role) const

examples/barmodelmapper/tablewidget.cpp +11 -9

                 chart->addSeries(series);
                 //! [4]
-                QStringList categories;
-                categories << "June" << "July" << "August" << "September" << "October" << "November";
-                chart->axisX()->categories()->insert(categories);
                 //! [5]
                 // for storing color hex from the series
                 QString seriesColorHex = "#000000";
                 }
                 //! [5]
-                //! [8]
+                //! [6]
+                QStringList categories;
+                categories << "April" << "May" << "June" << "July" << "August";
+                chart->axisX()->categories()->insert(categories);
+                //! [6]
+                //! [7]
                 QChartView *chartView = new QChartView(chart);
                 chartView->setRenderHint(QPainter::Antialiasing);
                 chartView->setMinimumSize(640, 480);
-                //! [8]
+                //! [7]
-                //! [9]
+                //! [8]
                 // create main layout
                 QGridLayout* mainLayout = new QGridLayout;
                 mainLayout->addWidget(tableView, 1, 0);
                 mainLayout->setColumnStretch(1, 1);
                 mainLayout->setColumnStretch(0, 0);
                 setLayout(mainLayout);
-                //! [9]
+                //! [8]
             }

src/areachart/qareaseries.cpp +6 0

                 return QAbstractSeries::SeriesTypeArea;
             }
+            /*!
+                Sets the \a series that is to be used as the area chart upper series.
+            */
             void QAreaSeries::setUpperSeries(QLineSeries* series)
             {
                 Q_D(QAreaSeries);
                 return d->m_upperSeries;
             }
+            /*!
+                Sets the \a series that is to be used as the area chart lower series.
+            */
             void QAreaSeries::setLowerSeries(QLineSeries* series)
             {
                 Q_D(QAreaSeries);

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