Class: QgsLabelingEngineSettings¶

Stores global configuration for labeling engine.

Enums

`Flag`	alias of `LabelingFlag`
`PlacementEngineVersion`	alias of `LabelPlacementEngineVersion`

Methods

`addRule`	Adds a labeling engine rule which must be satisfied while placing labels.
`clear`	Returns the configuration to the defaults
`defaultTextRenderFormat`	Returns the default text rendering format for the labels.
`flags`	Gets flags of the labeling engine
`maximumLineCandidatesPerCm`	Returns the maximum number of line label candidate positions per centimeter.
`maximumPolygonCandidatesPerCmSquared`	Returns the maximum number of polygon label candidate positions per centimeter squared.
`numCandidatePositions`	Gets number of candidate positions that will be generated for each label feature.
`placementVersion`	Returns the placement engine version, which dictates how the label placement problem is solved.
`readSettingsFromProject`	Read configuration of the labeling engine from a project
`readXml`	Reads the label engine settings from an XML element.
`resolveReferences`	Resolves reference to layers from stored layer ID.
`rules`	Returns a list of labeling engine rules which must be satisfied while placing labels.
`searchMethod`	Which search method to use for removal collisions between labels
`setDefaultTextRenderFormat`	Sets the default text rendering format for the labels.
`setFlag`	Sets whether a particual flag is enabled
`setFlags`	Sets flags of the labeling engine
`setMaximumLineCandidatesPerCm`	Sets the maximum number of line label candidates per centimeter.
`setMaximumPolygonCandidatesPerCmSquared`	Sets the maximum number of polygon label candidates per centimeter squared.
`setNumCandidatePositions`	Sets the number of candidate positions that will be generated for each label feature.
`setPlacementVersion`	Sets the placement engine version, which dictates how the label placement problem is solved.
`setRules`	Sets the labeling engine rules which must be satisfied while placing labels.
`setSearchMethod`	Used to set which search method to use for removal collisions between labels
`setUnplacedLabelColor`	Sets the color to use when rendering unplaced labels.
`testFlag`	Test whether a particular flag is enabled
`unplacedLabelColor`	Returns the color to use when rendering unplaced labels.
`writeSettingsToProject`	Write configuration of the labeling engine to a project.
`writeXml`	Writes the label engine settings to an XML element.

Attributes

`Chain`
`Falp`
`Popmusic_Chain`
`Popmusic_Tabu`
`Popmusic_Tabu_Chain`

class qgis.core.QgsLabelingEngineSettings[source]¶

Bases: object

Chain = 0¶

Falp = 4¶

Flag¶: alias of LabelingFlag

Flags¶: alias of LabelingFlags

PlacementEngineVersion¶: alias of LabelPlacementEngineVersion

Popmusic_Chain = 2¶

Popmusic_Tabu = 1¶

Popmusic_Tabu_Chain = 3¶

class Search¶: Bases: int

addRule(self, rule: QgsAbstractLabelingEngineRule | None)[source]¶

Adds a labeling engine rule which must be satisfied while placing labels.

Ownership of the rule is transferred to the settings.

See also

rules()

See also

setRules()

Added in version 3.40.

Parameters:: rule (Optional[QgsAbstractLabelingEngineRule])

clear(self)[source]¶: Returns the configuration to the defaults

defaultTextRenderFormat(self) → Qgis.TextRenderFormat[source]¶

Returns the default text rendering format for the labels.

See also

setDefaultTextRenderFormat()

Added in version 3.4.3.

Return type:: Qgis.TextRenderFormat

flags(self) → Qgis.LabelingFlags[source]¶

Gets flags of the labeling engine

Return type:: Qgis.LabelingFlags

maximumLineCandidatesPerCm(self) → float[source]¶

Returns the maximum number of line label candidate positions per centimeter.

See also

setMaximumLineCandidatesPerCm()

Added in version 3.12.

Return type:: float

maximumPolygonCandidatesPerCmSquared(self) → float[source]¶

Returns the maximum number of polygon label candidate positions per centimeter squared.

Added in version 3.12.

Return type:: float

numCandidatePositions(self)[source]¶: Gets number of candidate positions that will be generated for each label feature.

Deprecated since version 3.12: Use maximumPolygonCandidatesPerCmSquared() and maximumLineCandidatesPerCm() instead.