QgsVectorTileBasicLabeling Class Reference

Basic labeling configuration for vector tile layers. More...

#include <qgsvectortilebasiclabeling.h>

Inheritance diagram for QgsVectorTileBasicLabeling:

Public Member Functions
	QgsVectorTileBasicLabeling ()
QgsVectorTileLabeling *	clone () const override SIP_FACTORY
	Returns a new copy of the object. More...
QgsVectorTileLabelProvider *	provider (QgsVectorTileLayer *layer) const override SIP_SKIP
	Factory for label provider implementation. More...
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads labeling properties from given XML element. More...
void	setStyle (int index, const QgsVectorTileBasicLabelingStyle &style)
	Updates style definition at the paricular index of the list (the index must be in interval [0,N-1] otherwise this function does nothing) More...
void	setStyles (const QList< QgsVectorTileBasicLabelingStyle > &styles)
	Sets list of styles of the renderer. More...
QgsVectorTileBasicLabelingStyle	style (int index) const
	Returns style definition at the particular index. More...
QList< QgsVectorTileBasicLabelingStyle >	styles () const
	Returns list of styles of the renderer. More...
QString	type () const override
	Unique type string of the labeling configuration implementation. More...
void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
	Writes labeling properties to given XML element. More...
Public Member Functions inherited from QgsVectorTileLabeling
virtual	~QgsVectorTileLabeling ()=default
virtual void	resolveReferences (const QgsProject &project)
	Resolves references to other objects - second phase of loading - after readXml() More...

Detailed Description

Basic labeling configuration for vector tile layers.

It contains a definition of a list of labeling styles, where each labeling style is a combination of sub-layer name, geometry type, filter expression, zoom range and label settings.

Since

QGIS 3.14

Definition at line 107 of file qgsvectortilebasiclabeling.h.

Constructor & Destructor Documentation

QgsVectorTileBasicLabeling()

QgsVectorTileBasicLabeling::QgsVectorTileBasicLabeling

(

)

Definition at line 59 of file qgsvectortilebasiclabeling.cpp.

Member Function Documentation

clone()

QgsVectorTileLabeling * QgsVectorTileBasicLabeling::clone ( ) const

overridevirtual

Returns a new copy of the object.

Implements QgsVectorTileLabeling.

Definition at line 68 of file qgsvectortilebasiclabeling.cpp.

provider()

QgsVectorTileLabelProvider * QgsVectorTileBasicLabeling::provider ( QgsVectorTileLayer *  layer ) const

overridevirtual

Factory for label provider implementation.

Note

not available in Python bindings

Reimplemented from QgsVectorTileLabeling.

Definition at line 75 of file qgsvectortilebasiclabeling.cpp.

readXml()

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

overridevirtual

Reads labeling properties from given XML element.

Implements QgsVectorTileLabeling.

Definition at line 93 of file qgsvectortilebasiclabeling.cpp.

setStyle()

void QgsVectorTileBasicLabeling::setStyle ( int  index, const QgsVectorTileBasicLabelingStyle &  style  )

inline

Updates style definition at the paricular index of the list (the index must be in interval [0,N-1] otherwise this function does nothing)

Definition at line 123 of file qgsvectortilebasiclabeling.h.

setStyles()

void QgsVectorTileBasicLabeling::setStyles ( const QList< QgsVectorTileBasicLabelingStyle > &  styles )

inline

Sets list of styles of the renderer.

Definition at line 119 of file qgsvectortilebasiclabeling.h.

style()

QgsVectorTileBasicLabelingStyle QgsVectorTileBasicLabeling::style ( int  index ) const

inline

Returns style definition at the particular index.

Definition at line 125 of file qgsvectortilebasiclabeling.h.

styles()

QList<QgsVectorTileBasicLabelingStyle> QgsVectorTileBasicLabeling::styles ( ) const

inline

Returns list of styles of the renderer.

Definition at line 121 of file qgsvectortilebasiclabeling.h.

type()

QString QgsVectorTileBasicLabeling::type ( ) const

overridevirtual

Unique type string of the labeling configuration implementation.

Implements QgsVectorTileLabeling.

Definition at line 63 of file qgsvectortilebasiclabeling.cpp.

writeXml()

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

overridevirtual

Writes labeling properties to given XML element.

Implements QgsVectorTileLabeling.

Definition at line 80 of file qgsvectortilebasiclabeling.cpp.

---

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

• /build/qgis-3.22.4+99unstable/src/core/vectortile/qgsvectortilebasiclabeling.h
• /build/qgis-3.22.4+99unstable/src/core/vectortile/qgsvectortilebasiclabeling.cpp