qgslayoutitemchart.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemchart.h
                         -------------------
     begin                : August 2025
     copyright            : (C) 2025 by Mathieu
     email                : mathieu at opengis dot ch
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSLAYOUTITEMCHART_H
#define QGSLAYOUTITEMCHART_H
 
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include "qgslayoutitemmap.h"
#include "qgsplot.h"
#include "qgsvectorlayerplotdatagatherer.h"
#include "qgsvectorlayerref.h"
 
#include <QTimer>

class CORE_EXPORT QgsLayoutItemChart : public QgsLayoutItem
{
    Q_OBJECT
 
  public:
    class SeriesDetails
    {
      public:
        explicit SeriesDetails( const QString &name = QString() )
          : mName( name ) {};
 
        bool operator==( const SeriesDetails &other ) const
        {
          return mName == other.mName && mXExpression == other.mXExpression && mYExpression == other.mYExpression && mFilterExpression == other.mFilterExpression;
        }

        QString name() const { return mName; }

        void setName( const QString &name ) { mName = name; }

        QString xExpression() const { return mXExpression; }

        void setXExpression( const QString &xExpression ) { mXExpression = xExpression; }

        QString yExpression() const { return mYExpression; }

        void setYExpression( const QString &yExpression ) { mYExpression = yExpression; }

        QString filterExpression() const { return mFilterExpression; }

        void setFilterExpression( const QString &filterExpression ) { mFilterExpression = filterExpression; }
 
      private:
        QString mName;
        QString mXExpression;
        QString mYExpression;
        QString mFilterExpression;
    };

    QgsLayoutItemChart( QgsLayout *layout );
 
    int type() const override;
    QIcon icon() const override;

    void setPlot( QgsPlot *plot SIP_TRANSFER );

    QgsPlot *plot() { return mPlot.get(); }

    void setSourceLayer( QgsVectorLayer *layer );

    QgsVectorLayer *sourceLayer() const { return mVectorLayer.get(); }

    void setSortFeatures( bool sorted );

    bool sortFeatures() const { return mSortFeatures; }

    void setSortAscending( bool ascending );

    bool sortAscending() const { return mSortAscending; }

    void setSortExpression( const QString &expression );

    QString sortExpression() const { return mSortExpression; }

    void setSeriesList( const QList<QgsLayoutItemChart::SeriesDetails> &seriesList );

    QList<QgsLayoutItemChart::SeriesDetails> seriesList() const { return mSeriesList; }

    void setMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *map() const { return mMap; }

    void setFilterOnlyVisibleFeatures( bool visibleOnly );

    bool filterOnlyVisibleFeatures() const { return mFilterOnlyVisibleFeatures; }

    void setFilterToAtlasFeature( bool filterToAtlas );

    bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; }

    void setGenerateCategoriesFromRenderer( bool generateCategoriesFromRenderer );

    bool generateCategoriesFromRenderer() const { return mGenerateCategoriesFromRenderer; }

    void setApplyRendererStyle( bool applyRendererStyle );

    bool applyRendererStyle() const { return mApplyRendererStyle; }

    static QgsLayoutItemChart *create( QgsLayout *layout ) SIP_FACTORY;
 
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;
    void finalizeRestoreFromXml() override;
 
  public slots:
 
    void refresh() override;
 
  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private:
    void refreshData();
    void gatherData();
    void processData();
 
    void prepareGatherer();
 
    void createRendererSeriesDetails( QString &rendererXExpression, QStringList &rendererCategories );
    void applyRendererStyleToPlot( Qgs2DPlot *plot ) const;
 
    QgsLayoutItemChart() = delete;
    QgsLayoutItemChart( const QgsLayoutItemChart & ) = delete;
    QgsLayoutItemChart &operator=( const QgsLayoutItemChart & ) = delete;
 
    std::unique_ptr<Qgs2DPlot> mPlot;
    QgsPlotData mPlotData;
 
    QgsVectorLayerRef mVectorLayer = nullptr;
    bool mSortFeatures = false;
    bool mSortAscending = true;
    QString mSortExpression;
 
    QList<QgsLayoutItemChart::SeriesDetails> mSeriesList;
    bool mGenerateCategoriesFromRenderer = false;
    bool mApplyRendererStyle = true;
 
    QPointer< QgsLayoutItemMap > mMap = nullptr;
    QString mMapUuid;
 
    bool mFilterOnlyVisibleFeatures = false;
    bool mFilterToAtlasIntersection = false;
 
    bool mNeedsGathering = false;
    bool mIsGathering = false;
    QTimer mGathererTimer;
    QPointer<QgsVectorLayerAbstractPlotDataGatherer> mGatherer;
};
 
#endif // QGSLAYOUTITEMCHART_H