|
| QgsCategorizedSymbolRenderer (const QString &attrName=QString(), const QgsCategoryList &categories=QgsCategoryList()) |
| Constructor for QgsCategorizedSymbolRenderer. More...
|
|
| ~QgsCategorizedSymbolRenderer () override |
|
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
| Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
|
|
void | addCategory (const QgsRendererCategory &category) |
| Adds a new category to the renderer. More...
|
|
QgsFeatureRenderer::Capabilities | capabilities () override |
| Returns details about internals of this renderer. More...
|
|
const QgsCategoryList & | categories () const |
| Returns a list of all categories recognized by the renderer. More...
|
|
int | categoryIndexForLabel (const QString &val) |
| Returns the index of the category with the specified label (or -1 if the label was not found, or is not unique). More...
|
|
int | categoryIndexForValue (const QVariant &val) |
| Returns the index for the category with the specified value (or -1 if not found). More...
|
|
void | checkLegendSymbolItem (const QString &key, bool state=true) override |
| item in symbology was checked More...
|
|
QString | classAttribute () const |
| Returns the class attribute for the renderer, which is the field name or expression string from the layer which will be matched against the renderer categories. More...
|
|
QgsCategorizedSymbolRenderer * | clone () const override |
| Create a deep copy of this renderer. More...
|
|
QgsDataDefinedSizeLegend * | dataDefinedSizeLegend () const |
| Returns configuration of appearance of legend when using data-defined size for marker symbols. More...
|
|
void | deleteAllCategories () |
| Deletes all existing categories from the renderer. More...
|
|
bool | deleteCategory (int catIndex) |
| Deletes the category with the specified index from the renderer. More...
|
|
QString | dump () const override |
| Returns debug information about this renderer. More...
|
|
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 | filterNeedsGeometry () const override |
| Returns true if this renderer requires the geometry to apply the filter. More...
|
|
QString | legendClassificationAttribute () const override |
| If supported by the renderer, return classification attribute for the use in legend. More...
|
|
QSet< QString > | legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
| Returns legend keys matching a specified feature. More...
|
|
QString | legendKeyToExpression (const QString &key, QgsVectorLayer *layer, bool &ok) const override |
| Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key. More...
|
|
bool | legendSymbolItemChecked (const QString &key) override |
| items of symbology items in legend is checked More...
|
|
QgsLegendSymbolList | legendSymbolItems () const override |
| Returns a list of symbology items for the legend. More...
|
|
bool | legendSymbolItemsCheckable () const override |
| items of symbology items in legend should be checkable More...
|
|
int | matchToSymbols (QgsStyle *style, Qgis::SymbolType type, QVariantList &unmatchedCategories, QStringList &unmatchedSymbols, bool caseSensitive=true, bool useTolerantMatch=false) |
| Replaces category symbols with the symbols from a style that have a matching name and symbol type. More...
|
|
void | moveCategory (int from, int to) |
| Moves an existing category at index position from to index position to. More...
|
|
QgsSymbol * | originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
| Returns symbol for feature. More...
|
|
QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) override |
| Stores renderer properties to an XML element. More...
|
|
void | setClassAttribute (const QString &attr) |
| Sets the class attribute for the renderer, which is the field name or expression string from the layer which will be matched against the renderer categories. More...
|
|
void | setDataDefinedSizeLegend (QgsDataDefinedSizeLegend *settings) |
| Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. More...
|
|
void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override |
| Sets the symbol to be used for a legend symbol item. More...
|
|
void | setSourceColorRamp (QgsColorRamp *ramp) |
| Sets the source color ramp. More...
|
|
void | setSourceSymbol (QgsSymbol *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...
|
|
void | sortByLabel (Qt::SortOrder order=Qt::AscendingOrder) |
| Sorts the existing categories by their label. More...
|
|
void | sortByValue (Qt::SortOrder order=Qt::AscendingOrder) |
| Sorts the existing categories by their value. More...
|
|
QgsColorRamp * | sourceColorRamp () |
| Returns the source color ramp, from which each categories' color is derived. More...
|
|
const QgsColorRamp * | sourceColorRamp () const |
| Returns the source color ramp, from which each categories' color is derived. More...
|
|
QgsSymbol * | sourceSymbol () |
| Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color. More...
|
|
const QgsSymbol * | sourceSymbol () const |
| Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color. More...
|
|
void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
| Must be called when a new render cycle is started. More...
|
|
void | stopRender (QgsRenderContext &context) override |
| Must be called when a render cycle has finished, to allow the renderer to clean up. More...
|
|
QgsSymbol * | symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
| To be overridden. More...
|
|
QgsSymbolList | symbols (QgsRenderContext &context) const override |
| Returns list of symbols used by the renderer. More...
|
|
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override |
| used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
|
|
bool | updateCategoryLabel (int catIndex, const QString &label) |
| Changes the label for the category with the specified index. More...
|
|
bool | updateCategoryRenderState (int catIndex, bool render) |
| Changes the render state for the category with the specified index. More...
|
|
bool | updateCategorySymbol (int catIndex, QgsSymbol *symbol) |
| Changes the symbol for the category with the specified index. More...
|
|
bool | updateCategoryValue (int catIndex, const QVariant &value) |
| Changes the value for the category with the specified index. More...
|
|
void | updateColorRamp (QgsColorRamp *ramp) |
| Update the color ramp used and all symbols colors. More...
|
|
void | updateSymbols (QgsSymbol *sym) |
| Update all the symbols but leave categories and colors. More...
|
|
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
| Returns a list of attributes required by this renderer. More...
|
|
virtual | ~QgsFeatureRenderer () |
|
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
| Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
|
|
virtual QgsFeatureRenderer::Capabilities | capabilities () |
| Returns details about internals of this renderer. More...
|
|
virtual void | checkLegendSymbolItem (const QString &key, bool state=true) |
| item in symbology was checked More...
|
|
virtual QgsFeatureRenderer * | clone () const =0 |
| Create a deep copy of this renderer. More...
|
|
void | copyRendererData (QgsFeatureRenderer *destRenderer) const |
| Clones generic renderer data to another renderer. More...
|
|
virtual QString | dump () const |
| Returns debug information about this renderer. More...
|
|
virtual const QgsFeatureRenderer * | embeddedRenderer () const |
| Returns the current embedded renderer (subrenderer) for this feature renderer. 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 QSet< QString > | legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
| Returns legend keys matching a specified feature. More...
|
|
virtual QString | legendKeyToExpression (const QString &key, QgsVectorLayer *layer, bool &ok) const |
| Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key. More...
|
|
virtual bool | legendSymbolItemChecked (const QString &key) |
| items of symbology items in legend is checked More...
|
|
virtual QgsLegendSymbolList | legendSymbolItems () const |
| Returns a list of symbology items for the legend. More...
|
|
virtual bool | legendSymbolItemsCheckable () const |
| items of symbology items in legend should be checkable 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 |
| Gets 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 QgsSymbol * | originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
| Returns symbol for feature. More...
|
|
virtual QgsSymbolList | originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
| 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...
|
|
double | referenceScale () const |
| Returns the symbology reference scale. More...
|
|
virtual bool | renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException) |
| Render a feature using this renderer in the given context. More...
|
|
virtual QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) |
| Stores renderer properties to an XML element. More...
|
|
virtual void | setEmbeddedRenderer (QgsFeatureRenderer *subRenderer) |
| Sets an embedded renderer (subrenderer) for this feature renderer. More...
|
|
void | setForceRasterRender (bool forceRaster) |
| Sets whether the renderer should be rendered to a raster destination. More...
|
|
virtual void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) |
| Sets the symbol to be used for a legend symbol item. 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 | setReferenceScale (double scale) |
| Sets the symbology reference scale. More...
|
|
void | setUsingSymbolLevels (bool usingSymbolLevels) |
|
void | setVertexMarkerAppearance (Qgis::VertexMarkerType type, double size) |
| Sets type and size of editing vertex markers for subsequent rendering. More...
|
|
virtual void | startRender (QgsRenderContext &context, const QgsFields &fields) |
| Must be called when a new render cycle is started. More...
|
|
virtual void | stopRender (QgsRenderContext &context) |
| Must be called when a render cycle has finished, to allow the renderer to clean up. More...
|
|
virtual QgsSymbol * | symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const =0 |
| To be overridden. More...
|
|
virtual QgsSymbolList | symbols (QgsRenderContext &context) const |
| Returns list of symbols used by the renderer. More...
|
|
virtual QgsSymbolList | symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
| Returns list of symbols used for rendering the feature. More...
|
|
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 More...
|
|
QString | type () const |
|
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const =0 |
| Returns a list of attributes required by this renderer. More...
|
|
virtual bool | usesEmbeddedSymbols () const |
| Returns true if the renderer uses embedded symbols for features. More...
|
|
bool | usingSymbolLevels () const |
|
virtual bool | willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const |
| Returns whether the renderer will render a feature or not. More...
|
|
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName, const QVariantMap &props=QVariantMap()) const |
| create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
|
|