Class: QgsLayoutItemMapItemClipPathSettings¶

Contains settings relating to clipping a layout map by another layout item.

Added in version 3.16.

Class Hierarchy¶

Base classes¶

Methods

`clipPathInMapItemCoordinates`	Returns the clipping path geometry, in the map item's coordinate space.
`clippedMapExtent`	Returns the geometry to use for clipping the parent map, in the map item's CRS.
`enabled`	Returns `True` if the map content should be clipped to the associated item.
`featureClippingType`	Returns the feature clipping type to apply when clipping to the associated item.
`finalizeRestoreFromXml`	To be called after all pending items have been restored from XML.
`forceLabelsInsideClipPath`	Returns `True` if labels should only be placed inside the clip path geometry.
`isActive`	Returns `True` if the item clipping is enabled and set to a valid source item.
`readXml`	Sets the setting's state from a DOM document, where element is the DOM node corresponding to a 'LayoutMap' tag.
`setEnabled`	Sets whether the map content should be clipped to the associated item.
`setFeatureClippingType`	Sets the feature clipping type to apply when clipping to the associated item.
`setForceLabelsInsideClipPath`	Sets whether labels should only be placed inside the clip path geometry.
`setSourceItem`	Sets the source item which will provide the clipping path for the map.
`sourceItem`	Returns the source item which will provide the clipping path for the map, or `None` if no item is set.
`toMapClippingRegion`	Returns the clip path as a map clipping region.
`writeXml`	Stores settings in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

Signals

changed

Emitted when the item clipping settings are changed.

class qgis.core.QgsLayoutItemMapItemClipPathSettings[source]¶

Bases: QObject

__init__(map: QgsLayoutItemMap | None = None)

Constructor for QgsLayoutItemMapItemClipPathSettings, with the specified map parent.

Parameters:: map (Optional[QgsLayoutItemMap] = None)

signal changed[source]¶: Emitted when the item clipping settings are changed.

clipPathInMapItemCoordinates(self) → QgsGeometry[source]¶

Returns the clipping path geometry, in the map item’s coordinate space.

Warning

The return path is not in geographic coordinates, rather the map layout item’s QGraphicsItem coordinate space. Use clippedMapExtent() to retrieve the clip path in the map’s CRS.

See also

clippedMapExtent()

Return type:: QgsGeometry

clippedMapExtent(self) → QgsGeometry[source]¶

Returns the geometry to use for clipping the parent map, in the map item’s CRS.

See also

clipPathInMapItemCoordinates()

Return type:: QgsGeometry

enabled(self) → bool[source]¶

Returns True if the map content should be clipped to the associated item.

See also

setEnabled()

Return type:: bool

featureClippingType(self) → QgsMapClippingRegion.FeatureClippingType[source]¶

Returns the feature clipping type to apply when clipping to the associated item.

See also

setFeatureClippingType()

Return type:: QgsMapClippingRegion.FeatureClippingType

finalizeRestoreFromXml(self)[source]¶: To be called after all pending items have been restored from XML.

See also

readXml()

forceLabelsInsideClipPath(self) → bool[source]¶

Returns True if labels should only be placed inside the clip path geometry.

See also

setForceLabelsInsideClipPath()

Return type:: bool

isActive(self) → bool[source]¶

Returns True if the item clipping is enabled and set to a valid source item.

See also

enabled()

See also

sourceItem()

Return type:: bool

readXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

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

See also

writeXml()

See also

finalizeRestoreFromXml()

Parameters:

element (QDomElement)
doc (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool

setEnabled(self, enabled: bool)[source]¶

Sets whether the map content should be clipped to the associated item.

See also

enabled()

Parameters:: enabled (bool)

setFeatureClippingType(self, type: QgsMapClippingRegion.FeatureClippingType)[source]¶

Sets the feature clipping type to apply when clipping to the associated item.

See also

featureClippingType()

Parameters:: type (QgsMapClippingRegion.FeatureClippingType)

setForceLabelsInsideClipPath(self, forceInside: bool)[source]¶

Sets whether labels should only be placed inside the clip path geometry.

See also

forceLabelsInsideClipPath()

Parameters:: forceInside (bool)

setSourceItem(self, item: QgsLayoutItem | None)[source]¶

Sets the source item which will provide the clipping path for the map.

The specified item must return the QgsLayoutItem.FlagProvidesClipPath flag.

See also

sourceItem()

Parameters:: item (Optional[QgsLayoutItem])

sourceItem(self) → QgsLayoutItem | None[source]¶

Returns the source item which will provide the clipping path for the map, or None if no item is set.

See also

setSourceItem()

Return type:: Optional[QgsLayoutItem]

toMapClippingRegion(self) → QgsMapClippingRegion[source]¶

Returns the clip path as a map clipping region.

Return type:: QgsMapClippingRegion

writeXml(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

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