Class: QgsLayoutReportContext¶
-
class
qgis.core.
QgsLayoutReportContext
(layout: QgsLayout)¶ Bases:
PyQt5.QtCore.QObject
Constructor for QgsLayoutReportContext.
Stores information relating to the current reporting context for a layout.
New in version 3.0: Enums
Methods
Returns the current feature() geometry in the given
crs
.Returns the current feature for evaluating the layout.
Returns the vector layer associated with the layout’s context.
Returns the current list of predefined scales for use with the layout.
Sets the current
feature
for evaluating the layout.Sets the vector
layer
associated with the layout’s context.Sets the list of predefined
scales
to use with the layout.Signals
Emitted certain settings in the context is changed, e.g.
Emitted when the context’s
layer
is changed.Attributes
-
changed
¶ Emitted certain settings in the context is changed, e.g. by setting a new feature or vector layer for the context. [signal]
-
childEvent
()¶
-
connectNotify
()¶
-
currentGeometry
(self, crs: QgsCoordinateReferenceSystem = QgsCoordinateReferenceSystem()) → QgsGeometry¶ Returns the current feature() geometry in the given
crs
. If no CRS is specified, the original feature geometry is returned.Reprojection only works if a valid layer is set for layer().
See also
See also
-
customEvent
()¶
-
disconnectNotify
()¶
-
feature
(self) → QgsFeature¶ Returns the current feature for evaluating the layout. This feature may be used for altering an item’s content and appearance for a report or atlas layout.
See also
See also
-
isSignalConnected
()¶
-
layer
(self) → QgsVectorLayer¶ Returns the vector layer associated with the layout’s context.
See also
-
layerChanged
¶ Emitted when the context’s
layer
is changed. [signal]
-
predefinedScales
(self) → List[float]¶ Returns the current list of predefined scales for use with the layout.
See also
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setFeature
(self, feature: QgsFeature)¶ Sets the current
feature
for evaluating the layout. This feature may be used for altering an item’s content and appearance for a report or atlas layout.Emits the changed() signal.
See also
-
setLayer
(self, layer: QgsVectorLayer)¶ Sets the vector
layer
associated with the layout’s context.Emits the changed() signal.
See also
-
setPredefinedScales
(self, scales: Iterable[float])¶ Sets the list of predefined
scales
to use with the layout. This is used for maps which are set to the predefined atlas scaling mode.See also
-
timerEvent
()¶
-