HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r500:4d73e3f9e3b6

Fixing example documentation

Tero Ahola -

r500:4d73e3f9e3b6

parent child

Context file:

r500:4d73e3f9e3b6

Collapse all files

doc/src/example-splinechart.qdoc +1 -1

             /*!
-                 \example example/splinechart
+                 \example examples/splinechart
                  \title SplineChart Example
                  \subtitle
                  The example shows how to create simple spline chart.
             \image splinechart_example
                 To create spline chart we need to put our data into QSplineSeries. QSplineSeries automatically calculates spline segment control points that are needed to properly draw the spline.
                 \snippet ../examples/splinechart/splinewidget.cpp 1
                 Customize the look of the spline, by setting its pen's color and pen's width
                 \snippet ../examples/splinechart/splinewidget.cpp 2
             Now lets add some data points to the series.
             	\snippet ../examples/splinechart/splinewidget.cpp add points to series
             The data series has been populated. To display it on a chart we create QChartView object and add the data series to it. We also set the ranges on both axises, so that our chart is fully visible and there is some excess of space for adding more data points.
                 \snippet ../examples/splinechart/splinewidget.cpp 3
                 Then we add two buttons for adding and removing data points. Buttons clicked() signals are connected to handler functions.
                 \snippet ../examples/splinechart/splinewidget.cpp 4
                 In the end we add the chart and the buttons to the widget's layout.
                 \snippet ../examples/splinechart/splinewidget.cpp 5
             Here is the handler function for add new data point button:
             \snippet ../examples/splinechart/splinewidget.cpp add point
             And here is one for remove the last data point in the series:
             \snippet ../examples/splinechart/splinewidget.cpp remove point
             */

doc/src/examples-areachart.qdoc ~~doc/src/example-areachart.qdoc~~ renamed +1 -1

             /*!
-                 \example example/areachart
+                 \example examples/areachart
                  \title AreaChart Example
                  \subtitle
                  The example shows how to create simple area chart.
                 \image areachart.png
                 To create area charts, we need two QLineSeries instances. They are going to define upper and lower boundary of the area.
                 \snippet ../examples/areachart/main.cpp 1
                 We add data to both series, we use stream operator.
                 \snippet ../examples/areachart/main.cpp 2
                 Now we create QAreaSeries instance using two line series objects. We set the custom gradient fill and width of the outline.
                 \snippet ../examples/areachart/main.cpp 3
                 In the end we create QChartView instance, set title, set anti-aliasing and add area series. We also set the specific range for axes.
                 \snippet ../examples/areachart/main.cpp 4
                 Chart is ready to be shown.
                 \snippet ../examples/areachart/main.cpp 5
             */

doc/src/examples-barchart.qdoc ~~doc/src/example-barchart.qdoc~~ renamed +1 -1

             /*!
-                \example example/barchart
+                \example examples/barchart
                 \title BarChart Example
                 \subtitle
                 The example shows how to create simple bar chart. Barchart shows the data in sets as separate bars, which are grouped in categories.
             	\image barchart.png
                 First we define categories.
                 \snippet ../examples/barchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
                 \snippet ../examples/barchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
                 \snippet ../examples/barchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
                 \snippet ../examples/barchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
                 \snippet ../examples/barchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
                 \snippet ../examples/barchart/main.cpp 6
             */

doc/src/examples-linechart.qdoc ~~doc/src/example-linechart.qdoc~~ renamed +1 -1

             /*!
-                 \example example/linechart
+                 \example examples/linechart
                  \title LineChart Example
                  \subtitle
                  The example shows how to create simple line chart.
                 \image linechart.png
                 To create line charts, QLineSeries instance is needed. Here we create two line series and we set the color and width of line.
                 \snippet ../examples/linechart/main.cpp 1
                 We add data to be shown to both series. We can use add() member function or use stream operator.
                 \snippet ../examples/linechart/main.cpp 2
                 In the end we create QChartView instance, set title, set anti-aliasing and add both series.
                 \snippet ../examples/linechart/main.cpp 3
                 Chart is ready to be shown.
                 \snippet ../examples/linechart/main.cpp 4
             */

doc/src/examples-percentbarchart.qdoc ~~doc/src/example-percentbarchart.qdoc~~ renamed +1 -1

             /*!
-                \example example/percentbarchart
+                \example examples/percentbarchart
                 \title PercentBarChart Example
                 \subtitle
                 The example shows how to create simple percent bar chart. Percent bar chart shows the data in set as percentage of all sets, per category.
             	\image percentbarchart.png
                 First we define categories.
                 \snippet ../examples/percentbarchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
                 \snippet ../examples/percentbarchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
                 \snippet ../examples/percentbarchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
                 \snippet ../examples/percentbarchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
                 \snippet ../examples/percentbarchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
                 \snippet ../examples/percentbarchart/main.cpp 6
             */

