summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-11-08 11:30:15 +0100
committerLiang Qi <liang.qi@qt.io>2016-11-08 11:46:38 +0100
commit3f5c27908314074f177454ddcb1c18fce123fa6c (patch)
tree4fca1ae043413014e997a04a562e7ee6b4ae9270 /src/datavisualization/doc
parent779f6d8c23e75f12a830a4229db55f28ad1537b7 (diff)
parent90aff7026205d71efde65f1783a06af82e528287 (diff)
Merge remote-tracking branch 'origin/5.7' into 5.8
Conflicts: examples/datavisualization/bars/doc/src/bars.qdoc examples/datavisualization/custominput/doc/src/custominput.qdoc examples/datavisualization/customitems/doc/src/customitems.qdoc examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc examples/datavisualization/rotations/doc/src/rotations.qdoc examples/datavisualization/scatter/doc/src/scatter.qdoc examples/datavisualization/surface/doc/src/surface.qdoc examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc examples/datavisualization/volumetric/doc/src/volumetric.qdoc src/datavisualization/doc/src/qtdatavisualization.qdoc Change-Id: Ic15e77b1fee0708a235bf21815f72b854981537a
Diffstat (limited to 'src/datavisualization/doc')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc19
1 files changed, 9 insertions, 10 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
index d13412f8..37a05d9d 100644
--- a/src/datavisualization/doc/src/qtdatavisualization.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -30,8 +30,7 @@
/*!
\namespace QtDataVisualization
\inmodule QtDataVisualization
-
- QtDataVisualization namespace holds all the classes and enumerations in the QtDataVisualization
+ \brief Contains the classes and enumerations in the Qt Data Visualization
module.
\generatelist{classesbymodule QtDataVisualization}
@@ -77,7 +76,7 @@
\group qtdatavisualization_getting_started
\title Qt Data Visualization Getting Started
- \section1 Installing the Qt Data Visualization module
+ \section1 Installing the Qt Data Visualization Module
Use the \c {Package Manager} in \c {Maintenance Tool} or the \c {Online installer} to install
the Qt Data Visualization module. The module can be found under \c {Qt Enterprise Add-Ons}
@@ -159,7 +158,7 @@
\snippet doc_src_qtdatavisualization.cpp 7
- \section1 Creating a simple application
+ \section1 Creating a Simple Application
To create a simple application, start by creating a new Qt Gui Application project in Qt
Creator and add this line to the \c .pro file of the project:
@@ -202,7 +201,7 @@
\snippet doc_src_qtdatavisualization.cpp 11
- \section1 Data proxies
+ \section1 Data Proxies
The data that users wish to visualize comes in many formats, all of which cannot obviously be
directly supported. Therefore, Qt Data Visualization implements data proxies into which
@@ -223,7 +222,7 @@
it is usually more efficient to store each set in a different series and just change the series,
rather than reset the data in one proxy every time you need to switch.
- \section1 Item models and data mapping
+ \section1 Item Models and Data Mapping
For common use cases, Qt Data Visualization offers specialized proxies. One such case is having
data in an item model (QAbstractItemModel subclass), which is a common way to store data in
@@ -253,7 +252,7 @@
about how to use them: QItemModelBarDataProxy, QItemModelScatterDataProxy, and
QItemModelSurfaceDataProxy.
- \section1 Other custom proxies
+ \section1 Other Custom Proxies
QHeightMapSurfaceDataProxy is a specialized proxy for generating a surface graph from a
heightmap image. See the QHeightMapSurfaceDataProxy documentation for more information.
@@ -262,7 +261,7 @@
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
+ \section1 Dealing with Real-time Data
When you have a data set that updates rapidly, it is important to handle data properly to
ensure good performance. Since memory allocation is a costly operation, always use
@@ -293,13 +292,13 @@
\page qtdatavisualization_interacting_with_data.html
\title Qt Data Visualization Interacting with Data
- \section1 Interacting with data
+ \section1 Interacting with Data
You can interact with the rendered graph with either mouse or touch to rotate, zoom, or select
data. For the default mouse controls, see Q3DInputHandler documentation, and for the default
touch controls, see QTouch3DInputHandler documentation.
- \section1 Data selection modes
+ \section1 Data Selection Modes
All visualization types support selecting a single data item - a bar, a scatter item, or a surface
vertex - using mouse, touch, and programmatically via the series APIs. The selected item is highlighted