Class: QgsLayoutItemMapAtlasClippingSettings

Contains settings relating to clipping a layout map by the current atlas feature.

Added in version 3.16.

Class Hierarchy

Base classes

QObject

Methods

enabled	Returns True if the map content should be clipped to the current atlas feature.
featureClippingType	Returns the feature clipping type to apply when clipping to the current atlas feature.
forceLabelsInsideFeature	Returns True if labels should only be placed inside the atlas feature geometry.
layersToClip	Returns the list of map layers to clip to the atlas feature.
readXml	Sets the setting's state from a DOM document, where element is the DOM node corresponding to a 'LayoutMap' tag.
restrictToLayers	Returns True if clipping should be restricted to a subset of layers.
setEnabled	Sets whether the map content should be clipped to the current atlas feature.
setFeatureClippingType	Sets the feature clipping type to apply when clipping to the current atlas feature.
setForceLabelsInsideFeature	Sets whether labels should only be placed inside the atlas feature geometry.
setLayersToClip	Sets the list of map layers to clip to the atlas feature.
setRestrictToLayers	Sets whether clipping should be restricted to a subset of layers.
writeXml	Stores settings in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

Signals

changed

Emitted when the atlas clipping settings are changed.

class qgis.core.QgsLayoutItemMapAtlasClippingSettings

Bases: QObject

__init__(map: QgsLayoutItemMap | None = None)

Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified map parent.

Parameters:

map (Optional[QgsLayoutItemMap] = None)

signal changed

Emitted when the atlas clipping settings are changed.

enabled(self) → bool

Returns True if the map content should be clipped to the current atlas feature.

See also

setEnabled()

Return type:

bool

featureClippingType(self) → QgsMapClippingRegion.FeatureClippingType

Returns the feature clipping type to apply when clipping to the current atlas feature.

See also

setFeatureClippingType()

Return type:

QgsMapClippingRegion.FeatureClippingType

forceLabelsInsideFeature(self) → bool

Returns True if labels should only be placed inside the atlas feature geometry.

See also

setForceLabelsInsideFeature()

Return type:

bool

layersToClip(self) → List[QgsMapLayer]

Returns the list of map layers to clip to the atlas feature.

Note

This setting is only used if restrictToLayers() is True.

See also

restrictToLayers()

See also

setLayersToClip()

Return type:

List[QgsMapLayer]

readXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool

Sets the setting’s state from a DOM document, where element is the DOM node corresponding to a ‘LayoutMap’ tag.

See also

writeXml()

Parameters:

• element (QDomElement)

• doc (QDomDocument)

• context (QgsReadWriteContext)

Return type:

bool

restrictToLayers(self) → bool

Returns True if clipping should be restricted to a subset of layers.

See also

layersToClip()

See also

setRestrictToLayers()

Return type:

bool

setEnabled(self, enabled: bool)

Sets whether the map content should be clipped to the current atlas feature.

See also

enabled()

Parameters:

enabled (bool)

setFeatureClippingType(self, type: QgsMapClippingRegion.FeatureClippingType)

Sets the feature clipping type to apply when clipping to the current atlas feature.

See also

featureClippingType()

Parameters:

type (QgsMapClippingRegion.FeatureClippingType)

setForceLabelsInsideFeature(self, forceInside: bool)

Sets whether labels should only be placed inside the atlas feature geometry.

See also

forceLabelsInsideFeature()

Parameters:

forceInside (bool)

setLayersToClip(self, layers: Iterable[QgsMapLayer])

Sets the list of map layers to clip to the atlas feature.

Note

This setting is only used if restrictToLayers() is True.

See also

restrictToLayers()

See also

layersToClip()

Parameters:

layers (Iterable[QgsMapLayer])

setRestrictToLayers(self, enabled: bool)

Sets whether clipping should be restricted to a subset of layers.

See also

setLayersToClip()

See also

restrictToLayers()

Parameters:

enabled (bool)

writeXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

Stores settings in a DOM element, where element is the DOM element corresponding to a ‘LayoutMap’ tag.

See also

readXml()

Parameters:

• element (QDomElement)

• document (QDomDocument)

• context (QgsReadWriteContext)

Return type:

bool