Class: QgsLayoutItemPicture¶
- class qgis.core.QgsLayoutItemPicture¶
Bases:
QgsLayoutItem
A layout item subclass that displays SVG files or raster format images (jpg, png, …).
QgsLayoutItemPicture(layout:
QgsLayout
) Constructor forQgsLayoutItemPicture
, with the specified parentlayout
.Methods
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
.- param targetSize:
Returns a new picture item for the specified
layout
.- param 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.
Returns the current evaluated picture path, which includes the result of data defined path overrides.
Returns the path to use when drawing the item's frame or background.
- rtype:
QIcon
Returns
True
if the source image is missing and the picture cannot be rendered.Returns the linked rotation map, if set.
Returns the current picture mode (image format), FormatUnknown if given picture format is unknown
Returns the mode used to align the picture to a map's North.
Returns the offset added to the picture's rotation from a map's North.
Returns the original set picture mode (image format).
Returns the picture's current anchor, which controls how it is placed within the picture item's frame.
Returns the path of the source image.
Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise.
Returns the current position (in layout units) of a
reference
point for the item.Sets object properties from a DOM element
- param element:
Forces a recalculation of the picture's frame size
Refresh item's background color, considering data defined colors.
Refresh item's blend mode, considering data defined blend mode.
- param property:
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.
Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.
Returns the resize mode used for drawing the picture within the layout item's frame.
Sets a fixed
size
for the layout item, which prevents it from being freely resized.Sets the
map
object for rotation.Sets the minimum allowed
size
for the layout item.Sets the current picture
mode
(image format).Sets the
mode
used to align the picture to a map's North.Sets the
offset
added to the picture's rotation from a map's North.Sets the picture's
anchor
point, which controls how it is placed within the picture item's frame.Sets the source
path
of the image (may be svg or a raster format).Sets the picture
rotation
within the item bounds, in degrees clockwise.Sets the resize
mode
used for drawing the picture within the item bounds.Sets the SVG dynamic parameters
Sets the fill
color
used for parametrized SVG files.Sets the stroke
color
used for parametrized SVG files.Sets the stroke
width
(in layout units) used for parametrized SVG files.Returns the SVG dynamic parameters
Returns the fill color used for parametrized SVG files.
Returns the stroke color used for parametrized SVG files.
Returns the stroke width (in layout units) used for parametrized SVG files.
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified
point
.- rtype:
int
Stores object properties within an XML DOM element.
- param element:
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
Attributes
- Clip = 2¶
- class Format¶
Bases:
int
- FormatRaster = 1¶
- FormatSVG = 0¶
- FormatUnknown = 2¶
- FrameToImageSize = 4¶
- GridNorth = 0¶
- class NorthMode¶
Bases:
int
- class ResizeMode¶
Bases:
int
- Stretch = 1¶
- TrueNorth = 1¶
- Zoom = 0¶
- ZoomResizeFrame = 3¶
- adjustPointForReferencePosition(self, point: QPointF | QPoint | float, 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.
- applyDataDefinedSize(self, size: QgsLayoutSize) QgsLayoutSize ¶
Applies any present data defined size overrides to the specified layout
size
.
- applyItemSizeConstraint(self, targetSize: QSizeF) QSizeF ¶
- Parameters:
targetSize (QSizeF)
- Return type:
QSizeF
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- create(layout: QgsLayout) QgsLayoutItemPicture ¶
Returns a new picture item for the specified
layout
.The caller takes responsibility for deleting the returned object.
- Parameters:
layout (QgsLayout)
- Return type:
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- draw(self, context: QgsLayoutItemRenderContext)¶
- Parameters:
context (QgsLayoutItemRenderContext)
- drawBackground(self, context: QgsRenderContext)¶
Draws the background for the item.
See also
- drawDebugRect(self, painter: QPainter)¶
Draws a debugging rectangle of the item’s current bounds within the specified painter.
- Parameters:
painter – destination QPainter
- drawFrame(self, context: QgsRenderContext)¶
Draws the frame around the item.
See also
- drawRefreshingOverlay(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem)¶
Draws a “refreshing” overlay icon on the item.
Added in version 3.32.
- dropEvent(self, QGraphicsSceneDragDropEvent)¶
- evaluatedPath(self) str ¶
Returns the current evaluated picture path, which includes the result of data defined path overrides.
See also
Added in version 3.6.
- Return type:
str
- finalizeRestoreFromXml(self)¶
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- framePath(self) QPainterPath ¶
Returns the path to use when drawing the item’s frame or background.
See also
See also
Added in version 3.16.
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- icon(self) QIcon ¶
- Return type:
QIcon
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) Any ¶
- isMissingImage(self) bool ¶
Returns
True
if the source image is missing and the picture cannot be rendered.Added in version 3.6.
- Return type:
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) Any ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- linkedMap(self) QgsLayoutItemMap ¶
Returns the linked rotation map, if set. An
None
means map rotation is disabled. If this is set then the picture is rotated by the same amount as the specified map object.See also
- Return type:
- mode(self) QgsLayoutItemPicture.Format ¶
Returns the current picture mode (image format), FormatUnknown if given picture format is unknown
See also
- Return type:
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- northMode(self) QgsLayoutItemPicture.NorthMode ¶
Returns the mode used to align the picture to a map’s North.
See also
See also
- Return type:
- northOffset(self) float ¶
Returns the offset added to the picture’s rotation from a map’s North.
See also
See also
- Return type:
float
- originalMode(self) QgsLayoutItemPicture.Format ¶
Returns the original set picture mode (image format). It could differ from
mode()
if given picture format is unknownSee also
Added in version 3.22.
- Return type:
- pictureAnchor(self) QgsLayoutItem.ReferencePoint ¶
Returns the picture’s current anchor, which controls how it is placed within the picture item’s frame.
See also
- Return type:
- picturePath(self) str ¶
Returns the path of the source image. Data defined picture source may override this value. The path can either be a local path or a remote (http) path.
- Return type:
str
- Returns:
path for the source image
See also
See also
- pictureRotation(self) float ¶
Returns the rotation used for drawing the picture within the item’s frame, in degrees clockwise.
See also
See also
- Return type:
float
- pictureRotationChanged¶
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
- positionAtReferencePoint(self, reference: QgsLayoutItem.ReferencePoint) QPointF ¶
Returns the current position (in layout units) of a
reference
point for the item.
- 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 ¶
- Parameters:
element (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)
- Return type:
bool
- recalculateSize(self)¶
Forces a recalculation of the picture’s frame size
- receivers(self, PYQT_SIGNAL) int ¶
- 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.
- refreshBlendMode(self)¶
Refresh item’s blend mode, considering data defined blend mode.
- refreshDataDefinedProperty(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.DataDefinedProperty.AllProperties)¶
- Parameters:
property (QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.DataDefinedProperty.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.
- 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 | float = 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
- 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.
- refreshPicture(self, context: QgsExpressionContext = None)¶
Recalculates the source image (if using an expression for picture’s source) and reloads and redraws the picture.
- Parameters:
context (
QgsExpressionContext
= None) – expression context for evaluating data defined picture sources
- resizeMode(self) QgsLayoutItemPicture.ResizeMode ¶
Returns the resize mode used for drawing the picture within the layout item’s frame.
See also
- Return type:
- sceneEvent(self, QEvent) bool ¶
- sceneEventFilter(self, QGraphicsItem, QEvent) bool ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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
fixedSize()
See also
- setLinkedMap(self, map: QgsLayoutItemMap)¶
Sets the
map
object for rotation.If this is set then the picture will be rotated by the same amount as the specified map object. This is useful especially for syncing north arrows with a map item.
See also
See also
- Parameters:
map (QgsLayoutItemMap)
- 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
minimumSize()
See also
- setMode(self, mode: QgsLayoutItemPicture.Format)¶
Sets the current picture
mode
(image format).See also
Added in version 3.14.
- Parameters:
mode (QgsLayoutItemPicture.Format)
- setNorthMode(self, mode: QgsLayoutItemPicture.NorthMode)¶
Sets the
mode
used to align the picture to a map’s North.See also
See also
- Parameters:
- setNorthOffset(self, offset: float)¶
Sets the
offset
added to the picture’s rotation from a map’s North.See also
See also
- Parameters:
offset (float)
- setPictureAnchor(self, anchor: QgsLayoutItem.ReferencePoint)¶
Sets the picture’s
anchor
point, which controls how it is placed within the picture item’s frame.See also
- Parameters:
anchor (QgsLayoutItem.ReferencePoint)
- setPicturePath(self, path: str, format: QgsLayoutItemPicture.Format = QgsLayoutItemPicture.FormatUnknown)¶
Sets the source
path
of the image (may be svg or a raster format). Data defined picture source may override this value. The path can either be a local path or a remote (http) path.Ideally, the
format
argument should specify the image format.See also
- Parameters:
path (str)
format (QgsLayoutItemPicture.Format = QgsLayoutItemPicture.FormatUnknown)
- setPictureRotation(self, rotation: float)¶
Sets the picture
rotation
within the item bounds, in degrees clockwise. This does not affect the item’s frame, only the way the picture is drawn within the item.See also
- Parameters:
rotation (float)
- setResizeMode(self, mode: QgsLayoutItemPicture.ResizeMode)¶
Sets the resize
mode
used for drawing the picture within the item bounds.- Parameters:
mode (QgsLayoutItemPicture.ResizeMode) – ResizeMode to use for image file
See also
- setSvgDynamicParameters(self, parameters: Dict[str, QgsProperty])¶
Sets the SVG dynamic parameters
Added in version 3.20.
- Parameters:
parameters (Dict[str)
- setSvgFillColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Sets the fill
color
used for parametrized SVG files.Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
See also
- Parameters:
color (Union[QColor)
- setSvgStrokeColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Sets the stroke
color
used for parametrized SVG files.- Parameters:
color (Union[QColor) – stroke color.
Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
See also
- setSvgStrokeWidth(self, width: float)¶
Sets the stroke
width
(in layout units) used for parametrized SVG files.Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
See also
- Parameters:
width (float)
- svgDynamicParameters(self) Dict[str, QgsProperty] ¶
Returns the SVG dynamic parameters
Added in version 3.20.
- Return type:
Dict[str, QgsProperty]
- svgFillColor(self) QColor ¶
Returns the fill color used for parametrized SVG files.
See also
See also
- Return type:
QColor
- svgStrokeColor(self) QColor ¶
Returns the stroke color used for parametrized SVG files.
See also
See also
- Return type:
QColor
- svgStrokeWidth(self) float ¶
Returns the stroke width (in layout units) used for parametrized SVG files.
See also
See also
- Return type:
float
- 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
.
- type(self) int ¶
- Return type:
int
- updateMicroFocus(self)¶
- 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 ¶
- Parameters:
element (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)
- Return type:
bool