Class: QgsLayoutItem¶
- class qgis.core.QgsLayoutItem¶
Bases:
QgsLayoutObject
,PyQt5.QtWidgets.QGraphicsRectItem
,QgsLayoutUndoObjectInterface
Base class for graphical items within a
QgsLayout
.New in version 3.0.
QgsLayoutItem(layout:
QgsLayout
, manageZValue: bool = True) Constructor forQgsLayoutItem
, with the specified parentlayout
.If
manageZValue
isTrue
, the z-Value of this item will be managed by the layout. Generally this is the desired behavior.Methods
Accepts the specified style entity
visitor
, causing it to visit all style entities associated with the layout item.Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.Applies any present data defined size overrides to the specified layout
size
.Applies any item-specific size constraint handling to a given
targetSize
in layout units.Attempts to move the item to a specified
point
.Attempts to shift the item's position by a specified
deltaX
anddeltaY
, in layout units.Attempts to resize the item to a specified target
size
.Attempts to update the item's position and size to match the passed
rect
in layout coordinates.Returns the background color for this item.
Starts new undo command for this item.
Returns the item's composition blending mode.
Cancels the current item command and discards it.
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
Returns the clipping path generated by this item, in layout coordinates.
Returns
True
if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item.- param text:
- rtype:
QgsExpressionContext
Gets item display name.
Draws the item's contents using the specified item render
context
.Draws the background for the item.
Draws a debugging rectangle of the item's current bounds within the specified painter.
Draws the frame around the item.
Draws a "refreshing" overlay icon on the item.
Completes the current item command and push it onto the layout's undo stack.
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
Returns whether the item should be excluded from layout exports and prints.
Returns the behavior of this item during exporting to layered exports (e.g.
Returns the details for the specified current export layer.
Called after all pending items have been restored from XML.
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.
Returns
True
if the item includes a frame.Returns the join style used for drawing the item's frame.
Returns the path to use when drawing the item's frame or background.
Returns the frame's stroke color.
Returns the frame's stroke width.
Returns
True
if the item has a background.Returns the item's icon.
Returns the item's ID name.
Forces a deferred update of any cached image the item uses.
Returns
True
if the item is part of aQgsLayoutItemGroup
group.Returns
True
if the item is locked, and cannot be interacted with using the mouse.Returns
True
if the item is currently refreshing content in the background.Returns the item's flags, which indicate how the item behaves.
Returns the item's opacity.
Returns the current rotation for the item, in degrees clockwise.
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.
Moves the content of the item, by a specified
dx
anddy
in layout units.Moves to the next export part for a multi-layered export item, during a multi-layered export.
Returns the number of layers that this item requires for exporting during layered exports (e.g.
Returns the page the item is currently on, with the first page returning 0.
Returns the item's position (in layout units) relative to the top left corner of its current page.
Returns the item's position (in item units) relative to the top left corner of its current page.
Handles preparing a paint surface for the layout item and painting the item's content.
Returns the item's parent group, if the item is part of a
QgsLayoutItemGroup
group.Returns the current position (in layout units) of a
reference
point for the item.Returns the item's current position, including units.
Sets object properties from a DOM element
Sets item state from a DOM element.
Sets the item state from a DOM element.
Returns the item's rectangular bounds, including any bleed caused by the item's frame.
Triggers a redraw (update) of the item.
Returns the reference point for positioning of the layout item.
Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size.
Refresh item's background color, considering data defined colors.
Refresh item's blend mode, considering data defined blend mode.
Refreshes a data defined
property
for the item by reevaluating the property's value and redrawing the item with this new value.Refresh item's frame, considering data defined colors and frame size.
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning.
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation.
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.
Refresh item's opacity, considering data defined opacity.
Returns
True
if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats.Rotates the item by a specified
angle
in degrees clockwise around a specified reference point.Sets the background
color
for this item.Sets whether this item has a background drawn under it or not.
Sets the item's composition blending
mode
.Sets whether the item should be excluded from layout exports and prints.
Sets a fixed
size
for the layout item, which prevents it from being freely resized.Sets whether this item has a frame drawn around it or not.
Sets the join
style
used when drawing the item's frame.Sets the frame stroke
color
.Sets the frame stroke
width
.Set the item's
id
name.Sets the item's
opacity
.Sets the layout item's
rotation
, in degrees clockwise.Sets whether the item is
locked
, preventing mouse interactions with the item.Sets the minimum allowed
size
for the layout item.Sets temporary offset for the item, by a specified
dx
anddy
in layout units.Sets the item's parent
group
.Sets the reference
point
for positioning of the layout item.Sets whether the item should be selected.
Sets whether the item is
visible
.Returns whether the item should be drawn in the current context.
Returns the item's current size, including units.
Starts a multi-layer export operation.
Stops a multi-layer export operation.
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.Returns a unique graphics item type identifier.
Returns the item identification string.
Stores object properties within an XML DOM element.
Stores item state within an XML DOM element.
Stores the item state in a DOM element.
Zooms content of item.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
Attributes
- CanGroupWithAnyOtherItem = 0¶
- CanGroupWithItemsOfSameType = 1¶
- class ExportLayerBehavior¶
Bases:
int
- class ExportLayerDetail¶
- class ExportLayerDetail(QgsLayoutItem.ExportLayerDetail)
Bases:
sip.wrapper
- compositionMode¶
- mapLayerId¶
- mapTheme¶
- name¶
- opacity¶
- class Flag¶
Bases:
int
- FlagOverridesPaint = 2¶
- FlagProvidesClipPath = 4¶
- class Flags¶
- class Flags(Union[QgsLayoutItem.Flags, QgsLayoutItem.Flag])
- class Flags(QgsLayoutItem.Flags)
Bases:
sip.wrapper
- ItemContainsSubLayers = 3¶
- LowerLeft = 6¶
- LowerMiddle = 7¶
- LowerRight = 8¶
- Middle = 4¶
- MiddleLeft = 3¶
- MiddleRight = 5¶
- MustPlaceInOwnLayer = 2¶
- class ReferencePoint¶
Bases:
int
- UndoArrowHeadFillColor = 80¶
- UndoArrowHeadStrokeColor = 81¶
- UndoArrowHeadWidth = 79¶
- UndoArrowStrokeWidth = 78¶
- UndoAtlasMargin = 16¶
- UndoBackgroundColor = 5¶
- class UndoCommand¶
Bases:
int
- UndoCustomCommand = 99¶
- UndoElevationProfileChartBackground = 83¶
- UndoElevationProfileChartBorder = 84¶
- UndoElevationProfileDistanceFont = 88¶
- UndoElevationProfileDistanceFormat = 87¶
- UndoElevationProfileDistanceLabels = 89¶
- UndoElevationProfileDistanceMajorGridlines = 85¶
- UndoElevationProfileDistanceMinorGridlines = 86¶
- UndoElevationProfileElevationFont = 93¶
- UndoElevationProfileElevationFormat = 92¶
- UndoElevationProfileElevationLabels = 94¶
- UndoElevationProfileElevationMajorGridlines = 90¶
- UndoElevationProfileElevationMinorGridlines = 91¶
- UndoElevationProfileMaximumDistance = 96¶
- UndoElevationProfileMaximumElevation = 98¶
- UndoElevationProfileMinimumDistance = 95¶
- UndoElevationProfileMinimumElevation = 97¶
- UndoElevationProfileTolerance = 82¶
- UndoGridFramePenColor = 20¶
- UndoIncrementalMove = 1¶
- UndoIncrementalResize = 2¶
- UndoLabelFont = 35¶
- UndoLabelFontColor = 37¶
- UndoLabelMargin = 36¶
- UndoLabelText = 34¶
- UndoLegendBoxSpace = 54¶
- UndoLegendColumnCount = 39¶
- UndoLegendColumnSpace = 55¶
- UndoLegendFontColor = 53¶
- UndoLegendGroupFont = 60¶
- UndoLegendGroupIndent = 48¶
- UndoLegendGroupSpace = 47¶
- UndoLegendIconSymbolSpace = 52¶
- UndoLegendItemFont = 62¶
- UndoLegendLayerFont = 61¶
- UndoLegendLayerSpace = 50¶
- UndoLegendLineSpacing = 56¶
- UndoLegendMaxSymbolSize = 42¶
- UndoLegendMinSymbolSize = 43¶
- UndoLegendRasterStrokeColor = 58¶
- UndoLegendRasterStrokeWidth = 57¶
- UndoLegendSubgroupIndent = 49¶
- UndoLegendSymbolHeight = 41¶
- UndoLegendSymbolSpace = 51¶
- UndoLegendSymbolWidth = 40¶
- UndoLegendText = 38¶
- UndoLegendTitleFont = 59¶
- UndoLegendTitleSpaceBottom = 46¶
- UndoLegendWmsLegendHeight = 45¶
- UndoLegendWmsLegendWidth = 44¶
- UndoMapAnnotationDistance = 23¶
- UndoMapGridAnnotationFontColor = 24¶
- UndoMapGridFrameFill1Color = 21¶
- UndoMapGridFrameFill2Color = 22¶
- UndoMapGridIntervalRange = 27¶
- UndoMapGridLineSymbol = 25¶
- UndoMapGridMarkerSymbol = 26¶
- UndoMapLabelMargin = 28¶
- UndoMapRotation = 17¶
- UndoMarginBottom = 9¶
- UndoMarginLeft = 7¶
- UndoMarginRight = 10¶
- UndoMarginTop = 8¶
- UndoNodeMove = 15¶
- UndoNone = -1¶
- UndoOpacity = 6¶
- UndoOverviewStyle = 19¶
- UndoPictureFillColor = 30¶
- UndoPictureNorthOffset = 33¶
- UndoPictureRotation = 29¶
- UndoPictureStrokeColor = 31¶
- UndoPictureStrokeWidth = 32¶
- UndoRotation = 12¶
- UndoScaleBarBoxContentSpace = 77¶
- UndoScaleBarFillColor = 71¶
- UndoScaleBarFillColor2 = 72¶
- UndoScaleBarFontColor = 70¶
- UndoScaleBarHeight = 67¶
- UndoScaleBarLabelBarSize = 76¶
- UndoScaleBarLineWidth = 63¶
- UndoScaleBarMapUnitsSegment = 75¶
- UndoScaleBarSegmentSize = 64¶
- UndoScaleBarSegments = 66¶
- UndoScaleBarSegmentsLeft = 65¶
- UndoScaleBarStrokeColor = 73¶
- UndoScaleBarSubdivisions = 68¶
- UndoScaleBarSubdivisionsHeight = 69¶
- UndoScaleBarUnitText = 74¶
- UndoSetId = 11¶
- UndoShapeCornerRadius = 14¶
- UndoShapeStyle = 13¶
- UndoStrokeColor = 3¶
- UndoStrokeWidth = 4¶
- UndoZoomContent = 18¶
- UpperLeft = 0¶
- UpperMiddle = 1¶
- UpperRight = 2¶
- accept(self, visitor: QgsStyleEntityVisitorInterface) bool ¶
Accepts the specified style entity
visitor
, causing it to visit all style entities associated with the layout item.Returns
True
if the visitor should continue visiting other objects, orFalse
if visiting should be canceled.New in version 3.10.
- Parameters:
visitor (QgsStyleEntityVisitorInterface) –
- Return type:
bool
- adjustPointForReferencePosition(self, point: QPointF | QPoint, size: QSizeF, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Adjusts the specified
point
at which areference
position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position.- Parameters:
point (Union[QPointF) –
size (QSizeF) –
reference (QgsLayoutItem.ReferencePoint) –
- Return type:
QPointF
- applyDataDefinedSize(self, size: QgsLayoutSize) QgsLayoutSize ¶
Applies any present data defined size overrides to the specified layout
size
.- Parameters:
size (QgsLayoutSize) –
- Return type:
- applyItemSizeConstraint(self, targetSize: QSizeF) QSizeF ¶
Applies any item-specific size constraint handling to a given
targetSize
in layout units. Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered bysetFixedSize()
orsetMinimumSize()
. Item size constraints are applied after fixed, minimum and data defined size constraints.See also
See also
- Parameters:
targetSize (QSizeF) –
- Return type:
QSizeF
- attemptMove(self, point: QgsLayoutPoint, useReferencePoint: bool = True, includesFrame: bool = False, page: int = -1)¶
Attempts to move the item to a specified
point
.If
useReferencePoint
isTrue
, this method will respect the item’s reference point, in that the item will be moved so that its current reference point is placed at the specified target point.If
useReferencePoint
isFalse
, the item will be moved so thatpoint
falls at the top-left corner of the item.If
includesFrame
isTrue
, then the position specified bypoint
represents the point at which to place the outside of the item’s frame.If
page
is not left at the default -1 value, then the position specified bypoint
refers to the relative position on the corresponding layoutpage
(where apage
of 0 represents the first page).Note that the final position of the item may not match the specified target position, as data defined item position may override the specified value.
See also
See also
See also
See also
- Parameters:
point (QgsLayoutPoint) –
useReferencePoint (bool = True) –
includesFrame (bool = False) –
page (int = -1) –
- attemptMoveBy(self, deltaX: float, deltaY: float)¶
Attempts to shift the item’s position by a specified
deltaX
anddeltaY
, in layout units.Note that the final position of the item may not match the specified offsets, as data defined item position and size may override the specified value.
See also
See also
See also
See also
- Parameters:
deltaX (float) –
deltaY (float) –
- attemptResize(self, size: QgsLayoutSize, includesFrame: bool = False)¶
Attempts to resize the item to a specified target
size
. Note that the final size of the item may not match the specified target size, as items with a fixed or minimum size will place restrictions on the allowed item size. Data defined item size overrides will also override the specified target size.If
includesFrame
isTrue
, then the size specified bysize
includes the item’s frame.See also
See also
See also
See also
- Parameters:
size (QgsLayoutSize) –
includesFrame (bool = False) –
- attemptSetSceneRect(self, rect: QRectF, includesFrame: bool = False)¶
Attempts to update the item’s position and size to match the passed
rect
in layout coordinates.If
includesFrame
isTrue
, then the position and size specified byrect
represents the position and size at for the outside of the item’s frame.Note that the final position and size of the item may not match the specified target rect, as data defined item position and size may override the specified value.
See also
See also
See also
See also
- Parameters:
rect (QRectF) –
includesFrame (bool = False) –
- backgroundColor(self) QColor ¶
Returns the background color for this item. This is only used if
hasBackground()
returnsTrue
.See also
See also
- Return type:
QColor
- backgroundTaskCountChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- beginCommand(self, commandText: str, command: QgsLayoutItem.UndoCommand = QgsLayoutItem.UndoNone)¶
Starts new undo command for this item. The
commandText
should be a capitalized, imperative tense description (e.g. “Add Map Item”). If specified, multiple consecutive commands for this item with the samecommand
will be collapsed into a single undo command in the layout history.See also
See also
- Parameters:
commandText (str) –
command (QgsLayoutItem.UndoCommand = QgsLayoutItem.UndoNone) –
- blendMode(self) QPainter.CompositionMode ¶
Returns the item’s composition blending mode.
See also
- Return type:
QPainter.CompositionMode
- cancelCommand(self)¶
Cancels the current item command and discards it.
See also
See also
- childEvent(self, QChildEvent)¶
- cleanup(self)¶
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
- clipPath(self) QgsGeometry ¶
Returns the clipping path generated by this item, in layout coordinates.
Note
Not all items can function as clipping paths. The FlagProvidesClipPath flag indicates if a particular item can function as a clipping path provider.
New in version 3.16.
- Return type:
- clipPathChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- connectNotify(self, QMetaMethod)¶
- containsAdvancedEffects(self) bool ¶
Returns
True
if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item.Subclasses should ensure that implemented overrides of this method also check the base class result.
See also
- Return type:
bool
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- createCommand(self, text: str, id: int, parent: QUndoCommand = None) QgsAbstractLayoutUndoCommand ¶
- Parameters:
text (str) –
id (int) –
parent (QUndoCommand = None) –
- Return type:
- createExpressionContext(self) QgsExpressionContext ¶
- Return type:
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- displayName(self) str ¶
Gets item display name. This is the item’s id if set, and if not, a user-friendly string identifying item type.
See also
See also
- Return type:
str
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- draw(self, context: QgsLayoutItemRenderContext)¶
Draws the item’s contents using the specified item render
context
.Note that the context’s painter has been scaled so that painter units are pixels. Use the
QgsRenderContext
methods to convert from millimeters or other units to the painter’s units.- Parameters:
context (QgsLayoutItemRenderContext) –
- drawBackground(self, context: QgsRenderContext)¶
Draws the background for the item.
See also
- Parameters:
context (QgsRenderContext) –
- drawDebugRect(self, painter: QPainter)¶
Draws a debugging rectangle of the item’s current bounds within the specified painter.
- Parameters:
painter (QPainter) – destination QPainter
- drawFrame(self, context: QgsRenderContext)¶
Draws the frame around the item.
See also
- Parameters:
context (QgsRenderContext) –
- drawRefreshingOverlay(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem)¶
Draws a “refreshing” overlay icon on the item.
New in version 3.32.
- Parameters:
painter (QPainter) –
itemStyle (QStyleOptionGraphicsItem) –
- dropEvent(self, QGraphicsSceneDragDropEvent)¶
- endCommand(self)¶
Completes the current item command and push it onto the layout’s undo stack.
See also
See also
- estimatedFrameBleed(self) float ¶
Returns the estimated amount the item’s frame bleeds outside the item’s actual rectangle. For instance, if the item has a 2mm frame stroke, then 1mm of this frame is drawn outside the item’s rect. In this case the return value will be 1.0.
Returned values are in layout units.
See also
- Return type:
float
- excludeFromExports(self) bool ¶
Returns whether the item should be excluded from layout exports and prints.
See also
- Return type:
bool
- exportLayerBehavior(self) QgsLayoutItem.ExportLayerBehavior ¶
Returns the behavior of this item during exporting to layered exports (e.g. SVG).
See also
See also
New in version 3.10.
- Return type:
- exportLayerDetails(self) QgsLayoutItem.ExportLayerDetail ¶
Returns the details for the specified current export layer.
Only valid between calls to
startLayeredExport()
andstopLayeredExport()
New in version 3.10.
- Return type:
- finalizeRestoreFromXml(self)¶
Called after all pending items have been restored from XML. Items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time
readXml()
was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.See also
- fixedSize(self) QgsLayoutSize ¶
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.
See also
See also
- Return type:
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- frameChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- frameEnabled(self) bool ¶
Returns
True
if the item includes a frame.See also
See also
See also
See also
- Return type:
bool
- frameJoinStyle(self) Qt.PenJoinStyle ¶
Returns the join style used for drawing the item’s frame.
See also
See also
See also
See also
- Return type:
Qt.PenJoinStyle
- framePath(self) QPainterPath ¶
Returns the path to use when drawing the item’s frame or background.
See also
See also
New in version 3.16.
- Return type:
QPainterPath
- frameStrokeColor(self) QColor ¶
Returns the frame’s stroke color. This is only used if
frameEnabled()
returnsTrue
.See also
See also
See also
See also
- Return type:
QColor
- frameStrokeWidth(self) QgsLayoutMeasurement ¶
Returns the frame’s stroke width. This is only used if
frameEnabled()
returnsTrue
.See also
See also
See also
See also
- Return type:
- hasBackground(self) bool ¶
Returns
True
if the item has a background.See also
See also
- Return type:
bool
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- icon(self) QIcon ¶
Returns the item’s icon.
- Return type:
QIcon
- id(self) str ¶
Returns the item’s ID name. This is not necessarily unique, and duplicate ID names may exist for a layout.
See also
See also
- Return type:
str
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) Any ¶
- invalidateCache(self)¶
Forces a deferred update of any cached image the item uses.
- isGroupMember(self) bool ¶
Returns
True
if the item is part of aQgsLayoutItemGroup
group.See also
See also
- Return type:
bool
- isLocked(self) bool ¶
Returns
True
if the item is locked, and cannot be interacted with using the mouse.See also
See also
- Return type:
bool
- isRefreshing(self) bool ¶
Returns
True
if the item is currently refreshing content in the background.New in version 3.32.
- Return type:
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) Any ¶
- itemFlags(self) QgsLayoutItem.Flags ¶
Returns the item’s flags, which indicate how the item behaves.
New in version 3.4.3.
- Return type:
- itemOpacity(self) float ¶
Returns the item’s opacity. This method should be used instead of QGraphicsItem.opacity() as any data defined overrides will be respected.
- Return type:
float
- Returns:
opacity as double between 1.0 (opaque) and 0 (transparent).
See also
- itemRotation(self) float ¶
Returns the current rotation for the item, in degrees clockwise.
Note that this method will always return the user-set rotation for the item, which may differ from the current item rotation (if data defined rotation settings are present). Use QGraphicsItem.rotation() to obtain the current item rotation.
See also
- Return type:
float
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- lockChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- minimumSize(self) QgsLayoutSize ¶
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.
See also
See also
- Return type:
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- moveContent(self, dx: float, dy: float)¶
Moves the content of the item, by a specified
dx
anddy
in layout units. The default implementation has no effect.See also
See also
- Parameters:
dx (float) –
dy (float) –
- nextExportPart(self) bool ¶
Moves to the next export part for a multi-layered export item, during a multi-layered export.
See also
See also
New in version 3.10.
- Return type:
bool
- numberExportLayers(self) int ¶
Returns the number of layers that this item requires for exporting during layered exports (e.g. SVG). Returns 0 if this item is to be placed on the same layer as the previous item, 1 if it should be placed on its own layer, and >1 if it requires multiple export layers.
Items which require multiply layers should check
QgsLayoutContext.currentExportLayer()
during their rendering to determine which layer should be drawn.See also
See also
Deprecated since version Use:
nextExportPart()
andexportLayerBehavior()
instead.- Return type:
int
- page(self) int ¶
Returns the page the item is currently on, with the first page returning 0.
See also
- Return type:
int
- pagePos(self) QPointF ¶
Returns the item’s position (in layout units) relative to the top left corner of its current page.
See also
See also
- Return type:
QPointF
- pagePositionWithUnits(self) QgsLayoutPoint ¶
Returns the item’s position (in item units) relative to the top left corner of its current page.
See also
See also
- Return type:
- paint(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem, pWidget: QWidget)¶
Handles preparing a paint surface for the layout item and painting the item’s content. Derived classes must not override this method, but instead implement the pure virtual method QgsLayoutItem.draw.
- Parameters:
painter (QPainter) –
itemStyle (QStyleOptionGraphicsItem) –
pWidget (QWidget) –
- parentGroup(self) QgsLayoutItemGroup ¶
Returns the item’s parent group, if the item is part of a
QgsLayoutItemGroup
group.See also
See also
- Return type:
- positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Returns the current position (in layout units) of a
reference
point for the item.- Parameters:
reference (QgsLayoutItem.ReferencePoint) –
- Return type:
QPointF
- positionWithUnits(self) QgsLayoutPoint ¶
Returns the item’s current position, including units. The position returned is the position of the item’s reference point, which may not necessarily be the top left corner of the item.
See also
See also
See also
- Return type:
- prepareGeometryChange(self)¶
- readObjectPropertiesFromElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Sets object properties from a DOM element
- Parameters:
parentElement – is the parent DOM element for the object
document – DOM document
context – read write context
- Returns:
True
if read was successful
See also
- readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Sets item state from a DOM element.
- Parameters:
element (QDomElement) – is the DOM element for the item
document (QDomDocument) – DOM document
context (QgsReadWriteContext) – read write context
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the
finalizeRestoreFromXml()
method. E.g. when restoring a scalebar, the connection to the linked map’s signals should be implemented infinalizeRestoreFromXml()
, notreadPropertiesFromElement()
.See also
See also
- Return type:
bool
- readXml(self, itemElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Sets the item state from a DOM element.
- Parameters:
itemElement (QDomElement) – is the DOM node corresponding to item (e.g. ‘LayoutItem’ element)
document (QDomDocument) – DOM document
context (QgsReadWriteContext) – read write context
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the
finalizeRestoreFromXml()
method. E.g. when restoring a scalebar, the connection to the linked map’s signals should be implemented infinalizeRestoreFromXml()
, notreadXml()
.See also
See also
- Return type:
bool
- receivers(self, PYQT_SIGNAL) int ¶
- rectWithFrame(self) QRectF ¶
Returns the item’s rectangular bounds, including any bleed caused by the item’s frame. The bounds are returned in the item’s coordinate system (see Qt’s QGraphicsItem docs for more details about QGraphicsItem coordinate systems). The results differ from Qt’s
rect()
function, asrect()
makes no allowances for the portion of outlines which are drawn outside of the item.See also
- Return type:
QRectF
- redraw(self)¶
Triggers a redraw (update) of the item.
- referencePoint(self) QgsLayoutItem.ReferencePoint ¶
Returns the reference point for positioning of the layout item. This point is also fixed during resizing of the item, and any size changes will be performed so that the position of the reference point within the layout remains unchanged.
See also
- Return type:
- refresh(self)¶
Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size.
- refreshBackgroundColor(self, updateItem: bool = True)¶
Refresh item’s background color, considering data defined colors. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame color is set and a later call toupdate()
must be made.- Parameters:
updateItem (bool = True) –
- refreshBlendMode(self)¶
Refresh item’s blend mode, considering data defined blend mode.
- refreshDataDefinedProperty(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)¶
Refreshes a data defined
property
for the item by reevaluating the property’s value and redrawing the item with this new value. Ifproperty
is set toQgsLayoutObject
.AllProperties then all data defined properties for the item will be refreshed.- Parameters:
property (QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties) –
- refreshFrame(self, updateItem: bool = True)¶
Refresh item’s frame, considering data defined colors and frame size. If
updateItem
is set toFalse
, the item will not be automatically updated after the frame is set and a later call toupdate()
must be made.- Parameters:
updateItem (bool = True) –
- refreshItemPosition(self)¶
Refreshes an item’s position by rechecking it against any possible overrides such as data defined positioning.
See also
- refreshItemRotation(self, origin: QPointF | QPoint = None)¶
Refreshes an item’s rotation by rechecking it against any possible overrides such as data defined rotation.
The optional
origin
point specifies the origin (in item coordinates) around which the rotation should be applied.See also
See also
- Parameters:
origin (Union[QPointF) –
- refreshItemSize(self)¶
Refreshes an item’s size by rechecking it against any possible item fixed or minimum sizes.
See also
See also
See also
- refreshOpacity(self, updateItem: bool = True)¶
Refresh item’s opacity, considering data defined opacity. If
updateItem
is set toFalse
the item will not be automatically updated after the opacity is set and a later call toupdate()
must be made.- Parameters:
updateItem (bool = True) –
- requiresRasterization(self) bool ¶
Returns
True
if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats.See also
- Return type:
bool
- rotateItem(self, angle: float, transformOrigin: QPointF | QPoint)¶
Rotates the item by a specified
angle
in degrees clockwise around a specified reference point.See also
See also
- Parameters:
angle (float) –
transformOrigin (Union[QPointF) –
- rotationChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- sceneEvent(self, QEvent) bool ¶
- sceneEventFilter(self, QGraphicsItem, QEvent) bool ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBackgroundColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Sets the background
color
for this item.See also
See also
- Parameters:
color (Union[QColor) –
- setBackgroundEnabled(self, drawBackground: bool)¶
Sets whether this item has a background drawn under it or not.
See also
See also
- Parameters:
drawBackground (bool) –
- setBlendMode(self, mode: QPainter.CompositionMode)¶
Sets the item’s composition blending
mode
.See also
- Parameters:
mode (QPainter.CompositionMode) –
- setExcludeFromExports(self, exclude: bool)¶
Sets whether the item should be excluded from layout exports and prints.
See also
- Parameters:
exclude (bool) –
- setFixedSize(self, size: QgsLayoutSize)¶
Sets a fixed
size
for the layout item, which prevents it from being freely resized. Set an empty size if item can be freely resized.See also
See also
- Parameters:
size (QgsLayoutSize) –
- setFrameEnabled(self, drawFrame: bool)¶
Sets whether this item has a frame drawn around it or not.
See also
See also
See also
See also
- Parameters:
drawFrame (bool) –
- setFrameJoinStyle(self, style: Qt.PenJoinStyle)¶
Sets the join
style
used when drawing the item’s frame.See also
See also
See also
See also
- Parameters:
style (Qt.PenJoinStyle) –
- setFrameStrokeColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Sets the frame stroke
color
.See also
See also
See also
See also
- Parameters:
color (Union[QColor) –
- setFrameStrokeWidth(self, width: QgsLayoutMeasurement)¶
Sets the frame stroke
width
.See also
See also
See also
See also
- Parameters:
width (QgsLayoutMeasurement) –
- setId(self, id: str)¶
Set the item’s
id
name. This is not necessarily unique, and duplicate ID names may exist for a layout.See also
See also
- Parameters:
id (str) –
- setItemOpacity(self, opacity: float)¶
Sets the item’s
opacity
. This method should be used instead of QGraphicsItem.setOpacity() as any data defined overrides will be respected.- Parameters:
opacity (float) – double between 1.0 (opaque) and 0 (transparent).
See also
- setItemRotation(self, rotation: float, adjustPosition: bool = True)¶
Sets the layout item’s
rotation
, in degrees clockwise.If
adjustPosition
isTrue
, then this rotation occurs around the center of the item. IfadjustPosition
isFalse
, rotation occurs around the item origin.See also
See also
- Parameters:
rotation (float) –
adjustPosition (bool = True) –
- setLocked(self, locked: bool)¶
Sets whether the item is
locked
, preventing mouse interactions with the item.See also
See also
- Parameters:
locked (bool) –
- setMinimumSize(self, size: QgsLayoutSize)¶
Sets the minimum allowed
size
for the layout item. Set an empty size if item can be freely resized.See also
See also
- Parameters:
size (QgsLayoutSize) –
- setMoveContentPreviewOffset(self, dx: float, dy: float)¶
Sets temporary offset for the item, by a specified
dx
anddy
in layout units. This is useful for live updates when moving item content in aQgsLayoutView
. The default implementation has no effect.See also
- Parameters:
dx (float) –
dy (float) –
- setParentGroup(self, group: QgsLayoutItemGroup)¶
Sets the item’s parent
group
.See also
See also
- Parameters:
group (QgsLayoutItemGroup) –
- setReferencePoint(self, point: QgsLayoutItem.ReferencePoint)¶
Sets the reference
point
for positioning of the layout item. This point is also fixed during resizing of the item, and any size changes will be performed so that the position of the reference point within the layout remains unchanged.See also
- Parameters:
point (QgsLayoutItem.ReferencePoint) –
- setSelected(self, selected: bool)¶
Sets whether the item should be selected.
- Parameters:
selected (bool) –
- setVisibility(self, visible: bool)¶
Sets whether the item is
visible
.Note
QGraphicsItem.setVisible should not be called directly on a
QgsLayoutItem
, as some item types (e.g., groups) need to override the visibility toggle.- Parameters:
visible (bool) –
- shouldDrawItem(self) bool ¶
Returns whether the item should be drawn in the current context.
- Return type:
bool
- sizePositionChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- sizeWithUnits(self) QgsLayoutSize ¶
Returns the item’s current size, including units.
See also
See also
- Return type:
- startLayeredExport(self)¶
Starts a multi-layer export operation.
See also
See also
New in version 3.10.
- stopLayeredExport(self)¶
Stops a multi-layer export operation.
See also
See also
New in version 3.10.
- timerEvent(self, QTimerEvent)¶
- topLeftToReferencePoint(self, point: QgsLayoutPoint) QgsLayoutPoint ¶
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.- Parameters:
point (QgsLayoutPoint) –
- Return type:
- type(self) int ¶
Returns a unique graphics item type identifier.
Plugin based subclasses should return an identifier greater than
QgsLayoutItemRegistry
.PluginItem.- Return type:
int
- updateMicroFocus(self)¶
- uuid(self) str ¶
Returns the item identification string. This is a unique random string set for the item upon creation.
Note
There is no corresponding setter for the uuid - it’s created automatically.
See also
See also
- Return type:
str
- wheelEvent(self, QGraphicsSceneWheelEvent)¶
- writeObjectPropertiesToElement(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Stores object properties within an XML DOM element.
- Parameters:
parentElement – is the parent DOM element to store the object’s properties in
document – DOM document
context – read write context
- Returns:
True
if write was successful
See also
- writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Stores item state within an XML DOM element.
- Parameters:
element (QDomElement) – is the DOM element to store the item’s properties in
document (QDomDocument) – DOM document
context (QgsReadWriteContext) – read write context
See also
See also
- Return type:
bool
- writeXml(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool ¶
Stores the item state in a DOM element.
- Parameters:
parentElement (QDomElement) – parent DOM element (e.g. ‘Layout’ element)
document (QDomDocument) – DOM document
context (QgsReadWriteContext) – read write context
See also
- Return type:
bool
- zoomContent(self, factor: float, point: QPointF | QPoint)¶
Zooms content of item. Does nothing by default.
- Parameters:
factor (float) – zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out
point (Union[QPointF) – item point for zoom center
See also