Class: QgsLayoutItemMapAtlasClippingSettings¶
- class qgis.core.QgsLayoutItemMapAtlasClippingSettings¶
Bases:
PyQt5.QtCore.QObject
Contains settings relating to clipping a layout map by the current atlas feature.
New in version 3.16.
QgsLayoutItemMapAtlasClippingSettings(map:
QgsLayoutItemMap
= None) Constructor forQgsLayoutItemMapAtlasClippingSettings
, with the specifiedmap
parent.Methods
Returns
True
if the map content should be clipped to the current atlas feature.Returns the feature clipping type to apply when clipping to the current atlas feature.
Returns
True
if labels should only be placed inside the atlas feature geometry.Returns the list of map layers to clip to the atlas feature.
Sets the setting's state from a DOM document, where
element
is the DOM node corresponding to a 'LayoutMap' tag.Returns
True
if clipping should be restricted to a subset of layers.Sets whether the map content should be clipped to the current atlas feature.
Sets the feature clipping
type
to apply when clipping to the current atlas feature.Sets whether labels should only be placed inside the atlas feature geometry.
Sets the list of map
layers
to clip to the atlas feature.Sets whether clipping should be restricted to a subset of layers.
Stores settings in a DOM element, where
element
is the DOM element corresponding to a 'LayoutMap' tag.Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- changed¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_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