VectorImage QML Type
Loads a vector image file and displays it in a Qt Quick scene. More...
| Import Statement: | import QtQuick.VectorImage |
| Since: | Qt 6.8 |
| Inherits: |
Properties
- animations
(since 6.10)- animations.loops : int
(since 6.10) - animations.paused : bool
(since 6.10)
- animations.loops : int
- assumeTrustedSource : bool
(since 6.10) - fillMode : enumeration
- preferredRendererType : enumeration
- source : url
Detailed Description
The VectorImage can be used to load a vector image file and display this as an item in a Qt Quick scene.
It currently supports the SVG file format. In addition, Lottie support can be enabled by setting the assumeTrustedSource property to true and including the plugin from the Qt Lottie Animation module. This plugin is currently considered tech preview.
Note: This complements the approach of loading the vector image file through an Image element: Image creates a raster version of the image at the requested size. VectorImage builds a Qt Quick scene that represents the image. This means the resulting item can be scaled and rotated without losing quality, and it will typically consume less memory than the rasterized version.
Property Documentation
These properties can be used to control animations in the image, if it contains any.
The paused property can be set to true to temporarily pause all animations. When the property is reset to false, the animations will resume where they were. By default this property is false.
The loops property defines the number of times the animations in the document will repeat. By default this property is 1. Any animations that is set to loop indefinitely in the source image will be unaffected by this property. To make all animations in the document repeat indefinitely, the loops property can be set to Animation.Infinite.
This QML property was introduced in Qt 6.10.
assumeTrustedSource : bool |
Setting this to true when loading trusted source files expands support for some features that may be unsafe in an uncontrolled setting. For SVG in particular, this maps to the AssumeTrustedSource option.
When this is set to true, VectorImage will also try to load the image using the Lottie format plugin if this is available. This plugin is currently considered tech preview. See Qt Lottie Animation for additional information.
By default this property is false.
This property was introduced in Qt 6.10.
See also svgtoqml and lottietoqml.
fillMode : enumeration |
This property defines what happens if the width and height of the VectorImage differs from the implicit size of its contents.
| Constant | Description |
|---|---|
VectorImage.NoResize | The contents are still rendered at the size provided by the input. |
VectorImage.Stretch | The contents are scaled to match the width and height of the VectorImage. (This is the default.) |
VectorImage.PreserveAspectFit | The contents are scaled to fit inside the bounds of the VectorImage, while preserving aspect ratio. The actual bounding rect of the contents will sometimes be smaller than the VectorImage item. |
VectorImage.PreserveAspectCrop | The contents are scaled to fill the VectorImage item, while preserving the aspect ratio. The actual bounds of the contents will sometimes be larger than the VectorImage item. |
preferredRendererType : enumeration |
Requests a specific backend to use for rendering shapes in the VectorImage.
| Constant | Description |
|---|---|
VectorImage.GeometryRenderer | Equivalent to Shape.GeometryRenderer. This backend flattens curves and triangulates the result. It will give aliased results unless multi-sampling is enabled, and curve flattening may be visible when the item is scaled. |
VectorImage.CurveRenderer | Equivalent to Shape.CurveRenderer. With this backend, curves are rendered on the GPU and anti-aliasing is built in. Will typically give better visual results, but at some extra cost to performance. |
The default is VectorImage.GeometryRenderer.
source : url |
This property holds the URL of the vector image file to load.
VectorImage currently supports the SVG file format. In addition, Lottie support can be enabled by setting the assumeTrustedSource property to true and including the plugin from the Qt Lottie Animation module. This plugin is currently considered tech preview.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
