summaryrefslogtreecommitdiffstats
path: root/doc/src/examples-stackedbarchart.qdoc
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-09-11 16:59:42 +0200
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-09-16 09:26:32 +0300
commit66fa88d106401d019172e2cdb6d0de2b2a22df1f (patch)
tree4bcfb295643d4ecd834585e72cb7d50731fdde9b /doc/src/examples-stackedbarchart.qdoc
parentcff0f629c1c420dc38d59897d163034b395dd192 (diff)
Doc: language review of Qt Charts doc
Change-Id: I6bdf7b64851d1f0e2b98f37cbf9844aeb205bed1 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'doc/src/examples-stackedbarchart.qdoc')
-rw-r--r--doc/src/examples-stackedbarchart.qdoc39
1 files changed, 18 insertions, 21 deletions
diff --git a/doc/src/examples-stackedbarchart.qdoc b/doc/src/examples-stackedbarchart.qdoc
index c0410b78..7375b43a 100644
--- a/doc/src/examples-stackedbarchart.qdoc
+++ b/doc/src/examples-stackedbarchart.qdoc
@@ -3,52 +3,49 @@
\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
+ The example shows how to create a simple stacked bar chart. The stacked bar chart shows the data in sets as bars
stacked on top of each other. The stacking is done per category.
- The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are
+ The example shows how to create a 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.
- Creating stacked bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
- stacked bar chart, we use QStackedBarSeries api instead of QBarSeries.
+ Creating a stacked bar chart is just like creating a regular \l {BarChart Example} {bar chart}, except that for a
+ stacked bar chart, we use the QStackedBarSeries api instead of QBarSeries.
\image examples_stackedbarchart.png
-
+
The barsets are used in same way in all barcharts.
- To illustrate difference between various barcharts, we use same data in examples.
- Data that barchart visualizes, is defined by QBarSet instances. Here we create the sets and append data
+ To illustrate the difference between various barcharts, we use same data in all examples.
+ Data, which the barchart visualizes, is defined by the QBarSet instances. Here we create the sets and append data
to them. The data is appended here with << operator. Alternatively the append method could be used.
\snippet ../examples/stackedbarchart/main.cpp 1
We create the series and append the barsets to it. The series takes ownership of the barsets. The series groups the data from sets to categories.
- First values of each set are grouped together at first category second value to second category and so on.
+ The first values of each set are grouped together in the first category, the second values in the second category etc.
\snippet ../examples/stackedbarchart/main.cpp 2
- Here we create the chart object and add the series to it. We set the title for chart with setTitle and then turn on animations of the series by calling
- setAnimationOptions(QChart::SeriesAnimations)
+ Here we create the chart object and add the series to it. We set the title for the chart with setTitle, and then turn on animations of the series by calling
+ setAnimationOptions(QChart::SeriesAnimations).
\snippet ../examples/stackedbarchart/main.cpp 3
- To have categories displayed on axis, we need to create a QBarCategoryAxis for that. Here we create a category axis with list of categories and
- set it to be the x-axis of the chart. The chart takes ownership of axis. For y-axis we use default axis, which is created and scaled to series data
- by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
- override the category axis.
+ To have categories displayed on the axis, we need to create a QBarCategoryAxis. Here we create a category axis with list of categories and
+ set it to be the x-axis of the chart. The chart takes ownership of the axis. For the y-axis we use default axis, which is created and scaled to series data
+ by calling createDefaultAxes of the chart. Note that the call for createDefaultAxes must be before we set the category axis. Otherwise the default axis will
+ override the category axis.
\snippet ../examples/stackedbarchart/main.cpp 4
- We also want to show the legend. To do that, we get the legend pointer from chart and set it to visible. We also place the legend to bottom of the chart by setting its alignment
- to Qt::AlignBottom.
+ We also want to show the legend. To do so, we get the legend pointer from the chart and set it to visible. We also place the legend to the bottom of the chart by setting its alignment to Qt::AlignBottom.
\snippet ../examples/stackedbarchart/main.cpp 5
- Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.
+ Finally, we add the chart onto a view. We also turn on the antialiasing for the chartView.
\snippet ../examples/stackedbarchart/main.cpp 6
- Chart is ready to be shown. We set the chart to be central widget of the window.
- We also set the size for the chart window and show it.
+ The chart is ready to be shown. We set the chart to be the central widget of the window.
+ We also set the size for the chart window and show it.
\snippet ../examples/stackedbarchart/main.cpp 7
*/
-
-