Class: QgsVectorLayerSelectionProperties

Implementation of layer selection properties for vector layers.

Added in version 3.34.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsMapLayerSelectionProperties	Base class for storage of map layer selection properties.
QObject

Methods

selectionColor	Returns the color to use for rendering selected features in the layer.
selectionRenderingMode	Returns the selection rendering mode to use for selected features in the layer.
selectionSymbol	Returns the symbol used to render selected features in the layer.
setSelectionColor	Sets the color to use for rendering selected features in the layer.
setSelectionRenderingMode	Sets the selection rendering mode to use for selected features in the layer.
setSelectionSymbol	Sets the symbol used to render selected features in the layer.

Signals

selectionColorChanged	Emitted whenever the selection color changes.
selectionRenderingModeChanged	Emitted whenever the selection rendering mode changes.
selectionSymbolChanged	Emitted whenever the selection symbol changes.

class qgis.core.QgsVectorLayerSelectionProperties

Bases: QgsMapLayerSelectionProperties

__init__(parent: QObject | None = None)

Constructor for QgsVectorLayerSelectionProperties, with the specified parent object.

Parameters:

parent (Optional[QObject] = None)

selectionColor(self) → QColor

Returns the color to use for rendering selected features in the layer.

An invalid color indicates that the default (i.e. project level) selection color should be used instead.

See also

setSelectionColor()

Return type:

QColor

signal selectionColorChanged

Emitted whenever the selection color changes.

Added in version 4.0.

selectionRenderingMode(self) → Qgis.SelectionRenderingMode

Returns the selection rendering mode to use for selected features in the layer.

See also

setSelectionRenderingMode()

Return type:

Qgis.SelectionRenderingMode

signal selectionRenderingModeChanged

Emitted whenever the selection rendering mode changes.

Added in version 4.0.

selectionSymbol(self) → QgsSymbol | None

Returns the symbol used to render selected features in the layer.

May be None if the default symbol should be used instead.

See also

setSelectionSymbol()

Return type:

Optional[QgsSymbol]

signal selectionSymbolChanged

Emitted whenever the selection symbol changes.

Added in version 4.0.

setSelectionColor(self, color: QColor | Qt.GlobalColor)

Sets the color to use for rendering selected features in the layer.

An invalid color indicates that the default (i.e. project level) selection color should be used instead.

See also

selectionColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setSelectionRenderingMode(self, mode: Qgis.SelectionRenderingMode)

Sets the selection rendering mode to use for selected features in the layer.

See also

selectionRenderingMode()

Parameters:

mode (Qgis.SelectionRenderingMode)

setSelectionSymbol(self, symbol: QgsSymbol | None)

Sets the symbol used to render selected features in the layer.

Ownership of symbol is transferred to the plot. If symbol is None then the default symbol will be used instead.

See also

selectionSymbol()

Parameters:

symbol (Optional[QgsSymbol])