Class: QgsLayoutItemPicture¶

A layout item subclass that displays SVG files or raster format images (jpg, png, …).

Class Hierarchy¶

Base classes¶

`QgsLayoutItem`	Base class for graphical items within a `QgsLayout`.
`QgsLayoutObject`	A base class for objects which belong to a layout.
QObject
`QgsExpressionContextGenerator`	Abstract interface for generating an expression context.
QGraphicsRectItem
QAbstractGraphicsShapeItem
QGraphicsItem
`QgsLayoutUndoObjectInterface`	Interface for layout objects which support undo/redo commands.

Enums

Format

alias of PictureFormat

Methods

`evaluatedPath`	Returns the current evaluated picture path, which includes the result of data defined path overrides.
`isMissingImage`	Returns `True` if the source image is missing and the picture cannot be rendered.
`linkedMap`	Returns the linked rotation map, if set.
`mode`	Returns the current picture mode (image format), FormatUnknown if given picture format is unknown
`northMode`	Returns the mode used to align the picture to a map's North.
`northOffset`	Returns the offset added to the picture's rotation from a map's North.
`originalMode`	Returns the original set picture mode (image format).
`pictureAnchor`	Returns the picture's current anchor, which controls how it is placed within the picture item's frame.
`picturePath`	Returns the path of the source image.
`pictureRotation`	Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise.
`recalculateSize`	Forces a recalculation of the picture's frame size
`refreshPicture`	Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.
`resizeMode`	Returns the resize mode used for drawing the picture within the layout item's frame.
`setLinkedMap`	Sets the map object for rotation.
`setMode`	Sets the current picture mode (image format).
`setNorthMode`	Sets the mode used to align the picture to a map's North.
`setNorthOffset`	Sets the offset added to the picture's rotation from a map's North.
`setPictureAnchor`	Sets the picture's anchor point, which controls how it is placed within the picture item's frame.
`setPicturePath`	Sets the source path of the image (may be svg or a raster format).
`setPictureRotation`	Sets the picture rotation within the item bounds, in degrees clockwise.
`setResizeMode`	Sets the resize mode used for drawing the picture within the item bounds.
`setSvgDynamicParameters`	Sets the SVG dynamic parameters
`setSvgFillColor`	Sets the fill color used for parametrized SVG files.
`setSvgStrokeColor`	Sets the stroke color used for parametrized SVG files.
`setSvgStrokeWidth`	Sets the stroke width (in layout units) used for parametrized SVG files.
`svgDynamicParameters`	Returns the SVG dynamic parameters
`svgFillColor`	Returns the fill color used for parametrized SVG files.
`svgStrokeColor`	Returns the stroke color used for parametrized SVG files.
`svgStrokeWidth`	Returns the stroke width (in layout units) used for parametrized SVG files.

Static Methods

create

Returns a new picture item for the specified layout.

Signals

pictureRotationChanged

Emitted on picture rotation change

Attributes

`Clip`
`FrameToImageSize`
`GridNorth`
`Stretch`
`TrueNorth`
`Zoom`
`ZoomResizeFrame`

class qgis.core.QgsLayoutItemPicture[source]¶

Bases: QgsLayoutItem

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItemPicture, with the specified parent layout.

Parameters:: layout (Optional[QgsLayout])

Clip = 2¶

Format¶: alias of PictureFormat

FrameToImageSize = 4¶

GridNorth = 0¶

class NorthMode¶: Bases: int

class ResizeMode¶: Bases: int

Stretch = 1¶

TrueNorth = 1¶

Zoom = 0¶

ZoomResizeFrame = 3¶

static create(layout: QgsLayout | None) → QgsLayoutItemPicture | None[source]¶

Returns a new picture item for the specified layout.

The caller takes responsibility for deleting the returned object.

Parameters:: layout (Optional[QgsLayout])
Return type:: Optional[QgsLayoutItemPicture]

evaluatedPath(self) → str[source]¶

Returns the current evaluated picture path, which includes the result of data defined path overrides.

See also

