QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
A renderer that automatically displaces points with the same position. More...
#include <qgspointdisplacementrenderer.h>
Public Types | |
enum | Placement { Ring, ConcentricRings } |
Placement methods for dispersing points. More... | |
Public Types inherited from QgsFeatureRendererV2 | |
enum | Capabilities { SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 } |
Public Member Functions | |
QgsPointDisplacementRenderer (const QString &labelAttributeName="") | |
~QgsPointDisplacementRenderer () | |
virtual int | capabilities () override |
Proxy that will call this method on the embedded renderer. More... | |
QgsMarkerSymbolV2 * | centerSymbol () |
Returns the symbol for the center of a displacement group (but not ownership of the symbol) More... | |
virtual void | checkLegendSymbolItem (const QString &key, bool state=true) override |
item in symbology was checked More... | |
QColor | circleColor () const |
double | circleRadiusAddition () const |
double | circleWidth () const |
QgsPointDisplacementRenderer * | clone () const override |
const QgsFeatureRendererV2 * | embeddedRenderer () const override |
Returns the current embedded renderer (subrenderer) for this feature renderer. More... | |
QString | labelAttributeName () const |
QColor | labelColor () const |
QFont | labelFont () const |
virtual QSet< QString > | legendKeysForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Returns which legend keys match the feature. More... | |
virtual bool | legendSymbolItemChecked (const QString &key) override |
items of symbology items in legend is checked More... | |
QgsLegendSymbolList | legendSymbolItems (double scaleDenominator=-1, const QString &rule="") override |
virtual bool | legendSymbolItemsCheckable () const override |
items of symbology items in legend should be checkable More... | |
QgsLegendSymbologyList | legendSymbologyItems (QSize iconSize) override |
return a list of symbology items for the legend More... | |
double | maxLabelScaleDenominator () const |
virtual QgsSymbolV2 * | originalSymbolForFeature (QgsFeature &feat, QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
virtual QgsSymbolV2List | originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
Placement | placement () const |
Returns the placement method used for dispersing the points. More... | |
bool | renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override |
Reimplemented from QgsFeatureRendererV2. More... | |
QDomElement | save (QDomDocument &doc) override |
store renderer info to XML element More... | |
void | setCenterSymbol (QgsMarkerSymbolV2 *symbol) |
Sets the center symbol (takes ownership) More... | |
void | setCircleColor (const QColor &c) |
void | setCircleRadiusAddition (double d) |
void | setCircleWidth (double w) |
Q_DECL_DEPRECATED void | setDisplacementGroups (const QList< QMap< QgsFeatureId, QgsFeature > > &list) |
not available in python bindings More... | |
void | setEmbeddedRenderer (QgsFeatureRendererV2 *r) override |
Sets an embedded renderer (subrenderer) for this feature renderer. More... | |
void | setLabelAttributeName (const QString &name) |
void | setLabelColor (const QColor &c) |
void | setLabelFont (const QFont &f) |
virtual void | setLegendSymbolItem (const QString &key, QgsSymbolV2 *symbol) override |
Sets the symbol to be used for a legend symbol item. More... | |
void | setMaxLabelScaleDenominator (double d) |
void | setPlacement (Placement placement) |
Sets the placement method used for dispersing the points. More... | |
void | setTolerance (double t) |
Sets the tolerance distance for grouping points. More... | |
void | setToleranceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale object for the distance tolerance. More... | |
void | setToleranceUnit (QgsSymbolV2::OutputUnit unit) |
Sets the units for the tolerance distance. More... | |
virtual void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
Needs to be called when a new render cycle is started. More... | |
void | stopRender (QgsRenderContext &context) override |
Needs to be called when a render cycle has finished to clean up. More... | |
virtual QgsSymbolV2 * | symbolForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
virtual QgsSymbolV2List | symbols (QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
virtual QgsSymbolV2List | symbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
double | tolerance () const |
Returns the tolerance distance for grouping points. More... | |
const QgsMapUnitScale & | toleranceMapUnitScale () const |
Returns the map unit scale object for the distance tolerance. More... | |
QgsSymbolV2::OutputUnit | toleranceUnit () const |
Returns the units for the tolerance distance. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element) const override |
Writes the SLD element following the SLD v1.1 specs. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Writes the SLD element following the SLD v1.1 specs. More... | |
virtual QList< QString > | usedAttributes () override |
Partial proxy that will call this method on the embedded renderer. More... | |
virtual bool | willRenderFeature (QgsFeature &feat, QgsRenderContext &context) override |
Proxy that will call this method on the embedded renderer. More... | |
Public Member Functions inherited from QgsFeatureRendererV2 | |
virtual | ~QgsFeatureRendererV2 () |
virtual QString | dump () const |
for debugging More... | |
virtual QString | filter (const QgsFields &fields=QgsFields()) |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More... | |
virtual bool | filterNeedsGeometry () const |
Returns true if this renderer requires the geometry to apply the filter. More... | |
bool | forceRasterRender () const |
Returns whether the renderer must render as a raster. More... | |
virtual QString | legendClassificationAttribute () const |
If supported by the renderer, return classification attribute for the use in legend. More... | |
virtual QgsLegendSymbolListV2 | legendSymbolItemsV2 () const |
Return a list of symbology items for the legend. More... | |
virtual void | modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context) |
Allows for a renderer to modify the extent of a feature request prior to rendering. More... | |
QgsFeatureRequest::OrderBy | orderBy () const |
Get the order in which features shall be processed by this renderer. More... | |
bool | orderByEnabled () const |
Returns whether custom ordering will be applied before features are processed by this renderer. More... | |
virtual Q_DECL_DEPRECATED QgsSymbolV2 * | originalSymbolForFeature (QgsFeature &feature) |
Return symbol for feature. More... | |
virtual Q_DECL_DEPRECATED QgsSymbolV2List | originalSymbolsForFeature (QgsFeature &feat) |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the renderer. More... | |
virtual Q_DECL_DEPRECATED QString | rotationField () const |
return rotation field name (or empty string if not set or not supported by renderer) More... | |
void | setForceRasterRender (bool forceRaster) |
Sets whether the renderer should be rendered to a raster destination. More... | |
void | setOrderBy (const QgsFeatureRequest::OrderBy &orderBy) |
Define the order in which features shall be processed by this renderer. More... | |
void | setOrderByEnabled (bool enabled) |
Sets whether custom ordering should be applied before features are processed by this renderer. More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the renderer. More... | |
virtual Q_DECL_DEPRECATED void | setRotationField (const QString &fieldName) |
sets rotation field of renderer (if supported by the renderer) More... | |
void | setUsingSymbolLevels (bool usingSymbolLevels) |
void | setVertexMarkerAppearance (int type, int size) |
set type and size of editing vertex markers for subsequent rendering More... | |
virtual Q_DECL_DEPRECATED void | startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer) |
virtual Q_DECL_DEPRECATED QgsSymbolV2 * | symbolForFeature (QgsFeature &feature) |
To be overridden. More... | |
virtual Q_DECL_DEPRECATED QgsSymbolV2List | symbols () |
For symbol levels. More... | |
virtual Q_DECL_DEPRECATED QgsSymbolV2List | symbolsForFeature (QgsFeature &feat) |
Returns list of symbols used for rendering the feature. More... | |
QString | type () const |
bool | usingSymbolLevels () const |
virtual Q_DECL_DEPRECATED bool | willRenderFeature (QgsFeature &feat) |
Returns whether the renderer will render a feature or not. More... | |
virtual Q_DECL_DEPRECATED QDomElement | writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const |
create the SLD UserStyle element following the SLD v1.1 specs More... | |
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName) const |
create the SLD UserStyle element following the SLD v1.1 specs with the given name More... | |
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props) const |
create the SLD UserStyle element following the SLD v1.1 specs with the given name More... | |
Static Public Member Functions | |
static QgsPointDisplacementRenderer * | convertFromRenderer (const QgsFeatureRendererV2 *renderer) |
creates a QgsPointDisplacementRenderer from an existing renderer. More... | |
static QgsFeatureRendererV2 * | create (QDomElement &symbologyElem) |
create a renderer from XML element More... | |
Static Public Member Functions inherited from QgsFeatureRendererV2 | |
static QgsFeatureRendererV2 * | defaultRenderer (QGis::GeometryType geomType) |
return a new renderer - used by default in vector layers More... | |
static QgsFeatureRendererV2 * | load (QDomElement &symbologyElem) |
create a renderer from XML element More... | |
static QgsFeatureRendererV2 * | loadSld (const QDomNode &node, QGis::GeometryType geomType, QString &errorMessage) |
Create a new renderer according to the information contained in the UserStyle element of a SLD style document. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from QgsFeatureRendererV2 | |
QgsFeatureRendererV2 (const QString &type) | |
Q_DECL_DEPRECATED void | copyPaintEffect (QgsFeatureRendererV2 *destRenderer) const |
Copies paint effect of this renderer to another renderer. More... | |
void | copyRendererData (QgsFeatureRendererV2 *destRenderer) const |
Clones generic renderer data to another renderer. More... | |
void | renderFeatureWithSymbol (QgsFeature &feature, QgsSymbolV2 *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker) |
void | renderVertexMarker (QPointF pt, QgsRenderContext &context) |
render editing vertex marker at specified point More... | |
void | renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context) |
render editing vertex marker for a polygon More... | |
void | renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context) |
render editing vertex marker for a polyline More... | |
void | setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod) |
Static Protected Member Functions inherited from QgsFeatureRendererV2 | |
static QgsConstWkbPtr | _getLineString (QPolygonF &pts, QgsRenderContext &context, QgsConstWkbPtr &wkb, bool clipToExtent=true) |
Creates a line string in screen coordinates from a wkb string in map coordinates. More... | |
static QgsConstWkbPtr | _getPoint (QPointF &pt, QgsRenderContext &context, QgsConstWkbPtr &wkb) |
Creates a point in screen coordinates from a wkb string in map coordinates. More... | |
static QgsConstWkbPtr | _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, QgsConstWkbPtr &wkb, bool clipToExtent=true) |
Creates a polygon in screen coordinates from a wkb string in map coordinates. More... | |
static void | convertSymbolRotation (QgsSymbolV2 *symbol, const QString &field) |
static void | convertSymbolSizeScale (QgsSymbolV2 *symbol, QgsSymbolV2::ScaleMethod method, const QString &field) |
Protected Attributes inherited from QgsFeatureRendererV2 | |
int | mCurrentVertexMarkerSize |
The current size of editing marker. More... | |
int | mCurrentVertexMarkerType |
The current type of editing marker. More... | |
bool | mForceRaster |
QgsFeatureRequest::OrderBy | mOrderBy |
bool | mOrderByEnabled |
QgsPaintEffect * | mPaintEffect |
QString | mType |
bool | mUsingSymbolLevels |
A renderer that automatically displaces points with the same position.
Definition at line 33 of file qgspointdisplacementrenderer.h.
Placement methods for dispersing points.
Enumerator | |
---|---|
Ring | Place points in a single ring around group |
ConcentricRings | Place points in concentric rings around group |
Definition at line 39 of file qgspointdisplacementrenderer.h.
QgsPointDisplacementRenderer::QgsPointDisplacementRenderer | ( | const QString & | labelAttributeName = "" | ) |
Definition at line 43 of file qgspointdisplacementrenderer.cpp.
QgsPointDisplacementRenderer::~QgsPointDisplacementRenderer | ( | ) |
Definition at line 61 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 284 of file qgspointdisplacementrenderer.cpp.
|
inline |
Returns the symbol for the center of a displacement group (but not ownership of the symbol)
Definition at line 152 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
item in symbology was checked
Reimplemented from QgsFeatureRendererV2.
Definition at line 262 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 127 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 133 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 124 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Implements QgsFeatureRendererV2.
Definition at line 67 of file qgspointdisplacementrenderer.cpp.
|
static |
creates a QgsPointDisplacementRenderer from an existing renderer.
Definition at line 718 of file qgspointdisplacementrenderer.cpp.
|
static |
create a renderer from XML element
Definition at line 409 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Returns the current embedded renderer (subrenderer) for this feature renderer.
The base class implementation does not use subrenderers and will always return null.
Reimplemented from QgsFeatureRendererV2.
Definition at line 233 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 105 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 130 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 121 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Returns which legend keys match the feature.
Reimplemented from QgsFeatureRendererV2.
Definition at line 334 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
items of symbology items in legend is checked
Reimplemented from QgsFeatureRendererV2.
Definition at line 254 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 496 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
items of symbology items in legend should be checkable
Reimplemented from QgsFeatureRendererV2.
Definition at line 246 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
return a list of symbology items for the legend
Reimplemented from QgsFeatureRendererV2.
Definition at line 487 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 136 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 311 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 327 of file qgspointdisplacementrenderer.cpp.
|
inline |
Returns the placement method used for dispersing the points.
Definition at line 142 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Reimplemented from QgsFeatureRendererV2.
Definition at line 101 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
store renderer info to XML element
Reimplemented from QgsFeatureRendererV2.
Definition at line 445 of file qgspointdisplacementrenderer.cpp.
void QgsPointDisplacementRenderer::setCenterSymbol | ( | QgsMarkerSymbolV2 * | symbol | ) |
Sets the center symbol (takes ownership)
Definition at line 537 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 126 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 132 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 123 of file qgspointdisplacementrenderer.h.
|
inline |
not available in python bindings
Definition at line 118 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Sets an embedded renderer (subrenderer) for this feature renderer.
The base class implementation does nothing with subrenderers, but individual derived classes can use these to modify their behaviour.
subRenderer | the embedded renderer. Ownership will be transferred. |
Reimplemented from QgsFeatureRendererV2.
Definition at line 227 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 104 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 129 of file qgspointdisplacementrenderer.h.
|
inline |
Definition at line 120 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Sets the symbol to be used for a legend symbol item.
key | rule key for legend symbol |
symbol | new symbol for legend item. Ownership is transferred to renderer. |
Reimplemented from QgsFeatureRendererV2.
Definition at line 238 of file qgspointdisplacementrenderer.cpp.
|
inline |
Definition at line 135 of file qgspointdisplacementrenderer.h.
|
inline |
Sets the placement method used for dispersing the points.
placement | placement method |
Definition at line 149 of file qgspointdisplacementrenderer.h.
|
inline |
Sets the tolerance distance for grouping points.
Units are specified using setToleranceUnit().
t | tolerance distance |
Definition at line 162 of file qgspointdisplacementrenderer.h.
|
inline |
Sets the map unit scale object for the distance tolerance.
This is only used if the toleranceUnit() is set to QgsSymbolV2::MapUnit.
scale | scale for distance tolerance |
Definition at line 192 of file qgspointdisplacementrenderer.h.
|
inline |
Sets the units for the tolerance distance.
unit | tolerance distance units |
Definition at line 177 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Needs to be called when a new render cycle is started.
context | Additional information passed to the renderer about the job which will be rendered |
fields | The fields available for rendering |
Implements QgsFeatureRendererV2.
Definition at line 351 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Needs to be called when a render cycle has finished to clean up.
Implements QgsFeatureRendererV2.
Definition at line 385 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 302 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 293 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 318 of file qgspointdisplacementrenderer.cpp.
|
inline |
Returns the tolerance distance for grouping points.
Units are retrieved using toleranceUnit().
Definition at line 169 of file qgspointdisplacementrenderer.h.
|
inline |
Returns the map unit scale object for the distance tolerance.
This is only used if the toleranceUnit() is set to QgsSymbolV2::MapUnit.
Definition at line 199 of file qgspointdisplacementrenderer.h.
|
inline |
Returns the units for the tolerance distance.
Definition at line 184 of file qgspointdisplacementrenderer.h.
|
overridevirtual |
Writes the SLD element following the SLD v1.1 specs.
Reimplemented from QgsFeatureRendererV2.
Definition at line 90 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Writes the SLD element following the SLD v1.1 specs.
Reimplemented from QgsFeatureRendererV2.
Definition at line 95 of file qgspointdisplacementrenderer.cpp.
Partial proxy that will call this method on the embedded renderer.
Implements QgsFeatureRendererV2.
Definition at line 270 of file qgspointdisplacementrenderer.cpp.
|
overridevirtual |
Proxy that will call this method on the embedded renderer.
Reimplemented from QgsFeatureRendererV2.
Definition at line 341 of file qgspointdisplacementrenderer.cpp.