HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1415:3a9150ae63dc

stacked bar drilldown example documentation update

sauimone -

r1415:3a9150ae63dc

parent child

Context file:

r1415:3a9150ae63dc

Collapse all files

doc/src/examples-stackedbarchartdrilldown.qdoc +18 -15

             /*!
                 \example examples/stackedbarchartdrilldown
                 \title StackedBarChart Drilldown Example
                 \subtitle
                 The example shows how to implement drilldown using stacked barchart. In drilldown example we create stacked barchart, which shows the harvest of various chili peppers during season. In season view the harvest is grouped by month. To drill down to weekly view, user clicks selected month with right mouse button. On weekly view, the harvest of clicked month is shown by week. For example purposes each month is 4 weeks long :)
                 Season view looks like this:
                 \image examples_stackedbarchartdrilldown1.png
                 Mouse button clicked on a month, shows the harvest from that month:
                 \image examples_stackedbarchartdrilldown2.png
-                Here we define a drilldown series, which adds mapping for categories to other drilldown series.
+                First we define a drilldown series class, which adds categories to stacked bar series and mapping for categories to other drilldown series.
-                Purpose of drilldown series is to contain knowledge of the drilldown structure. The mapDrilldownSeries function maps the category to given series. We can ask the mapping for category with drilldownSeries(QString category) function.
+                Purpose of drilldown series is to contain knowledge of the drilldown structure. The mapDrilldownSeries function maps the category to given series. We can ask the mapping for category with drilldownSeries(int category) function.
-                \snippet ../examples/stackedbarchartdrilldown/main.cpp 1
+                \snippet ../examples/stackedbarchartdrilldown/drilldownseries.h 1
-                To enable drilldown we create own view, which implements handler for right click. All QBarSeries derived classes send out rightClicked(QBarSet*, QString) signal when series is clicked with right mouse button. The parameters QBarSet and QString contain the pointer to clicked bar set and name of category, where click occurred.
+                Next we define our own drilldown chart, which implements handler for mouse click. All QBarSeries derived classes send out clicked(QBarSet*, int) signal when series is clicked with mouse. The parameter QBarSet contains pointer to clicked bar set and parameter int contains the index of clicked category.
+            	\snippet ../examples/stackedbarchartdrilldown/drilldownchart.h 1
-                In our DrilldownChart we implement handler, which selects the drilldown chart with the category.
+            	Now we have our drilldown classes and we can start using them.
+            	First create the chart.
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 1
+            	We define categories, from wich the drilldown series will be constructed.
                 \snippet ../examples/stackedbarchartdrilldown/main.cpp 2
-                Here we define data, which we use to construct the chart.
-                \snippet ../examples/stackedbarchartdrilldown/main.cpp 3
                 To create the drilldown structure, we first create our top level series, which we call seasonSeries. For each month in seasonSeries we create a drilldown series, called weeklySeries which contains more detailed data for that month.
                 In weeklySeries, we use the drilldown handler to bring us back to seasonSeries. To do this we add mapping to the series. The seasonSeries is mapped to weeklySeries for each month. Every weeklySeries is mapped back to the seasonSeries.
-                To make mapping work, we connect the rightClicked signals from our series to the drilldownChart.
+                To make mapping work, we connect the clicked signals from our series to the drilldownChart.
-                \snippet ../examples/stackedbarchartdrilldown/main.cpp 4
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 3
-                When we have our drilldown structure ready, we can add the data to it. Here we generate random crop for each plant in each week. The monthly crop is calculated from weekly crops. To enable floating values, we connect the clicked signal to toggle the value of corresponding set.
+                When we have our drilldown structure ready, we can add the data to it. Here we generate random crop for each plant in each week. The monthly crop is calculated from weekly crops and is set as value to monthly series.
-                \snippet ../examples/stackedbarchartdrilldown/main.cpp 5
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 4
                 Here we set the chart to show top level series initially.
-                \snippet ../examples/stackedbarchartdrilldown/main.cpp 6
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 5
             */

examples/stackedbarchartdrilldown/drilldownchart.h +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$
             **
             ****************************************************************************/
             #ifndef DRILLDOWNCHART_H
             #define DRILLDOWNCHART_H
             #include <QChart>
             #include "drilldownseries.h"
             QTCOMMERCIALCHART_USE_NAMESPACE
