summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
blob: 4b83bf3ae17eeec4016b69640109bc19a780e3d2 (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
85
/****************************************************************************
**
** Copyright (C) 2017 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$
**
****************************************************************************/

/*!
    \title Qt Data Visualization
    \page qtdatavisualization-index.html
    \brief Provides functionality for 3D visualization.


    The Qt Data Visualization module enables you to visualize data in 3D as
    bar, scatter, and surface graphs. It's especially useful for visualizing
    depth maps and large quantities of rapidly changing data, such as data
    received from multiple sensors. The look and feel of graphs can be
    customized by using themes or by adding custom items and labels.

    Qt Data Visualization is built on Qt 6 and OpenGL to take advantage of
    hardware acceleration and Qt Quick 2.

    \section1 Using the Module

    \section2 QML API

    \include {module-use.qdocinc} {using the qml api} {QtDataVisualization}

    \section2 C++ API

    \include {module-use.qdocinc} {using the c++ api}

    \section3 Building with CMake

    \include {module-use.qdocinc} {building with cmake} {DataVisualization}

    \section3 Building with qmake

    \include {module-use.qdocinc} {building_with_qmake} {datavisualization}

    \section1 Articles and Guides
    \list
        \li \l{Qt Data Visualization Overview}{Overview}
        \li \l{Qt Data Visualization Data Handling}{Data Handling}
        \li \l{Qt Data Visualization Interacting with Data}{Interacting with
        Data}
        \li \l{Qt Data Visualization Known Issues}{Known Issues}
    \endlist

    \section1 Examples
    \list
        \li \l{Qt Data Visualization Examples}
    \endlist

    \section1 API Reference
    \list
        \li \l{Qt Data Visualization C++ Classes}
        \li \l{Qt Data Visualization QML Types}
    \endlist

    \section1 Licenses and Attributions
    Qt Data Visualization is available under commercial licenses from \l{The Qt
    Company}. In addition, it is available under the \l{GNU General Public
    License, version 3}. See \l{Qt Licensing} for further details.
*/