Class: QgsFormAnnotation

An annotation item that embeds a designer form showing the feature attribute

Class Hierarchy

Base classes

QgsAnnotation	Abstract base class for annotation items which are drawn over a map.
QObject

Methods

designerForm	Returns the path to the Qt Designer UI file to show in the annotation.
preferredFrameSize	Returns the optimal frame size
setDesignerForm	Sets the path to the Qt Designer UI file to show in the annotation.

Static Methods

create

Returns a new QgsFormAnnotation object.

class qgis.gui.QgsFormAnnotation

Bases: QgsAnnotation

__init__(parent: QObject | None = None)

Constructor for QgsFormAnnotation.

Parameters:

parent (Optional[QObject] = None)

static create() → QgsFormAnnotation | None

Returns a new QgsFormAnnotation object.

Return type:

Optional[QgsFormAnnotation]

designerForm(self) → str

Returns the path to the Qt Designer UI file to show in the annotation.

See also

setDesignerForm()

Return type:

str

preferredFrameSize(self) → QSizeF

Returns the optimal frame size

Return type:

QSizeF

setDesignerForm(self, uiFile: str | None)

Sets the path to the Qt Designer UI file to show in the annotation.

See also

designerForm()

Parameters:

uiFile (Optional[str])