HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r574:5a19c3a8f92b

Updates presenter example documentation

Michal Klocek -

r574:5a19c3a8f92b

parent child

Context file:

r574:5a19c3a8f92b

Collapse all files

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

NO CONTENT: new file 100644, binary diff hidden

doc/src/examples-presenterchart.qdoc +16 -5

             /*!
                  \example examples/presenterchart
                  \title PresenterChart Example
                  \subtitle
-                 The example shows how to create chart which presents the same set of data as line, scatter and spline charts.
+                 The example shows how to create chart which presents the same set of data as line, scatter, spline and area charts.
-                 ChartPresenter will switch between these three chart types every few seconds.
+                 ChartPresenter will switch between these four chart types every few seconds.
                  Please note this example does not use common data model. A use of common data model is documented here.[TODO]
                 \image presenterchart1.png
                 \image presenterchart2.png
                 \image presenterchart3.png
+                \image presenterchart4.png
                 We create simple ChartView class which derives form QChartView.
                 \snippet ../examples/presenterchart/chartview.h 1
                 Class will implement \c handleTimeout() slot which we are going to use to trigger switching between different chart presentations.
+                We are also going to provide \c handlePoitClicked() slot which will show clicked point on the chart.
                 Class members \c m_series and \c m_titles are going to store series and related titles. In example we are going to present data as a line chart
-                using QLineSeries , as scatter chart using QScatterSeries, and as a spline chart using QSplineSeries. We create needed instances in constructor of ChartView class.
+                using QLineSeries , as scatter chart using QScatterSeries, as a spline chart using QSplineSeries and a area chart using QAreaSeries. We create needed instances in constructor of ChartView class.
                 We set custom line and points colors.
                 \snippet ../examples/presenterchart/chartview.cpp 1
-                We add data to all three series. We can use add() member function. If data set is large,it is wiser to use shared data model, as described here.[TODO]
+                We add data to three series. Please note area chart is going to use QLineSeries as the upper line. We can use add() member function. If data set is large,
+                it is wiser to use shared data model, as described here.[TODO]
                 \snippet ../examples/presenterchart/chartview.cpp 2
                 In the end we store references all the created series and matching titles.
                 \snippet ../examples/presenterchart/chartview.cpp 3
-                In  \c handleTimeout() slot  we change currently displayed chart by removing previous series and adding next series from the \c m_series list. We also set proper title.
+                We connect \c clicked() signals from each series with our \c handlePointClciked() slot.
                 \snippet ../examples/presenterchart/chartview.cpp 4
+                In  \c handleTimeout() slot  we change currently displayed chart by removing previous series and adding next series from the \c m_series list. We also set proper title.
+                \snippet ../examples/presenterchart/chartview.cpp 5
+                In  \c handlePointClciked() slot we set the chart's title to show clicked point x and y coordinates.
+                \snippet ../examples/presenterchart/chartview.cpp 6
             */

examples/presenterchart/chartview.cpp +6 -2

             #include "chartview.h"
             #include <qlineseries.h>
             #include <qscatterseries.h>
             #include <qsplineseries.h>
             #include <qareaseries.h>
             #include <QTime>
             ChartView::ChartView(QWidget* parent):QChartView(parent),
             m_index(0)
             {
                 QTime now = QTime::currentTime();
                 qsrand((uint)now.msec());
                 setChartTitle("Three random line charts");
                 QObject::connect(&m_timer,SIGNAL(timeout()),this,SLOT(handleTimeout()));
                 m_timer.setInterval(3000);
             //![1]
                 QLineSeries* series0 = new QLineSeries(this);
                 QPen blue(Qt::blue);
                 blue.setWidth(3);
                 series0->setPen(blue);
                 QScatterSeries* series1 = new QScatterSeries(this);
                 QPen red(Qt::red);
                 red.setWidth(3);
                 series1->setPen(red);
                 series1->setBrush(Qt::white);
                 QSplineSeries* series2 = new QSplineSeries(this);
                 QPen green(Qt::green);
                 green.setWidth(3);
                 series2->setPen(green);
                 QAreaSeries* series3 = new QAreaSeries(series0);
                 QPen yellow(Qt::black);
                 yellow.setWidth(3);
                 series3->setPen(yellow);
                 series3->setBrush(Qt::yellow);
             //![1]
             //![2]
                 int numPoints = 10;
                 for (int x = 0; x <= numPoints; ++x) {
                     qreal y = qrand() % 100;
                     series0->add(x,y);
                     series1->add(x,y);
                     series2->add(x,y);
                 }
             //![2]
             //![3]
                 m_series<<series0;
                 m_titles<<chartTitle()+": LineChart";
                 m_series<<series1;
                 m_titles<<chartTitle()+": ScatterChart";
                 m_series<<series2;
                 m_titles<<chartTitle()+": SplineChart";
                 m_series<<series3;
                 m_titles<<chartTitle()+": AreaChart";
             //![3]
                 addSeries(series0);
                 setChartTitle(m_titles.at(0));
+            //![4]
                 foreach (QSeries* series, m_series) {
                     QObject::connect(series,SIGNAL(clicked(const QPointF&)),this,SLOT(handlePointClicked(const QPointF&)));
                 }
+            //![4]
                 m_timer.start();
             }
             ChartView::~ChartView()
             {
                 if(m_series.size()==0) return;
                 removeSeries(m_series.at(m_index));
                 qDeleteAll(m_series);
             }
