qcategoryaxis.cpp
376 lines
| 11.3 KiB
| text/x-c
|
CppLexer
|
r2854 | /**************************************************************************** | ||
|
r1701 | ** | ||
|
r2854 | ** Copyright (C) 2016 The Qt Company Ltd. | ||
** Contact: https://www.qt.io/licensing/ | ||||
|
r1701 | ** | ||
|
r2854 | ** This file is part of the Qt Charts module of the Qt Toolkit. | ||
|
r1701 | ** | ||
|
r2854 | ** $QT_BEGIN_LICENSE:GPL$ | ||
|
r2845 | ** Commercial License Usage | ||
** Licensees holding valid commercial Qt licenses may use this file in | ||||
** accordance with the commercial license agreement provided with the | ||||
** Software or, alternatively, in accordance with the terms contained in | ||||
** a written agreement between you and The Qt Company. For licensing terms | ||||
|
r2854 | ** and conditions see https://www.qt.io/terms-conditions. For further | ||
** information use the contact form at https://www.qt.io/contact-us. | ||||
** | ||||
** GNU General Public License Usage | ||||
** Alternatively, this file may be used under the terms of the GNU | ||||
** General Public License version 3 or (at your option) any later version | ||||
** approved by the KDE Free Qt Foundation. The licenses are as published by | ||||
** the Free Software Foundation and appearing in the file LICENSE.GPL3 | ||||
** included in the packaging of this file. Please review the following | ||||
** information to ensure the GNU General Public License requirements will | ||||
** be met: https://www.gnu.org/licenses/gpl-3.0.html. | ||||
|
r1701 | ** | ||
|
r2845 | ** $QT_END_LICENSE$ | ||
** | ||||
|
r2854 | ****************************************************************************/ | ||
|
r1701 | |||
|
r2714 | #include <QtCharts/QCategoryAxis> | ||
#include <private/qcategoryaxis_p.h> | ||||
#include <private/chartcategoryaxisx_p.h> | ||||
#include <private/chartcategoryaxisy_p.h> | ||||
#include <private/polarchartcategoryaxisangular_p.h> | ||||
#include <private/polarchartcategoryaxisradial_p.h> | ||||
#include <QtCharts/QChart> | ||||
#include <QtCore/QtMath> | ||||
#include <QtCore/QDebug> | ||||
|
r1701 | |||
|
r2712 | QT_CHARTS_BEGIN_NAMESPACE | ||
|
r1701 | /*! | ||
|
r1816 | \class QCategoryAxis | ||
|
r2639 | \inmodule Qt Charts | ||
|
r1834 | \brief The QCategoryAxis class allows putting a named ranges on the axis. | ||
This class can be used when the underlying data needs to be given extra meaning. | ||||
Unlike with the QBarCategoryAxis the QCategoryAxis allows the categories ranges widths to be specified freely. | ||||
|
r1887 | |||
|
r2220 | Example code on how to use QCategoryAxis: | ||
|
r2750 | \image api_category_axis.png | ||
\code | ||||
QChartView *chartView = new QChartView; | ||||
QLineSeries *series = new QLineSeries; | ||||
// ... | ||||
chartView->chart()->addSeries(series); | ||||
|
r1887 | |||
|
r2750 | QCategoryAxis *axisY = new QCategoryAxis; | ||
axisY->setMin(0); | ||||
axisY->setMax(52); | ||||
axisY->setStartValue(15); | ||||
axisY->append("First", 20); | ||||
axisY->append("Second", 37); | ||||
axisY->append("Third", 52); | ||||
chartView->chart()->setAxisY(axisY, series); | ||||
\endcode | ||||
|
r1701 | */ | ||
|
r2639 | /*! | ||
\qmltype CategoryAxis | ||||
\instantiates QCategoryAxis | ||||
|
r2712 | \inqmlmodule QtCharts | ||
|
r2639 | |||
|
r2712 | \inherits AbstractAxis | ||
\brief CategoryAxis allows putting a named ranges on the axis. | ||||
|
r1870 | |||
|
r2712 | For example: | ||
|
r2750 | \image examples_qmlaxes3.png | ||
\snippet qmlaxes/qml/qmlaxes/View3.qml 1 | ||||
|
r1834 | */ | ||
/*! | ||||
\property QCategoryAxis::startValue | ||||
Defines the low end of the first category on the axis. | ||||
*/ | ||||
/*! | ||||
\qmlproperty int CategoryAxis::startValue | ||||
Defines the low end of the first category on the axis. | ||||
|
r1701 | */ | ||
|
r2249 | /*! | ||
\property QCategoryAxis::count | ||||
The count of categories. | ||||
*/ | ||||
/*! | ||||
\qmlproperty int CategoryAxis::count | ||||
The count of categories. | ||||
*/ | ||||
/*! | ||||
\property QCategoryAxis::categoriesLabels | ||||
The category labels as a string list. | ||||
*/ | ||||
/*! | ||||
\qmlproperty StringList CategoryAxis::categoriesLabels | ||||
The category labels as a list of strings. | ||||
*/ | ||||
|
r2483 | /*! | ||
\fn void QCategoryAxis::categoriesChanged() | ||||
Axis emits signal when the categories of the axis have changed. | ||||
*/ | ||||
|
r2780 | /*! | ||
\enum QCategoryAxis::AxisLabelsPosition | ||||
This enum describes the position of the category labels. | ||||
\value AxisLabelsPositionCenter Labels are centered to category. | ||||
\value AxisLabelsPositionOnValue Labels are positioned to the high end limit of the category. | ||||
*/ | ||||
/*! | ||||
\property QCategoryAxis::labelsPosition | ||||
Defines the position of the category labels. The labels in the beginning and in the end of the | ||||
axes may overlap other axes labels when positioned on value. | ||||
*/ | ||||
/*! | ||||
\qmlproperty AxisLabelsPosition CategoryAxis::labelsPosition | ||||
Defines the position of the category labels. The labels in the beginning and in the end of the | ||||
axes may overlap other axes labels when positioned on value. | ||||
*/ | ||||
|
r2483 | |||
|
r1701 | /*! | ||
Constructs an axis object which is a child of \a parent. | ||||
*/ | ||||
|
r1816 | QCategoryAxis::QCategoryAxis(QObject *parent): | ||
|
r2097 | QValueAxis(*new QCategoryAxisPrivate(this), parent) | ||
|
r1701 | { | ||
} | ||||
/*! | ||||
Destroys the object | ||||
*/ | ||||
|
r1816 | QCategoryAxis::~QCategoryAxis() | ||
|
r1701 | { | ||
|
r2273 | Q_D(QCategoryAxis); | ||
if (d->m_chart) | ||||
d->m_chart->removeAxis(this); | ||||
|
r1701 | } | ||
/*! | ||||
\internal | ||||
*/ | ||||
|
r2097 | QCategoryAxis::QCategoryAxis(QCategoryAxisPrivate &d, QObject *parent): QValueAxis(d, parent) | ||
|
r1701 | { | ||
} | ||||
|
r1870 | /*! | ||
\qmlmethod CategoryAxis::append(string label, real endValue) | ||||
Appends new category to the axis with an \a label. Category label has to be unique. | ||||
Parameter \a endValue specifies the high end limit of the category. | ||||
It has to be greater than the high end limit of the previous category. | ||||
Otherwise the method returns without adding a new category. | ||||
*/ | ||||
|
r1701 | /*! | ||
|
r1829 | Appends new category to the axis with an \a categoryLabel. | ||
Category label has to be unique. | ||||
|
r1849 | Parameter \a categoryEndValue specifies the high end limit of the category. | ||
|
r1829 | It has to be greater than the high end limit of the previous category. | ||
Otherwise the method returns without adding a new category. | ||||
|
r1701 | */ | ||
|
r2104 | void QCategoryAxis::append(const QString &categoryLabel, qreal categoryEndValue) | ||
|
r1701 | { | ||
|
r1816 | Q_D(QCategoryAxis); | ||
|
r1708 | |||
|
r2097 | if (!d->m_categories.contains(categoryLabel)) { | ||
if (d->m_categories.isEmpty()) { | ||||
|
r1849 | Range range(d->m_categoryMinimum, categoryEndValue); | ||
|
r1829 | d->m_categoriesMap.insert(categoryLabel, range); | ||
d->m_categories.append(categoryLabel); | ||||
|
r2483 | emit categoriesChanged(); | ||
|
r2097 | } else if (categoryEndValue > endValue(d->m_categories.last())) { | ||
|
r1829 | Range previousRange = d->m_categoriesMap.value(d->m_categories.last()); | ||
|
r1849 | d->m_categoriesMap.insert(categoryLabel, Range(previousRange.second, categoryEndValue)); | ||
|
r1829 | d->m_categories.append(categoryLabel); | ||
|
r2483 | emit categoriesChanged(); | ||
|
r1708 | } | ||
|
r1701 | } | ||
} | ||||
|
r1834 | /*! | ||
Sets \a min to be the low end limit of the first category on the axis. | ||||
|
r1847 | If there is already some categories added to the axis then passed value must be lower than the high end value of the already defined first category range. | ||
Otherwise nothing is done. | ||||
|
r1731 | */ | ||
|
r1829 | void QCategoryAxis::setStartValue(qreal min) | ||
|
r1701 | { | ||
|
r1816 | Q_D(QCategoryAxis); | ||
|
r2097 | if (d->m_categories.isEmpty()) { | ||
|
r1708 | d->m_categoryMinimum = min; | ||
|
r2483 | emit categoriesChanged(); | ||
|
r2097 | } else { | ||
|
r1829 | Range range = d->m_categoriesMap.value(d->m_categories.first()); | ||
|
r2483 | if (min < range.second) { | ||
|
r1847 | d->m_categoriesMap.insert(d->m_categories.first(), Range(min, range.second)); | ||
|
r2483 | emit categoriesChanged(); | ||
} | ||||
|
r1708 | } | ||
|
r1701 | } | ||
|
r1731 | /*! | ||
|
r1829 | Returns the low end limit of the category specified by an \a categoryLabel | ||
|
r1731 | */ | ||
|
r2104 | qreal QCategoryAxis::startValue(const QString &categoryLabel) const | ||
|
r1701 | { | ||
|
r1816 | Q_D(const QCategoryAxis); | ||
|
r1935 | if (categoryLabel.isEmpty()) | ||
|
r1847 | return d->m_categoryMinimum; | ||
|
r2097 | return d->m_categoriesMap.value(categoryLabel).first; | ||
|
r1701 | } | ||
|
r1731 | /*! | ||
|
r1829 | Returns the high end limit of the interval specified by an \a categoryLabel | ||
|
r1731 | */ | ||
|
r2104 | qreal QCategoryAxis::endValue(const QString &categoryLabel) const | ||
|
r1701 | { | ||
|
r1816 | Q_D(const QCategoryAxis); | ||
|
r1829 | return d->m_categoriesMap.value(categoryLabel).second; | ||
|
r1701 | } | ||
|
r1870 | /*! | ||
\qmlmethod CategoryAxis::remove(string label) | ||||
Removes a category specified by the \a label from the axis | ||||
*/ | ||||
|
r1701 | /*! | ||
|
r1829 | Removes an interval specified by the \a categoryLabel from the axis | ||
|
r1701 | */ | ||
|
r1829 | void QCategoryAxis::remove(const QString &categoryLabel) | ||
|
r1701 | { | ||
|
r1816 | Q_D(QCategoryAxis); | ||
|
r1829 | int labelIndex = d->m_categories.indexOf(categoryLabel); | ||
|
r1708 | |||
// check if such label exists | ||||
if (labelIndex != -1) { | ||||
|
r1829 | d->m_categories.removeAt(labelIndex); | ||
d->m_categoriesMap.remove(categoryLabel); | ||||
|
r1708 | |||
// the range of the interval that follows (if exists) needs to be updated | ||||
|
r1829 | if (labelIndex < d->m_categories.count()) { | ||
QString label = d->m_categories.at(labelIndex); | ||||
Range range = d->m_categoriesMap.value(label); | ||||
|
r1708 | |||
// set the range | ||||
if (labelIndex == 0) { | ||||
range.first = d->m_categoryMinimum; | ||||
|
r1829 | d->m_categoriesMap.insert(label, range); | ||
|
r1708 | } else { | ||
|
r1829 | range.first = d->m_categoriesMap.value(d->m_categories.at(labelIndex - 1)).second; | ||
d->m_categoriesMap.insert(label, range); | ||||
|
r1708 | } | ||
|
r2407 | } | ||
|
r2483 | emit categoriesChanged(); | ||
|
r1708 | } | ||
|
r1701 | } | ||
|
r1870 | /*! | ||
\qmlmethod CategoryAxis::replace(string oldLabel, string newLabel) | ||||
Replaces \a oldLabel of an existing category with a \a newLabel. | ||||
If the old label does not exist the method returns without making any changes. | ||||
*/ | ||||
|
r1800 | /*! | ||
|
r1829 | Replaces \a oldLabel of an existing category with a \a newLabel | ||
|
r1800 | If the old label does not exist the method returns without making any changes. | ||
*/ | ||||
|
r2104 | void QCategoryAxis::replaceLabel(const QString &oldLabel, const QString &newLabel) | ||
|
r1777 | { | ||
|
r1816 | Q_D(QCategoryAxis); | ||
|
r1829 | int labelIndex = d->m_categories.indexOf(oldLabel); | ||
|
r1777 | |||
// check if such label exists | ||||
if (labelIndex != -1) { | ||||
|
r1829 | d->m_categories.replace(labelIndex, newLabel); | ||
Range range = d->m_categoriesMap.value(oldLabel); | ||||
d->m_categoriesMap.remove(oldLabel); | ||||
|
r2407 | d->m_categoriesMap.insert(newLabel, range); | ||
|
r2483 | emit categoriesChanged(); | ||
|
r1777 | } | ||
} | ||||
|
r1800 | /*! | ||
Returns the list of the intervals labels | ||||
*/ | ||||
|
r1829 | QStringList QCategoryAxis::categoriesLabels() | ||
|
r1701 | { | ||
|
r1816 | Q_D(QCategoryAxis); | ||
|
r1829 | return d->m_categories; | ||
|
r1701 | } | ||
/*! | ||||
|
r1799 | Returns number of intervals. | ||
|
r1701 | */ | ||
|
r1816 | int QCategoryAxis::count() const | ||
|
r1701 | { | ||
|
r1816 | Q_D(const QCategoryAxis); | ||
|
r1829 | return d->m_categories.count(); | ||
|
r1701 | } | ||
/*! | ||||
Returns the type of the axis | ||||
*/ | ||||
|
r1816 | QAbstractAxis::AxisType QCategoryAxis::type() const | ||
|
r1701 | { | ||
|
r1818 | return QAbstractAxis::AxisTypeCategory; | ||
|
r1701 | } | ||
|
r2780 | void QCategoryAxis::setLabelsPosition(QCategoryAxis::AxisLabelsPosition position) | ||
{ | ||||
Q_D(QCategoryAxis); | ||||
if (d->m_labelsPosition != position) { | ||||
d->m_labelsPosition = position; | ||||
emit labelsPositionChanged(position); | ||||
} | ||||
} | ||||
QCategoryAxis::AxisLabelsPosition QCategoryAxis::labelsPosition() const | ||||
{ | ||||
Q_D(const QCategoryAxis); | ||||
return d->m_labelsPosition; | ||||
} | ||||
|
r1701 | ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// | ||
|
r2104 | QCategoryAxisPrivate::QCategoryAxisPrivate(QCategoryAxis *q) | ||
: QValueAxisPrivate(q), | ||||
|
r2780 | m_categoryMinimum(0), | ||
m_labelsPosition(QCategoryAxis::AxisLabelsPositionCenter) | ||||
|
r1701 | { | ||
} | ||||
|
r1816 | QCategoryAxisPrivate::~QCategoryAxisPrivate() | ||
|
r1701 | { | ||
} | ||||
|
r1816 | int QCategoryAxisPrivate::ticksCount() const | ||
|
r1701 | { | ||
|
r1829 | return m_categories.count() + 1; | ||
|
r1701 | } | ||
|
r2483 | void QCategoryAxisPrivate::initializeGraphics(QGraphicsItem *parent) | ||
|
r1701 | { | ||
|
r1816 | Q_Q(QCategoryAxis); | ||
|
r2483 | ChartAxisElement *axis(0); | ||
if (m_chart->chartType() == QChart::ChartTypeCartesian) { | ||||
if (orientation() == Qt::Vertical) | ||||
axis = new ChartCategoryAxisY(q,parent); | ||||
else if (orientation() == Qt::Horizontal) | ||||
axis = new ChartCategoryAxisX(q,parent); | ||||
} | ||||
if (m_chart->chartType() == QChart::ChartTypePolar) { | ||||
if (orientation() == Qt::Vertical) | ||||
axis = new PolarChartCategoryAxisRadial(q, parent); | ||||
if (orientation() == Qt::Horizontal) | ||||
axis = new PolarChartCategoryAxisAngular(q, parent); | ||||
} | ||||
|
r2273 | |||
m_item.reset(axis); | ||||
QAbstractAxisPrivate::initializeGraphics(parent); | ||||
|
r1701 | } | ||
|
r1817 | #include "moc_qcategoryaxis.cpp" | ||
#include "moc_qcategoryaxis_p.cpp" | ||||
|
r1701 | |||
|
r2712 | QT_CHARTS_END_NAMESPACE | ||