Class: QgsVectorTileBasicRendererStyle

Definition of map rendering of a subset of vector tile data.

The subset of data is defined by:

  • sub-layer name

  • geometry type (a single sub-layer may have multiple geometry types)

  • filter expression

Rendering is determined by the associated symbol (QgsSymbol). Symbol has to be of the same type as the chosen geometryType() - i.e. QgsMarkerSymbol for points, QgsLineSymbol for linestrings and QgsFillSymbol for polygons.

It is possible to further constrain when this style is applied by setting a range of allowed zoom levels, or by disabling it.

Added in version 3.14.

class qgis.core.QgsVectorTileBasicRendererStyle[source]

Bases: object

__init__(stName: str | None = '', laName: str | None = '', geomType: Qgis.GeometryType = Qgis.GeometryType.Unknown)

Constructs a style object

Parameters:

  • stName (Optional[str] = '')

  • laName (Optional[str] = '')

  • geomType (Qgis.GeometryType = Qgis.GeometryType.Unknown)

__init__(other: QgsVectorTileBasicRendererStyle)
Parameters:

other (QgsVectorTileBasicRendererStyle)

filterExpression(self) → str[source]

Returns filter expression (empty filter means that all features match)

Return type:

str

geometryType(self) → Qgis.GeometryType[source]

Returns type of the geometry that will be used (point / line / polygon)

Return type:

Qgis.GeometryType

isActive(self, zoomLevel: int) → bool[source]

Returns whether the style is active at given zoom level (also checks “enabled” flag)

Parameters:

zoomLevel (int)

Return type:

bool

isEnabled(self) → bool[source]

Returns whether this style is enabled (used for rendering)

Return type:

bool

layerName(self) → str[source]

Returns name of the sub-layer to render (empty layer means that all layers match)

Return type:

str

maxZoomLevel(self) → int[source]

Returns the maximum zoom level index (negative number means no limit).

The style will be rendered if the zoom level is less than or equal to the maximum zoom.

Warning

This differs from the handling of the max zoom as defined in the MapBox Style Specifications, where the style is rendered only if the zoom level is less than the maximum zoom.

See also

setMaxZoomLevel()

See also

minZoomLevel()

Return type:

int

minZoomLevel(self) → int[source]

Returns the minimum zoom level index (negative number means no limit).

The style will be rendered if the zoom level is greater than or equal to the this level.

See also

setMinZoomLevel()

See also

maxZoomLevel()

Return type:

int

readXml(self, elem: QDomElement, context: QgsReadWriteContext)[source]

Reads object content from given DOM element

Parameters:
setEnabled(self, enabled: bool)[source]

Sets whether this style is enabled (used for rendering)

Parameters:

enabled (bool)

setFilterExpression(self, expr: str | None)[source]

Sets filter expression (empty filter means that all features match)

Parameters:

expr (Optional[str])

setGeometryType(self, geomType: Qgis.GeometryType)[source]

Sets type of the geometry that will be used (point / line / polygon)

Parameters:

geomType (Qgis.GeometryType)

setLayerName(self, name: str | None)[source]

Sets name of the sub-layer to render (empty layer means that all layers match)

Parameters:

name (Optional[str])

setMaxZoomLevel(self, maxZoom: int)[source]

Sets maximum zoom level index (negative number means no limit).

The style will be rendered if the zoom level is less than or equal to maxZoom.

Warning

This differs from the handling of the max zoom as defined in the MapBox Style Specifications, where the style is rendered only if the zoom level is less than the maximum zoom.

See also

maxZoomLevel()

See also

setMinZoomLevel()

Parameters:

maxZoom (int)

setMinZoomLevel(self, minZoom: int)[source]

Sets minimum zoom level index (negative number means no limit).

The style will be rendered if the zoom level is greater than or equal to minZoom.

See also

minZoomLevel()

See also

setMaxZoomLevel()

Parameters:

minZoom (int)

setStyleName(self, name: str | None)[source]

Sets human readable name of this style

Parameters:

name (Optional[str])

setSymbol(self, sym: QgsSymbol | None)[source]

Sets symbol for rendering. Takes ownership of the symbol.

Parameters:

sym (Optional[QgsSymbol])

styleName(self) → str[source]

Returns human readable name of this style

Return type:

str

symbol(self) → QgsSymbol | None[source]

Returns symbol for rendering

Return type:

Optional[QgsSymbol]

writeXml(self, elem: QDomElement, context: QgsReadWriteContext)[source]

Writes object content to given DOM element

Parameters: