qgsgraduatedsymbolrenderer.h

Go to the documentation of this file.

/***************************************************************************
    qgsgraduatedsymbolrenderer.h
    ---------------------
    begin                : November 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSGRADUATEDSYMBOLRENDERER_H
#define QGSGRADUATEDSYMBOLRENDERER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsclassificationmethod.h"
#include "qgsrenderer.h"
#include "qgsrendererrange.h"
 
class QgsVectorLayer;
class QgsColorRamp;
class QgsDataDefinedSizeLegend;
class QgsSymbol;
class QgsExpression;

class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer
{
  public:
    QgsGraduatedSymbolRenderer( const QString &attrName = QString(), const QgsRangeList &ranges = QgsRangeList() );
 
    ~QgsGraduatedSymbolRenderer() override;
 
    Qgis::FeatureRendererFlags flags() const override;
    QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
    void stopRender( QgsRenderContext &context ) override;
    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
    bool filterNeedsGeometry() const override;
    QString dump() const override;
    QgsGraduatedSymbolRenderer *clone() const override SIP_FACTORY;
    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override SIP_DEPRECATED;
    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;
    QgsFeatureRenderer::Capabilities capabilities() override { return SymbolLevels | Filter; }
    QgsSymbolList symbols( QgsRenderContext &context ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    QString classAttribute() const { return mAttrName; }

    void setClassAttribute( const QString &attr ) { mAttrName = attr; }

    const QgsRangeList &ranges() const { return mRanges; }
 
    bool updateRangeSymbol( int rangeIndex, QgsSymbol *symbol SIP_TRANSFER );
    bool updateRangeLabel( int rangeIndex, const QString &label );
    bool updateRangeUpperValue( int rangeIndex, double value );
    bool updateRangeLowerValue( int rangeIndex, double value );
    bool updateRangeRenderState( int rangeIndex, bool render );

    void addClass( QgsSymbol *symbol );

    void addClass( const QgsRendererRange &range ) SIP_PYNAME( addClassRange );

    void addClass( double lower, double upper ) SIP_PYNAME( addClassLowerUpper );

    void addBreak( double breakValue, bool updateSymbols = true );
 
    void deleteClass( int idx );
    void deleteAllClasses();

    void moveClass( int from, int to );

    bool rangesOverlap() const;

    bool rangesHaveGaps() const;
 
    void sortByValue( Qt::SortOrder order = Qt::AscendingOrder );
    void sortByLabel( Qt::SortOrder order = Qt::AscendingOrder );

    QgsClassificationMethod *classificationMethod() const;

    void setClassificationMethod( QgsClassificationMethod *method SIP_TRANSFER );

    enum Mode
    {
      EqualInterval,
      Quantile,
      Jenks,
      StdDev,
      Pretty,
      Custom
    };
    // TODO QGIS 5: remove
    // this could not be tagged with Q_DECL_DEPRECATED due to Doxygen warning
    // might be fixed in newer Doxygen (does not on 1.8.13, might be ok on 1.8.16)
 

    Q_DECL_DEPRECATED Mode mode() const SIP_DEPRECATED { return modeFromMethodId( mClassificationMethod->id() ); }
    Q_DECL_DEPRECATED void setMode( Mode mode ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED bool useSymmetricMode() const SIP_DEPRECATED { return mClassificationMethod->symmetricModeEnabled(); }

    Q_DECL_DEPRECATED void setUseSymmetricMode( bool useSymmetricMode ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double symmetryPoint() const SIP_DEPRECATED { return mClassificationMethod->symmetryPoint(); }

    Q_DECL_DEPRECATED void setSymmetryPoint( double symmetryPoint ) SIP_DEPRECATED;
 

    Q_DECL_DEPRECATED bool astride() const SIP_DEPRECATED { return mClassificationMethod->symmetryAstride(); }

    Q_DECL_DEPRECATED void setAstride( bool astride ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static void makeBreaksSymmetric( QList<double> &breaks SIP_INOUT, double symmetryPoint, bool astride ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static QList<double> calcEqualIntervalBreaks( double minimum, double maximum, int classes, bool useSymmetricMode, double symmetryPoint, bool astride ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses, bool useSymmetricMode = false, double symmetryPoint = 0.0, bool astride = false ) SIP_DEPRECATED;

    void updateClasses( const QgsVectorLayer *vl, int nclasses, QString &error SIP_OUT );
 
    Q_NOWARN_DEPRECATED_PUSH;

    Q_DECL_DEPRECATED QgsRendererRangeLabelFormat labelFormat() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ) SIP_DEPRECATED;
 
    Q_NOWARN_DEPRECATED_POP;

    void calculateLabelPrecision( bool updateRanges = true );
 
    Q_NOWARN_DEPRECATED_PUSH;

    Q_DECL_DEPRECATED static QgsGraduatedSymbolRenderer *createRenderer(
      QgsVectorLayer *vlayer,
      const QString &attrName,
      int classes,
      Mode mode,
      QgsSymbol *symbol SIP_TRANSFER,
      QgsColorRamp *ramp SIP_TRANSFER,
      const QgsRendererRangeLabelFormat &legendFormat = QgsRendererRangeLabelFormat(),
      bool useSymmetricMode = false,
      double symmetryPoint = 0.0,
      const QStringList &listForCboPrettyBreaks = QStringList(),
      bool astride = false
    ) SIP_DEPRECATED;
    Q_NOWARN_DEPRECATED_POP;

    static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
 
    QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
    QgsLegendSymbolList legendSymbolItems() const override;
    QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;

    QgsSymbol *sourceSymbol();

    const QgsSymbol *sourceSymbol() const SIP_SKIP;

    void setSourceSymbol( QgsSymbol *sym SIP_TRANSFER );

    QgsColorRamp *sourceColorRamp();

    const QgsColorRamp *sourceColorRamp() const SIP_SKIP;

    void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );

    void updateColorRamp( QgsColorRamp *ramp SIP_TRANSFER = nullptr );

    void updateSymbols( QgsSymbol *sym );

    void setSymbolSizes( double minSize, double maxSize );

    double minSymbolSize() const;

    double maxSymbolSize() const;

    Qgis::GraduatedMethod graduatedMethod() const { return mGraduatedMethod; }

    void setGraduatedMethod( Qgis::GraduatedMethod method ) { mGraduatedMethod = method; }
 
    bool legendSymbolItemsCheckable() const override;
    bool legendSymbolItemChecked( const QString &key ) override;
    void checkLegendSymbolItem( const QString &key, bool state = true ) override;
    void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
    QString legendClassificationAttribute() const override { return classAttribute(); }

    static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;

    void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );

    QgsDataDefinedSizeLegend *dataDefinedSizeLegend() const;

    void updateRangeLabels();

    const QgsRendererRange *rangeForValue( double value ) const;
 
  protected:
    QString mAttrName;
    QgsRangeList mRanges;
    std::unique_ptr<QgsSymbol> mSourceSymbol;
    std::unique_ptr<QgsColorRamp> mSourceColorRamp;
 
    std::unique_ptr<QgsExpression> mExpression;
    Qgis::GraduatedMethod mGraduatedMethod = Qgis::GraduatedMethod::Color;
 
    int mAttrNum = -1;
    bool mCounting = false;
 
    std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;

    QgsSymbol *symbolForValue( double value ) const;

    QString legendKeyForValue( double value ) const;

    static QString graduatedMethodStr( Qgis::GraduatedMethod method ) SIP_SKIP;
 
    std::shared_ptr<QgsClassificationMethod> mClassificationMethod;
 
  private:
    QVariant valueForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;

    QgsLegendSymbolList baseLegendSymbolItems() const;
 
    // TODO QGIS 5: remove
    Q_NOWARN_DEPRECATED_PUSH
    static QString methodIdFromMode( QgsGraduatedSymbolRenderer::Mode mode );
    static QgsGraduatedSymbolRenderer::Mode modeFromMethodId( const QString &methodId );
    Q_NOWARN_DEPRECATED_POP
 
#ifdef SIP_RUN
    QgsGraduatedSymbolRenderer( const QgsGraduatedSymbolRenderer & );
    QgsGraduatedSymbolRenderer &operator=( const QgsGraduatedSymbolRenderer & );
#endif
 
    friend class TestQgsGraduatedSymbolRenderer;
};
 
#endif // QGSGRADUATEDSYMBOLRENDERER_H