Class: QgsMapSettingsUtils¶

Utilities for map settings.

Classes

Enums

Flags for controlling the behavior of containsAdvancedEffects()

Static Methods

`containsAdvancedEffects`	Checks whether any of the layers attached to a map settings object contain advanced effects.
`worldFileContent`	Creates the content of a world file.
`worldFileParameters`	Computes the six parameters of a world file.

class qgis.core.QgsMapSettingsUtils[source]¶

Bases: object

class EffectsCheckFlag(*values)¶

Bases: IntEnum

Flags for controlling the behavior of containsAdvancedEffects()

Added in version 3.14.

IgnoreGeoPdfSupportedEffects: Ignore advanced effects which are supported in geospatial PDF exports

class EffectsCheckFlags¶
class EffectsCheckFlags(f: QgsMapSettingsUtils.EffectsCheckFlags | QgsMapSettingsUtils.EffectsCheckFlag)
class EffectsCheckFlags(a0: QgsMapSettingsUtils.EffectsCheckFlags): Bases: object

static containsAdvancedEffects(mapSettings: QgsMapSettings, flags: QgsMapSettingsUtils.EffectsCheckFlags | QgsMapSettingsUtils.EffectsCheckFlag = QgsMapSettingsUtils.EffectsCheckFlags()) → list[str][source]¶

Checks whether any of the layers attached to a map settings object contain advanced effects.

The optional flags argument can be used to fine-tune the check behavior.

Parameters:

mapSettings (QgsMapSettings)
flags (Union[QgsMapSettingsUtils.EffectsCheckFlags, QgsMapSettingsUtils.EffectsCheckFlag] = QgsMapSettingsUtils.EffectsCheckFlags())

Return type:

list[str]

static worldFileContent(mapSettings: QgsMapSettings) → str[source]¶

Creates the content of a world file.

Note

Uses 17 places of precision for all numbers output

static worldFileParameters(mapSettings: QgsMapSettings)[source]¶

Computes the six parameters of a world file.

Parameters:

mapSettings (QgsMapSettings) – map settings

Return type:

(float, float, float, float, float, float)

Returns:

Added in version 3.10.