HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1639:ef5607ba9d7f

qml doc update

sauimone -

r1639:ef5607ba9d7f

parent child

Context file:

r1639:ef5607ba9d7f

Collapse all files

doc/src/qml.qdoc +3 -1

                             <td valign="top">
                                 <ul>
                                 <li><a href="qml-chartview.html">ChartView</a></li>
-                                <li><a href="qml-axis.html">Axis</a></li>
+                                <li><a href="qml-abstractaxis.html">AbstractAxis</a></li>
+                                <li><a href="qml-valuesaxis.html">ValuesAxis</a></li>
+                                <li><a href="qml-barcategoriesaxis.html">BarCategoriesAxis</a></li>
                                 <li><a href="qml-legend.html">Legend</a></li>
                                 <li><a href="qml-abstractseries.html">AbstractSeries</a></li>
                                 </ul>

plugins/declarative/declarativechart.cpp +4 -4

             /*!
               \qmlmethod ChartView::scrollLeft(real pixels)
               Scrolls to left by \a pixels. This is a convenience function that suits for example for key navigation.
-              \sa Axis::min, Axis::max
+              \sa AbstractAxis::min, AbstractAxis::max
             */
             /*!
               \qmlmethod ChartView::scrollRight(real pixels)
               Scrolls to right by \a pixels. This is a convenience function that suits for example for key navigation.
-              \sa Axis::min, Axis::max
+              \sa AbstractAxis::min, AbstractAxis::max
             */
             /*!
               \qmlmethod ChartView::scrollUp(real pixels)
               Scrolls up by \a pixels. This is a convenience function that suits for example for key navigation.
-              \sa Axis::min, Axis::max
+              \sa AbstractAxis::min, AbstractAxis::max
             */
             /*!
               \qmlmethod ChartView::scrollDown(real pixels)
               Scrolls down by \a pixels. This is a convenience function that suits for example for key navigation.
-              \sa Axis::min, Axis::max
+              \sa AbstractAxis::min, AbstractAxis::max
             */
             /*!

src/axis/qabstractaxis.cpp +14 -14

                 \brief The QAbstractAxis class is used for manipulating chart's axis.
                 \mainclass
-                There is only one x Axis, however there can be multiple y axes.
+                There is only one x Axis visible at the time, however there can be multiple y axes.
                 Each chart series can be bound to exactly one Y axis and the shared common X axis.
                 Axis can be setup to show axis line with tick marks, grid lines and shades.
             */
             /*!
-                \qmlclass Axis QAbstractAxis
+                \qmlclass AbstractAxis QAbstractAxis
                 \brief The Axis element is used for manipulating chart's axes
-                There is only one x Axis, however there can be multiple y axes on a ChartView.
+                There is only one x Axis visible at the time, however there can be multiple y axes on a ChartView.
                 Each chart series can be bound to exactly one Y axis and the shared common X axis.
                 Axis can be setup to show axis line with tick marks, grid lines and shades.
               The visibility of the axis arrow
             */
             /*!
-              \qmlproperty bool Axis::arrrowVisible
+              \qmlproperty bool AbstractAxis::arrrowVisible
               The visibility of the axis arrow
             */
               Defines if axis labels are visible.
             */
             /*!
-              \qmlproperty bool Axis::labelsVisible
+              \qmlproperty bool AbstractAxis::labelsVisible
               Defines if axis labels are visible.
             */
               The visibility of the axis.
             */
             /*!
-              \qmlproperty bool Axis::visible
+              \qmlproperty bool AbstractAxis::visible
               The visibility of the axis.
             */
               The visibility of the grid lines.
             */
             /*!
-              \qmlproperty bool Axis::gridVisible
+              \qmlproperty bool AbstractAxis::gridVisible
               The visibility of the grid lines.
             */
               The color of the axis and ticks.
             */
             /*!
-              \qmlproperty color Axis::color
+              \qmlproperty color AbstractAxis::color
               The color of the axis and ticks.
             */
             */
             /*!
-              \qmlproperty Font Axis::labelsFont
+              \qmlproperty Font AbstractAxis::labelsFont
               The font of the axis labels.
               See the \l {Font} {QML Font Element} for detailed documentation.
               The color of the axis labels.
             */
             /*!
-              \qmlproperty color Axis::labelsColor
+              \qmlproperty color AbstractAxis::labelsColor
               The color of the axis labels.
             */
               The angle of the axis labels in degrees.
             */
             /*!
-              \qmlproperty int Axis::labelsAngle
+              \qmlproperty int AbstractAxis::labelsAngle
               The angle of the axis labels in degrees.
             */
               The visibility of the axis shades.
             */
             /*!
-              \qmlproperty bool Axis::shadesVisible
+              \qmlproperty bool AbstractAxis::shadesVisible
               The visibility of the axis shades.
             */
               The fill (brush) color of the axis shades.
             */
             /*!
-              \qmlproperty color Axis::shadesColor
+              \qmlproperty color AbstractAxis::shadesColor
               The fill (brush) color of the axis shades.
             */
               The border (pen) color of the axis shades.
             */
             /*!
-              \qmlproperty color Axis::shadesBorderColor
+              \qmlproperty color AbstractAxis::shadesBorderColor
               The border (pen) color of the axis shades.
             */

