__all__ = ['SVGExporter']
import contextlib
import re
import xml.dom.minidom as xml
import numpy as np
from .. import debug
from .. import functions as fn
from ..parametertree import Parameter
from ..Qt import QtCore, QtGui, QtSvg, QtWidgets
from .Exporter import Exporter
translate = QtCore.QCoreApplication.translate
class SVGExporter(Exporter):
Name = "Scalable Vector Graphics (SVG)"
allowCopy=True
def __init__(self, item):
Exporter.__init__(self, item)
tr = self.getTargetRect()
scene = item.scene() if isinstance(item, QtWidgets.QGraphicsItem) else item
bgbrush = scene.views()[0].backgroundBrush()
bg = bgbrush.color()
if bgbrush.style() == QtCore.Qt.BrushStyle.NoBrush:
bg.setAlpha(0)
self.params = Parameter.create(name='params', type='group', children=[
{'name': 'background', 'title': translate("Exporter", 'background'), 'type': 'color', 'value': bg},
{'name': 'width', 'title': translate("Exporter", 'width'), 'type': 'float', 'value': tr.width(),
'limits': (0, None)},
{'name': 'height', 'title': translate("Exporter", 'height'), 'type': 'float', 'value': tr.height(),
'limits': (0, None)},
#{'name': 'viewbox clipping', 'type': 'bool', 'value': True},
#{'name': 'normalize coordinates', 'type': 'bool', 'value': True},
{
'name': 'scaling stroke',
'title': translate("Exporter", 'scaling stroke'),
'type': 'bool',
'value': False,
'tip': "If False, strokes are non-scaling, which means that "
"they appear the same width on screen regardless of "
"how they are scaled or how the view is zoomed."
},
])
self.params.param('width').sigValueChanged.connect(self.widthChanged)
self.params.param('height').sigValueChanged.connect(self.heightChanged)
def widthChanged(self):
sr = self.getSourceRect()
ar = sr.height() / sr.width()
self.params.param('height').setValue(self.params['width'] * ar, blockSignal=self.heightChanged)
def heightChanged(self):
sr = self.getSourceRect()
ar = sr.width() / sr.height()
self.params.param('width').setValue(self.params['height'] * ar, blockSignal=self.widthChanged)
def parameters(self):
return self.params
def export(self, fileName=None, toBytes=False, copy=False):
if toBytes is False and copy is False and fileName is None:
self.fileSaveDialog(filter=f"{translate('Exporter', 'Scalable Vector Graphics')} (*.svg)")
return
## Qt's SVG generator is not complete. (notably, it lacks clipping)
## Instead, we will use Qt to generate SVG for each item independently,
## then manually reconstruct the entire document.
options = {ch.name():ch.value() for ch in self.params.children()}
options['background'] = self.params['background']
options['width'] = self.params['width']
options['height'] = self.params['height']
xml = generateSvg(self.item, options)
if toBytes:
return xml.encode('UTF-8')
elif copy:
md = QtCore.QMimeData()
md.setData('image/svg+xml', QtCore.QByteArray(xml.encode('UTF-8')))
QtWidgets.QApplication.clipboard().setMimeData(md)
else:
with open(fileName, 'wb') as fh:
fh.write(xml.encode('utf-8'))
# Includes space for extra attributes
xmlHeader = """\
\n"
def _generateItemSvg(item, nodes=None, root=None, options=None):
"""This function is intended to work around some issues with Qt's SVG generator
and SVG in general.
.. warning::
This function, while documented, is not considered part of the public
API. The reason for its documentation is for ease of referencing by
:func:`~pyqtgraph.GraphicsItem.generateSvg`. There should be no need
to call this function explicitly.
1. Qt SVG does not implement clipping paths. This is absurd.
The solution is to let Qt generate SVG for each item independently,
then glue them together manually with clipping. The format Qt generates
for all items looks like this:
.. code-block:: xml
one or more of: or or
one or more of: or or
. . .
2. There seems to be wide disagreement over whether path strokes
should be scaled anisotropically. Given that both inkscape and
illustrator seem to prefer isotropic scaling, we will optimize for
those cases.
.. note::
see: http://web.mit.edu/jonas/www/anisotropy/
3. Qt generates paths using non-scaling-stroke from SVG 1.2, but
inkscape only supports 1.1.
Both 2 and 3 can be addressed by drawing all items in world coordinates.
Parameters
----------
item : :class:`~pyqtgraph.GraphicsItem`
GraphicsItem to generate SVG of
nodes : dict of str, optional
dictionary keyed on graphics item names, values contains the
XML elements, by default None
root : :class:`~pyqtgraph.GraphicsItem`, optional
root GraphicsItem, if none, assigns to `item`, by default None
options : dict of str, optional
Options to be applied to the generated XML, by default None
Returns
-------
tuple
tuple where first element is XML element, second element is
a list of child GraphicItems XML elements
"""
profiler = debug.Profiler()
if options is None:
options = {}
if nodes is None: ## nodes maps all node IDs to their XML element.
## this allows us to ensure all elements receive unique names.
nodes = {}
if root is None:
root = item
## Skip hidden items
if hasattr(item, 'isVisible') and not item.isVisible():
return None
with contextlib.suppress(NotImplementedError, AttributeError):
# If this item defines its own SVG generator, use that.
return item.generateSvg(nodes)
## Generate SVG text for just this item (exclude its children; we'll handle them later)
if isinstance(item, QtWidgets.QGraphicsScene):
xmlStr = "\n\n"
doc = xml.parseString(xmlStr)
childs = [i for i in item.items() if i.parentItem() is None]
elif item.__class__.paint == QtWidgets.QGraphicsItem.paint:
xmlStr = "\n\n"
doc = xml.parseString(xmlStr)
childs = item.childItems()
else:
childs = item.childItems()
tr = itemTransform(item, item.scene())
# offset to corner of root item
if isinstance(root, QtWidgets.QGraphicsScene):
rootPos = QtCore.QPoint(0,0)
else:
rootPos = root.scenePos()
# handle rescaling from the export dialog
if hasattr(root, 'boundingRect'):
resize_x = options["width"] / root.boundingRect().width()
resize_y = options["height"] / root.boundingRect().height()
else:
resize_x = resize_y = 1
tr2 = QtGui.QTransform(resize_x, 0, 0, resize_y, -rootPos.x(), -rootPos.y())
tr = tr * tr2
# tr = manipulate * tr * tr2
arr = QtCore.QByteArray()
buf = QtCore.QBuffer(arr)
svg = QtSvg.QSvgGenerator()
svg.setOutputDevice(buf)
dpi = QtGui.QGuiApplication.primaryScreen().logicalDotsPerInchX()
svg.setResolution(int(dpi))
p = QtGui.QPainter()
p.begin(svg)
if hasattr(item, 'setExportMode'):
item.setExportMode(True, {'painter': p})
try:
p.setTransform(tr)
opt = QtWidgets.QStyleOptionGraphicsItem()
if item.flags() & QtWidgets.QGraphicsItem.GraphicsItemFlag.ItemUsesExtendedStyleOption:
opt.exposedRect = item.boundingRect()
item.paint(p, opt, None)
finally:
p.end()
## Can't do this here--we need to wait until all children have painted as well.
## this is taken care of in generateSvg instead.
# if hasattr(item, 'setExportMode'):
# item.setExportMode(False)
doc = xml.parseString(arr.data())
try:
## Get top-level group for this item
g1 = doc.getElementsByTagName('g')[0]
defs = doc.getElementsByTagName('defs')
if len(defs) > 0:
defs = [n for n in defs[0].childNodes if isinstance(n, xml.Element)]
except:
print(doc.toxml())
raise
profiler('render')
## Get rid of group transformation matrices by applying
## transformation to inner coordinates
correctCoordinates(g1, defs, item, options)
profiler('correct')
## decide on a name for this item
baseName = item.__class__.__name__
i = 1
while True:
name = baseName + "_%d" % i
if name not in nodes:
break
i += 1
nodes[name] = g1
g1.setAttribute('id', name)
## If this item clips its children, we need to take care of that.
childGroup = g1 ## add children directly to this node unless we are clipping
if (
not isinstance(item, QtWidgets.QGraphicsScene) and
item.flags() & item.GraphicsItemFlag.ItemClipsChildrenToShape
):
## Generate svg for just the path
path = QtWidgets.QGraphicsPathItem(item.mapToScene(item.shape()))
item.scene().addItem(path)
try:
pathNode = _generateItemSvg(path, root=root, options=options)[0].getElementsByTagName('path')[0]
# assume for this path is empty.. possibly problematic.
finally:
item.scene().removeItem(path)
## and for the clipPath element
clip = f'{name}_clip'
clipNode = g1.ownerDocument.createElement('clipPath')
clipNode.setAttribute('id', clip)
clipNode.appendChild(pathNode)
g1.appendChild(clipNode)
childGroup = g1.ownerDocument.createElement('g')
childGroup.setAttribute('clip-path', f'url(#{clip})')
g1.appendChild(childGroup)
profiler('clipping')
## Add all child items as sub-elements.
childs.sort(key=lambda c: c.zValue())
for ch in childs:
csvg = _generateItemSvg(ch, nodes, root, options=options)
if csvg is None:
continue
cg, cdefs = csvg
childGroup.appendChild(cg) ### this isn't quite right--some items draw below their parent (good enough for now)
defs.extend(cdefs)
profiler('children')
return g1, defs
def correctCoordinates(node, defs, item, options):
# correct the defs in the linearGradient
for d in defs:
if d.tagName == "linearGradient":
# reset "gradientUnits" attribute to SVG default value
d.removeAttribute("gradientUnits")
# replace with percentages
for coord in ("x1", "x2", "y1", "y2"):
if coord.startswith("x"):
denominator = item.boundingRect().width()
else:
denominator = item.boundingRect().height()
percentage = round(float(d.getAttribute(coord)) * 100 / denominator)
d.setAttribute(coord, f"{percentage}%")
# replace stops with percentages
for child in filter(
lambda e: isinstance(e, xml.Element) and e.tagName == "stop",
d.childNodes
):
offset = child.getAttribute("offset")
try:
child.setAttribute("offset", f"{round(float(offset) * 100)}%")
except ValueError:
# offset attribute could not be converted to float
# must be one of the other SVG accepted formats
continue
## Remove transformation matrices from tags by applying matrix to coordinates inside.
## Each item is represented by a single top-level group with one or more groups inside.
## Each inner group contains one or more drawing primitives, possibly of different types.
groups = node.getElementsByTagName('g')
## Since we leave text unchanged, groups which combine text and non-text primitives must be split apart.
## (if at some point we start correcting text transforms as well, then it should be safe to remove this)
groups2 = []
for grp in groups:
subGroups = [grp.cloneNode(deep=False)]
textGroup = None
for ch in grp.childNodes[:]:
if isinstance(ch, xml.Element):
if textGroup is None:
textGroup = ch.tagName == 'text'
if ch.tagName == 'text':
if textGroup is False:
subGroups.append(grp.cloneNode(deep=False))
textGroup = True
else:
if textGroup is True:
subGroups.append(grp.cloneNode(deep=False))
textGroup = False
subGroups[-1].appendChild(ch)
groups2.extend(subGroups)
for sg in subGroups:
node.insertBefore(sg, grp)
node.removeChild(grp)
groups = groups2
for grp in groups:
matrix = grp.getAttribute('transform')
match = re.match(r'matrix\((.*)\)', matrix)
if match is None:
vals = [1,0,0,1,0,0]
else:
vals = [float(a) for a in match.groups()[0].split(',')]
tr = np.array([[vals[0], vals[2], vals[4]], [vals[1], vals[3], vals[5]]])
removeTransform = False
for ch in grp.childNodes:
if not isinstance(ch, xml.Element):
continue
if ch.tagName == 'polyline':
removeTransform = True
coords = np.array([[float(a) for a in c.split(',')] for c in ch.getAttribute('points').strip().split(' ')])
coords = fn.transformCoordinates(tr, coords, transpose=True)
ch.setAttribute('points', ' '.join([','.join([str(a) for a in c]) for c in coords]))
elif ch.tagName == 'path':
removeTransform = True
newCoords = ''
oldCoords = ch.getAttribute('d').strip()
if oldCoords == '':
continue
for c in oldCoords.split(' '):
x,y = c.split(',')
if x[0].isalpha():
t = x[0]
x = x[1:]
else:
t = ''
nc = fn.transformCoordinates(tr, np.array([[float(x),float(y)]]), transpose=True)
newCoords += t+str(nc[0,0])+','+str(nc[0,1])+' '
# If coords start with L instead of M, then the entire path will not be rendered.
# (This can happen if the first point had nan values in it--Qt will skip it on export)
if newCoords[0] != 'M':
newCoords = f'M{newCoords[1:]}'
ch.setAttribute('d', newCoords)
elif ch.tagName == 'text':
removeTransform = False
## leave text alone for now. Might need this later to correctly render text with outline.
# c = np.array([
# [float(ch.getAttribute('x')), float(ch.getAttribute('y'))],
# [float(ch.getAttribute('font-size')), 0],
# [0,0]])
# c = fn.transformCoordinates(tr, c, transpose=True)
# ch.setAttribute('x', str(c[0,0]))
# ch.setAttribute('y', str(c[0,1]))
# fs = c[1]-c[2]
# fs = (fs**2).sum()**0.5
# ch.setAttribute('font-size', str(fs))
## Correct some font information
families = ch.getAttribute('font-family').split(',')
if len(families) == 1:
font = QtGui.QFont(families[0].strip('" '))
if font.styleHint() == font.StyleHint.SansSerif:
families.append('sans-serif')
elif font.styleHint() == font.StyleHint.Serif:
families.append('serif')
elif font.styleHint() == font.StyleHint.Courier:
families.append('monospace')
ch.setAttribute('font-family', ', '.join([f if ' ' not in f else '"%s"'%f for f in families]))
## correct line widths if needed
if removeTransform and ch.getAttribute('vector-effect') != 'non-scaling-stroke' and grp.getAttribute('stroke-width') != '':
w = float(grp.getAttribute('stroke-width'))
s = fn.transformCoordinates(tr, np.array([[w,0], [0,0]]), transpose=True)
w = ((s[0]-s[1])**2).sum()**0.5
ch.setAttribute('stroke-width', str(w))
# Remove non-scaling-stroke if requested
if options.get('scaling stroke') is True and ch.getAttribute('vector-effect') == 'non-scaling-stroke':
ch.removeAttribute('vector-effect')
if removeTransform:
grp.removeAttribute('transform')
SVGExporter.register()
def itemTransform(item, root):
## Return the transformation mapping item to root
## (actually to parent coordinate system of root)
if item is root:
tr = QtGui.QTransform()
tr.translate(*item.pos())
tr = tr * item.transform()
return tr
if item.flags() & item.GraphicsItemFlag.ItemIgnoresTransformations:
pos = item.pos()
parent = item.parentItem()
if parent is not None:
pos = itemTransform(parent, root).map(pos)
tr = QtGui.QTransform()
tr.translate(pos.x(), pos.y())
tr = item.transform() * tr
else:
## find next parent that is either the root item or
## an item that ignores its transformation
nextRoot = item
while True:
nextRoot = nextRoot.parentItem()
if nextRoot is None:
nextRoot = root
break
if nextRoot is root or (nextRoot.flags() & nextRoot.GraphicsItemFlag.ItemIgnoresTransformations):
break
if isinstance(nextRoot, QtWidgets.QGraphicsScene):
tr = item.sceneTransform()
else:
tr = itemTransform(nextRoot, root) * item.itemTransform(nextRoot)[0]
return tr
def cleanXml(node):
## remove extraneous text; let the xml library do the formatting.
hasElement = False
nonElement = []
for ch in node.childNodes:
if isinstance(ch, xml.Element):
hasElement = True
cleanXml(ch)
else:
nonElement.append(ch)
if hasElement:
for ch in nonElement:
node.removeChild(ch)
elif node.tagName == 'g': ## remove childless groups
node.parentNode.removeChild(node)