Class: QgsMapSettingsUtils

class qgis.core.QgsMapSettingsUtils

Bases: sip.wrapper

Utilities for map settings.

Enums

EffectsCheckFlag

Bases: enum.IntEnum

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 EffectsCheckFlag(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

Flags for controlling the behavior of containsAdvancedEffects()

Added in version 3.14.

  • IgnoreGeoPdfSupportedEffects: Ignore advanced effects which are supported in GeoPDF exports

IgnoreGeoPdfSupportedEffects = 1
class EffectsCheckFlags
class EffectsCheckFlags(f: QgsMapSettingsUtils.EffectsCheckFlags | QgsMapSettingsUtils.EffectsCheckFlag)
class EffectsCheckFlags(a0: QgsMapSettingsUtils.EffectsCheckFlags)

Bases: sip.wrapper

containsAdvancedEffects(mapSettings: QgsMapSettings, flags: QgsMapSettingsUtils.EffectsCheckFlags | QgsMapSettingsUtils.EffectsCheckFlag = QgsMapSettingsUtils.EffectsCheckFlags()) → List[str]

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:
Return type:

List[str]

worldFileContent(mapSettings: QgsMapSettings) → str

Creates the content of a world file.

Parameters:

mapSettings (QgsMapSettings) – map settings

Note

Uses 17 places of precision for all numbers output

Return type:

str

worldFileParameters(mapSettings: QgsMapSettings)

Computes the six parameters of a world file.

Parameters:

mapSettings (QgsMapSettings) -> (float) – map settings

Returns:

  • a: the a parameter

  • b: the b parameter

  • c: the c parameter

  • d: the d parameter

  • e: the e parameter

  • f: the f parameter

Added in version 3.10.