Class: QgsSvgCache¶
-
class
qgis.core.
QgsSvgCache
(parent: QObject = None)¶ Bases:
PyQt5.QtCore.QObject
Constructor for QgsSvgCache.
A cache for images / pictures derived from svg files. This class supports parameter replacement in svg files according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are the parameters ‘fill-color’, ‘pen-color’, ‘outline-width’, ‘stroke-width’. E.g. <circle fill=”param(fill-color red)” stroke=”param(pen-color black)” stroke-width=”param(outline-width 1)”
QgsSvgCache
is not usually directly created, but rather accessed throughQgsApplication.svgCache()
- Parameters
parent –
-
childEvent
()¶
-
connectNotify
()¶
-
containsParams
(self, path: str, defaultFillColor: Union[QColor, Qt.GlobalColor], defaultStrokeColor: Union[QColor, Qt.GlobalColor]) → Tuple[bool, bool, bool, float]¶ Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered*
- Parameters
path (str) –
defaultFillColor (Union[QColor) –
defaultStrokeColor (Union[QColor) –
- Return type
Tuple[bool, bool, bool, float]
-
containsParamsV3
(self, path: str, defaultFillColor: Union[QColor, Qt.GlobalColor], defaultStrokeColor: Union[QColor, Qt.GlobalColor]) → Tuple[bool, bool, bool, bool, float, bool, bool, bool, bool, float, bool, bool, float]¶ Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered.
- Parameters
path (str) – path to SVG file
hasFillParam – will be true if fill param present in SVG
hasDefaultFillParam – will be true if fill param has a default value specified
defaultFillColor (Union[QColor) – will be set to default fill color specified in SVG, if present
hasFillOpacityParam – will be true if fill opacity param present in SVG
hasDefaultFillOpacity – will be true if fill opacity param has a default value specified
defaultFillOpacity – will be set to default fill opacity specified in SVG, if present
hasStrokeParam – will be true if stroke param present in SVG
hasDefaultStrokeColor – will be true if stroke param has a default value specified
defaultStrokeColor (Union[QColor) – will be set to default stroke color specified in SVG, if present
hasStrokeWidthParam – will be true if stroke width param present in SVG
hasDefaultStrokeWidth – will be true if stroke width param has a default value specified
defaultStrokeWidth – will be set to default stroke width specified in SVG, if present
hasStrokeOpacityParam – will be true if stroke opacity param present in SVG
hasDefaultStrokeOpacity – will be true if stroke opacity param has a default value specified
defaultStrokeOpacity – will be set to default stroke opacity specified in SVG, if present
Note
available in Python bindings as containsParamsV3
New in version 2.14.
- Return type
Tuple[bool, bool, bool, bool, float, bool, bool, bool, bool, float, bool, bool, float]
-
customEvent
()¶
-
disconnectNotify
()¶
-
getImageData
(self, path: str) → QByteArray¶ Gets image data
- Parameters
path (str) –
- Return type
QByteArray
-
isSignalConnected
()¶
-
receivers
()¶
-
remoteSvgFetched
¶ Emitted when the cache has finished retrieving an SVG file from a remote
url
.New in version 3.2: [signal]
-
sender
()¶
-
senderSignalIndex
()¶
-
statusChanged
¶ Emit a signal to be caught by qgisapp and display a msg on status bar [signal]
-
svgAsImage
(self, path: str, size: float, fill: Union[QColor, Qt.GlobalColor], stroke: Union[QColor, Qt.GlobalColor], strokeWidth: float, widthScaleFactor: float, fixedAspectRatio: float = 0) → Tuple[QImage, bool]¶ Gets SVG as QImage.
- Parameters
path (str) – Absolute path to SVG file.
size (float) – size of cached image
fill (Union[QColor) – color of fill
stroke (Union[QColor) – color of stroke
strokeWidth (float) – width of stroke
widthScaleFactor (float) – width scale factor
fitsInCache –
fixedAspectRatio (float = 0) – fixed aspect ratio (optional)
- Return type
Tuple[QImage, bool]
-
svgAsPicture
(self, path: str, size: float, fill: Union[QColor, Qt.GlobalColor], stroke: Union[QColor, Qt.GlobalColor], strokeWidth: float, widthScaleFactor: float, forceVectorOutput: bool = False, fixedAspectRatio: float = 0) → QPicture¶ Gets SVG as QPicture&.
- Parameters
path (str) – Absolute path to SVG file.
size (float) – size of cached image
fill (Union[QColor) – color of fill
stroke (Union[QColor) – color of stroke
strokeWidth (float) – width of stroke
widthScaleFactor (float) – width scale factor
forceVectorOutput (bool = False) –
fixedAspectRatio (float = 0) – fixed aspect ratio (optional)
- Return type
QPicture
-
svgContent
(self, path: str, size: float, fill: Union[QColor, Qt.GlobalColor], stroke: Union[QColor, Qt.GlobalColor], strokeWidth: float, widthScaleFactor: float, fixedAspectRatio: float = 0) → QByteArray¶ Gets SVG content
- Parameters
path (str) –
size (float) –
fill (Union[QColor) –
stroke (Union[QColor) –
strokeWidth (float) –
widthScaleFactor (float) –
fixedAspectRatio (float = 0) –
- Return type
QByteArray
-
svgViewboxSize
(self, path: str, size: float, fill: Union[QColor, Qt.GlobalColor], stroke: Union[QColor, Qt.GlobalColor], strokeWidth: float, widthScaleFactor: float, fixedAspectRatio: float = 0) → QSizeF¶ Calculates the viewbox size of a (possibly cached) SVG file.
- Parameters
path (str) – Absolute path to SVG file.
size (float) – size of cached image
fill (Union[QColor) – color of fill
stroke (Union[QColor) – color of stroke
strokeWidth (float) – width of stroke
widthScaleFactor (float) – width scale factor
fixedAspectRatio (float = 0) – fixed aspect ratio (optional)
- Return type
QSizeF
- Returns
viewbox size set in SVG file
New in version 2.14.
-
timerEvent
()¶