QGIS API Documentation
2.14.0-Essen
|
#include <qgscategorizedsymbolrendererv2.h>
Public Member Functions | |
QgsCategorizedSymbolRendererV2 (const QString &attrName=QString(), const QgsCategoryList &categories=QgsCategoryList()) | |
virtual | ~QgsCategorizedSymbolRendererV2 () |
void | addCategory (const QgsRendererCategoryV2 &category) |
virtual int | capabilities () override |
returns bitwise OR-ed capabilities of the renderer More... | |
const QgsCategoryList & | categories () const |
int | categoryIndexForLabel (const QString &val) |
return index of category with specified label (-1 if not found or not unique) More... | |
int | categoryIndexForValue (const QVariant &val) |
return index of category with specified value (-1 if not found) More... | |
virtual void | checkLegendSymbolItem (const QString &key, bool state=true) override |
item in symbology was checked More... | |
QString | classAttribute () const |
virtual QgsCategorizedSymbolRendererV2 * | clone () const override |
void | deleteAllCategories () |
bool | deleteCategory (int catIndex) |
virtual QString | dump () const override |
for debugging More... | |
virtual QString | filter (const QgsFields &fields=QgsFields()) override |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More... | |
bool | invertedColorRamp () |
virtual QString | legendClassificationAttribute () const override |
If supported by the renderer, return classification attribute for the use in legend. More... | |
virtual QSet< QString > | legendKeysForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Return legend keys matching a specified feature. More... | |
virtual bool | legendSymbolItemChecked (const QString &key) override |
item in symbology was checked More... | |
virtual QgsLegendSymbolList | legendSymbolItems (double scaleDenominator=-1, const QString &rule=QString()) override |
return a list of item text / symbol More... | |
virtual bool | legendSymbolItemsCheckable () const override |
items of symbology items in legend should be checkable More... | |
QgsLegendSymbolListV2 | legendSymbolItemsV2 () const override |
virtual QgsLegendSymbologyList | legendSymbologyItems (QSize iconSize) override |
return a list of symbology items for the legend More... | |
void | moveCategory (int from, int to) |
Moves the category at index position from to index position to. More... | |
virtual QgsSymbolV2 * | originalSymbolForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Q_DECL_DEPRECATED QString | rotationField () const override |
return rotation field name (or empty string if not set or not supported by renderer) More... | |
virtual QDomElement | save (QDomDocument &doc) override |
store renderer info to XML element More... | |
QgsSymbolV2::ScaleMethod | scaleMethod () const |
void | setClassAttribute (const QString &attr) |
void | setInvertedColorRamp (bool inverted) |
virtual void | setLegendSymbolItem (const QString &key, QgsSymbolV2 *symbol) override |
Sets the symbol to be used for a legend symbol item. More... | |
Q_DECL_DEPRECATED void | setRotationField (const QString &fieldOrExpression) override |
sets rotation field of renderer (if supported by the renderer) More... | |
void | setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod) |
void | setSizeScaleField (const QString &fieldOrExpression) |
void | setSourceColorRamp (QgsVectorColorRampV2 *ramp) |
Sets the source color ramp. More... | |
void | setSourceSymbol (QgsSymbolV2 *sym) |
Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying the categories' color. More... | |
QString | sizeScaleField () const |
void | sortByLabel (Qt::SortOrder order=Qt::AscendingOrder) |
void | sortByValue (Qt::SortOrder order=Qt::AscendingOrder) |
QgsVectorColorRampV2 * | sourceColorRamp () |
Returns the source color ramp, from which each categories' color is derived. More... | |
QgsSymbolV2 * | sourceSymbol () |
Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color. More... | |
virtual void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
Needs to be called when a new render cycle is started. More... | |
virtual 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 |
virtual QgsSymbolV2List | symbols (QgsRenderContext &context) override |
virtual void | toSld (QDomDocument &doc, QDomElement &element) const override |
used from subclasses to create SLD Rule elements following SLD v1.1 specs More... | |
bool | updateCategoryLabel (int catIndex, const QString &label) |
bool | updateCategoryRenderState (int catIndex, bool render) |
bool | updateCategorySymbol (int catIndex, QgsSymbolV2 *symbol) |
bool | updateCategoryValue (int catIndex, const QVariant &value) |
void | updateColorRamp (QgsVectorColorRampV2 *ramp, bool inverted=false) |
Update the color ramp used and all symbols colors. More... | |
void | updateSymbols (QgsSymbolV2 *sym) |
Update all the symbols but leave categories and colors. More... | |
virtual QList< QString > | usedAttributes () override |
Returns a set of attributes required for this renderer. More... | |
Public Member Functions inherited from QgsFeatureRendererV2 | |
virtual | ~QgsFeatureRendererV2 () |
bool | forceRasterRender () const |
Returns whether the renderer must render as a raster. 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... | |
virtual QgsSymbolV2List | originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context) |
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 bool | renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) |
Render a feature using this renderer in the given context. 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... | |
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... | |
virtual QgsSymbolV2List | symbolsForFeature (QgsFeature &feat, QgsRenderContext &context) |
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 bool | willRenderFeature (QgsFeature &feat, QgsRenderContext &context) |
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... | |
Static Public Member Functions | |
static QgsCategorizedSymbolRendererV2 * | convertFromRenderer (const QgsFeatureRendererV2 *renderer) |
creates a QgsCategorizedSymbolRendererV2 from an existing renderer. More... | |
static QgsFeatureRendererV2 * | create (QDomElement &element) |
create 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... | |
Protected Member Functions | |
void | rebuildHash () |
QgsSymbolV2 * | skipRender () |
QgsSymbolV2 * | symbolForValue (const QVariant &value) |
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) |
Additional Inherited Members | |
Public Types inherited from QgsFeatureRendererV2 | |
enum | Capabilities { SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 } |
Static Protected Member Functions inherited from QgsFeatureRendererV2 | |
static QgsConstWkbPtr | _getLineString (QPolygonF &pts, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true) |
static QgsConstWkbPtr | _getPoint (QPointF &pt, QgsRenderContext &context, QgsConstWkbPtr wkb) |
static QgsConstWkbPtr | _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true) |
static void | convertSymbolRotation (QgsSymbolV2 *symbol, const QString &field) |
static void | convertSymbolSizeScale (QgsSymbolV2 *symbol, QgsSymbolV2::ScaleMethod method, const QString &field) |
Definition at line 73 of file qgscategorizedsymbolrendererv2.h.
QgsCategorizedSymbolRendererV2::QgsCategorizedSymbolRendererV2 | ( | const QString & | attrName = QString() , |
const QgsCategoryList & | categories = QgsCategoryList() |
||
) |
Definition at line 149 of file qgscategorizedsymbolrendererv2.cpp.
|
virtual |
Definition at line 170 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::addCategory | ( | const QgsRendererCategoryV2 & | category | ) |
Definition at line 343 of file qgscategorizedsymbolrendererv2.cpp.
|
inlineoverridevirtual |
returns bitwise OR-ed capabilities of the renderer
Reimplemented from QgsFeatureRendererV2.
Definition at line 100 of file qgscategorizedsymbolrendererv2.h.
|
inline |
Definition at line 114 of file qgscategorizedsymbolrendererv2.h.
int QgsCategorizedSymbolRendererV2::categoryIndexForLabel | ( | const QString & | val | ) |
return index of category with specified label (-1 if not found or not unique)
Definition at line 295 of file qgscategorizedsymbolrendererv2.cpp.
int QgsCategorizedSymbolRendererV2::categoryIndexForValue | ( | const QVariant & | val | ) |
return index of category with specified value (-1 if not found)
Definition at line 285 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
item in symbology was checked
Reimplemented from QgsFeatureRendererV2.
Definition at line 1013 of file qgscategorizedsymbolrendererv2.cpp.
|
inline |
Definition at line 140 of file qgscategorizedsymbolrendererv2.h.
|
overridevirtual |
Implements QgsFeatureRendererV2.
Definition at line 503 of file qgscategorizedsymbolrendererv2.cpp.
|
static |
creates a QgsCategorizedSymbolRendererV2 from an existing renderer.
Definition at line 1021 of file qgscategorizedsymbolrendererv2.cpp.
|
static |
create renderer from XML element
Definition at line 620 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::deleteAllCategories | ( | ) |
Definition at line 363 of file qgscategorizedsymbolrendererv2.cpp.
bool QgsCategorizedSymbolRendererV2::deleteCategory | ( | int | catIndex | ) |
Definition at line 354 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
for debugging
Reimplemented from QgsFeatureRendererV2.
Definition at line 495 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
This will be called once after startRender() and before the first call to renderFeature(). By default this returns a null string and all features will be requested. You do not need to specify the extent in here, this is taken care of separately and will be combined with a filter returned from this method.
Reimplemented from QgsFeatureRendererV2.
Definition at line 537 of file qgscategorizedsymbolrendererv2.cpp.
|
inline |
Definition at line 190 of file qgscategorizedsymbolrendererv2.h.
|
inlineoverridevirtual |
If supported by the renderer, return classification attribute for the use in legend.
Reimplemented from QgsFeatureRendererV2.
Definition at line 225 of file qgscategorizedsymbolrendererv2.h.
|
overridevirtual |
Return legend keys matching a specified feature.
Reimplemented from QgsFeatureRendererV2.
Definition at line 871 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
item in symbology was checked
Reimplemented from QgsFeatureRendererV2.
Definition at line 993 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
return a list of item text / symbol
Reimplemented from QgsFeatureRendererV2.
Definition at line 806 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
items of symbology items in legend should be checkable
Reimplemented from QgsFeatureRendererV2.
Definition at line 988 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 821 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
return a list of symbology items for the legend
Reimplemented from QgsFeatureRendererV2.
Definition at line 792 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::moveCategory | ( | int | from, |
int | to | ||
) |
Moves the category at index position from to index position to.
Definition at line 368 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 266 of file qgscategorizedsymbolrendererv2.cpp.
|
protected |
Definition at line 174 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
return rotation field name (or empty string if not set or not supported by renderer)
Reimplemented from QgsFeatureRendererV2.
Definition at line 943 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
store renderer info to XML element
Reimplemented from QgsFeatureRendererV2.
Definition at line 714 of file qgscategorizedsymbolrendererv2.cpp.
|
inline |
Definition at line 207 of file qgscategorizedsymbolrendererv2.h.
|
inline |
Definition at line 141 of file qgscategorizedsymbolrendererv2.h.
|
inline |
Definition at line 191 of file qgscategorizedsymbolrendererv2.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 1003 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
sets rotation field of renderer (if supported by the renderer)
Reimplemented from QgsFeatureRendererV2.
Definition at line 934 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::setScaleMethod | ( | QgsSymbolV2::ScaleMethod | scaleMethod | ) |
Definition at line 978 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::setSizeScaleField | ( | const QString & | fieldOrExpression | ) |
Definition at line 955 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::setSourceColorRamp | ( | QgsVectorColorRampV2 * | ramp | ) |
Sets the source color ramp.
ramp | color ramp. Ownership is transferred to the renderer |
Definition at line 905 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::setSourceSymbol | ( | QgsSymbolV2 * | sym | ) |
Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying the categories' color.
sym | source symbol, ownership is transferred to the renderer |
Definition at line 895 of file qgscategorizedsymbolrendererv2.cpp.
QString QgsCategorizedSymbolRendererV2::sizeScaleField | ( | ) | const |
Definition at line 960 of file qgscategorizedsymbolrendererv2.cpp.
|
protected |
Definition at line 185 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::sortByLabel | ( | Qt::SortOrder | order = Qt::AscendingOrder | ) |
Definition at line 405 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::sortByValue | ( | Qt::SortOrder | order = Qt::AscendingOrder | ) |
Definition at line 383 of file qgscategorizedsymbolrendererv2.cpp.
QgsVectorColorRampV2 * QgsCategorizedSymbolRendererV2::sourceColorRamp | ( | ) |
Returns the source color ramp, from which each categories' color is derived.
Definition at line 900 of file qgscategorizedsymbolrendererv2.cpp.
QgsSymbolV2 * QgsCategorizedSymbolRendererV2::sourceSymbol | ( | ) |
Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color.
Definition at line 891 of file qgscategorizedsymbolrendererv2.cpp.
|
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 417 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
Needs to be called when a render cycle has finished to clean up.
Implements QgsFeatureRendererV2.
Definition at line 448 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 214 of file qgscategorizedsymbolrendererv2.cpp.
|
protected |
Definition at line 194 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 608 of file qgscategorizedsymbolrendererv2.cpp.
|
overridevirtual |
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Reimplemented from QgsFeatureRendererV2.
Definition at line 520 of file qgscategorizedsymbolrendererv2.cpp.
bool QgsCategorizedSymbolRendererV2::updateCategoryLabel | ( | int | catIndex, |
const QString & | label | ||
) |
Definition at line 327 of file qgscategorizedsymbolrendererv2.cpp.
bool QgsCategorizedSymbolRendererV2::updateCategoryRenderState | ( | int | catIndex, |
bool | render | ||
) |
Definition at line 335 of file qgscategorizedsymbolrendererv2.cpp.
bool QgsCategorizedSymbolRendererV2::updateCategorySymbol | ( | int | catIndex, |
QgsSymbolV2 * | symbol | ||
) |
Definition at line 319 of file qgscategorizedsymbolrendererv2.cpp.
bool QgsCategorizedSymbolRendererV2::updateCategoryValue | ( | int | catIndex, |
const QVariant & | value | ||
) |
Definition at line 311 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::updateColorRamp | ( | QgsVectorColorRampV2 * | ramp, |
bool | inverted = false |
||
) |
Update the color ramp used and all symbols colors.
ramp | color ramp. Ownership is transferred to the renderer |
inverted | set to true to invert ramp colors |
Definition at line 910 of file qgscategorizedsymbolrendererv2.cpp.
void QgsCategorizedSymbolRendererV2::updateSymbols | ( | QgsSymbolV2 * | sym | ) |
Update all the symbols but leave categories and colors.
This method also sets the source symbol for the renderer.
sym | source symbol to use for categories. Ownership is not transferred. |
Definition at line 965 of file qgscategorizedsymbolrendererv2.cpp.
Returns a set of attributes required for this renderer.
TODO QGIS3: Change QList to QSet
Implements QgsFeatureRendererV2.
Definition at line 466 of file qgscategorizedsymbolrendererv2.cpp.
|
protected |
Definition at line 233 of file qgscategorizedsymbolrendererv2.h.
|
protected |
attribute index (derived from attribute name in startRender)
Definition at line 244 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 234 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 248 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 241 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 237 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 238 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 240 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 239 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 236 of file qgscategorizedsymbolrendererv2.h.
|
protected |
Definition at line 235 of file qgscategorizedsymbolrendererv2.h.
|
protected |
hashtable for faster access to symbols
Definition at line 247 of file qgscategorizedsymbolrendererv2.h.
|
protected |
temporary symbols, used for data-defined rotation and scaling
Definition at line 251 of file qgscategorizedsymbolrendererv2.h.