summaryrefslogtreecommitdiffstats
path: root/src/chartsqml2/declarativepolarchart.cpp
blob: ba35256adc1ffffcf52a4814dd0a7f5eb14d94c4 (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
80
81
82
83
84
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Charts module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "declarativepolarchart_p.h"
#include <QtCharts/QChart>

QT_BEGIN_NAMESPACE

/*!
    \qmltype PolarChartView
    \inherits ChartView
    \instantiates DeclarativePolarChart
    \inqmlmodule QtCharts

    \brief Presents data in polar charts.

    Polar charts present data in a circular graph, where the placement of data
    is based on the angle and distance from the center of the graph, the
    \e pole.

    \image examples_qmlpolarchart1.png

    A polar chart is a specialization of the ChartView type. It supports line,
    spline, area, and scatter series, and all axis types supported by them. Each
    axis can be used either as a radial or an angular axis.

    The first and last tick mark on an angular ValueAxis are co-located at a
    0/360 degree angle.

    If the angular distance between two consecutive points in a series is more
    than 180 degrees, any direct line connecting the two points becomes
    meaningless, and will not be drawn. Instead, a line will be drawn to and
    from the center of the chart. Therefore, the axis ranges must be chosen
    accordingly when displaying line, spline, or area series.

    Polar charts draw all axes of the same orientation in the same position, so
    using multiple axes of the same orientation can be confusing, unless the
    extra axes are only used to customize the grid. For example, you can display
    a highlighted range with a secondary shaded CategoryAxis or provide
    unlabeled subticks with a secondary ValueAxis thas has hidden labels.

    The following QML code shows how to create a polar chart with a spline and
    scatter series and two value axes:
    \snippet qmlpolarchart/qml/qmlpolarchart/View1.qml 1
*/

DeclarativePolarChart::DeclarativePolarChart(QQuickItem *parent)
    : DeclarativeChart(QChart::ChartTypePolar, parent)
{
}

DeclarativePolarChart::~DeclarativePolarChart()
{
}

QT_END_NAMESPACE

#include "moc_declarativepolarchart_p.cpp"