File indexing completed on 2024-10-06 03:40:52

 /*
  * SPDX-FileCopyrightText: 2019 Arjen Hiemstra <ahiemstra@heimr.nl>
  *
  * SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
  */
 
 #ifndef BARCHART_H
 #define BARCHART_H
 
 #include <qqmlregistration.h>
 
 #include "XYChart.h"
 
 struct Bar;
 
 /**
  * An item to render a bar chart.
  *
  * This chart renders
  *
  * ## Usage example
  *
  * \snippet snippets/barchart.qml example
  *
  * \image html barchart.png "The resulting bar chart."
  */
 class QUICKCHARTS_EXPORT BarChart : public XYChart
 {
     Q_OBJECT
     QML_ELEMENT
 
 public:
     /**
      * Helper enum to provide an easy way to set barWidth to auto.
      */
     enum WidthMode { AutoWidth = -2 };
     Q_ENUM(WidthMode)
 
     enum Orientation {
         HorizontalOrientation = Qt::Horizontal, ///< Bars are oriented horizontally, with low values left and high values right.
         VerticalOrientation = Qt::Vertical ///< Bars are oriented vertically, with low values at the bottom and high values at the top.
     };
     Q_ENUM(Orientation)
 
     explicit BarChart(QQuickItem *parent = nullptr);
 
     /**
      * The spacing between bars for each value source.
      *
      * Note that spacing between each X axis value is determined automatically
      * based on barWidth, spacing and total chart width. The default is 0.
      */
     Q_PROPERTY(qreal spacing READ spacing WRITE setSpacing NOTIFY spacingChanged)
     qreal spacing() const;
     void setSpacing(qreal newSpacing);
     Q_SIGNAL void spacingChanged();
 
     /**
      * The width of individual bars in the chart.
      *
      * If set to WidthMode::AutoWidth (also the default), the width will be
      * calculated automatically based on total chart width and item count.
      */
     Q_PROPERTY(qreal barWidth READ barWidth WRITE setBarWidth NOTIFY barWidthChanged)
     qreal barWidth() const;
     void setBarWidth(qreal newBarWidth);
     Q_SIGNAL void barWidthChanged();
 
     /**
      * The radius of the ends of bars in the chart in pixels.
      *
      * By default this is 0, which means no rounding will be done.
      */
     Q_PROPERTY(qreal radius READ radius WRITE setRadius NOTIFY radiusChanged)
     qreal radius() const;
     void setRadius(qreal newRadius);
     Q_SIGNAL void radiusChanged();
 
     /**
      * The orientation of bars in the chart.
      *
      * By default this is Vertical.
      */
     Q_PROPERTY(Orientation orientation READ orientation WRITE setOrientation NOTIFY orientationChanged)
     Orientation orientation() const;
     void setOrientation(Orientation newOrientation);
     Q_SIGNAL void orientationChanged();
 
     /**
      * The background color of bars in the chart.
      *
      * By default this is Qt::transparent. If set to something non-transparent,
      * the chart will render backgrounds for the bars. These backgrounds will
      * have the same width as the bars but stretch the full height.
      */
     Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY backgroundColorChanged)
     QColor backgroundColor() const;
     void setBackgroundColor(const QColor &newBackgroundColor);
     Q_SIGNAL void backgroundColorChanged();
 
 protected:
     /**
      * Reimplemented from QQuickItem.
      */
     QSGNode *updatePaintNode(QSGNode *node, QQuickItem::UpdatePaintNodeData *) override;
     /**
      * Reimplemented from Chart.
      */
     void onDataChanged() override;
 
 private:
     QList<Bar> calculateBars();
 
     qreal m_spacing = 0.0;
     qreal m_barWidth = AutoWidth;
     qreal m_radius = 0.0;
     Orientation m_orientation = VerticalOrientation;
     bool m_orientationChanged = false;
     struct BarData {
         qreal value = 0;
         QColor color;
     };
     QList<QList<BarData>> m_barDataItems;
     QColor m_backgroundColor = Qt::transparent;
 };
 
 #endif // BARCHART_H