Subgroup: other
Class: QgsCategorizedSymbolRenderer¶
-
class
qgis.core.
QgsCategorizedSymbolRenderer
(attrName: str = '', categories: object = QgsCategoryList())¶ Bases:
qgis._core.QgsFeatureRenderer
Methods
addCategory
capabilities
categories
categoryIndexForLabel
return index of category with specified label (-1 if not found or not unique) categoryIndexForValue
return index of category with specified value (-1 if not found) checkLegendSymbolItem
classAttribute
clone
convertFromRenderer
creates a QgsCategorizedSymbolRenderer from an existing renderer. convertSymbolRotation
convertSymbolSizeScale
copyRendererData
create
create renderer from XML element dataDefinedSizeLegend
Returns configuration of appearance of legend when using data-defined size for marker symbols. deleteAllCategories
deleteCategory
dump
filter
legendClassificationAttribute
legendKeysForFeature
legendSymbolItemChecked
legendSymbolItems
legendSymbolItemsCheckable
moveCategory
Moves the category at index position from to index position to. originalSymbolForFeature
rebuildHash
hashtable for faster access to symbols renderFeatureWithSymbol
renderVertexMarker
renderVertexMarkerPolygon
renderVertexMarkerPolyline
save
setClassAttribute
setDataDefinedSizeLegend
Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. setLegendSymbolItem
setSourceColorRamp
Sets the source color ramp. setSourceSymbol
Sets the source symbol for the renderer, which is the base symbol used for the each categories’ symbol before applying the categories’ color. skipRender
. sortByLabel
sortByValue
sourceColorRamp
Returns the source color ramp, from which each categories’ color is derived. sourceSymbol
Returns the renderer’s source symbol, which is the base symbol used for the each categories’ symbol before applying the categories’ color. startRender
stopRender
symbolForFeature
symbolForValue
Returns the matching symbol corresponding to an attribute value
.symbolForValue2
Returns the matching symbol corresponding to an attribute value
.symbols
toSld
updateCategoryLabel
updateCategoryRenderState
. updateCategorySymbol
updateCategoryValue
updateColorRamp
Update the color ramp used and all symbols colors. updateSymbols
Update all the symbols but leave categories and colors. usedAttributes
Signals
Attributes
-
addCategory
(self, category: QgsRendererCategory)¶
-
capabilities
(self) → QgsFeatureRenderer.Capabilities¶
-
categories
(self) → object¶
-
categoryIndexForLabel
(self, val: str) → int¶ return index of category with specified label (-1 if not found or not unique)
New in version 2.5.
-
categoryIndexForValue
(self, val: Any) → int¶ return index of category with specified value (-1 if not found)
-
checkLegendSymbolItem
(self, key: str, state: bool = True)¶
-
classAttribute
(self) → str¶
-
clone
(self) → QgsCategorizedSymbolRenderer¶
-
convertFromRenderer
(renderer: QgsFeatureRenderer) → QgsCategorizedSymbolRenderer¶ creates a QgsCategorizedSymbolRenderer from an existing renderer.
Returns: a new renderer if the conversion was possible, otherwise 0. New in version 2.5.
-
convertSymbolRotation
()¶
-
convertSymbolSizeScale
()¶
-
copyRendererData
()¶
-
create
(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶ create renderer from XML element
-
dataDefinedSizeLegend
(self) → QgsDataDefinedSizeLegend¶ Returns configuration of appearance of legend when using data-defined size for marker symbols. Will return null if the functionality is disabled.
New in version 3.0.
-
deleteAllCategories
(self)¶
-
deleteCategory
(self, catIndex: int) → bool¶
-
dump
(self) → str¶
-
filter
(self, fields: QgsFields = QgsFields()) → str¶
-
legendClassificationAttribute
(self) → str¶
-
legendKeysForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → Set[str]¶
-
legendSymbolItemChecked
(self, key: str) → bool¶
-
legendSymbolItems
(self) → object¶
-
legendSymbolItemsCheckable
(self) → bool¶
-
moveCategory
(self, from_: int, to: int)¶ Moves the category at index position from to index position to.
-
originalSymbolForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶
-
rebuildHash
(self)¶ hashtable for faster access to symbols
-
renderFeatureWithSymbol
()¶
-
renderVertexMarker
()¶
-
renderVertexMarkerPolygon
()¶
-
renderVertexMarkerPolyline
()¶
-
save
(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶
-
setClassAttribute
(self, attr: str)¶
-
setDataDefinedSizeLegend
(self, settings: QgsDataDefinedSizeLegend)¶ Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. This allows configuring for which values (symbol sizes) should be shown in the legend, whether to display different symbol sizes collapsed in one legend node or separated across multiple legend nodes etc.
When renderer does not use data-defined size or does not use marker symbols, these settings will be ignored. Takes ownership of the passed settings objects. Null pointer is a valid input that disables data-defined size legend.
New in version 3.0.
-
setLegendSymbolItem
(self, key: str, symbol: QgsSymbol)¶
-
setSourceColorRamp
(self, ramp: QgsColorRamp)¶ Sets the source color ramp.
Parameters: ramp – color ramp. Ownership is transferred to the renderer See also
See also
-
setSourceSymbol
(self, sym: QgsSymbol)¶ Sets the source symbol for the renderer, which is the base symbol used for the each categories’ symbol before applying the categories’ color.
Parameters: sym – source symbol, ownership is transferred to the renderer See also
See also
-
skipRender
(self) → QgsSymbol¶ Deprecated since version No: longer used, will be removed in QGIS 4.0
-
sortByLabel
(self, order: Qt.SortOrder = Qt.AscendingOrder)¶
-
sortByValue
(self, order: Qt.SortOrder = Qt.AscendingOrder)¶
-
sourceColorRamp
(self) → QgsColorRamp¶ Returns the source color ramp, from which each categories’ color is derived.
See also
See also
-
sourceSymbol
(self) → QgsSymbol¶ Returns the renderer’s source symbol, which is the base symbol used for the each categories’ symbol before applying the categories’ color.
See also
See also
-
startRender
(self, context: QgsRenderContext, fields: QgsFields)¶
-
stopRender
(self, context: QgsRenderContext)¶
-
symbolForFeature
(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶
-
symbolForValue
(self, value: Any) → QgsSymbol¶ Returns the matching symbol corresponding to an attribute
value
.Deprecated since version use: variant which takes a second bool argument instead.
-
symbolForValue2
(self, value: Any) → Tuple[QgsSymbol, bool]¶ Returns the matching symbol corresponding to an attribute
value
.Will return None if no matching symbol was found for
value
, or if the category corresponding tovalue
is currently disabled (see QgsRendererCategory.renderState()).If
foundMatchingSymbol
is specified then it will be set to true if a matching category was found. This can be used to differentiate between a None returned as a result of no matching category vs a None as a result of disabled categories.Note
available in Python bindings as symbolForValue2
-
symbols
(self, context: QgsRenderContext) → object¶
-
toSld
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str] = {})¶
-
updateCategoryLabel
(self, catIndex: int, label: str) → bool¶
-
updateCategoryRenderState
(self, catIndex: int, render: bool) → bool¶ New in version 2.5.
-
updateCategorySymbol
(self, catIndex: int, symbol: QgsSymbol) → bool¶
-
updateCategoryValue
(self, catIndex: int, value: Any) → bool¶
-
updateColorRamp
(self, ramp: QgsColorRamp)¶ Update the color ramp used and all symbols colors.
Parameters: ramp – color ramp. Ownership is transferred to the renderer New in version 2.5.
-
updateSymbols
(self, sym: QgsSymbol)¶ Update all the symbols but leave categories and colors. This method also sets the source symbol for the renderer.
Parameters: sym – source symbol to use for categories. Ownership is not transferred. See also
-
usedAttributes
(self, context: QgsRenderContext) → Set[str]¶
-