summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
blob: 0a5f04344ffd40bb20e5b2e35f33cceb55538224 (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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Data Visualization 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$
**
****************************************************************************/

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

    Qt Data Visualization module provides a way to visualize data in 3D.

    \section1 Features

    \list
        \li Multiple data visualization options: 3D Bars, 3D Scatter, and 3D Surface
        \li 2D slice views of the 3D data
        \li Interactive data: rotate, zoom, and highlight data using mouse or touch
        \li Uses OpenGL for rendering the data
        \li QML2 support
        \li Customizable axes for data
        \list
            \li Control viewable data window with axis ranges
            \li Customize value axis grid lines and labels with axis formatters
            \li Polar horizontal axes support for surface and scatter graphs
        \endlist
        \li Customizable input handling
        \li Customizable themes
        \li Custom items and labels can be added to any graph
        \li Ready-made data proxies to visualize data from Qt item models and height maps
        \li Perspective and orthographic projections
        \li Volumetric custom items
    \endlist

    \section1 Getting Started

    To import Qt Data Visualization QML types, add the following import statement to your \c .qml
    file:

    \snippet doc_src_qmldatavisualization.cpp 0

    If you intend to use Qt Data Visualization C++ classes in your application, use the
    following include and using directives:

    \snippet doc_src_qtdatavisualization.cpp 0

    \note If you are only using a few classes from this module, we recommend including only those
    specific classes instead of the whole module.

    To link against the Qt Data Visualization module, add this line to your \c qmake project file:

    \snippet doc_src_qtdatavisualization.pro 0

    See the \l{Qt Data Visualization Getting Started}{Getting started} page for further information on
    how to use Qt Data Visualization in your application.

    \section1 Articles
    \list
        \li \l{Qt Data Visualization Getting Started}{Getting Started}
        \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
*/