Class: QgsSvgAnnotation

class qgis.core.QgsSvgAnnotation

Bases: QgsAnnotation

An annotation which renders the contents of an SVG file.

Added in version 3.0.

QgsSvgAnnotation(parent: Optional[QObject] = None) Constructor for QgsSvgAnnotation.

Methods

childEvent

clone

rtype:

Optional[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, a0: QChildEvent | None)
clone(self) → QgsSvgAnnotation | None
Return type:

Optional[QgsSvgAnnotation]

connectNotify(self, signal: QMetaMethod)
copyCommonProperties(self, target: QgsAnnotation | None)

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

create() → QgsSvgAnnotation | None

Returns a new QgsSvgAnnotation object.

Return type:

Optional[QgsSvgAnnotation]

customEvent(self, a0: QEvent | None)
disconnectNotify(self, signal: QMetaMethod)
filePath(self) → str

Returns the file path for the source SVG file.

See also

setFilePath()

Return type:

str

isSignalConnected(self, signal: 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, signal: PYQT_SIGNAL) → int
renderAnnotation(self, context: QgsRenderContext, size: QSizeF)
Parameters:
sender(self) → QObject | None
senderSignalIndex(self) → int
setFilePath(self, file: str | None)

Sets the file path for the source SVG file.

See also

filePath()

Parameters:

file (Optional[str])

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