-            //![4]
+            //![5]
             void ChartView::handleTimeout()
             {
                 if(m_series.size()==0) return;
                 removeSeries(m_series.at(m_index));
                 m_index++;
                 m_index=m_index%m_series.size();
                 addSeries(m_series.at(m_index));
                 setChartTitle(m_titles.at(m_index));
             }
-            //![4]
+            //![5]
+            //![6]
             void ChartView::handlePointClicked(const QPointF& point)
             {
                 setChartTitle(m_titles.at(m_index) + QString(" x: %1 y: %2").arg(point.x()).arg(point.y()));
             }
+            //![6]

src/areachart/qareaseries.cpp +5 0

             #include "qareaseries.h"
             #include "qlineseries.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.
             	\image areachart.png
             	Creating basic area chart is simple:
             	\code
             	QLineSeries* lineSeries = new QLineSeries();
             	series->add(0, 6);
             	series->add(2, 4);
             	QAreaSeries* areaSeries = new QAreaSeries(lineSeries);
             	...
             	chartView->addSeries(areaSeries);
                 \endcode
             */
             /*!
                 \fn virtual QSeriesType QAreaSeries::type() const
                 \brief Returns type of series.
                 \sa QSeries, QSeriesType
             */
             /*!
                \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::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 transfered.
             */
             QAreaSeries::QAreaSeries(QLineSeries* upperSeries,QLineSeries* lowerSeries):QSeries(upperSeries),
             m_upperSeries(upperSeries),
             m_lowerSeries(lowerSeries),
             m_pointsVisible(false)
             {
             }
             /*!
                 Destroys the object. Series added to QChartView or QChart instances are owned by those,
                 and are deleted when mentioned object are destroyed.
             */
             QAreaSeries::~QAreaSeries()
             {
             }
             /*!
                 Sets \a pen used for drawing area outline.
             */
             void QAreaSeries::setPen(const QPen& pen)
             {
                 if(m_pen!=pen){
                     m_pen=pen;
                     emit updated();
                 }
             }
             /*!
                 Sets \a brush used for filling the area.
             */
             void QAreaSeries::setBrush(const QBrush& brush)
             {
                 if(m_brush!=brush){
                     m_brush=brush;
                     emit updated();
                 }
             }
             /*!
                 Sets if data points are \a visible and should be drawn on line.
             */
             void QAreaSeries::setPointsVisible(bool visible)
             {
                 if(m_pointsVisible!=visible){
                     m_pointsVisible=visible;
                     emit updated();
                 }
             }
             #include "moc_qareaseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/scatterseries/qscatterseries.cpp 0 -5

             #include "qscatterseries.h"
             #include "qchart.h"
             /*!
                 \class QScatterSeries
                 \brief The QScatterSeries class is used for making scatter charts.
                 \mainclass
                 The scatter data is displayed as a collection of points on the chart. Each point determines the position on the horizontal axis
                 and the vertical axis.
                 \image scatterchart.png
                 Creating basic scatter chart is simple:
                 \code
                 QScatterSeries* series = new QScatterSeries();
                 series->add(0, 6);
                 series->add(2, 4);
                 ...
                 chartView->addSeries(series);
                 \endcode
             */
             /*!
                 \enum QScatterSeries::MarkerShape
                 This enum describes the shape used when rendering marker items.
                 \value MarkerShapeCircle
                 \value MarkerShapeRectangle
             */
             /*!
                 \fn QChartSeriesType QScatterSeries::type() const
                 \brief Returns QChartSeries::SeriesTypeScatter.
                 \sa QSeries, QSeriesType
             */
