Class: QgsLayoutRenderContext¶

class qgis.core.QgsLayoutRenderContext(layout: QgsLayout)¶

Bases: PyQt5.QtCore.QObject

Constructor for QgsLayoutRenderContext.

Stores information relating to the current rendering settings for a layout.

New in version 3.0: Enums

Methods

`boundingBoxesVisible`	Returns `True` if the item bounding boxes should be drawn.
`childEvent`
`connectNotify`
`currentExportLayer`	Returns the current item layer to draw while exporting.
`customEvent`
`disconnectNotify`
`dpi`	Returns the `dpi` for outputting the layout.
`flags`	Returns the current combination of flags used for rendering the layout.
`gridVisible`	Returns `True` if the page grid should be drawn.
`isPreviewRender`	Returns `True` if the render current being conducted is a preview render, i.e.
`isSignalConnected`
`measurementConverter`	Returns the layout measurement converter to be used in the layout.
`pagesVisible`	Returns whether the page items are be visible in the layout.
`receivers`
`renderContextFlags`	Returns the combination of render context flags matched to the layout context’s settings.
`selectionColor`	Gets color that is used for drawing of selected vector features
`sender`
`senderSignalIndex`
`setBoundingBoxesVisible`	Sets whether the item bounding boxes should be `visible`.
`setCurrentExportLayer`	Sets the current item `layer` to draw while exporting.
`setDpi`	Sets the `dpi` for outputting the layout.
`setFlag`	Enables or disables a particular rendering `flag` for the layout.
`setFlags`	Sets the combination of `flags` that will be used for rendering the layout.
`setGridVisible`	Sets whether the page grid should be `visible`.
`setPagesVisible`	Sets whether the page items should be `visible` in the layout.
`setSelectionColor`	Sets color that is used for drawing of selected vector features
`setTextRenderFormat`	Sets the text render `format`, which dictates how text is rendered (e.g.
`testFlag`	Check whether a particular rendering `flag` is enabled for the layout.
`textRenderFormat`	Returns the text render format, which dictates how text is rendered (e.g.
`timerEvent`

Signals

`dpiChanged`	Emitted when the context’s DPI is changed.
`flagsChanged`	Emitted whenever the context’s `flags` change.

Attributes

`FlagAntialiasing`
`FlagDebug`
`FlagDisableTiledRasterLayerRenders`
`FlagDrawSelection`
`FlagForceVectorOutput`
`FlagHideCoverageLayer`
`FlagOutlineOnly`
`FlagUseAdvancedEffects`

class Flag¶: Bases: int

FlagAntialiasing = 8¶

FlagDebug = 2¶

FlagDisableTiledRasterLayerRenders = 256¶

FlagDrawSelection = 128¶

FlagForceVectorOutput = 32¶

FlagHideCoverageLayer = 64¶

FlagOutlineOnly = 4¶

FlagUseAdvancedEffects = 16¶

class Flags¶

Bases: sip.wrapper

QgsLayoutRenderContext.Flags(Union[QgsLayoutRenderContext.Flags, QgsLayoutRenderContext.Flag]) QgsLayoutRenderContext.Flags(QgsLayoutRenderContext.Flags)

boundingBoxesVisible(self) → bool¶: Returns True if the item bounding boxes should be drawn.

See also

setBoundingBoxesVisible()

childEvent()¶

connectNotify()¶

currentExportLayer(self) → int¶

Returns the current item layer to draw while exporting. QgsLayoutItem subclasses which support multi-layer SVG exports must check this and customize their rendering based on the layer.

If layer is -1, all item layers should be rendered.