Class: QgsMeshLayerSimpleLabeling

class qgis.core.QgsMeshLayerSimpleLabeling

Bases: QgsAbstractMeshLayerLabeling

Basic implementation of the labeling interface for mesh layer.

Added in version 3.36.

QgsMeshLayerSimpleLabeling(settings: QgsPalLayerSettings, labelFaces: bool = False) Constructs simple labeling configuration with given initial settings. Labels are placed on mesh vertices unless labelFaces is True, when they are placed on mesh faces.

Methods

accept

param visitor:

clone

rtype:

Optional[QgsMeshLayerSimpleLabeling]

create

Create the instance from a DOM element with saved configuration

multiplyOpacity

param opacityFactor:

requiresAdvancedEffects

rtype:

bool

save

param doc:

setSettings

Set pal settings (takes ownership).

settings

param providerId:

type

rtype:

str

accept(self, visitor: QgsStyleEntityVisitorInterface | None) bool
Parameters:

visitor (Optional[QgsStyleEntityVisitorInterface])

Return type:

bool

clone(self) QgsMeshLayerSimpleLabeling | None
Return type:

Optional[QgsMeshLayerSimpleLabeling]

create(element: QDomElement, context: QgsReadWriteContext) QgsMeshLayerSimpleLabeling | None

Create the instance from a DOM element with saved configuration

Parameters:
Return type:

Optional[QgsMeshLayerSimpleLabeling]

multiplyOpacity(self, opacityFactor: float)
Parameters:

opacityFactor (float)

requiresAdvancedEffects(self) bool
Return type:

bool

save(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement
Parameters:
Return type:

QDomElement

setSettings(self, settings: QgsPalLayerSettings | None, providerId: str | None = '')

Set pal settings (takes ownership).

Parameters:
  • settings (Optional[QgsPalLayerSettings]) – Pal layer settings

  • providerId (Optional[str] = '') – Unused parameter

settings(self, providerId: str | None = '') QgsPalLayerSettings
Parameters:

providerId (Optional[str] = '')

Return type:

QgsPalLayerSettings

type(self) str
Return type:

str