Class: QgsLayoutItemMapAtlasClippingSettings¶
-
class
qgis.core.
QgsLayoutItemMapAtlasClippingSettings
(map: QgsLayoutItemMap = None)¶ Bases:
PyQt5.QtCore.QObject
Constructor for
QgsLayoutItemMapAtlasClippingSettings
, with the specifiedmap
parent.Contains settings relating to clipping a layout map by the current atlas feature.
New in version 3.16.
- Parameters
map –
-
changed
¶ Emitted when the atlas clipping settings are changed. [signal]
-
childEvent
(self, QChildEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
customEvent
(self, QEvent)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
enabled
(self) → bool¶ Returns
True
if the map content should be clipped to the current atlas feature.See also
- Return type
bool
-
featureClippingType
(self) → QgsMapClippingRegion.FeatureClippingType¶ Returns the feature clipping type to apply when clipping to the current atlas feature.
See also
- Return type
-
forceLabelsInsideFeature
(self) → bool¶ Returns
True
if labels should only be placed inside the atlas feature geometry.See also
- Return type
bool
-
isSignalConnected
(self, QMetaMethod) → 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()
isTrue
.See also
See also
- 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
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
-
receivers
(self, PYQT_SIGNAL) → int¶
-
restrictToLayers
(self) → bool¶ Returns
True
if clipping should be restricted to a subset of layers.See also
See also
- Return type
bool
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setEnabled
(self, enabled: bool)¶ Sets whether the map content should be clipped to the current atlas feature.
See also
- Parameters
enabled (bool) –
-
setFeatureClippingType
(self, type: QgsMapClippingRegion.FeatureClippingType)¶ Sets the feature clipping
type
to apply when clipping to the current atlas feature.See also
- Parameters
-
setForceLabelsInsideFeature
(self, forceInside: bool)¶ Sets whether labels should only be placed inside the atlas feature geometry.
See also
- 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()
isTrue
.See also
See also
- Parameters
layers (Iterable[QgsMapLayer]) –
-
setRestrictToLayers
(self, enabled: bool)¶ Sets whether clipping should be restricted to a subset of layers.
See also
See also
- Parameters
enabled (bool) –
-
timerEvent
(self, QTimerEvent)¶
-
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
- Parameters
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool