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

             /*!
                 \page examples.html
                 \title Examples
                 \keyword Examples
                 \raw HTML
                     <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
                     <tr>
                     <th class="titleheader" width="33%">
                     List of examples
                     </th>
                     </tr>
                     <tr>
                     <td valign="top">
                     <ul>
                         <li><a href="examples-areachart.html">Area chart</a></li>
                         <li><a href="examples-barchart.html">Bar chart</a></li>
                         <li><a href="examples-customchart.html">Custom chart</a></li>
                         <li><a href="examples-groupedbarchart.html">Grouped bar chart</a></li>
                         <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>
                         <li><a href="examples-presenterchart.html">Presenter chart</a></li>
                         <li><a href="examples-scatterchart.html">Scatter chart</a></li>
                         <li><a href="examples-scatterinteractions.html">Scatter interactions</a></li>
                         <li><a href="examples-splinechart.html">Spline chart</a></li>
                         <li><a href="examples-stackedbarchart.html">Stacked bar chart</a></li>
                         <li><a href="examples-stackedbarchartdrilldown.html">Stacked bar chart drilldown</a></li>
                         <li><a href="examples-zoomlinechart.html">Zoom line</a></li>
                     </ul>
                     </td>
                     </tr>
                     </table>
                 \endraw
             */

