Class: QgsHtmlAnnotation

class qgis.core.QgsHtmlAnnotation(parent: QObject = None)

Bases: QgsAnnotation

Constructor for QgsHtmlAnnotation.

An annotation item that embeds HTML content.

New in version 3.0.

Parameters

parent

childEvent(self, QChildEvent)
clone(self)QgsHtmlAnnotation
Return type

QgsHtmlAnnotation

connectNotify(self, QMetaMethod)
copyCommonProperties(self, target: QgsAnnotation)

Copies common annotation properties to the targe annotation. Can be used within QgsAnnotation.clone() implementations to assist with creating copies.

create()QgsHtmlAnnotation

Returns a new QgsHtmlAnnotation object.

Return type

QgsHtmlAnnotation

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
isSignalConnected(self, QMetaMethod) → bool
minimumFrameSize(self) → QSizeF
Return type

QSizeF

readXml(self, itemElem: QDomElement, context: QgsReadWriteContext)
Parameters
receivers(self, PYQT_SIGNAL) → int
renderAnnotation(self, context: QgsRenderContext, size: QSizeF)
Parameters
sender(self) → QObject
senderSignalIndex(self) → int
setAssociatedFeature(self, feature: QgsFeature)
Parameters

feature (QgsFeature) –

setSourceFile(self, htmlFile: str)

Sets the file path for the source HTML file.

See also

sourceFile()

Parameters

htmlFile (str) –

sourceFile(self) → str

Returns the file path for the source HTML file.

See also

setSourceFile()

Return type

str

timerEvent(self, QTimerEvent)
writeXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)
Parameters