diff --git a/doc/src/qml.qdoc b/doc/src/qml.qdoc index 1baf7a2..4bf5eef 100644 --- a/doc/src/qml.qdoc +++ b/doc/src/qml.qdoc @@ -18,7 +18,9 @@ diff --git a/plugins/declarative/declarativechart.cpp b/plugins/declarative/declarativechart.cpp index e491876..782a7ae 100644 --- a/plugins/declarative/declarativechart.cpp +++ b/plugins/declarative/declarativechart.cpp @@ -165,25 +165,25 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \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 */ /*! diff --git a/src/axis/qabstractaxis.cpp b/src/axis/qabstractaxis.cpp index 3368183..be6371e 100644 --- a/src/axis/qabstractaxis.cpp +++ b/src/axis/qabstractaxis.cpp @@ -28,16 +28,16 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \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. @@ -74,7 +74,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The visibility of the axis arrow */ /*! - \qmlproperty bool Axis::arrrowVisible + \qmlproperty bool AbstractAxis::arrrowVisible The visibility of the axis arrow */ @@ -83,7 +83,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines if axis labels are visible. */ /*! - \qmlproperty bool Axis::labelsVisible + \qmlproperty bool AbstractAxis::labelsVisible Defines if axis labels are visible. */ @@ -92,7 +92,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The visibility of the axis. */ /*! - \qmlproperty bool Axis::visible + \qmlproperty bool AbstractAxis::visible The visibility of the axis. */ @@ -101,7 +101,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The visibility of the grid lines. */ /*! - \qmlproperty bool Axis::gridVisible + \qmlproperty bool AbstractAxis::gridVisible The visibility of the grid lines. */ @@ -110,7 +110,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The color of the axis and ticks. */ /*! - \qmlproperty color Axis::color + \qmlproperty color AbstractAxis::color The color of the axis and ticks. */ @@ -120,7 +120,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \qmlproperty Font Axis::labelsFont + \qmlproperty Font AbstractAxis::labelsFont The font of the axis labels. See the \l {Font} {QML Font Element} for detailed documentation. @@ -131,7 +131,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The color of the axis labels. */ /*! - \qmlproperty color Axis::labelsColor + \qmlproperty color AbstractAxis::labelsColor The color of the axis labels. */ @@ -140,7 +140,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The angle of the axis labels in degrees. */ /*! - \qmlproperty int Axis::labelsAngle + \qmlproperty int AbstractAxis::labelsAngle The angle of the axis labels in degrees. */ @@ -149,7 +149,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The visibility of the axis shades. */ /*! - \qmlproperty bool Axis::shadesVisible + \qmlproperty bool AbstractAxis::shadesVisible The visibility of the axis shades. */ @@ -158,7 +158,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The fill (brush) color of the axis shades. */ /*! - \qmlproperty color Axis::shadesColor + \qmlproperty color AbstractAxis::shadesColor The fill (brush) color of the axis shades. */ @@ -167,7 +167,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The border (pen) color of the axis shades. */ /*! - \qmlproperty color Axis::shadesBorderColor + \qmlproperty color AbstractAxis::shadesBorderColor The border (pen) color of the axis shades. */ diff --git a/src/axis/qbarcategoriesaxis.cpp b/src/axis/qbarcategoriesaxis.cpp index e047464..698855a 100644 --- a/src/axis/qbarcategoriesaxis.cpp +++ b/src/axis/qbarcategoriesaxis.cpp @@ -31,21 +31,25 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \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" - axisX.max: "Jun" - // Add a few series... + BarCategoriesAxis { + id: categoryAxis + categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun" ] + } + // Add a few series... } \endcode */ @@ -55,7 +59,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the categories of axis */ /*! - \qmlproperty QStringList Axis::categories + \qmlproperty QStringList BarCategoriesAxis::categories Defines the categories of axis */ @@ -64,7 +68,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the minimum value on the axis. */ /*! - \qmlproperty real Axis::min + \qmlproperty real BarCategoriesAxis::min Defines the minimum value on the axis. */ @@ -73,7 +77,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the maximum value on the axis. */ /*! - \qmlproperty real Axis::max + \qmlproperty real BarCategoriesAxis::max Defines the maximum value on the axis. */ diff --git a/src/axis/qvaluesaxis.cpp b/src/axis/qvaluesaxis.cpp index a6e5506..e500182 100644 --- a/src/axis/qvaluesaxis.cpp +++ b/src/axis/qvaluesaxis.cpp @@ -30,24 +30,26 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \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 - \brief The Axis element is used for manipulating chart's axes + \qmlclass ValuesAxis QValuesAxis + \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 - axisX.max: 3 - axisX.ticksCount: 4 - axisY.min: 0 - axisY.max: 4 - // Add a few series... + ValuesAxis { + id: xAxis + min: 0 + max: 10 + } + // Add a few series... } \endcode */ @@ -57,7 +59,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the minimum value on the axis. */ /*! - \qmlproperty real Axis::min + \qmlproperty real ValuesAxis::min Defines the minimum value on the axis. */ @@ -66,7 +68,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the maximum value on the axis. */ /*! - \qmlproperty real Axis::max + \qmlproperty real ValuesAxis::max Defines the maximum value on the axis. */ @@ -91,7 +93,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \qmlproperty int Axis::ticksCount + \qmlproperty int ValuesAxis::ticksCount The number of tick marks for the axis. */ @@ -101,7 +103,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \qmlproperty bool Axis::niceNumbersEnabled + \qmlproperty bool ValuesAxis::niceNumbersEnabled Whether the nice numbers algorithm is enabled or not for the axis. */