examples/barmodelmapper/customtablemodel.cpp +2 -2

             /****************************************************************************
             **
             ** 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 "customtablemodel.h"
             #include <QVector>
             #include <QTime>
             #include <QRect>
             #include <QColor>
             CustomTableModel::CustomTableModel(QObject *parent) :
                 QAbstractTableModel(parent)
             {
                 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++)
                 {
                     QVector<qreal>* dataVec = new QVector<qreal>(m_columnCount);
                     for (int k = 0; k < dataVec->size(); k++)
                     {
                         if (k%2 == 0)
                             dataVec->replace(k, i * 50 + qrand()%20);
                         else
                             dataVec->replace(k, qrand()%100);
                     }
                     m_data.append(dataVec);
                 }
             }
             int CustomTableModel::rowCount(const QModelIndex & parent) const
             {
                 Q_UNUSED(parent)
                 return m_data.count();
             }
             int CustomTableModel::columnCount(const QModelIndex & parent) const
             {
                 Q_UNUSED(parent)
                 return m_columnCount;
             }
             QVariant CustomTableModel::headerData (int section, Qt::Orientation orientation, int role ) const
             {
                 if (role != Qt::DisplayRole)
                     return QVariant();
                 if (orientation == Qt::Horizontal)
                 {
                     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
             {
                 if (role == Qt::DisplayRole)
                 {
                     return m_data[index.row()]->at(index.column());
                 }
                 else if (role == Qt::EditRole)
                 {
                     return m_data[index.row()]->at(index.column());
                 }
                 else if (role == Qt::BackgroundRole)
                 {
                     QRect rect;
                     foreach(rect, m_mapping)
                         if(rect.contains(index.column(), index.row()))
                             return QColor(m_mapping.key(rect));
                     // cell not mapped return white color
                     return QColor(Qt::white);
                 }
                 return QVariant();
             }
             bool CustomTableModel::setData ( const QModelIndex & index, const QVariant & value, int role)
             {
                 if (index.isValid() && role == Qt::EditRole)
                 {
                     m_data[index.row()]->replace(index.column(), value.toDouble());
                     emit dataChanged(index, index);
                     return true;
                 }
                 return false;
             }
             Qt::ItemFlags CustomTableModel::flags ( const QModelIndex & index ) const
             {
                 return QAbstractItemModel::flags(index) | Qt::ItemIsEditable;
             }
             void CustomTableModel::addMapping(QString color, QRect area)
             {
                 m_mapping.insertMulti(color, area);
             }

examples/barmodelmapper/tablewidget.cpp +12 -10

             /****************************************************************************
             **
             ** 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 "tablewidget.h"
             #include "customtablemodel.h"
             #include <QGridLayout>
             #include <QTableView>
             #include <QChart>
             #include <QChartView>
             #include <QLineSeries>
             #include <QVXYModelMapper>
             #include <QGroupedBarSeries>
             #include <QBarSet>
             #include <QVBarModelMapper>
             #include <QHeaderView>
             QTCOMMERCIALCHART_USE_NAMESPACE
             TableWidget::TableWidget(QWidget *parent)
                 : QWidget(parent)
             {
                 // create simple model for storing data
                 // user's table data model
                 //! [1]
                 CustomTableModel *model = new CustomTableModel;
                 //! [1]
                 //! [2]
                 // create table view and add model to it
                 QTableView *tableView = new QTableView;
                 tableView->setModel(model);
                 tableView->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
                 tableView->verticalHeader()->setResizeMode(QHeaderView::Stretch);
                 //! [2]
                 //! [3]
                 QChart *chart = new QChart;
                 chart->setAnimationOptions(QChart::AllAnimations);
                 //! [3]
                 // series 1
                 //! [4]
                 QGroupedBarSeries *series = new QGroupedBarSeries;
                 int first = 3;
                 int count = 5;
                 QVBarModelMapper *mapper = new QVBarModelMapper(this);
                 mapper->setFirstBarSetColumn(1);
                 mapper->setLastBarSetColumn(4);
                 mapper->setFirst(3);
                 mapper->setCount(count);
                 mapper->setSeries(series);
                 mapper->setModel(model);
                 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";
                 // get the color of the series and use it for showing the mapped area
                 QList<QBarSet*> barsets = series->barSets();
                 for (int i = 0; i < barsets.count(); i++) {
                     seriesColorHex = "#" + QString::number(barsets.at(i)->brush().color().rgb(), 16).right(6).toUpper();
                     model->addMapping(seriesColorHex, QRect(1 + i, first, 1, barsets.at(i)->count()));
                 }
                 //! [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->addWidget(chartView, 1, 1);
                 mainLayout->setColumnStretch(1, 1);
                 mainLayout->setColumnStretch(0, 0);
                 setLayout(mainLayout);
-                //! [9]
+                //! [8]
             }

src/areachart/qareaseries.cpp +6 0

             /****************************************************************************
             **
             ** 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 "qareaseries.h"
             #include "qareaseries_p.h"
             #include "qlineseries.h"
             #include "areachartitem_p.h"
             #include "legendmarker_p.h"
             #include "domain_p.h"
             #include "chartdataset_p.h"
             #include "charttheme_p.h"
             #include "chartanimator_p.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QAreaSeries
                 \brief The QAreaSeries class is used for making area charts.
                 \mainclass
             	An area chart is used to show quantitative data. It is based on line chart, in the way that area between axis and the line
             	is emphasized with color. Since the area chart is based on line chart, QAreaSeries constructor needs QLineSeries instance,
             	which defines "upper" boundary of the area. "Lower" boundary is defined by default by axis X. Instead of axis X "lower" boundary can be specified by other line.
             	In that case QAreaSeries should be initiated with two QLineSerie instances. Please note terms "upper" and "lower" boundary can be misleading in cases
             	where "lower" boundary had bigger values than the "upper" one, however the main point that area between these two boundary lines will be filled.
                 See the \l {AreaChart Example} {area chart example} to learn how to create a simple area chart.
                 \image examples_areachart.png
             */
             /*!
                \fn QLineSeries* QAreaSeries::upperSeries() const
                \brief Returns upperSeries used to define one of area boundaries.
             */
             /*!
                \fn QLineSeries* QAreaSeries::lowerSeries() const
                \brief Returns lowerSeries used to define one of area boundaries. Note if QAreaSeries where counstucted wihtout a\ lowerSeries
                 this function return Null pointer.
             */
             /*!
                \fn QPen QAreaSeries::pen() const
                \brief  Returns the pen used to draw line for this series.
                 \sa setPen()
             */
             /*!
                \fn QPen QAreaSeries::brush() const
                \brief  Returns the brush used to draw line for this series.
                 \sa setBrush()
             */
             /*!
                \fn bool  QAreaSeries::pointsVisible() const
                \brief  Returns if the points are drawn for this series.
                 \sa setPointsVisible()
             */
             /*!
                 \fn void QAreaSeries::clicked(const QPointF& point)
                 \brief Signal is emitted when user clicks the \a point on area chart.
             */
             /*!
                 \fn void QAreaSeries::selected()
                 The signal is emitted if the user selects/deselects the XY series. The logic for maintaining selections should be
                 implemented by the user of QAreaSeries API.
             */
             /*!
                 \fn void QAreaSeriesPrivate::updated()
                 \brief \internal
             */
             /*!
                 Constructs area series object which is a child of \a upperSeries. Area will be spanned between \a
                 upperSeries line and \a lowerSeries line.  If no \a lowerSeries is passed to constructor, area is specified by axis x (y=0) instead.
                 When series object is added to QChartView or QChart instance ownerships is transferred.
             */
             QAreaSeries::QAreaSeries(QLineSeries *upperSeries, QLineSeries *lowerSeries)
                 : QAbstractSeries(*new QAreaSeriesPrivate(upperSeries,lowerSeries,this),upperSeries)
             {
             }
             /*!
                 Constructs area series object without upper or lower series with \a parent object.
             */
             QAreaSeries::QAreaSeries(QObject *parent)
                 : QAbstractSeries(*new QAreaSeriesPrivate(0, 0, this), parent)
             {
             }
             /*!
                 Destroys the object. Series added to QChartView or QChart instances are owned by those,
                 and are deleted when mentioned object are destroyed.
             */
             QAreaSeries::~QAreaSeries()
             {
             }
             /*!
                 Returns QChartSeries::SeriesTypeArea.
             */
             QAbstractSeries::SeriesType QAreaSeries::type() const
             {
                 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);
                 d->m_upperSeries = series;
             }
             QLineSeries* QAreaSeries::upperSeries() const
             {
                 Q_D(const 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);
                 d->m_lowerSeries = series;
             }
             QLineSeries* QAreaSeries::lowerSeries() const
             {
                 Q_D(const QAreaSeries);
                 return d->m_lowerSeries;
             }
             /*!
                 Sets \a pen used for drawing area outline.
             */
             void QAreaSeries::setPen(const QPen &pen)
             {
                 Q_D(QAreaSeries);
                 if (d->m_pen != pen) {
                     d->m_pen = pen;
                     emit d->updated();
                 }
             }
             QPen  QAreaSeries::pen() const
             {
                 Q_D(const QAreaSeries);
                 return d->m_pen;
             }
             /*!
                 Sets \a brush used for filling the area.
             */
             void QAreaSeries::setBrush(const QBrush &brush)
             {
                 Q_D(QAreaSeries);
                 if (d->m_brush != brush) {
                     d->m_brush = brush;
                     emit d->updated();
                 }
             }
             QBrush QAreaSeries::brush() const
             {
                 Q_D(const QAreaSeries);
                 return d->m_brush;
             }
             /*!
                 Sets if data points are \a visible and should be drawn on line.
             */
             void QAreaSeries::setPointsVisible(bool visible)
             {
                 Q_D(QAreaSeries);
                 if (d->m_pointsVisible != visible) {
                     d->m_pointsVisible = visible;
                     emit d->updated();
                 }
             }
             bool QAreaSeries::pointsVisible() const
             {
                 Q_D(const QAreaSeries);
                 return d->m_pointsVisible;
             }
             ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
             QAreaSeriesPrivate::QAreaSeriesPrivate(QLineSeries *upperSeries, QLineSeries *lowerSeries,QAreaSeries* q) :
                 QAbstractSeriesPrivate(q),
                 m_upperSeries(upperSeries),
                 m_lowerSeries(lowerSeries),
                 m_pointsVisible(false)
             {
             }
             void QAreaSeriesPrivate::scaleDomain(Domain& domain)
             {
                 Q_Q(QAreaSeries);
                 qreal minX(domain.minX());
                 qreal minY(domain.minY());
                 qreal maxX(domain.maxX());
                 qreal maxY(domain.maxY());
                 int tickXCount(domain.tickXCount());
                 int tickYCount(domain.tickYCount());
                 QLineSeries* upperSeries = q->upperSeries();
                 QLineSeries* lowerSeries = q->lowerSeries();
                 const QList<QPointF>& points = upperSeries->points();
                 for (int i = 0; i < points.count(); i++)
                 {
                     qreal x = points[i].x();
                     qreal y = points[i].y();
                     minX = qMin(minX, x);
                     minY = qMin(minY, y);
                     maxX = qMax(maxX, x);
                     maxY = qMax(maxY, y);
                 }
                 if(lowerSeries) {
                     const QList<QPointF>& points = lowerSeries->points();
                     for (int i = 0; i < points.count(); i++)
                     {
                         qreal x = points[i].x();
                         qreal y = points[i].y();
                         minX = qMin(minX, x);
                         minY = qMin(minY, y);
                         maxX = qMax(maxX, x);
                         maxY = qMax(maxY, y);
                     }}
                 domain.setRange(minX,maxX,minY,maxY,tickXCount,tickYCount);
             }
             Chart* QAreaSeriesPrivate::createGraphics(ChartPresenter* presenter)
             {
                 Q_Q(QAreaSeries);
                 AreaChartItem* area = new AreaChartItem(q,presenter);
                 if(presenter->animationOptions().testFlag(QChart::SeriesAnimations)) {
                     area->upperLineItem()->setAnimator(presenter->animator());
                     area->upperLineItem()->setAnimation(new XYAnimation(area->upperLineItem()));
                     if(q->lowerSeries())  {
                         area->lowerLineItem()->setAnimator(presenter->animator());
                         area->lowerLineItem()->setAnimation(new XYAnimation(area->lowerLineItem()));
                     }
                 }
                 presenter->chartTheme()->decorate(q, presenter->dataSet()->seriesIndex(q));
                 return area;
             }
             QList<LegendMarker*> QAreaSeriesPrivate::createLegendMarker(QLegend* legend)
             {
                 Q_Q(QAreaSeries);
                 QList<LegendMarker*> list;
                 return list << new AreaLegendMarker(q,legend);
             }
             #include "moc_qareaseries.cpp"
             #include "moc_qareaseries_p.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

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