Class: QgsRendererCategory

Represents an individual category (class) from a QgsCategorizedSymbolRenderer.

Methods

dump	Returns a string representing the categories settings, used for debugging purposes only.
label	Returns the label for this category, which is used to represent the category within legends and the layer tree.
renderState	Returns True if the category is currently enabled and should be rendered.
setLabel	Sets the label for this category, which is used to represent the category within legends and the layer tree.
setRenderState	Sets whether the category is currently enabled and should be rendered.
setSymbol	Sets the symbol which will be used to render this category.
setValue	Sets the value corresponding to this category.
symbol	Returns the symbol which will be used to render this category.
toSld	Converts the category to a matching SLD rule, within the specified DOM document and element.
uuid	Returns the unique identifier for this category.
value	Returns the value corresponding to this category.

class qgis.core.QgsRendererCategory

Bases: object

__init__()

__init__(value: Any, symbol: QgsSymbol | None, label: str | None, render: bool = True, uuid: str | None = '')

Constructor for a new QgsRendererCategory, with the specified value and symbol.

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.

The optional uuid argument manually set the UUID key identifier for the category (since QGIS 3.34).

Parameters:

• value (Any)

• symbol (Optional[QgsSymbol])

• label (Optional[str])

• render (bool = True)

• uuid (Optional[str] = '')

__init__(cat: QgsRendererCategory)

Parameters:

cat (QgsRendererCategory)

dump(self) → str

Returns a string representing the categories settings, used for debugging purposes only.

Return type:

str

label(self) → str

Returns the label for this category, which is used to represent the category within legends and the layer tree.

See also

setLabel()

Return type:

str

renderState(self) → bool

Returns True if the category is currently enabled and should be rendered.

See also

setRenderState()

Return type:

bool

setLabel(self, label: str | None)

Sets the label for this category, which is used to represent the category within legends and the layer tree.

See also

label()

Parameters:

label (Optional[str])

setRenderState(self, render: bool)

Sets whether the category is currently enabled and should be rendered.

See also

renderState()

Parameters:

render (bool)

setSymbol(self, s: QgsSymbol | None)

Sets the symbol which will be used to render this category.

Ownership of the symbol is transferred to the category.

See also

symbol()

Parameters:

s (Optional[QgsSymbol])

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

value()

Parameters:

value (Any)

symbol(self) → QgsSymbol | None

Returns the symbol which will be used to render this category.

See also

setSymbol()

Return type:

Optional[QgsSymbol]

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any])

Converts the category to a matching SLD rule, within the specified DOM document and element.

Deprecated since version 3.44: Use the version with QgsSldExportContext instead.

Parameters:

• doc (QDomDocument)

• element (QDomElement)

• props (Dict[str, Any])

toSld(self, doc: QDomDocument, element: QDomElement, classAttribute: str | None, context: QgsSldExportContext) → bool

Converts the category to a matching SLD rule, within the specified DOM document and element.

Added in version 3.44.

Parameters:

• doc (QDomDocument)

• element (QDomElement)

• classAttribute (Optional[str])

• context (QgsSldExportContext)

Return type:

bool

uuid(self) → str

Returns the unique identifier for this category.

Added in version 3.34.

Return type:

str

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

setValue()

Return type:

Any