| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the Qt Charts module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:GPL$ |
| ** 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 |
| ** 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. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #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> |
| |
| QT_CHARTS_BEGIN_NAMESPACE |
| /*! |
| \class QCategoryAxis |
| \inmodule QtCharts |
| \brief The QCategoryAxis class places named ranges on the axis. |
| |
| This class can be used to explain the underlying data by adding labeled categories. |
| Unlike QBarCategoryAxis, QCategoryAxis allows the widths of the category ranges to |
| be specified freely. |
| |
| Example code on how to use QCategoryAxis: |
| \image api_category_axis.png |
| \code |
| QChartView *chartView = new QChartView; |
| QLineSeries *series = new QLineSeries; |
| // ... |
| chartView->chart()->addSeries(series); |
| |
| 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 |
| */ |
| /*! |
| \qmltype CategoryAxis |
| \instantiates QCategoryAxis |
| \inqmlmodule QtCharts |
| |
| \inherits AbstractAxis |
| \brief CategoryAxis places named ranges on the axis. |
| |
| This type can be used to explain the underlying data by adding labeled categories. |
| The widths of the category ranges can be specified freely. |
| |
| For example: |
| \image examples_qmlaxes3.png |
| \snippet qmlaxes/qml/qmlaxes/View3.qml 1 |
| */ |
| |
| /*! |
| \property QCategoryAxis::startValue |
| \brief The low end of the first category on the axis. |
| */ |
| /*! |
| \qmlproperty int CategoryAxis::startValue |
| The low end of the first category on the axis. |
| */ |
| |
| /*! |
| \property QCategoryAxis::count |
| \brief The number of categories. |
| */ |
| /*! |
| \qmlproperty int CategoryAxis::count |
| The number of categories. |
| */ |
| |
| /*! |
| \property QCategoryAxis::categoriesLabels |
| \brief The category labels as a string list. |
| */ |
| /*! |
| \qmlproperty StringList CategoryAxis::categoriesLabels |
| The category labels as a list of strings. |
| */ |
| |
| /*! |
| \fn void QCategoryAxis::categoriesChanged() |
| This signal is emitted when the categories of the axis change. |
| */ |
| |
| /*! |
| \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 |
| \brief 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 enumeration CategoryAxis::labelsPosition |
| |
| 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. |
| |
| \value CategoryAxis.AxisLabelsPositionCenter |
| Labels are centered to category. |
| \value CategoryAxis.AxisLabelsPositionOnValue |
| Labels are positioned to the high end limit of the category. |
| */ |
| |
| |
| /*! |
| Constructs an axis object that is a child of \a parent. |
| */ |
| QCategoryAxis::QCategoryAxis(QObject *parent): |
| QValueAxis(*new QCategoryAxisPrivate(this), parent) |
| { |
| } |
| |
| /*! |
| Destroys the object. |
| */ |
| QCategoryAxis::~QCategoryAxis() |
| { |
| Q_D(QCategoryAxis); |
| if (d->m_chart) |
| d->m_chart->removeAxis(this); |
| } |
| |
| /*! |
| \internal |
| */ |
| QCategoryAxis::QCategoryAxis(QCategoryAxisPrivate &d, QObject *parent): QValueAxis(d, parent) |
| { |
| |
| } |
| |
| /*! |
| \qmlmethod CategoryAxis::append(string label, real endValue) |
| Appends a new category to the axis with the label \a label. A category label has to be unique. |
| \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. |
| */ |
| /*! |
| Appends a new category to the axis with the label \a categoryLabel. |
| A category label has to be unique. |
| \a categoryEndValue 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. |
| */ |
| void QCategoryAxis::append(const QString &categoryLabel, qreal categoryEndValue) |
| { |
| Q_D(QCategoryAxis); |
| |
| if (!d->m_categories.contains(categoryLabel)) { |
| if (d->m_categories.isEmpty()) { |
| Range range(d->m_categoryMinimum, categoryEndValue); |
| d->m_categoriesMap.insert(categoryLabel, range); |
| d->m_categories.append(categoryLabel); |
| emit categoriesChanged(); |
| } else if (categoryEndValue > endValue(d->m_categories.last())) { |
| Range previousRange = d->m_categoriesMap.value(d->m_categories.last()); |
| d->m_categoriesMap.insert(categoryLabel, Range(previousRange.second, categoryEndValue)); |
| d->m_categories.append(categoryLabel); |
| emit categoriesChanged(); |
| } |
| } |
| } |
| |
| /*! |
| Sets \a min to be the low end limit of the first category on the axis. |
| If categories have already been added to the axis, the passed value must be less |
| than the high end value of the already defined first category range. |
| Otherwise nothing is done. |
| */ |
| void QCategoryAxis::setStartValue(qreal min) |
| { |
| Q_D(QCategoryAxis); |
| if (d->m_categories.isEmpty()) { |
| d->m_categoryMinimum = min; |
| emit categoriesChanged(); |
| } else { |
| Range range = d->m_categoriesMap.value(d->m_categories.first()); |
| if (min < range.second) { |
| d->m_categoriesMap.insert(d->m_categories.first(), Range(min, range.second)); |
| emit categoriesChanged(); |
| } |
| } |
| } |
| |
| /*! |
| Returns the low end limit of the category specified by \a categoryLabel. |
| */ |
| qreal QCategoryAxis::startValue(const QString &categoryLabel) const |
| { |
| Q_D(const QCategoryAxis); |
| if (categoryLabel.isEmpty()) |
| return d->m_categoryMinimum; |
| return d->m_categoriesMap.value(categoryLabel).first; |
| } |
| |
| /*! |
| Returns the high end limit of the category specified by \a categoryLabel. |
| */ |
| qreal QCategoryAxis::endValue(const QString &categoryLabel) const |
| { |
| Q_D(const QCategoryAxis); |
| return d->m_categoriesMap.value(categoryLabel).second; |
| } |
| |
| /*! |
| \qmlmethod CategoryAxis::remove(string label) |
| Removes a category specified by the label \a label from the axis. |
| */ |
| /*! |
| Removes a category specified by the label \a categoryLabel from the axis. |
| */ |
| void QCategoryAxis::remove(const QString &categoryLabel) |
| { |
| Q_D(QCategoryAxis); |
| int labelIndex = d->m_categories.indexOf(categoryLabel); |
| |
| // check if such label exists |
| if (labelIndex != -1) { |
| d->m_categories.removeAt(labelIndex); |
| d->m_categoriesMap.remove(categoryLabel); |
| |
| // the range of the interval that follows (if exists) needs to be updated |
| if (labelIndex < d->m_categories.count()) { |
| QString label = d->m_categories.at(labelIndex); |
| Range range = d->m_categoriesMap.value(label); |
| |
| // set the range |
| if (labelIndex == 0) { |
| range.first = d->m_categoryMinimum; |
| d->m_categoriesMap.insert(label, range); |
| } else { |
| range.first = d->m_categoriesMap.value(d->m_categories.at(labelIndex - 1)).second; |
| d->m_categoriesMap.insert(label, range); |
| } |
| } |
| emit categoriesChanged(); |
| } |
| } |
| |
| /*! |
| \qmlmethod CategoryAxis::replace(string oldLabel, string newLabel) |
| Replaces an existing category label specified by \a oldLabel with \a newLabel. |
| If the old label does not exist, the method returns without making any changes. |
| */ |
| /*! |
| Replaces an existing category label specified by \a oldLabel with \a newLabel. |
| If the old label does not exist, the method returns without making any changes. |
| */ |
| void QCategoryAxis::replaceLabel(const QString &oldLabel, const QString &newLabel) |
| { |
| Q_D(QCategoryAxis); |
| int labelIndex = d->m_categories.indexOf(oldLabel); |
| |
| // check if such label exists |
| if (labelIndex != -1) { |
| d->m_categories.replace(labelIndex, newLabel); |
| Range range = d->m_categoriesMap.value(oldLabel); |
| d->m_categoriesMap.remove(oldLabel); |
| d->m_categoriesMap.insert(newLabel, range); |
| emit categoriesChanged(); |
| } |
| } |
| |
| /*! |
| Returns the list of the categories' labels. |
| */ |
| QStringList QCategoryAxis::categoriesLabels() |
| { |
| Q_D(QCategoryAxis); |
| return d->m_categories; |
| } |
| |
| /*! |
| Returns the number of categories. |
| */ |
| int QCategoryAxis::count() const |
| { |
| Q_D(const QCategoryAxis); |
| return d->m_categories.count(); |
| } |
| |
| /*! |
| Returns the type of the axis. |
| */ |
| QAbstractAxis::AxisType QCategoryAxis::type() const |
| { |
| return QAbstractAxis::AxisTypeCategory; |
| } |
| |
| 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; |
| } |
| |
| ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
| |
| QCategoryAxisPrivate::QCategoryAxisPrivate(QCategoryAxis *q) |
| : QValueAxisPrivate(q), |
| m_categoryMinimum(0), |
| m_labelsPosition(QCategoryAxis::AxisLabelsPositionCenter) |
| { |
| |
| } |
| |
| QCategoryAxisPrivate::~QCategoryAxisPrivate() |
| { |
| |
| } |
| |
| int QCategoryAxisPrivate::ticksCount() const |
| { |
| return m_categories.count() + 1; |
| } |
| |
| void QCategoryAxisPrivate::initializeGraphics(QGraphicsItem *parent) |
| { |
| Q_Q(QCategoryAxis); |
| 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); |
| } |
| |
| m_item.reset(axis); |
| QAbstractAxisPrivate::initializeGraphics(parent); |
| } |
| |
| QT_CHARTS_END_NAMESPACE |
| |
| #include "moc_qcategoryaxis.cpp" |
| #include "moc_qcategoryaxis_p.cpp" |