diff options
Diffstat (limited to 'src/datavisualization/doc/src')
9 files changed, 30 insertions, 26 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index a81dbd16..5896b094 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -14,7 +14,7 @@ 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. + hardware acceleration and Qt Quick. \section1 Using the Module diff --git a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc index ff08fb6b..0bf83ec4 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc @@ -5,6 +5,7 @@ \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 @@ -55,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 @@ -68,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 @@ -81,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 @@ -114,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 @@ -187,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 @@ -199,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 8abf4ed2..c2bb0cc5 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -284,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 f428524e..5116aa3a 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc @@ -9,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: * @@ -19,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 12fb6650..cb8b70d2 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc @@ -17,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 d3375a90..36277944 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -30,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 5088e1ca..8e43ea79 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -9,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: @@ -19,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 682a4ccb..b8f47fd3 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -9,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: @@ -19,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 7a4e6886..5b91c2da 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -27,7 +27,6 @@ /*! \group datavisualization_examples - \ingroup all-examples \title Qt Data Visualization Examples \brief Examples for the Qt Data Visualization. @@ -37,6 +36,8 @@ \section1 Examples \annotatedlist qtdatavisualization_examples + The following examples show how to use Qt Quick to visualize data: + \annotatedlist qtdatavisualization_qmlexamples */ /*! @@ -111,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 @@ -161,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 @@ -200,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. |