QGIS API Documentation 3.39.0-Master (bca3cdb6021)
Loading...
Searching...
No Matches
qgsgraduatedsymbolrenderer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsgraduatedsymbolrenderer.h
3 ---------------------
4 begin : November 2009
5 copyright : (C) 2009 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSGRADUATEDSYMBOLRENDERER_H
16#define QGSGRADUATEDSYMBOLRENDERER_H
17
18#include "qgis_core.h"
19#include "qgis_sip.h"
20#include "qgis.h"
21#include "qgsrenderer.h"
22#include "qgsrendererrange.h"
24
25class QgsVectorLayer;
26class QgsColorRamp;
28class QgsSymbol;
29class QgsExpression;
30
37{
38 public:
39
40 QgsGraduatedSymbolRenderer( const QString &attrName = QString(), const QgsRangeList &ranges = QgsRangeList() );
41
43
44 Qgis::FeatureRendererFlags flags() const override;
45 QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
46 QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
47 void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
48 void stopRender( QgsRenderContext &context ) override;
49 QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
50 bool filterNeedsGeometry() const override;
51 QString dump() const override;
53 void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override;
54 QgsFeatureRenderer::Capabilities capabilities() override { return SymbolLevels | Filter; }
55 QgsSymbolList symbols( QgsRenderContext &context ) const override;
56 bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
57
63 QString classAttribute() const { return mAttrName; }
64
70 void setClassAttribute( const QString &attr ) { mAttrName = attr; }
71
75 const QgsRangeList &ranges() const { return mRanges; }
76
77 bool updateRangeSymbol( int rangeIndex, QgsSymbol *symbol SIP_TRANSFER );
78 bool updateRangeLabel( int rangeIndex, const QString &label );
79 bool updateRangeUpperValue( int rangeIndex, double value );
80 bool updateRangeLowerValue( int rangeIndex, double value );
81 bool updateRangeRenderState( int rangeIndex, bool render );
82
83 void addClass( QgsSymbol *symbol );
85 void addClass( const QgsRendererRange &range ) SIP_PYNAME( addClassRange );
87 void addClass( double lower, double upper ) SIP_PYNAME( addClassLowerUpper );
88
96 void addBreak( double breakValue, bool updateSymbols = true );
97
98 void deleteClass( int idx );
99 void deleteAllClasses();
100
102 void moveClass( int from, int to );
103
108 bool rangesOverlap() const;
109
114 bool rangesHaveGaps() const;
115
116 void sortByValue( Qt::SortOrder order = Qt::AscendingOrder );
117 void sortByLabel( Qt::SortOrder order = Qt::AscendingOrder );
118
123 QgsClassificationMethod *classificationMethod() const;
124
130 void setClassificationMethod( QgsClassificationMethod *method SIP_TRANSFER );
131
145 // TODO QGIS 4: remove
146 // this could not be tagged with Q_DECL_DEPRECATED due to Doxygen warning
147 // might be fixed in newer Doxygen (does not on 1.8.13, might be ok on 1.8.16)
148
149
151 Q_DECL_DEPRECATED Mode mode() const SIP_DEPRECATED { return modeFromMethodId( mClassificationMethod->id() ); }
153 Q_DECL_DEPRECATED void setMode( Mode mode ) SIP_DEPRECATED;
154
160 Q_DECL_DEPRECATED bool useSymmetricMode() const SIP_DEPRECATED { return mClassificationMethod->symmetricModeEnabled(); }
161
167 Q_DECL_DEPRECATED void setUseSymmetricMode( bool useSymmetricMode ) SIP_DEPRECATED;
168
174 Q_DECL_DEPRECATED double symmetryPoint() const SIP_DEPRECATED { return mClassificationMethod->symmetryPoint(); }
175
181 Q_DECL_DEPRECATED void setSymmetryPoint( double symmetryPoint ) SIP_DEPRECATED;
182
183
189 Q_DECL_DEPRECATED bool astride() const SIP_DEPRECATED { return mClassificationMethod->symmetryAstride(); }
190
196 Q_DECL_DEPRECATED void setAstride( bool astride ) SIP_DEPRECATED;
197
207 Q_DECL_DEPRECATED static void makeBreaksSymmetric( QList<double> &breaks SIP_INOUT, double symmetryPoint, bool astride ) SIP_DEPRECATED;
208
219 Q_DECL_DEPRECATED static QList<double> calcEqualIntervalBreaks( double minimum, double maximum, int classes, bool useSymmetricMode, double symmetryPoint, bool astride ) SIP_DEPRECATED;
220
231 Q_DECL_DEPRECATED void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses, bool useSymmetricMode = false, double symmetryPoint = 0.0, bool astride = false ) SIP_DEPRECATED;
232
239 void updateClasses( const QgsVectorLayer *vl, int nclasses, QString &error SIP_OUT );
240
242
247 Q_DECL_DEPRECATED QgsRendererRangeLabelFormat labelFormat() const SIP_DEPRECATED;
248
255 Q_DECL_DEPRECATED void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ) SIP_DEPRECATED;
256
258
263 void calculateLabelPrecision( bool updateRanges = true );
264
266
283 Q_DECL_DEPRECATED static QgsGraduatedSymbolRenderer *createRenderer( QgsVectorLayer *vlayer,
284 const QString &attrName,
285 int classes,
286 Mode mode,
287 QgsSymbol *symbol SIP_TRANSFER,
290 bool useSymmetricMode = false,
291 double symmetryPoint = 0.0,
292 const QStringList &listForCboPrettyBreaks = QStringList(),
293 bool astride = false ) SIP_DEPRECATED;
295
297 static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
298
299 QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
300 QgsLegendSymbolList legendSymbolItems() const override;
301 QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
302 QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;
303
310 QgsSymbol *sourceSymbol();
311
319 const QgsSymbol *sourceSymbol() const SIP_SKIP;
320
328 void setSourceSymbol( QgsSymbol *sym SIP_TRANSFER );
329
335 QgsColorRamp *sourceColorRamp();
336
343 const QgsColorRamp *sourceColorRamp() const SIP_SKIP;
344
349 void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );
350
356 void updateColorRamp( QgsColorRamp *ramp SIP_TRANSFER = nullptr );
357
364 void updateSymbols( QgsSymbol *sym );
365
370 void setSymbolSizes( double minSize, double maxSize );
371
375 double minSymbolSize() const;
376
380 double maxSymbolSize() const;
381
387 Qgis::GraduatedMethod graduatedMethod() const { return mGraduatedMethod; }
388
394 void setGraduatedMethod( Qgis::GraduatedMethod method ) { mGraduatedMethod = method; }
395
396 bool legendSymbolItemsCheckable() const override;
397 bool legendSymbolItemChecked( const QString &key ) override;
398 void checkLegendSymbolItem( const QString &key, bool state = true ) override;
399 void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
400 QString legendClassificationAttribute() const override { return classAttribute(); }
401
406 static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
407
417 void setDataDefinedSizeLegend( QgsDataDefinedSizeLegend *settings SIP_TRANSFER );
418
423 QgsDataDefinedSizeLegend *dataDefinedSizeLegend() const;
424
429 void updateRangeLabels();
430
437 const QgsRendererRange *rangeForValue( double value ) const;
438
439 protected:
440 QString mAttrName;
442 std::unique_ptr<QgsSymbol> mSourceSymbol;
443 std::unique_ptr<QgsColorRamp> mSourceColorRamp;
444
445 std::unique_ptr<QgsExpression> mExpression;
448
449 int mAttrNum = -1;
450 bool mCounting = false;
451
452 std::unique_ptr<QgsDataDefinedSizeLegend> mDataDefinedSizeLegend;
453
457 QgsSymbol *symbolForValue( double value ) const;
458
462 QString legendKeyForValue( double value ) const;
463
465 static QString graduatedMethodStr( Qgis::GraduatedMethod method ) SIP_SKIP;
466
467 std::shared_ptr<QgsClassificationMethod> mClassificationMethod;
468
469 private:
470
474 QVariant valueForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
475
477 QgsLegendSymbolList baseLegendSymbolItems() const;
478
479 // TODO QGIS 4: remove
481 static QString methodIdFromMode( QgsGraduatedSymbolRenderer::Mode mode );
482 static QgsGraduatedSymbolRenderer::Mode modeFromMethodId( const QString &methodId );
484
485#ifdef SIP_RUN
488#endif
489
490 friend class TestQgsGraduatedSymbolRenderer;
491
492};
493
494#endif // QGSGRADUATEDSYMBOLRENDERER_H
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
Definition qgis.h:772
GraduatedMethod
Methods for modifying symbols by range in a graduated symbol renderer.
Definition qgis.h:3074
@ Color
Alter color of symbols.
QgsClassificationMethod is an abstract class for implementations of classification methods.
Abstract base class for color ramps.
Object that keeps configuration of appearance of marker symbol's data-defined size in legend.
Class for parsing and evaluation of expressions (formerly called "search strings").
Abstract base class for all 2D vector feature renderers.
virtual bool legendSymbolItemsCheckable() const
Returns true if symbology items in legend are checkable.
virtual bool legendSymbolItemChecked(const QString &key)
Returns true if the legend symbology item with the specified key is checked.
virtual void setLegendSymbolItem(const QString &key, QgsSymbol *symbol)
Sets the symbol to be used for a legend symbol item.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
virtual Qgis::FeatureRendererFlags flags() const
Returns flags associated with the renderer.
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
QFlags< Capability > Capabilities
virtual void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QString dump() const
Returns debug information about this renderer.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const =0
Returns a list of attributes required by this renderer.
virtual QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const =0
To be overridden.
virtual void checkLegendSymbolItem(const QString &key, bool state=true)
Sets whether the legend symbology item with the specified ley should be checked.
@ Filter
Features may be filtered, i.e. some features may not be rendered (categorized, rule based ....
virtual bool filterNeedsGeometry() const
Returns true if this renderer requires the geometry to apply the filter.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
virtual QgsSymbol * originalSymbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns symbol for feature.
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
A vector feature renderer which uses numeric attributes to classify features into different ranges.
QString legendClassificationAttribute() const override
If supported by the renderer, return classification attribute for the use in legend.
std::unique_ptr< QgsDataDefinedSizeLegend > mDataDefinedSizeLegend
Q_DECL_DEPRECATED bool useSymmetricMode() const
Returns if we want to classify symmetric around a given value.
std::unique_ptr< QgsSymbol > mSourceSymbol
void setGraduatedMethod(Qgis::GraduatedMethod method)
Set the method used for graduation (either size or color).
std::shared_ptr< QgsClassificationMethod > mClassificationMethod
Q_DECL_DEPRECATED bool astride() const
Returns if we want to have a central class astride the pivot value.
QgsFeatureRenderer::Capabilities capabilities() override
Returns details about internals of this renderer.
QString classAttribute() const
Returns the attribute name (or expression) used for the classification.
std::unique_ptr< QgsColorRamp > mSourceColorRamp
Q_DECL_DEPRECATED Mode mode() const
void setClassAttribute(const QString &attr)
Sets the attribute name (or expression) used for the classification.
std::unique_ptr< QgsExpression > mExpression
const QgsRangeList & ranges() const
Returns a list of all ranges used in the classification.
Q_DECL_DEPRECATED double symmetryPoint() const
Returns the pivot value for symmetric classification.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
An interface for classes which can visit style entity (e.g.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
Represents a vector layer which manages a vector based data sets.
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:6460
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6459
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_PYNAME(name)
Definition qgis_sip.h:81
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_INOUT
Definition qgis_sip.h:71
QList< QgsLegendSymbolItem > QgsLegendSymbolList
QList< QgsSymbol * > QgsSymbolList
Definition qgsrenderer.h:47
QList< QgsRendererRange > QgsRangeList