QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsVectorTileBasicLabelingStyle Class Reference

Configuration of a single style within QgsVectorTileBasicLabeling. More...

#include <qgsvectortilebasiclabeling.h>

Public Member Functions

QString filterExpression () const
 Returns filter expression (empty filter means that all features match) More...
 
Qgis::GeometryType geometryType () const
 Returns type of the geometry that will be used (point / line / polygon) More...
 
bool isActive (int zoomLevel) const
 Returns whether the style is active at given zoom level (also checks "enabled" flag) More...
 
bool isEnabled () const
 Returns whether this style is enabled (used for rendering) More...
 
QgsPalLayerSettings labelSettings () const
 Returns labeling configuration of this style. More...
 
QString layerName () const
 Returns name of the sub-layer to render (empty layer means that all layers match) More...
 
int maxZoomLevel () const
 Returns the maximum zoom level index (negative number means no limit). More...
 
int minZoomLevel () const
 Returns the minimum zoom level index (negative number means no limit). More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads object content from given DOM element. More...
 
void setEnabled (bool enabled)
 Sets whether this style is enabled (used for rendering) More...
 
void setFilterExpression (const QString &expr)
 Sets filter expression (empty filter means that all features match) More...
 
void setGeometryType (Qgis::GeometryType geomType)
 Sets type of the geometry that will be used (point / line / polygon) More...
 
void setLabelSettings (const QgsPalLayerSettings &settings)
 Sets labeling configuration of this style. More...
 
void setLayerName (const QString &name)
 Sets name of the sub-layer to render (empty layer means that all layers match) More...
 
void setMaxZoomLevel (int maxZoom)
 Sets maximum zoom level index (negative number means no limit). More...
 
void setMinZoomLevel (int minZoom)
 Sets minimum zoom level index (negative number means no limit). More...
 
void setStyleName (const QString &name)
 Sets human readable name of this style. More...
 
QString styleName () const
 Returns human readable name of this style. More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const
 Writes object content to given DOM element. More...
 

Detailed Description

Configuration of a single style within QgsVectorTileBasicLabeling.

Since
QGIS 3.14

Definition at line 31 of file qgsvectortilebasiclabeling.h.

Member Function Documentation

◆ filterExpression()

QString QgsVectorTileBasicLabelingStyle::filterExpression ( ) const
inline

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

Definition at line 58 of file qgsvectortilebasiclabeling.h.

◆ geometryType()

Qgis::GeometryType QgsVectorTileBasicLabelingStyle::geometryType ( ) const
inline

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

Definition at line 53 of file qgsvectortilebasiclabeling.h.

◆ isActive()

bool QgsVectorTileBasicLabelingStyle::isActive ( int  zoomLevel) const
inline

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

Definition at line 119 of file qgsvectortilebasiclabeling.h.

◆ isEnabled()

bool QgsVectorTileBasicLabelingStyle::isEnabled ( ) const
inline

Returns whether this style is enabled (used for rendering)

Definition at line 63 of file qgsvectortilebasiclabeling.h.

◆ labelSettings()

QgsPalLayerSettings QgsVectorTileBasicLabelingStyle::labelSettings ( ) const
inline

Returns labeling configuration of this style.

Definition at line 38 of file qgsvectortilebasiclabeling.h.

◆ layerName()

QString QgsVectorTileBasicLabelingStyle::layerName ( ) const
inline

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

Definition at line 48 of file qgsvectortilebasiclabeling.h.

◆ maxZoomLevel()

int QgsVectorTileBasicLabelingStyle::maxZoomLevel ( ) const
inline

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()
minZoomLevel()

Definition at line 115 of file qgsvectortilebasiclabeling.h.

◆ minZoomLevel()

int QgsVectorTileBasicLabelingStyle::minZoomLevel ( ) const
inline

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()
maxZoomLevel()

Definition at line 85 of file qgsvectortilebasiclabeling.h.

◆ readXml()

void QgsVectorTileBasicLabelingStyle::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)

Reads object content from given DOM element.

Definition at line 40 of file qgsvectortilebasiclabeling.cpp.

◆ setEnabled()

void QgsVectorTileBasicLabelingStyle::setEnabled ( bool  enabled)
inline

Sets whether this style is enabled (used for rendering)

Definition at line 61 of file qgsvectortilebasiclabeling.h.

◆ setFilterExpression()

void QgsVectorTileBasicLabelingStyle::setFilterExpression ( const QString &  expr)
inline

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

Definition at line 56 of file qgsvectortilebasiclabeling.h.

◆ setGeometryType()

void QgsVectorTileBasicLabelingStyle::setGeometryType ( Qgis::GeometryType  geomType)
inline

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

Definition at line 51 of file qgsvectortilebasiclabeling.h.

◆ setLabelSettings()

void QgsVectorTileBasicLabelingStyle::setLabelSettings ( const QgsPalLayerSettings settings)
inline

Sets labeling configuration of this style.

Definition at line 36 of file qgsvectortilebasiclabeling.h.

◆ setLayerName()

void QgsVectorTileBasicLabelingStyle::setLayerName ( const QString &  name)
inline

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

Definition at line 46 of file qgsvectortilebasiclabeling.h.

◆ setMaxZoomLevel()

void QgsVectorTileBasicLabelingStyle::setMaxZoomLevel ( int  maxZoom)
inline

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()
setMinZoomLevel()

Definition at line 100 of file qgsvectortilebasiclabeling.h.

◆ setMinZoomLevel()

void QgsVectorTileBasicLabelingStyle::setMinZoomLevel ( int  minZoom)
inline

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()
setMaxZoomLevel()

Definition at line 74 of file qgsvectortilebasiclabeling.h.

◆ setStyleName()

void QgsVectorTileBasicLabelingStyle::setStyleName ( const QString &  name)
inline

Sets human readable name of this style.

Definition at line 41 of file qgsvectortilebasiclabeling.h.

◆ styleName()

QString QgsVectorTileBasicLabelingStyle::styleName ( ) const
inline

Returns human readable name of this style.

Definition at line 43 of file qgsvectortilebasiclabeling.h.

◆ writeXml()

void QgsVectorTileBasicLabelingStyle::writeXml ( QDomElement &  elem,
const QgsReadWriteContext context 
) const

Writes object content to given DOM element.

Definition at line 25 of file qgsvectortilebasiclabeling.cpp.


The documentation for this class was generated from the following files: