summaryrefslogtreecommitdiffstats
path: root/src/charts/doc/src/examples-barchart.qdoc
blob: 818adcd18933e1f5039566aed9e1edfef12a6956 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example barchart
    \title BarChart Example
    \ingroup qtcharts_examples

    \brief The example shows how to create a bar chart.

    BarChart shows the data in sets as separate bars, which are  in categories.

    \image examples_barchart.png

    \include examples-run.qdocinc

    \section1 Creating Bar Charts

    The barsets are used in the same way in all barcharts.
    To illustrate the difference between various barcharts, we use the same data in the examples.
    Data that 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 the << operator. Alternatively, the append method could be used.

    \snippet barchart/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.

    \snippet barchart/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)

    \snippet barchart/main.cpp 3

    To have categories displayed on axis, we need to create a QBarCategoryAxis
    for that. Here we create a category axis with a list of categories and
    set it to be aligned to the bottom, acting as the x-axis, and attach it to
    the series. The chart takes ownership of the axis. For y-axis we use a
    value axis, aligned to the left-hand side.

    \snippet barchart/main.cpp 4

    We also want to show the legend. To do that, 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 barchart/main.cpp 5

    Finally we add the chart onto a view. We also turn on the antialiasing for the chartView.

    \snippet barchart/main.cpp 6

    The 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.

    \snippet barchart/main.cpp 7
*/