HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2812:2c2bde37df65

Clarified box-and-whiskers chart documentation...

Titta Heikkala -

r2812:2c2bde37df65

parent child

Context file:

r2812:2c2bde37df65

Collapse all files

src/charts/boxplotchart/qboxplotseries.cpp +11 -5

                 \inmodule Qt Charts
                 \brief Series for creating box-and-whiskers chart.
-                QBoxPlotSeries represents a series of data shown as box-and-whisker bars. The purpose of this class is to act as
+                QBoxPlotSeries represents a series of data shown as box-and-whisker bars. The purpose of this
-                a container for single box-and-whisker items. Each item is drawn to own slot. If chart includes multiple instances of
+                class is to act as a container for single box-and-whisker items. Each item is drawn to own slot.
-                QBoxPlotSeries then box-and-whiskers items with the same index are drawn to same slot.
+                If chart includes multiple instances of QBoxPlotSeries then box-and-whiskers items with the same
+                index are drawn to same slot.
-                See the \l {Box and Whiskers Example} {box-and-whiskers chart example} to learn how to create a box-and-whiskers chart.
+                \note The slot, each item in QBoxPlotSeries is drawn, represents a category in QBarCategoryAxis.
+                The category labels have to be unique. If same category label is defined for several
+                box-and-whisker items only the first one is drawn.
+                See the \l {Box and Whiskers Example} {box-and-whiskers chart example} to learn how to create a
+                box-and-whiskers chart.
                 \image examples_boxplotchart.png
-                \sa QBoxSet
+                \sa QBoxSet, QBarCategoryAxis
             */
             /*!
                 \fn QBoxPlotSeries::boxsetsAdded(QList<QBoxSet *> sets)

src/charts/boxplotchart/qboxset.cpp +2 -2

             }
             /*!
-                Sets new \a label for set.
+                Sets new \a label for the category of the set.
             */
             void QBoxSet::setLabel(const QString label)
             {
             }
             /*!
-                Returns label of the set.
+                Returns the label of the the category of the set.
             */
             QString QBoxSet::label() const
             {

src/chartsqml2/declarativeboxplotseries.cpp +7 -1

             */
             /*!
                 \qmlproperty string BoxSet::label
-                Defines the label of the box-and-whiskers set.
+                Defines the label of the category of the box-and-whiskers set.
             */
             /*!
                 \qmlproperty int BoxSet::count
                 slot. If chart includes multiple instances of BoxPlotSeries then box-and-whiskers items with the
                 same index are drawn to same slot.
+                \note The slot, each item in BoxPlotSeries is drawn, represents a category in BarCategoryAxis.
+                The category labels have to be unique. If same category label is defined for several
+                box-and-whisker items only the first one is drawn.
                 The following QML shows how to create a simple box-and-whiskers chart:
                 \code
                 import QtQuick 2.0
                 \image examples_qmlboxplot.png
                 \endfloat
                 \clearfloat
+                \sa BoxSet, BarCategoryAxis
             */
             /*!

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages