Class: QgsHtmlAnnotation

class qgis.core.QgsHtmlAnnotation

Bases: QgsAnnotation

An annotation item that embeds HTML content.

New in version 3.0.

QgsHtmlAnnotation(parent: QObject = None) Constructor for QgsHtmlAnnotation.

Methods

childEvent

clone

rtype:

QgsHtmlAnnotation

connectNotify

copyCommonProperties

Copies common annotation properties to the targe annotation.

create

Returns a new QgsHtmlAnnotation object.

customEvent

disconnectNotify

htmlSource

Returns html source text

isSignalConnected

minimumFrameSize

rtype:

QSizeF

readXml

param itemElem:

receivers

renderAnnotation

param context:

sender

senderSignalIndex

setAssociatedFeature

param feature:

setHtmlSource

Sets the html source directly (not coming from a file)

setSourceFile

Sets the file path for the source HTML file.

sourceFile

Returns the file path for the source HTML file.

timerEvent

writeXml

param elem:

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)
htmlSource(self) str

Returns html source text

Return type:

str

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) –

setHtmlSource(self, htmlSource: str)

Sets the html source directly (not coming from a file)

Parameters:

htmlSource (str) –

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: