Class: QgsRendererCategory¶
-
class
qgis.core.
QgsRendererCategory
¶ Bases:
sip.wrapper
Constructor for QgsRendererCategory.
QgsRendererCategory(value: Any, symbol: QgsSymbol, label: str, render: bool = True) Constructor for a new QgsRendererCategory, with the specified
value
andsymbol
.If
value
is a list, then the category will match any of the values from this list.The ownership of
symbol
is transferred to the category.The
label
argument specifies the label used for this category in legends and the layer tree.The
render
argument indicates whether the category should initially be rendered and appear checked in the layer tree.QgsRendererCategory(cat: QgsRendererCategory) Copy constructor.
Represents an individual category (class) from a QgsCategorizedSymbolRenderer.
Enums
Methods
Returns a string representing the categories settings, used for debugging purposes only.
Returns the label for this category, which is used to represent the category within legends and the layer tree.
Returns true if the category is currently enabled and should be rendered.
Sets the
label
for this category, which is used to represent the category within legends and the layer tree.Sets whether the category is currently enabled and should be rendered.
Sets the symbol which will be used to render this category.
Sets the
value
corresponding to this category.Returns the symbol which will be used to render this category.
Converts the category to a matching SLD rule, within the specified DOM document and
element
.Returns the value corresponding to this category.
Signals
Attributes
-
dump
(self) → str¶ Returns a string representing the categories settings, used for debugging purposes only.
-
label
(self) → str¶ Returns the label for this category, which is used to represent the category within legends and the layer tree.
See also
-
renderState
(self) → bool¶ Returns true if the category is currently enabled and should be rendered.
See also
New in version 2.5.
-
setLabel
(self, label: str)¶ Sets the
label
for this category, which is used to represent the category within legends and the layer tree.See also
-
setRenderState
(self, render: bool)¶ Sets whether the category is currently enabled and should be rendered.
See also
New in version 2.5.
-
setSymbol
(self, s: QgsSymbol)¶ Sets the symbol which will be used to render this category.
Ownership of the symbol is transferred to the category.
See also
-
setValue
(self, value: Any)¶ Sets the
value
corresponding to this category.If
value
is a list, then the category will match any of the values from this list.See also
-
swap
(self, other: QgsRendererCategory)¶
-
symbol
(self) → QgsSymbol¶ Returns the symbol which will be used to render this category.
See also
-
toSld
(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])¶ Converts the category to a matching SLD rule, within the specified DOM document and
element
.
-
value
(self) → Any¶ Returns the value corresponding to this category.
If the returned value is a list, then the category will match any of the values from this list.
See also
-