-            /*!
-                \fn void QScatterSeries::clicked(const QPointF& point)
-                \brief Signal is emitted when user clicks the \a point on scatter chart.
-            */
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 Constructs a series object which is a child of \a parent.
             */
             QScatterSeries::QScatterSeries(QObject *parent) :
                 QXYSeries(parent),
                 m_shape(QScatterSeries::MarkerShapeCircle),
                 m_size(9.0)
             {
             }
             /*!
                 Destroys the object. Note that adding series to QChart transfers the ownership to the chart.
             */
             QScatterSeries::~QScatterSeries()
             {
             }
             /*!
                 Returns the shape used for drawing markers.
             */
             QScatterSeries::MarkerShape QScatterSeries::shape() const
             {
                 return m_shape;
             }
             /*!
                 Overrides the default shape of the marker items with a user defined \a shape. The default shape
                 is defined by chart theme setting.
             */
             void QScatterSeries::setShape(MarkerShape shape)
             {
                 if(m_shape!= shape){
                     m_shape=shape;
                     emit QXYSeries::updated();
                 }
             }
             /*!
                 Returns the size of the marker items.
             */
             qreal QScatterSeries::size() const
             {
                 return m_size;
             }
             /*!
                 Set the \a size of the marker items. The default size is 9.0.
             */
             void QScatterSeries::setSize(qreal size)
             {
                 if(m_size != size){
                     m_size=size;
                     emit updated();
                 }
             }
             QTCOMMERCIALCHART_END_NAMESPACE

