diff options
Diffstat (limited to 'src/datavisualization/doc/src')
8 files changed, 106 insertions, 49 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index 843df153..2a09dc68 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -22,28 +22,54 @@ \brief QtDataVisualization module provides functionality for 3D visualization. Qt Data Visualization module provides a way to visualize data in 3D. - It uses OpneGL for the data rendering. + + \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 - control viewable data window with axis ranges + \li Customizable input handling (upcoming feature - not supported in technology preview) + \li Customizable scene handling - full control of cameras and lights (upcoming feature - + not supported in technology preview) + \li Customizable themes (upcoming feature - not supported in technology preview) + \endlist \section1 Getting Started - Qt Data Visualization provides classes for rendering 3D data. To include - the definitions of the module's classes, use the following directive: + 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 directive: \snippet doc_src_qtdatavisualization.cpp 0 - To link against the module, add this line to your qmake \c - .pro file: + \note If you are using a few classes from this module, we recommend including those specific + classes only instead of the whole module. + + To link against Qt Data Visualization module, add this line to your \c qmake project file: \snippet doc_src_qtdatavisualization.pro 0 + See \l{Qt Data Visualization Getting Started}{Getting started} page for further information + how to use Qt Data Visualization in your application. + \section1 Articles \list - \li \l{Qt Data Visualization License Information}{License Information} + \li \l{Qt Data Visualization Data Handling}{Data input} + \li \l{Qt Data Visualization Interacting with Data}{Interacting with visualized data} \endlist \section1 References \list \li \l{Qt Data Visualization C++ Classes} + \li \l{Qt Data Visualization QML Types} \endlist Qt Data Visualization comes with the following examples: diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 300a31b6..7a0d2c4a 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -18,9 +18,12 @@ /*! \qmltype AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Base type for 3D visualizations. - This type is the base class for all 3D visualizations in Qt Quick 2. + This type is the base type for all 3D visualizations in QtDataVisualization. It resides in the data visualization module that can be imported like this: @@ -29,7 +32,6 @@ Note that this type is uncreatable, but contains properties that are shared between the 3D visualizations. - \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc index fac53960..f778cc92 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -19,7 +19,10 @@ /*! * \qmltype Bars3D * \inherits AbstractGraph3D - * \inmodule QtDataVisualization + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml + * \brief 3D bar graph. * * This type enables developers to render bar graphs in 3D with Qt Quick 2. * diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc index 98b29c87..f8edf492 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -18,6 +18,10 @@ /*! \qmltype ColorGradientStop + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Defines the color at a position in ColorGradient. Defines the color at a position in a ColorGradient. @@ -46,6 +50,10 @@ /*! \qmltype ColorGradient + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief Defines a color gradient. A gradient is defined by two or more colors, which will be blended seamlessly. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index d78cc3a7..2839468e 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -19,7 +19,10 @@ /*! \qmltype Scatter3D \inherits AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief 3D scatter graph. This type enables developers to render scatter graphs in 3D with Qt Quick 2. diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index 31d05844..3669c1cd 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -19,7 +19,10 @@ /*! \qmltype Surface3D \inherits AbstractGraph3D - \inmodule QtDataVisualization + \inqmlmodule com.digia.QtDataVisualization 1.0 + \since com.digia.QtDataVisualization 1.0 + \ingroup datavisualization_qml + \brief 3D surface graph. This type enables developers to render surface plots in 3D with Qt Quick 2. diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 5ddd0720..c0e317d0 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -24,3 +24,52 @@ \brief The QtDataVisualization module provides functionality for 3D visualization. */ +/*! + \group datavisualization_qml + \title Qt Data Visualization QML Types + + \brief QML types for the Qt Data Visualization API. + + Qt Data Visualization functionality can be accessed via these QML types. + + \section1 QML Types +*/ + +/*! + \page qtdatavisualization_getting_started.html + \title Qt Data Visualization Getting Started + + \section1 Building Qt Data Visualization + + TODO + + \section1 Creating a simple application + + TODO +*/ + +/*! + \page qtdatavisualization_data_handling.html + \title Qt Data Visualization Data Handling + + \section1 Data proxies + + TODO + + \section1 Item models and data mapping + + TODO +*/ + +/*! + \page qtdatavisualization_interacting_with_data.html + \title Qt Data Visualization Interacting with Data + + \section1 View manipulation + + TODO + + \section1 Highlighting data + + TODO +*/ diff --git a/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc b/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc deleted file mode 100644 index 16c1ed70..00000000 --- a/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc +++ /dev/null @@ -1,37 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc -** All rights reserved. -** For any questions to Digia, please use contact form at http://qt.digia.com -** -** This file is part of the QtDataVisualization module. -** -** Licensees holding valid Qt Enterprise licenses may use this file in -** accordance with the Qt Enterprise License Agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. -** -** If you have questions regarding the use of this file, please use -** contact form at http://qt.digia.com -** -****************************************************************************/ - -/*! - \page qtdatavisualizationlicense.html - \title Qt Data Visualization License Information - \ingroup licensing - \brief License information for Qt Data Visualization - - \legalese - Copyright 2013 Digia. - - Qt and Qt logos are trademarks of of Digia Corporation in Finland and/or other countries - worldwide. - - All other trademarks are property of their respective owners. - - Licensees holding valid Qt Enterprise licenses may use this document in accordance with the - Qt Enterprise License Agreement provided with the Software or, alternatively, in accordance - with the terms contained in a written agreement between you and Digia. - \endlegalese -*/ |