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
Returns true if the item bounding boxes should be drawn.
Returns the current item layer to draw while exporting.
Returns the
dpi
for outputting the layout.Returns the current combination of flags used for rendering the layout.
Returns true if the page grid should be drawn.
Returns true if the render current being conducted is a preview render, i.e.
Returns the layout measurement converter to be used in the layout.
Returns whether the page items are be visible in the layout.
Returns the combination of render context flags matched to the layout context’s settings.
Gets color that is used for drawing of selected vector features
Sets whether the item bounding boxes should be
visible
.Sets the current item
layer
to draw while exporting.Sets the
dpi
for outputting the layout.Enables or disables a particular rendering
flag
for the layout.Sets the combination of
flags
that will be used for rendering the layout.Sets whether the page grid should be
visible
.Sets whether the page items should be
visible
in the layout.Sets color that is used for drawing of selected vector features
Sets the text render
format
, which dictates how text is rendered (e.g.Check whether a particular rendering
flag
is enabled for the layout.Returns the text render format, which dictates how text is rendered (e.g.
Signals
Emitted when the context’s DPI is changed.
Emitted whenever the context’s
flags
change.Attributes
-
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
-
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.See also
-
customEvent
()¶
-
disconnectNotify
()¶
-
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
See also
See also
-
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
-
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.
See also
-
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
See also
New in version 3.4.
-
sender
()¶
-
senderSignalIndex
()¶
-
setBoundingBoxesVisible
(self, visible: bool)¶ Sets whether the item bounding boxes should be
visible
.See also
-
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.See also
-
setDpi
(self, dpi: float)¶ Sets the
dpi
for outputting the layout. This also sets the corresponding DPI for the context’s measurementConverter().See also
-
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
See also
See also
-
setFlags
(self, flags: Union[QgsLayoutRenderContext.Flags, QgsLayoutRenderContext.Flag])¶ Sets the combination of
flags
that will be used for rendering the layout.See also
See also
See also
-
setGridVisible
(self, visible: bool)¶ Sets whether the page grid should be
visible
.See also
-
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
-
setSelectionColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets color that is used for drawing of selected vector features
See also
New in version 3.4.
-
setTextRenderFormat
(self, format: QgsRenderContext.TextRenderFormat)¶ Sets the text render
format
, which dictates how text is rendered (e.g. as paths or real text objects).See also
New in version 3.4.3.
-
testFlag
(self, flag: QgsLayoutRenderContext.Flag) → bool¶ Check whether a particular rendering
flag
is enabled for the layout.See also
See also
See also
-
textRenderFormat
(self) → QgsRenderContext.TextRenderFormat¶ Returns the text render format, which dictates how text is rendered (e.g. as paths or real text objects).
See also
New in version 3.4.3.
-
timerEvent
()¶
-
class