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

setSimplifyMethod

Sets the simplification setting to use when rendering vector layers.

setTextRenderFormat

Sets the text render format, which dictates how text is rendered (e.g.

simplifyMethod

Returns the simplification settings to use when rendering vector layers.

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

FlagRenderLabelsByMapLayer

FlagUseAdvancedEffects

class Flag

Bases: int

FlagAntialiasing = 8
FlagDebug = 2
FlagDisableTiledRasterLayerRenders = 256
FlagDrawSelection = 128
FlagForceVectorOutput = 32
FlagHideCoverageLayer = 64
FlagOutlineOnly = 4
FlagRenderLabelsByMapLayer = 512
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.

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.

Deprecated since version Items: should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().

customEvent()
disconnectNotify()
dpi(self) → float

Returns the dpi for outputting the layout.

See also

setDpi()

dpiChanged

Emitted when the context’s DPI is changed. [signal]

flags(self) → QgsLayoutRenderContext.Flags

Returns the current combination of flags used for rendering the layout.

See also

setFlags()

See also

setFlag()

See also

testFlag()

flagsChanged

Emitted whenever the context’s flags change.

See also

setFlags() [signal]

gridVisible(self) → bool

Returns True if the page grid should be drawn.

See also

setGridVisible()

isPreviewRender(self) → bool

Returns True if the render current being conducted is a preview render, i.e. it is being rendered inside a QGraphicsView widget as opposed to a destination device (such as an image).

isSignalConnected()
measurementConverter(self) → QgsLayoutMeasurementConverter

Returns the layout measurement converter to be used in the layout. This converter is used for translating between other measurement units and the layout’s native unit.

pagesVisible(self) → bool

Returns whether the page items are be visible in the layout. This setting effects both display of the page boundaries in layout views and whether they will be rendered in layout exports.

receivers()
renderContextFlags(self) → QgsRenderContext.Flags

Returns the combination of render context flags matched to the layout context’s settings.

selectionColor(self) → QColor

Gets color that is used for drawing of selected vector features

New in version 3.4.

sender()
senderSignalIndex()
setBoundingBoxesVisible(self, visible: bool)

Sets whether the item bounding boxes should be visible.

setCurrentExportLayer(self, layer: int = -1)

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

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

Deprecated since version Items: should now handle this themselves, via QgsLayoutItem.exportLayerBehavior() and returning QgsLayoutItem.nextExportPart().

setDpi(self, dpi: float)

Sets the dpi for outputting the layout. This also sets the corresponding DPI for the context’s measurementConverter().

See also

dpi()

setFlag(self, flag: QgsLayoutRenderContext.Flag, on: bool = True)

Enables or disables a particular rendering flag for the layout. Other existing flags are not affected.

See also

setFlags()

See also

flags()

See also

testFlag()

setFlags(self, flags: Union[QgsLayoutRenderContext.Flags, QgsLayoutRenderContext.Flag])

Sets the combination of flags that will be used for rendering the layout.

See also

setFlag()

See also

flags()

See also

testFlag()

setGridVisible(self, visible: bool)

Sets whether the page grid should be visible.

See also

gridVisible()

setPagesVisible(self, visible: bool)

Sets whether the page items should be visible in the layout. Removing them will prevent both display of the page boundaries in layout views and will also prevent them from being rendered in layout exports.

See also

pagesVisible()

setSelectionColor(self, color: Union[QColor, Qt.GlobalColor])

Sets color that is used for drawing of selected vector features

See also

selectionColor()

New in version 3.4.

setSimplifyMethod(self, method: QgsVectorSimplifyMethod)

Sets the simplification setting to use when rendering vector layers.

If the simplify method is enabled, it apply to all vector layers rendered inside map items.

This can be used to specify global simplification methods to apply during map exports, e.g. to allow vector layers to be simplified to an appropriate maximum level of detail during PDF exports (avoiding excessive PDF size due to huge numbers of vertices).

The default is to use no simplification.

Note

This simplification method is only used during non-preview renders.

See also

simplifyMethod()

New in version 3.10.

setTextRenderFormat(self, format: QgsRenderContext.TextRenderFormat)

Sets the text render format, which dictates how text is rendered (e.g. as paths or real text objects).

New in version 3.4.3.

simplifyMethod(self) → QgsVectorSimplifyMethod

Returns the simplification settings to use when rendering vector layers.

If enabled, it will apply to all vector layers rendered for the map.

The default is to use no simplification.

Note

This simplification method is only used during non-preview renders.

New in version 3.10.

testFlag(self, flag: QgsLayoutRenderContext.Flag) → bool

Check whether a particular rendering flag is enabled for the layout.

See also

setFlags()

See also

setFlag()

See also

flags()

textRenderFormat(self) → QgsRenderContext.TextRenderFormat

Returns the text render format, which dictates how text is rendered (e.g. as paths or real text objects).

New in version 3.4.3.

timerEvent()