Class: QgsLabelingEngineSettings

class qgis.core.QgsLabelingEngineSettings

Bases: sip.wrapper

Stores global configuration for labeling engine

New in version 3.0: Enums

Methods

clear Returns the configuration to the defaults
defaultTextRenderFormat Returns the default text rendering format for the labels.
flags Gets flags of the labeling engine
numCandidatePositions Gets number of candidate positions that will be generated for each label feature (default to 8)
readSettingsFromProject Read configuration of the labeling engine from a project
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
setNumCandidatePositions Sets number of candidate positions that will be generated for each label feature
setSearchMethod Sets which search method to use for removal collisions between labels
testFlag Test whether a particular flag is enabled
writeSettingsToProject Write configuration of the labeling engine to a project

Signals

Attributes

Chain
DrawCandidates
DrawLabelRectOnly
Falp
Popmusic_Chain
Popmusic_Tabu
Popmusic_Tabu_Chain
RenderOutlineLabels
UseAllLabels
UsePartialCandidates
Chain = 0
DrawCandidates = 32
DrawLabelRectOnly = 16
Falp = 4
class Flag

Bases: int

class Flags

Bases: sip.wrapper

QgsLabelingEngineSettings.Flags(Union[QgsLabelingEngineSettings.Flags, QgsLabelingEngineSettings.Flag]) QgsLabelingEngineSettings.Flags(QgsLabelingEngineSettings.Flags)

Popmusic_Chain = 2
Popmusic_Tabu = 1
Popmusic_Tabu_Chain = 3
RenderOutlineLabels = 8
class Search

Bases: int

UseAllLabels = 2
UsePartialCandidates = 4
clear(self)

Returns the configuration to the defaults

defaultTextRenderFormat(self) → QgsRenderContext.TextRenderFormat

Returns the default text rendering format for the labels.

New in version 3.4.3.

flags(self) → QgsLabelingEngineSettings.Flags

Gets flags of the labeling engine

numCandidatePositions(self) → Tuple[int, int, int]

Gets number of candidate positions that will be generated for each label feature (default to 8)

readSettingsFromProject(self, project: QgsProject)

Read configuration of the labeling engine from a project

searchMethod(self) → QgsLabelingEngineSettings.Search

Which search method to use for removal collisions between labels

setDefaultTextRenderFormat(self, format: QgsRenderContext.TextRenderFormat)

Sets the default text rendering format for the labels.

New in version 3.4.3.

setFlag(self, f: QgsLabelingEngineSettings.Flag, enabled: bool = True)

Sets whether a particual flag is enabled

setFlags(self, flags: Union[QgsLabelingEngineSettings.Flags, QgsLabelingEngineSettings.Flag])

Sets flags of the labeling engine

setNumCandidatePositions(self, candPoint: int, candLine: int, candPolygon: int)

Sets number of candidate positions that will be generated for each label feature

setSearchMethod(self, s: QgsLabelingEngineSettings.Search)

Sets which search method to use for removal collisions between labels

testFlag(self, f: QgsLabelingEngineSettings.Flag) → bool

Test whether a particular flag is enabled

writeSettingsToProject(self, project: QgsProject)

Write configuration of the labeling engine to a project