diff options
Diffstat (limited to 'src/datavisualization/doc')
17 files changed, 91 insertions, 487 deletions
diff --git a/src/datavisualization/doc/qtdatavis3d.qdocconf b/src/datavisualization/doc/qtdatavis3d.qdocconf index a0231392..952cac3e 100644 --- a/src/datavisualization/doc/qtdatavis3d.qdocconf +++ b/src/datavisualization/doc/qtdatavis3d.qdocconf @@ -5,6 +5,7 @@ project = QtDataVis3D description = Qt Data Visualization Reference Documentation version = $QT_VERSION buildversion = Qt Data Visualization | Commercial or GPLv3 +moduleheader = QtDataVisualization examplesinstallpath = datavisualization exampledirs += ../../../examples/datavisualization \ @@ -46,5 +47,3 @@ qhp.QtDataVis3D.subprojects.types.sortPages = true navigation.landingpage = Qt Data Visualization navigation.cppclassespage = Qt Data Visualization C++ Classes navigation.qmltypespage = Qt Data Visualization QML Types - -manifestmeta.highlighted.names = "QtDataVis3D/Textured Surface Example" diff --git a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp index 53c3f515..2f10a988 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [3] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp index 975b0d4e..5bf508f3 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [3] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp index 94fde08f..3946ede6 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [5] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp index ed798ae4..a192976d 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #include <QtDataVisualization/Q3DBars> #include <QtDataVisualization/Q3DTheme> diff --git a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp index c02c89f4..488d3a6f 100644 --- a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] import QtDataVisualization 1.2 diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp index 7d41cac4..fa4e5178 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro index fea49c20..00652a42 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro @@ -1,31 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2018 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$ -** -****************************************************************************/ +// Copyright (C) 2018 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #! [0] QT += datavisualization diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index b433f262..5896b094 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \title Qt Data Visualization @@ -31,47 +7,39 @@ \brief Provides functionality for 3D visualization. - Qt Data Visualization module provides a way to visualize data in 3D as bar, - scatter, and surface graphs. It is 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 to them. + 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 5 and OpenGL to take advantage of - hardware acceleration and Qt Quick 2. + Qt Data Visualization is built on Qt 6 and OpenGL to take advantage of + hardware acceleration and Qt Quick. - \section1 Getting Started + \section1 Using the Module - To import Qt Data Visualization QML types, add the following import statement to your \c .qml - file: + \section2 QML API - \qml \QtMinorVersion - import QtDataVisualization 1.\1 - \endqml + \include {module-use.qdocinc} {using the qml api} {QtDataVisualization} - If you intend to use Qt Data Visualization C++ classes in your application, use the - following include: + \section2 C++ API - \snippet doc_src_qtdatavisualization.cpp 0 + \include {module-use.qdocinc} {using the c++ api} - \note If you are only using a few classes from this module, we recommend including only those - specific classes instead of the whole module. + \section3 Building with CMake - To link against the Qt Data Visualization module, add this line to your \c qmake project file: + \include {module-use.qdocinc} {building with cmake} {DataVisualization} - \snippet doc_src_qtdatavisualization.pro 0 + \section3 Building with qmake - \section1 Licenses + \include {module-use.qdocinc} {building_with_qmake} {datavisualization} - 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. - - \section1 Articles + \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 Interacting with Data}{Interacting with + Data} \li \l{Qt Data Visualization Known Issues}{Known Issues} \endlist @@ -85,4 +53,9 @@ \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. */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc index f62a1d90..0bf83ec4 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc @@ -1,34 +1,11 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \title Qt Data Visualization Overview \page qtdatavisualization-overview.html \brief An overview of the Qt Data Visualization module. + \ingroup explanation The Qt Data Visualization module provides a way to develop rapidly responding, complex, and dynamic 3D visualization for analytical demanding @@ -79,8 +56,8 @@ \image q3dbars-minimal.png - For more information, see \l{How to construct a minimal Q3DBars graph}, - \l {Bars Example}, and \l {Qt Quick 2 Bars Example}. + For more information, see \l{How to construct a minimal Q3DBars graph}, and + \l {Simple Bar Graph} examples. \section2 3D Scatter Graphs @@ -92,8 +69,8 @@ \image q3dscatter-minimal.png - For more information, see \l{How to construct a minimal Q3DScatter graph}, - \l{Scatter Example}, and \l{Qt Quick 2 Scatter Example}. + For more information, see \l{How to construct a minimal Q3DScatter graph}, and + \l{Simple Scatter Graph} examples. \section2 3D Surface Graphs @@ -105,9 +82,8 @@ \image q3dsurface-minimal.png - For more information, see \l{How to construct a minimal Q3DSurface graph}, - \l{Surface Example}, \l{Textured Surface Example}, \l{Qt Quick 2 Surface - Example}, and \l{Qt Quick 2 Surface Multiseries Example}. + For more information, see \l{How to construct a minimal Q3DSurface graph}, \l{Graph Gallery}, + and \l{Surface Graph Gallery} examples. \section1 Using OpenGL for Rendering Data @@ -138,7 +114,7 @@ be partially transparent. Therefore, changing the rendering mode is a question of performance versus quality. - Qt Quick 2 uses a dedicated scenegraph for data rendering, and is therefore + Qt Quick uses a dedicated scenegraph for data rendering, and is therefore the best choice for data visualization. \section1 3D Axes @@ -211,7 +187,7 @@ If a graph displays the data from several data series, some settings can be specified separately for each series. For example, different gradients can be specified for different layers of the graph to make it look more - realistic. For an example, see \l{Qt Quick 2 Surface Multiseries Example}. + realistic. For an example, see \l{Surface Graph Gallery}. \section1 Customizing 3D Scenes @@ -223,7 +199,7 @@ position follows the camera automatically. The camera can be customized by specifying its preset position, rotation, - and zoom level. For an example, see \l{Qt Quick 2 Scatter Example}. + and zoom level. For an example, see \l{Simple Scatter Graph}. \section1 Customizing Items diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 9f9dd6e1..c2bb0cc5 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype AbstractGraph3D @@ -308,7 +284,7 @@ * \c selectedElementChanged signal is emitted. * * The signal can be used for example for implementing customized input - * handling, as demonstrated by the \l {Qt Quick 2 Axis Dragging Example}. + * handling, as demonstrated by the \l {Axis Handling} example. * * \sa selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), * Bars3D::selectedSeries, Scatter3D::selectedSeries, Scene3D::selectionQueryPosition, diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc index 437f2f6f..5116aa3a 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! * \qmltype Bars3D @@ -33,7 +9,7 @@ * \ingroup datavisualization_qml * \brief 3D bar graph. * - * This type enables developers to render bar graphs in 3D with Qt Quick 2. + * This type enables developers to render bar graphs in 3D with Qt Quick. * * You will need to import data visualization module to use this type: * @@ -43,7 +19,7 @@ * * \snippet doc_src_qmldatavisualization.cpp 1 * - * See \l{Qt Quick 2 Bars Example} for more thorough usage example. + * See \l{Simple Bar Graph} for more thorough usage example. * * \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc index ee23ae20..cb8b70d2 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype ThemeColor @@ -41,4 +17,6 @@ The color property describes the color of this ThemeColor. The default color is black. + + \note Transparency is not supported and will result in undefined behavior. */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc index 57a4f983..36277944 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype ColorGradientStop @@ -54,6 +30,8 @@ The default color is black. + \note Transparency in a gradient is not supported and will result in undefined behavior. + \sa ColorGradient */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index 8a5ce9d8..8e43ea79 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype Scatter3D @@ -33,7 +9,7 @@ \ingroup datavisualization_qml \brief 3D scatter graph. - This type enables developers to render scatter graphs in 3D with Qt Quick 2. + This type enables developers to render scatter graphs in 3D with Qt Quick. You will need to import data visualization module to use this type: @@ -43,7 +19,7 @@ \snippet doc_src_qmldatavisualization.cpp 2 - See \l{Qt Quick 2 Scatter Example} for more thorough usage example. + See \l{Simple Scatter Graph} for more thorough usage example. \sa Scatter3DSeries, ScatterDataProxy, Bars3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index c3daca2a..b8f47fd3 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype Surface3D @@ -33,7 +9,7 @@ \ingroup datavisualization_qml \brief Describes the usage of the 3D surface graph. - This type enables developers to render surface plots in 3D with Qt Quick 2. + This type enables developers to render surface plots in 3D with Qt Quick. You will need to import the data visualization module to use this type: @@ -43,7 +19,7 @@ \snippet doc_src_qmldatavisualization.cpp 3 - See \l{Qt Quick 2 Surface Example} for more thorough usage example. + See \l{Surface Graph Gallery} for more thorough usage example. \sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 33448065..5b91c2da 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -1,34 +1,12 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \module QtDataVisualization \title Qt Data Visualization C++ Classes \ingroup modules + \qtcmakepackage DataVisualization + \qtvariable datavisualization \brief C++ classes for the Qt Data Visualization API. @@ -49,7 +27,6 @@ /*! \group datavisualization_examples - \ingroup all-examples \title Qt Data Visualization Examples \brief Examples for the Qt Data Visualization. @@ -59,10 +36,12 @@ \section1 Examples \annotatedlist qtdatavisualization_examples + The following examples show how to use Qt Quick to visualize data: + \annotatedlist qtdatavisualization_qmlexamples */ /*! - \page qtdatavisualization_data_handling.html + \page qtdatavisualization-data-handling.html \title Qt Data Visualization Data Handling \section1 Series @@ -133,9 +112,9 @@ QHeightMapSurfaceDataProxy is a specialized proxy for generating a surface graph from a heightmap image. See the QHeightMapSurfaceDataProxy documentation for more information. - The \l{Custom Proxy Example}{Custom Proxy} example shows how a custom proxy can be created. It - defines a custom data set based on variant lists and an extension of the basic proxy to resolve - that data with an associated mapper. + The \l{Graph Gallery} example shows how a custom proxy can be created, under the + \uicontrol {Bar Graph} tab. It defines a custom data set based on variant lists and an + extension of the basic proxy to resolve that data with an associated mapper. \section1 Dealing with Real-time Data @@ -165,7 +144,7 @@ */ /*! - \page qtdatavisualization_interacting_with_data.html + \page qtdatavisualization-interacting-with-data.html \title Qt Data Visualization Interacting with Data \section1 Interacting with Data @@ -183,9 +162,8 @@ the default touch controls, see QTouch3DInputHandler. The default handlers must be disabled when using customized input handlers. - The \l{Custom Input Example} illustrates how to use a custom input handler - to select items upon mouseover instead of mouse click. The information - below the mouse cursor is displayed as a popup. + The \l{Graph Gallery} example, under \uicontrol {Scatter Graph} tab, illustrates how to use + a custom input handler to drag an axis label to move the visible part of the data. In addition to perspective projection, orthographic projection can be used to create 2D graphs by replacing the default input handler with one that @@ -212,7 +190,7 @@ */ /*! - \page qtdatavisualization_known_issues.html + \page qtdatavisualization-known-issues.html \title Qt Data Visualization Known Issues \list @@ -222,7 +200,7 @@ application main. It can be defined by adding \c {qputenv("QSG_RHI_BACKEND", "opengl");} in the beginning of your main function. \li Some platforms like Android and WinRT cannot handle multiple native windows properly, - so only the Qt Quick 2 graphs are available in practice for those platforms. + so only the Qt Quick graphs are available in practice for those platforms. \li Surfaces with non-straight rows and columns do not always render properly. \li Q3DLight class (and Light3D QML item) are currently not usable for anything. \li Changing most of Q3DScene properties affecting subviewports currently has no effect. |