doc/src/examples-piechart.qdoc ~~doc/src/example-piechart.qdoc~~ renamed +1 -1

             /*!
-                 \example example/piechart
+                 \example examples/piechart
                  \title LineChart Example
                  \subtitle
                  The example shows how to create simple pie chart.
                  ...
             */

doc/src/examples-presenterchart.qdoc ~~doc/src/example-presenterchart.qdoc~~ renamed +1 -1

             /*!
-                 \example example/presenterchart
+                 \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.
                  ChartPresenter will switch between these three 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
                 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.
                 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.
                 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]
                 \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.
                 \snippet ../examples/presenterchart/chartview.cpp 4
             */

doc/src/examples-scatterchart.qdoc ~~doc/src/example-scatterchart.qdoc~~ renamed +1 -1

             /*!
-                 \example example/scatterchart
+                 \example examples/scatterchart
                  \title ScatterChart Example
                  \subtitle
                  The example shows how to create simple scatter chart.
                 \image scatterchart.png
                 To create scatter charts, QScatterSeries instance is needed. Here we create scatter series instance and we set the type, color and width of outline for scatter points.
                 \snippet ../examples/scatterchart/main.cpp 1
                 We add data to be shown. We can use add() member function or use stream operator.
                 \snippet ../examples/scatterchart/main.cpp 2
                 In the end we create QChartView instance, set title, set anti-aliasing and add scatter series.
                 \snippet ../examples/scatterchart/main.cpp 3
                 Chart is ready to be shown.
                 \snippet ../examples/scatterchart/main.cpp 4
             */

doc/src/examples-stackedbarchart-drilldown.qdoc ~~doc/src/example-stackedbarchart-drilldown.qdoc~~ renamed +1 -1

             /*!
-                \example example/stackedbarchartdrilldown
+                \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 stackedbarchart_drilldown_season.png
             	Right mouse button clicked on august, shows the harvest from august:
             	\image stackedbarchart_drilldown_august.png
                 Here we define a drilldown series, which adds 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.
                 \snippet ../examples/stackedbarchartdrilldown/main.cpp 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 occured.
             	In our DrilldownChart we implement handler, which selects the drilldown chart with the category.
                 \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.
                 \snippet ../examples/stackedbarchartdrilldown/main.cpp 4
                 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.
                 \snippet ../examples/stackedbarchartdrilldown/main.cpp 5
             	Here we set the chart to show top level series initially.
                 \snippet ../examples/stackedbarchartdrilldown/main.cpp 6
             */

doc/src/examples-stackedbarchart.qdoc ~~doc/src/example-stackedbarchart.qdoc~~ renamed +1 -1

             /*!
-                \example example/stackedbarchart
+                \example examples/stackedbarchart
                 \title StackedBarChart Example
                 \subtitle
                 The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are stacked on top of each other. The stacking is done per category.
             	\image stackedbarchart.png
                 First we define categories.
                 \snippet ../examples/stackedbarchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
                 \snippet ../examples/stackedbarchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
                 \snippet ../examples/stackedbarchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
                 \snippet ../examples/stackedbarchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
                 \snippet ../examples/stackedbarchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
                 \snippet ../examples/stackedbarchart/main.cpp 6
             */

doc/src/examples.qdoc +10 -10

             /*!
                 \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="example-areachart.html">Area Chart example</a></li>
+                        <li><a href="examples-areachart.html">Area Chart example</a></li>
-                        <li><a href="example-barchart.html">Bar Chart example</a></li>
+                        <li><a href="examples-barchart.html">Bar Chart example</a></li>
-                        <li><a href="example-linechart.html">Line Chart example</a></li>
+                        <li><a href="examples-linechart.html">Line Chart example</a></li>
-                        <li><a href="example-percentbarchart.html">Percent Bar Chart example</a></li>
+                        <li><a href="examples-percentbarchart.html">Percent Bar Chart example</a></li>
-                        <li><a href="example-piechart.html">Pie Chart example</a></li>
+                        <li><a href="examples-piechart.html">Pie Chart example</a></li>
-                        <li><a href="example-presenterchart.html">Presenter Chart example</a></li>
+                        <li><a href="examples-presenterchart.html">Presenter Chart example</a></li>
-                        <li><a href="example-scatterchart.html">Scatter Chart example</a></li>
+                        <li><a href="examples-scatterchart.html">Scatter Chart example</a></li>
-                        <li><a href="example-splinechart.html">Spline Chart example</a></li>
+                        <li><a href="examples-splinechart.html">Spline Chart example</a></li>
-                        <li><a href="example-stackedbarchart.html">Stacked Bar Chart example</a></li>
+                        <li><a href="examples-stackedbarchart.html">Stacked Bar Chart example</a></li>
-                        <li><a href="example-stackedbarchartdrilldown.html">Stacked Bar Chart Drilldown example</a></li>
+                        <li><a href="examples-stackedbarchartdrilldown.html">Stacked Bar Chart Drilldown example</a></li>
                         <li><a href="examples-customcolors.html">Customizing colors example</a></li>
                     </ul>
                     </td>
                     </tr>
                     </table>
                 \endraw
             */

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