picturePath()

Added in version 3.6.

Return type:: str

isMissingImage(self) → bool[source]¶

Returns True if the source image is missing and the picture cannot be rendered.

Added in version 3.6.

Return type:: bool

linkedMap(self) → QgsLayoutItemMap | None[source]¶

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

setLinkedMap()

Return type:: Optional[QgsLayoutItemMap]

mode(self) → Qgis.PictureFormat[source]¶

Returns the current picture mode (image format), FormatUnknown if given picture format is unknown

See also

setMode()

See also

originalMode()

Return type:: Qgis.PictureFormat

northMode(self) → QgsLayoutItemPicture.NorthMode[source]¶

Returns the mode used to align the picture to a map’s North.

See also

setNorthMode()

See also

northOffset()

Return type:: QgsLayoutItemPicture.NorthMode

northOffset(self) → float[source]¶

Returns the offset added to the picture’s rotation from a map’s North.

See also

setNorthOffset()

See also

northMode()

Return type:: float

originalMode(self) → Qgis.PictureFormat[source]¶

Returns the original set picture mode (image format). It could differ from mode() if given picture format is unknown

See also

setMode()

See also

mode()

Added in version 3.22.

Return type:: Qgis.PictureFormat

pictureAnchor(self) → QgsLayoutItem.ReferencePoint[source]¶

Returns the picture’s current anchor, which controls how it is placed within the picture item’s frame.

See also

setPictureAnchor()

Return type:: QgsLayoutItem.ReferencePoint

picturePath(self) → str[source]¶

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

setPicturePath()

See also

evaluatedPath()

pictureRotation(self) → float[source]¶

Returns the rotation used for drawing the picture within the item’s frame, in degrees clockwise.

See also

setPictureRotation()

See also

linkedMap()

Return type:: float

signal pictureRotationChanged(newRotation: float)[source]¶

Emitted on picture rotation change

Parameters:: newRotation (float)

recalculateSize(self)[source]¶: Forces a recalculation of the picture’s frame size

refreshPicture(self, context: QgsExpressionContext | None = None)[source]¶

Recalculates the source image (if using an expression for picture’s source) and reloads and redraws the picture.

Parameters:: context (Optional[QgsExpressionContext] = None) – expression context for evaluating data defined picture sources

resizeMode(self) → QgsLayoutItemPicture.ResizeMode[source]¶

Returns the resize mode used for drawing the picture within the layout item’s frame.

See also

setResizeMode()

Return type:: QgsLayoutItemPicture.ResizeMode

setLinkedMap(self, map: QgsLayoutItemMap | None)[source]¶

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

setPictureRotation()

See also

linkedMap()

Parameters:: map (Optional[QgsLayoutItemMap])

setMode(self, mode: Qgis.PictureFormat)[source]¶

Sets the current picture mode (image format).

See also

mode()

Added in version 3.14.

Parameters:: mode (Qgis.PictureFormat)

setNorthMode(self, mode: QgsLayoutItemPicture.NorthMode)[source]¶

Sets the mode used to align the picture to a map’s North.

See also

northMode()

See also

setNorthOffset()

Parameters:: mode (QgsLayoutItemPicture.NorthMode)

setNorthOffset(self, offset: float)[source]¶

Sets the offset added to the picture’s rotation from a map’s North.

See also

northOffset()

See also

setNorthMode()

Parameters:: offset (float)

setPictureAnchor(self, anchor: QgsLayoutItem.ReferencePoint)[source]¶

Sets the picture’s anchor point, which controls how it is placed within the picture item’s frame.

See also

pictureAnchor()

Parameters:: anchor (QgsLayoutItem.ReferencePoint)

setPicturePath(self, path: str | None, format: Qgis.PictureFormat = Qgis.PictureFormat.Unknown)[source]¶

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

picturePath()

Parameters:

path (Optional[str])
format (Qgis.PictureFormat = Qgis.PictureFormat.Unknown)

setPictureRotation(self, rotation: float)[source]¶

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

pictureRotation()