Class: QgsSvgAnnotation

class qgis.core.QgsSvgAnnotation

Bases: QgsAnnotation

An annotation which renders the contents of an SVG file.

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

Methods

childEvent

clone

rtype:

QgsSvgAnnotation

connectNotify

copyCommonProperties

Copies common annotation properties to the targe annotation.

create

Returns a new QgsSvgAnnotation object.

customEvent

disconnectNotify

filePath

Returns the file path for the source SVG file.

isSignalConnected

minimumFrameSize

Returns the minimum frame size for the annotation.

readXml

param itemElem:

receivers

renderAnnotation

param context:

sender

senderSignalIndex

setFilePath

Sets the file path for the source SVG file.

timerEvent

writeXml

param elem:

childEvent(self, QChildEvent)
clone(self) QgsSvgAnnotation
Return type:

QgsSvgAnnotation

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() QgsSvgAnnotation

Returns a new QgsSvgAnnotation object.

Return type:

QgsSvgAnnotation

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
filePath(self) str

Returns the file path for the source SVG file.

See also

setFilePath()

Return type:

str

isSignalConnected(self, QMetaMethod) bool
minimumFrameSize(self) QSizeF

Returns the minimum frame size for the annotation. Subclasses should implement this if they cannot be resized smaller than a certain minimum size.

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
setFilePath(self, file: str)

Sets the file path for the source SVG file.

See also

filePath()

Parameters:

file (str) –

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