src/axis/qbarcategoriesaxis.cpp +13 -9

                 \brief The QBarCategoriesAxis class is used for manipulating chart's axis.
                 \mainclass
-                Axis can be setup to show axis line with tick marks, grid lines and shades.
+                BarCategoriesAxis can be setup to show axis line with tick marks, grid lines and shades.
+                Categories are drawn between ticks.
             */
             /*!
-                \qmlclass Axis QBarCategoriesAxis
+                \qmlclass BarCategoriesAxis QBarCategoriesAxis
                 \brief The Axis element is used for manipulating chart's axes.
                 Axis can be setup to show axis line with tick marks, grid lines and shades.
+                Categories are drawn between ticks.
-                To access Axes you can use ChartView API. For example:
+                To access BarCategoriesAxis you can use ChartView API. For example:
                 \code
                     ChartView {
-                        axisX.min: "Feb"
+                        BarCategoriesAxis {
-                        axisX.max: "Jun"
+                            id: categoryAxis
-                        // Add a few series...
+                            categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun" ]
+                        }
+                    // Add a few series...
                     }
                 \endcode
             */
               Defines the categories of axis
             */
             /*!
-              \qmlproperty QStringList Axis::categories
+              \qmlproperty QStringList BarCategoriesAxis::categories
               Defines the categories of axis
             */
               Defines the minimum value on the axis.
             */
             /*!
-              \qmlproperty real Axis::min
+              \qmlproperty real BarCategoriesAxis::min
               Defines the minimum value on the axis.
             */
               Defines the maximum value on the axis.
             */
             /*!
-              \qmlproperty real Axis::max
+              \qmlproperty real BarCategoriesAxis::max
               Defines the maximum value on the axis.
             */

src/axis/qvaluesaxis.cpp +16 -14

                 \brief The QValuesAxis class is used for manipulating chart's axis.
                 \mainclass
-                Axis can be setup to show axis line with tick marks, grid lines and shades.
+                ValuesAxis can be setup to show axis line with tick marks, grid lines and shades.
+                Values of axis are drawn to position of ticks
             */
             /*!
-                \qmlclass Axis QValuesAxis
+                \qmlclass ValuesAxis QValuesAxis
-                \brief The Axis element is used for manipulating chart's axes
+                \brief The ValuesAxis element is used for manipulating chart's axes
-                Axis can be setup to show axis line with tick marks, grid lines and shades.
+                ValueAxis can be setup to show axis line with tick marks, grid lines and shades.
+                Values of axis are drawn to position of ticks
                 To access Axes you can use ChartView API. For example:
                 \code
                     ChartView {
-                        axisX.min: 0
+                        ValuesAxis {
-                        axisX.max: 3
+                            id: xAxis
-                        axisX.ticksCount: 4
+                            min: 0
-                        axisY.min: 0
+                            max: 10
-                        axisY.max: 4
-                        // Add a few series...
+                    // Add a few series...
                     }
                 \endcode
             */
               Defines the minimum value on the axis.
             */
             /*!
-              \qmlproperty real Axis::min
+              \qmlproperty real ValuesAxis::min
               Defines the minimum value on the axis.
             */
               Defines the maximum value on the axis.
             */
             /*!
-              \qmlproperty real Axis::max
+              \qmlproperty real ValuesAxis::max
               Defines the maximum value on the axis.
             */
             */
             /*!
-              \qmlproperty int Axis::ticksCount
+              \qmlproperty int ValuesAxis::ticksCount
               The number of tick marks for the axis.
             */
             */
             /*!
-              \qmlproperty bool Axis::niceNumbersEnabled
+              \qmlproperty bool ValuesAxis::niceNumbersEnabled
               Whether the nice numbers algorithm is enabled or not for the axis.
             */

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