diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-03-01 22:35:30 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-03-02 11:25:22 +0000 |
commit | 044275ad2b4cf5ccd0bef968237ecf8fc731633a (patch) | |
tree | 678e3b834b1af731a3e6561eedca4da50cbc50cf | |
parent | eb7bca1edcdd229b92c5d013847492a882194e1f (diff) |
Doc: Fix issues in Q[H|V]XYModelMapper documentation
* The detailed description for these two types were swapped
* Clarify the data model used for the mapper, and suggest a
table model as a good fit
* Link to the example that makes use of a mapper
Fixes: QTBUG-80828
Change-Id: If45dce47e74c28eb76d248133bbbfd2e44555750
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit ef331c506ab960d2a6e22c17c4af199b1079ef73)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/charts/xychart/qhxymodelmapper.cpp | 12 | ||||
-rw-r--r-- | src/charts/xychart/qvxymodelmapper.cpp | 12 |
2 files changed, 16 insertions, 8 deletions
diff --git a/src/charts/xychart/qhxymodelmapper.cpp b/src/charts/xychart/qhxymodelmapper.cpp index 083dc03c..de5cca82 100644 --- a/src/charts/xychart/qhxymodelmapper.cpp +++ b/src/charts/xychart/qhxymodelmapper.cpp @@ -40,12 +40,14 @@ QT_CHARTS_BEGIN_NAMESPACE Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A horizontal model mapper is used to create a connection between a line, spline, or scatter series and the data - model that holds the consecutive data point coordinates on rows. + model that has \e X and \e Y rows for the coordinates and holds the data + points for the XYSeries as columns. A \e TableModel is a natural choice + for the model. Both model and series properties can be used to manipulate the data. The model mapper keeps the series and the data model in sync. - \sa QVXYModelMapper, QXYSeries + \sa QVXYModelMapper, QXYSeries, {Model Data Example} */ /*! \qmltype HXYModelMapper @@ -57,12 +59,14 @@ QT_CHARTS_BEGIN_NAMESPACE Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A horizontal model mapper is used to create a connection between a line, spline, or scatter series and the data - model that holds the consecutive data point coordinates on rows. + model that has \e X and \e Y rows for the coordinates and holds the data + points for the XYSeries as columns. A \e TableModel is a natural choice + for the model. Both model and series properties can be used to manipulate the data. The model mapper keeps the series and the data model in sync. - \sa VXYModelMapper, XYSeries + \sa VXYModelMapper, XYSeries, {Model Data Example} */ /*! diff --git a/src/charts/xychart/qvxymodelmapper.cpp b/src/charts/xychart/qvxymodelmapper.cpp index ff9a4f21..71ae79ce 100644 --- a/src/charts/xychart/qvxymodelmapper.cpp +++ b/src/charts/xychart/qvxymodelmapper.cpp @@ -40,12 +40,14 @@ QT_CHARTS_BEGIN_NAMESPACE Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A vertical model mapper is used to create a connection between a line, spline, or scatter series and the data - model that holds the consecutive data point coordinates in columns. + model that has \e X and \e Y columns for the coordinates and holds the data + points for the XYSeries as rows. A \e TableModel is a natural choice + for the model. Both model and series properties can be used to manipulate the data. The model mapper keeps the series and the data model in sync. - \sa QHXYModelMapper, QXYSeries + \sa QHXYModelMapper, QXYSeries, {Model Data Example} */ /*! \qmltype VXYModelMapper @@ -57,12 +59,14 @@ QT_CHARTS_BEGIN_NAMESPACE Model mappers enable using a data model derived from the QAbstractItemModel class as a data source for a chart. A vertical model mapper is used to create a connection between a line, spline, or scatter series and the data - model that holds the consecutive data point coordinates in columns. + model that has \e X and \e Y columns for the coordinates and holds the data + points for the XYSeries as rows. A \e TableModel is a natural choice + for the model. Both model and series properties can be used to manipulate the data. The model mapper keeps the series and the data model in sync. - \sa HXYModelMapper, XYSeries + \sa HXYModelMapper, XYSeries, {Model Data Example} */ /*! |