-            //! [2]
+            //! [1]
             class DrilldownChart : public QChart
             {
                 Q_OBJECT
             public:
                 explicit DrilldownChart(QGraphicsItem *parent = 0, Qt::WindowFlags wFlags = 0);
                 void changeSeries(DrilldownBarSeries *series);
             public Q_SLOTS:
                 void handleClicked(QBarSet *barset, int index);
             private:
                 DrilldownBarSeries* m_currentSeries;
             };
-            //! [2]
+            //! [1]
             #endif // DRILLDOWNCHART_H

examples/stackedbarchartdrilldown/main.cpp +12 -14

             /****************************************************************************
             **
             ** 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 <QtGui/QApplication>
             #include <QMainWindow>
             #include <QChartView>
             #include <QBarSet>
             #include <QLegend>
             #include "drilldownseries.h"
             #include "drilldownchart.h"
             QTCOMMERCIALCHART_USE_NAMESPACE
             int main(int argc, char *argv[])
             {
-            //! [1]
                 QApplication a(argc, argv);
                 QMainWindow window;
-            //! [1]
-            //! [2]
+            //! [1]
                 DrilldownChart* drilldownChart =  new DrilldownChart();
                 drilldownChart->setTheme(QChart::ChartThemeBlueIcy);
                 drilldownChart->setAnimationOptions(QChart::SeriesAnimations);
-            //! [2]
+            //! [1]
-            //! [3]
+            //! [2]
                 // Define categories
                 QStringList months;
                 months << "May" << "Jun" << "Jul" << "Aug" << "Sep";
                 QStringList weeks;
                 weeks << "week 1" << "week 2" << "week 3" << "week 4";
                 QStringList plants;
                 plants << "Habanero" << "Lemon Drop" << "Starfish" << "Aji Amarillo";
-            //! [3]
+            //! [2]
-            //! [4]
+            //! [3]
                 // Create drilldown structure
                 DrilldownBarSeries* seasonSeries = new DrilldownBarSeries(months, drilldownChart);
                 seasonSeries->setName("Crop by month - Season");
                 // Each month in season series has drilldown series for weekly data
                 for (int month=0; month < months.count(); month++) {
                     // Create drilldown series for every week
                     DrilldownBarSeries* weeklySeries = new DrilldownBarSeries(weeks, drilldownChart);
                     seasonSeries->mapDrilldownSeries(month, weeklySeries);
                     // Drilling down from weekly data brings us back to season data.
                     for (int week=0; week < weeks.count(); week++) {
                         weeklySeries->mapDrilldownSeries(week, seasonSeries);
                         weeklySeries->setName(QString("Crop by week - " + months.at(month)));
                     }
                     // Use right click signal to implement drilldown
                     QObject::connect(weeklySeries, SIGNAL(clicked(QBarSet*,int)), drilldownChart, SLOT(handleClicked(QBarSet*,int)));
                 }
                 // Enable drilldown from season series using right click.
                 QObject::connect(seasonSeries, SIGNAL(clicked(QBarSet*,int)), drilldownChart, SLOT(handleClicked(QBarSet*,int)));
-            //! [4]
+            //! [3]
-            //! [5]
+            //! [4]
                 // Fill monthly and weekly series with data
                 foreach (QString plant, plants) {
                     QBarSet* monthlyCrop = new QBarSet(plant);
                     for (int month=0; month<months.count(); month++) {
                         QBarSet* weeklyCrop = new QBarSet(plant);
                         for (int week=0; week<weeks.count(); week++) {
                             *weeklyCrop << (qrand() % 20);
                         }
                         // Get the drilldown series from season series and add crop to it.
                         seasonSeries->drilldownSeries(month)->append(weeklyCrop);
                         *monthlyCrop << weeklyCrop->sum();
                     }
                     seasonSeries->append(monthlyCrop);
                 }
-            //! [5]
+            //! [4]
-            //! [6]
+            //! [5]
                 // Show season series in initial view
                 drilldownChart->changeSeries(seasonSeries);
                 drilldownChart->setTitle(seasonSeries->name());
-            //! [6]
+            //! [5]
-            //! [7]
+            //! [6]
                 drilldownChart->axisX()->setGridLineVisible(false);
                 drilldownChart->axisY()->setNiceNumbersEnabled(true);
                 drilldownChart->legend()->setVisible(true);
                 drilldownChart->legend()->setAlignment(Qt::AlignBottom);
-            //! [7]
+            //! [6]
                 QChartView *chartView = new QChartView(drilldownChart);
                 window.setCentralWidget(chartView);
                 window.resize(400, 300);
                 window.show();
                 return a.exec();
             }

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