src/xychart/qxyseries.cpp +5 0

             #include "qxyseries.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QXYSeries
                 \brief The QXYSeries class is a base class for line, spline and scatter series.
             */
             /*!
                \fn QPen QXYSeries::pen() const
                \brief  Returns pen used to draw points for series.
                 \sa setPen()
             */
             /*!
                \fn QBrush QXYSeries::brush() const
                \brief  Returns brush used to draw points for series.
                 \sa setBrush()
             */
             /*!
+                \fn void QXYSeries::clicked(const QPointF& point)
+                \brief Signal is emitted when user clicks the \a point on chart.
+            */
+            /*!
                 \fn void QXYSeries::pointReplaced(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::pointAdded(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::pointRemoved(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::updated()
                 \brief \internal
             */
             /*!
                 Constructs empty series object which is a child of \a parent.
                 When series object is added to QChartView or QChart instance ownerships is transfered.
             */
             QXYSeries::QXYSeries(QObject* parent):QSeries(parent)
             {
                 m_model = NULL;
                 m_mapX = -1;
                 m_mapY = -1;
                 m_mapOrientation = Qt::Vertical;
             //    m_mapYOrientation = Qt::Vertical;
             }
             /*!
                 Destroys the object. Series added to QChartView or QChart instances are owned by those,
                 and are deleted when mentioned object are destroyed.
             */
             QXYSeries::~QXYSeries()
             {
             }
             /*!
                 Adds data point \a x \a y to the series. Points are connected with lines on the chart.
              */
             void QXYSeries::add(qreal x,qreal y)
             {
                 Q_ASSERT(m_x.size() == m_y.size());
                 m_x<<x;
                 m_y<<y;
                 emit pointAdded(m_x.size()-1);
             }
             /*!
                This is an overloaded function.
                Adds data \a point to the series. Points are connected with lines on the chart.
              */
             void QXYSeries::add(const QPointF& point)
             {
                 add(point.x(),point.y());
             }
             /*!
                This is an overloaded function.
                Adds list of data \a points to the series. Points are connected with lines on the chart.
              */
             void QXYSeries::add(const QList<QPointF> points)
             {
                 foreach(const QPointF& point , points) {
                     add(point.x(),point.y());
                 }
             }
             /*!
               Modifies \a y value for given \a x a value.
             */
             void QXYSeries::replace(qreal x,qreal y)
             {
                 int index = m_x.indexOf(x);
                 m_x[index]=x;
                 m_y[index]=y;
                 emit pointReplaced(index);
             }
             /*!
               This is an overloaded function.
               Replaces current y value of for given \a point x value with \a point y value.
             */
             void QXYSeries::replace(const QPointF& point)
             {
                 replace(point.x(),point.y());
             }
             /*!
               Removes current \a x and \a y value.
             */
             void QXYSeries::remove(qreal x,qreal y)
             {
                 int index =-1;
                 do{
                     index = m_x.indexOf(x,index+1);
                 }while(index !=-1 && m_y.at(index)!=y);
                 if(index==-1) return;
                 m_x.remove(index);
                 m_y.remove(index);
                 emit pointRemoved(index);
             }
             /*!
               Removes current \a point x value. Note \a point y value is ignored.
             */
             void QXYSeries::remove(const QPointF& point)
             {
                 remove(point.x(),point.y());
             }
             /*!
                Removes all data points from the series.
             */
             void QXYSeries::removeAll()
             {
                 m_x.clear();
                 m_y.clear();
             }
             /*!
                 \internal \a pos
             */
             qreal QXYSeries::x(int pos) const
             {
                 if (m_model)
                     if (m_mapOrientation == Qt::Vertical)
                         // consecutive data is read from model's column
                         return m_model->data(m_model->index(pos, m_mapX), Qt::DisplayRole).toDouble();
                     else
                         // consecutive data is read from model's row
                         return m_model->data(m_model->index(m_mapX, pos), Qt::DisplayRole).toDouble();
                 else
                     // model is not specified, return the data from series' internal data store
                     return m_x.at(pos);
             }
             /*!
                 \internal \a pos
             */
             qreal QXYSeries::y(int pos) const
             {
                 if (m_model)
                     if (m_mapOrientation == Qt::Vertical)
                         // consecutive data is read from model's column
                         return m_model->data(m_model->index(pos, m_mapY), Qt::DisplayRole).toDouble();
                     else
                         // consecutive data is read from model's row
                         return m_model->data(m_model->index(m_mapY, pos), Qt::DisplayRole).toDouble();
                 else
                     // model is not specified, return the data from series' internal data store
                     return m_y.at(pos);
             }
             /*!
                 Returns number of data points within series.
             */
             int QXYSeries::count() const
             {
                 Q_ASSERT(m_x.size() == m_y.size());
                 if (m_model)
                     if (m_mapOrientation == Qt::Vertical)
                         // data is in a column, so return the number of items in single column
                         return m_model->rowCount();
                     else
                         // data is in a row, so return the number of items in single row
                         m_model->columnCount();
                 else
                     // model is not specified, return the number of points in the series internal data store
                     return m_x.size();
             }
             /*!
                 Returns the data points of the series.
             */
             QList<QPointF> QXYSeries::data()
             {
                 QList<QPointF> data;
                 for (int i(0); i < m_x.count() && i < m_y.count(); i++)
                     data.append(QPointF(m_x.at(i), m_y.at(i)));
                 return data;
             }
             /*!
                 Sets \a pen used for drawing points on the chart. If the pen is not defined, the
                 pen from chart theme is used.
                 \sa QChart::setChartTheme()
             */
             void QXYSeries::setPen(const QPen& pen)
             {
                 if(pen!=m_pen){
                     m_pen=pen;
                     emit updated();
                 }
             }
             /*!
                 Sets \a brush used for drawing points on the chart. If the brush is not defined, brush
                 from chart theme setting is used.
                 \sa QChart::setChartTheme()
             */
             void QXYSeries::setBrush(const QBrush& brush)
             {
                 if(brush!=m_brush){
                     m_brush=brush;
                     emit updated();
                 }
             }
             /*!
                 Stream operator for adding a data \a point to the series.
                 \sa add()
             */
             QXYSeries& QXYSeries::operator<< (const QPointF &point)
             {
                 add(point);
                 return *this;
             }
             /*!
                 Stream operator for adding a list of \a points to the series.
                 \sa add()
             */
             QXYSeries& QXYSeries::operator<< (const QList<QPointF> points)
             {
                 add(points);
                 return *this;
             }
             void QXYSeries::modelUpdated(QModelIndex topLeft, QModelIndex bottomRight)
             {
                 emit pointReplaced(topLeft.row());
             }
             void QXYSeries::modelDataAdded(QModelIndex parent, int start, int end)
             {
                 emit pointAdded(start);
             }
             void QXYSeries::modelDataRemoved(QModelIndex parent, int start, int end)
             {
                 emit pointRemoved(start);
             }
             bool QXYSeries::setModel(QAbstractItemModel* model) {
                 m_model = model;
                 //    for (int i = 0; i < m_model->rowCount(); i++)
                 //        emit pointAdded(i);
                 connect(m_model,SIGNAL(dataChanged(QModelIndex,QModelIndex)), this, SLOT(modelUpdated(QModelIndex, QModelIndex)));
                 connect(m_model,SIGNAL(rowsInserted(QModelIndex, int, int)), this, SLOT(modelDataAdded(QModelIndex,int,int)));
                 connect(m_model, SIGNAL(rowsRemoved(QModelIndex, int, int)), this, SLOT(modelDataRemoved(QModelIndex,int,int)));
             }
             void QXYSeries::setModelMapping(int modelX, int modelY, Qt::Orientation orientation)
             {
                 m_mapX = modelX;
                 m_mapY = modelY;
                 m_mapOrientation = orientation;
             }
             //void QXYSeries::setModelMappingY(int modelLineIndex, Qt::Orientation orientation)
             //{
             //    m_mapY = modelLineIndex;
             //    m_mapYOrientation = orientation;
             //}
             #include "moc_qxyseries.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