QSvgRenderer¶

PyQt5.QtSvg.QSvgRenderer: Inherits from QObject.

Description¶

The QSvgRenderer class is used to draw the contents of SVG files onto paint devices.

Using QSvgRenderer, Scalable Vector Graphics (SVG) can be rendered onto any QPaintDevice subclass, including QWidget, QImage, and QGLWidget.

QSvgRenderer provides an API that supports basic features of SVG rendering, such as loading and rendering of static drawings, and more interactive features like animation. Since the rendering is performed using QPainter, SVG drawings can be rendered on any subclass of QPaintDevice.

SVG drawings are either loaded when an QSvgRenderer is constructed, or loaded later using the load() functions. Data is either supplied directly as serialized XML, or indirectly using a file name. If a valid file has been loaded, either when the renderer is constructed or at some later time, isValid() returns true; otherwise it returns false. QSvgRenderer provides the render() slot to render the current document, or the current frame of an animated document, using a given painter.

The defaultSize() function provides information about the amount of space that is required to render the currently loaded SVG file. This is useful for paint devices, such as QWidget, that often need to supply a size hint to their parent layout. The default size of a drawing may differ from its visible area, found using the viewBox() property.

Animated SVG drawings are supported, and can be controlled with a simple collection of functions and properties:

The animated() function indicates whether a drawing contains animation information.
The framesPerSecond() property contains the rate at which the animation plays.

Finally, the QSvgRenderer class provides the repaintNeeded signal which is emitted whenever the rendering of the document needs to be updated.

Methods¶

__init__(parent: QObject = None): Constructs a new renderer with the given parent.

__init__(str, parent: QObject = None): Constructs a new renderer with the given parent and loads the contents of the SVG file with the specified filename.

__init__(Union[QByteArray, bytes, bytearray], parent: QObject = None): Constructs a new renderer with the given parent and loads the SVG data from the byte array specified by contents.

__init__(QXmlStreamReader, parent: QObject = None): Constructs a new renderer with the given parent and loads the SVG data using the stream reader specified by contents.

animated() → bool: Returns true if the current document contains animated elements; otherwise returns false.

See also

framesPerSecond().

animationDuration() → int: Returns the number of frames in the animation, or 0 if the current document is not animated.

See also

animated(), framesPerSecond().

boundsOnElement(str) → QRectF: Returns bounding rectangle of the item with the given id. The transformation matrix of parent elements is not affecting the bounds of the element.

See also

matrixForElement().

currentFrame() → int: TODO

defaultSize() → QSize: Returns the default size of the document contents.

elementExists(str) → bool

Returns true if the element with the given id exists in the currently parsed SVG file and is a renderable element.

Note: this method returns true only for elements that can be rendered. Which implies that elements that are considered part of the fill/stroke style properties, e.g. radialGradients even tough marked with “id” attributes will not be found by this method.

framesPerSecond() → int: See also

setFramesPerSecond().

isValid() → bool: Returns true if there is a valid current document; otherwise returns false.

load(str) → bool: Loads the SVG file specified by filename, returning true if the content was successfully parsed; otherwise returns false.

load(Union[QByteArray, bytes, bytearray]) → bool: Loads the specified SVG format contents, returning true if the content was successfully parsed; otherwise returns false.

load(QXmlStreamReader) → bool

Loads the specified SVG in contents, returning true if the content was successfully parsed; otherwise returns false.

The reader will be used from where it currently is positioned. If contents is null, behavior is undefined.

render(QPainter): Renders the current document, or the current frame of an animated document, using the given painter.

render(QPainter, QRectF): Renders the current document, or the current frame of an animated document, using the given painter on the specified bounds within the painter. If the bounding rectangle is not specified the SVG file is mapped to the whole paint device.

render(QPainter, str, bounds: QRectF = QRectF()): Renders the given element with elementId using the given painter on the specified bounds. If the bounding rectangle is not specified the SVG element is mapped to the whole paint device.

setCurrentFrame(int): TODO

setFramesPerSecond(int): See also

framesPerSecond().

setViewBox(QRect): See also

viewBox().

setViewBox(QRectF): TODO

viewBox() → QRect: Returns viewBoxF().toRect().

See also

setViewBox(), viewBoxF().

viewBoxF() → QRectF: TODO

Signals¶

repaintNeeded(): TODO