Class: QgsCategorizedSymbolRendererWidget

QgsCategorizedSymbolRendererWidget

Class Hierarchy

Base classes

QgsRendererWidget	Base class for renderer settings widgets.
QgsPanelWidget	Base class for any widget that can be shown as a inline panel
QWidget
QObject
QPaintDevice
QgsExpressionContextGenerator	Abstract interface for generating an expression context.

class qgis.gui.QgsCategorizedSymbolRendererWidget(layer: QgsVectorLayer | None, style: QgsStyle | None, renderer: QgsFeatureRenderer | None)

Bases: QgsRendererWidget

class CustomRole(*values)

Bases: IntEnum

Custom model roles.

Note

Prior to QGIS 3.36 this was available as QgsCategorizedSymbolRendererWidget.CustomRoles

Added in version 3.36.

• Value: Category value

  Available as QgsCategorizedSymbolRendererWidget.ValueRole in older QGIS releases.

CustomRoles

alias of CustomRole

addCategories(self)

addCategory(self)

applyChangeToSymbol(self)

Applies current symbol to selected categories, or to all categories if none is selected

applyColorRamp(self)

Applies the color ramp passed on by the color ramp button

categoriesDoubleClicked(self, idx: QModelIndex)

Parameters:

idx (QModelIndex)

categoryColumnChanged(self, field: str | None)

Parameters:

field (Optional[str])

changeCategorizedSymbol(self)

changeCategorySymbol(self)

changeSelectedSymbols(self)

Changes the selected symbols alone for the change button, if there is a selection

currentCategoryRow(self) → int

Returns row index for the currently selected category (-1 if on no selection)

Return type:

int

deleteAllCategories(self)

deleteCategories(self)

matchToSymbols(self, style: QgsStyle | None) → int

Replaces category symbols with the symbols from a style that have a matching name.

Parameters:

style (Optional[QgsStyle]) – style containing symbols to match with

Return type:

int

Returns:

number of symbols matched

See also

matchToSymbolsFromLibrary()

See also

matchToSymbolsFromXml()

matchToSymbolsFromLibrary(self)

Replaces category symbols with the symbols from the users’ symbol library that have a matching name.

See also

matchToSymbolsFromXml()

See also

matchToSymbols()

matchToSymbolsFromXml(self)

Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name.

See also

matchToSymbolsFromLibrary()

See also

matchToSymbols()

populateCategories(self)

rowsMoved(self)

selectedCategories(self) → List[int]

Returns a list of indexes for the categories under selection

Return type:

List[int]

selectedCategoryList(self) → List[QgsRendererCategory]

Return type:

List[QgsRendererCategory]

showSymbolLevels(self)

updateUiFromRenderer(self)