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

                  \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
                 \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

                 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();
             }
                 qDeleteAll(m_series);
             }
-            //![4]
+            //![5]
             void ChartView::handleTimeout()
             {
                 if(m_series.size()==0) return;
                 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

             */
             /*!
+                \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
             */

src/scatterseries/qscatterseries.cpp 0 -5

                 \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
             /*!

src/xychart/qxyseries.cpp +5 0

             */
             /*!
+                \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
             */

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