Class: QgsAnnotationPictureItem

An annotation item which renders a picture.

Added in version 3.40.

Class Hierarchy

Base classes

QgsAnnotationRectItem	Abstract base class for annotation items which render annotations in a rectangular shape.
QgsAnnotationItem	Abstract base class for annotation items which are drawn with QgsAnnotationLayers.

Methods

format	Returns the picture format.
lockAspectRatio	Returns True if the aspect ratio of the picture will be retained.
path	Returns the path of the image used to render the item.
setLockAspectRatio	Sets whether the aspect ratio of the picture will be retained.
setPath	Sets the format and path of the image used to render the item.

Static Methods

create

Creates a new polygon annotation item.

class qgis.core.QgsAnnotationPictureItem

Bases: QgsAnnotationRectItem

__init__(format: Qgis.PictureFormat, path: str | None, bounds: QgsRectangle)

Constructor for QgsAnnotationPictureItem, rendering the specified image path within the specified bounds geometry.

Parameters:

• format (Qgis.PictureFormat)

• path (Optional[str])

• bounds (QgsRectangle)

static create() → QgsAnnotationPictureItem | None

Creates a new polygon annotation item.

Return type:

Optional[QgsAnnotationPictureItem]

format(self) → Qgis.PictureFormat

Returns the picture format.

Return type:

Qgis.PictureFormat

lockAspectRatio(self) → bool

Returns True if the aspect ratio of the picture will be retained.

See also

setLockAspectRatio()

Return type:

bool

path(self) → str

Returns the path of the image used to render the item.

See also

setPath()

Return type:

str

setLockAspectRatio(self, locked: bool)

Sets whether the aspect ratio of the picture will be retained.

See also

lockAspectRatio()

Parameters:

locked (bool)

setPath(self, format: Qgis.PictureFormat, path: str | None)

Sets the format and path of the image used to render the item.

See also

path()

See also

format()

Parameters:

• format (Qgis.PictureFormat)

• path (Optional[str])