Class: QgsLayoutReportContext¶

Stores information relating to the current reporting context for a layout.

Class Hierarchy¶

Base classes¶

Methods

`currentGeometry`	Returns the current `feature()` geometry in the given crs.
`feature`	Returns the current feature for evaluating the layout.
`layer`	Returns the vector layer associated with the layout's context.
`predefinedScales`	Returns the current list of predefined scales for use with the layout.
`setFeature`	Sets the current feature for evaluating the layout.
`setLayer`	Sets the vector layer associated with the layout's context.
`setPredefinedScales`	Sets the list of predefined scales to use with the layout.

Signals

`changed`	Emitted certain settings in the context is changed, e.g. by setting a new feature or vector layer for the context.
`layerChanged`	Emitted when the context's layer is changed.

class qgis.core.QgsLayoutReportContext[source]¶

Bases: QObject

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutReportContext.

Parameters:: layout (Optional[QgsLayout])

signal changed[source]¶: Emitted certain settings in the context is changed, e.g. by setting a new feature or vector layer for the context.

currentGeometry(self, crs: QgsCoordinateReferenceSystem = QgsCoordinateReferenceSystem()) → QgsGeometry[source]¶

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

feature()

See also

layer()

Parameters:: crs (QgsCoordinateReferenceSystem = QgsCoordinateReferenceSystem())
Return type:: QgsGeometry

feature(self) → QgsFeature[source]¶

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

currentGeometry()

See also

setFeature()

Return type:: QgsFeature

layer(self) → QgsVectorLayer | None[source]¶

Returns the vector layer associated with the layout’s context.

See also

setLayer()

Return type:: Optional[QgsVectorLayer]

signal layerChanged(layer: QgsVectorLayer)[source]¶

Emitted when the context’s layer is changed.

Parameters:: layer (QgsVectorLayer)

predefinedScales(self) → List[float]¶

Returns the current list of predefined scales for use with the layout.

See also

setPredefinedScales()

Deprecated since version 3.40: Use QgsLayoutRenderContext.predefinedScales().

Return type:: List[float]

setFeature(self, feature: QgsFeature)[source]¶

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

feature()