commit afd0de670850e316d1327de6d92a5b0051b895bd · cduck.me/drawsvg

+10 -7

README.md

···

       50
        
                   stroke='black'))

     

       51
        
       

     

       52
        
       # Draw a rectangle

     

       53
       -
       r = draw.Rectangle(0,0,40,50, fill='#1248ff')

     

       54
        
       r.appendTitle("Our first rectangle")  # Add a tooltip

     

       55
        
       d.append(r)

     

       56
        
       

     
···

       59
        
                   fill='red', stroke_width=2, stroke='black'))

     

       60
        
       

     

       61
        
       # Draw an arbitrary path (a triangle in this case)

     

       62
       -
       p = draw.Path(stroke_width=2, stroke='green',

     

       63
       -
                     fill='black', fill_opacity=0.5)

     

       64
       -
       p.M(-30,5)  # Start path at point (-30, 5)

     

       65
       -
       p.l(60,30)  # Draw line to (60, 30)

     

       66
       -
       p.h(-70)    # Draw horizontal line to x=-70

     

       67
       -
       p.Z()       # Draw line to start

     

       68
        
       d.append(p)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       69
        
       

     

       70
        
       # Draw multiple circular arcs

     

       71
        
       d.append(draw.ArcLine(60,-20,20,60,270,

···

       50
        
                   stroke='black'))

     

       51
        
       

     

       52
        
       # Draw a rectangle

     

       53
       +
       r = draw.Rectangle(-80,0,40,50, fill='#1248ff')

     

       54
        
       r.appendTitle("Our first rectangle")  # Add a tooltip

     

       55
        
       d.append(r)

     

       56
        
       

     
···

       59
        
                   fill='red', stroke_width=2, stroke='black'))

     

       60
        
       

     

       61
        
       # Draw an arbitrary path (a triangle in this case)

     

       62
       +
       p = draw.Path(stroke_width=2, stroke='lime',

     

       63
       +
                     fill='black', fill_opacity=0.2)

     

       64
       +
       p.M(-10, 20)  # Start path at point (-10, 20)

     

       65
       +
       p.C(30, -10, 30, 50, 70, 20)  # Draw a curve to (70, 20)

     

       0
        
       
     

       0
        
       
     

       66
        
       d.append(p)

     

       67
       +
       

     

       68
       +
       # Draw text

     

       69
       +
       d.append(draw.Text('Basic text', 8, -10, 35, fill='blue'))  # Text with font size 8

     

       70
       +
       d.append(draw.Text('Path text', 8, path=p, text_anchor='start', valign='middle'))

     

       71
       +
       d.append(draw.Text(['Multi-line', 'text'], 8, path=p, text_anchor='end'))

     

       72
        
       

     

       73
        
       # Draw multiple circular arcs

     

       74
        
       d.append(draw.ArcLine(60,-20,20,60,270,

+122 -43

drawSvg/elements.py

···

       378
        
           ''' Text

     

       379
        
       

     

       380
        
               Additional keyword arguments are output as additional arguments to the

     

       381
       -
               SVG node e.g. fill="red", font_size=20, text_anchor="middle". '''

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       382
        
           TAG_NAME = 'text'

     

       383
        
           hasContent = True

     

       384
       -
           def __init__(self, text, fontSize, x, y, center=False, valign=None,

     

       385
       -
                        lineHeight=1, **kwargs):

     

       386
       -
               singleLine = isinstance(text, str)

     

       387
       -
               if '\n' in text:

     

       388
       -
                   text = text.splitlines()

     

       389
       -
                   singleLine = False

     

       390
       -
               if not singleLine:

     

       391
       -
                   text = tuple(text)

     

       392
       -
                   numLines = len(text)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       393
        
               else:

     

       394
       -
                   numLines = 1

     

       395
       -
               centerOffset = 0

     

       396
       -
               emOffset = 0

     

       397
       -
               if center:

     

       398
       -
                   if 'text_anchor' not in kwargs:

     

       399
       -
                       kwargs['text_anchor'] = 'middle'

     

       400
       -
                   if valign is None:

     

       401
       -
                       if singleLine:

     

       402
       -
                           # Backwards compatible centering

     

       403
       -
                           centerOffset = fontSize*0.5*center

     

       404
       -
                       else:

     

       405
       -
                           emOffset = 0.4 - lineHeight * (numLines - 1) / 2

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       406
        
               if valign == 'middle':

     

       407
       -
                   emOffset = 0.4 - lineHeight * (numLines - 1) / 2

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       408
        
               elif valign == 'top':

     

       409
       -
                   emOffset = 1

     

       410
        
               elif valign == 'bottom':

     

       411
       -
                   emOffset = -lineHeight * (numLines - 1)

     

       412
       -
               if centerOffset:

     

       413
       -
                   try:

     

       414
       -
                       fontSize = float(fontSize)

     

       415
       -
                   except TypeError:

     

       416
       -
                       pass

     

       417
       -
                   else:

     

       418
       -
                       translate = 'translate(0,{})'.format(centerOffset)

     

       419
       -
                       if 'transform' in kwargs:

     

       420
       -
                           kwargs['transform'] += ' ' + translate

     

       421
       -
                       else:

     

       422
       -
                           kwargs['transform'] = translate

     

       423
       -
               super().__init__(x=x, y=-y, font_size=fontSize, **kwargs)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       424
        
               if singleLine:

     

       425
       -
                   self.escapedText = xml.escape(text)

     

       426
        
               else:

     

       0
        
       
     

       427
        
                   self.escapedText = ''

     

       428
       -
                   # Text is an iterable

     

       429
       -
                   for i, line in enumerate(text):

     

       430
       -
                       dy = '{}em'.format(emOffset if i == 0 else lineHeight)

     

       431
       -
                       self.appendLine(line, x=x, dy=dy)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       432
        
           def writeContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       433
        
               if dryRun:

     

       434
        
                   return

     
···

       444
        
               for child in children:

     

       445
        
                   child.writeSvgElement(idGen, isDuplicate, outputFile, dryRun)

     

       446
        
           def appendLine(self, line, **kwargs):

     

       0
        
       
     

       0
        
       
     

       447
        
               self.append(TSpan(line, **kwargs))

     

       448
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       449
        
       class _TextContainingElement(DrawingBasicElement):

     

       450
        
           ''' A private parent class used for elements that only have plain text

     

       451
        
               content. '''

     
···

       457
        
               if dryRun:

     

       458
        
                   return

     

       459
        
               outputFile.write(self.escapedText)

     

       460
       -
       

     

       461
        
       

     

       462
        
       class TSpan(_TextContainingElement):

     

       463
        
           ''' A line of text within the Text element. '''

···

       378
        
           ''' Text

     

       379
        
       

     

       380
        
               Additional keyword arguments are output as additional arguments to the

     

       381
       +
               SVG node e.g. fill='red', font_size=20, text_anchor='middle',

     

       382
       +
               letter_spacing=1.5.

     

       383
       +
       

     

       384
       +
               CairoSVG bug with letter spacing text on a path: The first two letters

     

       385
       +
               are always spaced as if letter_spacing=1. '''

     

       386
        
           TAG_NAME = 'text'

     

       387
        
           hasContent = True

     

       388
       +
           def __new__(cls, text, *args, path=None, id=None, _skipCheck=False,

     

       389
       +
                       **kwargs):

     

       390
       +
               # Check for the special case of multi-line text on a path

     

       391
       +
               # This is inconsistently implemented by renderers so we return a group

     

       392
       +
               # of single-line text on paths instead.

     

       393
       +
               if path is not None and not _skipCheck:

     

       394
       +
                   text, _ = cls._handleTextArgument(text, True)

     

       395
       +
                   if len(text) > 1:

     

       396
       +
                       # Special case

     

       397
       +
                       g = Group(id=id)

     

       398
       +
                       for i, line in enumerate(text):

     

       399
       +
                           subtext = [None] * len(text)

     

       400
       +
                           subtext[i] = line

     

       401
       +
                           g.append(Text(subtext, *args, path=path, _skipCheck=True,

     

       402
       +
                                         **kwargs))

     

       403
       +
                       return g

     

       404
       +
               return super().__new__(cls)

     

       405
       +
           def __init__(self, text, fontSize, x=None, y=None, *, center=False,

     

       406
       +
                        valign=None, lineHeight=1, lineOffset=0, path=None,

     

       407
       +
                        startOffset=None, pathArgs=None, tspanArgs=None,

     

       408
       +
                        cairoFix=True, _skipCheck=False, **kwargs):

     

       409
       +
               # Check argument requirements

     

       410
       +
               if path is None:

     

       411
       +
                   if x is None or y is None:

     

       412
       +
                       raise TypeError(

     

       413
       +
                               "__init__() missing required arguments: 'x' and 'y' "

     

       414
       +
                               "are required unless 'path' is specified")

     

       415
       +
                   try:

     

       416
       +
                       y = -y

     

       417
       +
                   except TypeError:

     

       418
       +
                       pass

     

       419
        
               else:

     

       420
       +
                   if x is not None or y is not None:

     

       421
       +
                       raise TypeError(

     

       422
       +
                               "__init__() conflicting arguments: 'x' and 'y' "

     

       423
       +
                               "should not be used when 'path' is specified")

     

       424
       +
               if pathArgs is None:

     

       425
       +
                   pathArgs = {}

     

       426
       +
               if startOffset is not None:

     

       427
       +
                   pathArgs.setdefault('startOffset', startOffset)

     

       428
       +
               if tspanArgs is None:

     

       429
       +
                   tspanArgs = {}

     

       430
       +
               onPath = path is not None

     

       431
       +
       

     

       432
       +
               text, singleLine = self._handleTextArgument(text, forceMulti=onPath)

     

       433
       +
               numLines = len(text)

     

       434
       +
       

     

       435
       +
               # Text alignment

     

       436
       +
               centerCompat = False

     

       437
       +
               if center and valign is None:

     

       438
       +
                   valign = 'middle'

     

       439
       +
                   centerCompat = singleLine and not onPath

     

       440
       +
               if center and kwargs.get('text_anchor') is None:

     

       441
       +
                   kwargs['text_anchor'] = 'middle'

     

       442
        
               if valign == 'middle':

     

       443
       +
                   if centerCompat:  # Backwards compatible centering

     

       444
       +
                       lineOffset += 0.5 * center

     

       445
       +
                   else:

     

       446
       +
                       lineOffset += 0.4 - lineHeight * (numLines - 1) / 2

     

       447
        
               elif valign == 'top':

     

       448
       +
                   lineOffset += 1

     

       449
        
               elif valign == 'bottom':

     

       450
       +
                   lineOffset += -lineHeight * (numLines - 1)

     

       451
       +
               if singleLine:

     

       452
       +
                   dy = '{}em'.format(lineOffset)

     

       453
       +
                   kwargs.setdefault('dy', dy)

     

       454
       +
               # Text alignment on a path

     

       455
       +
               if onPath:

     

       456
       +
                   if kwargs.get('text_anchor') == 'start':

     

       457
       +
                       pathArgs.setdefault('startOffset', '0')

     

       458
       +
                   elif kwargs.get('text_anchor') == 'middle':

     

       459
       +
                       pathArgs.setdefault('startOffset', '50%')

     

       460
       +
                   elif kwargs.get('text_anchor') == 'end':

     

       461
       +
                       if cairoFix and 'startOffset' not in pathArgs:

     

       462
       +
                           # Fix CairoSVG not drawing the last character with aligned

     

       463
       +
                           # right

     

       464
       +
                           tspanArgs.setdefault('dx', -1)

     

       465
       +
                       pathArgs.setdefault('startOffset', '100%')

     

       466
       +
       

     

       467
       +
               super().__init__(x=x, y=y, font_size=fontSize, **kwargs)

     

       468
       +
               self._textPath = None

     

       469
        
               if singleLine:

     

       470
       +
                   self.escapedText = xml.escape(text[0])

     

       471
        
               else:

     

       472
       +
                   # Add elements for each line of text

     

       473
        
                   self.escapedText = ''

     

       474
       +
                   if path is None:

     

       475
       +
                       # Text is an iterable

     

       476
       +
                       for i, line in enumerate(text):

     

       477
       +
                           dy = '{}em'.format(lineOffset if i == 0 else lineHeight)

     

       478
       +
                           self.appendLine(line, x=x, dy=dy, **tspanArgs)

     

       479
       +
                   else:

     

       480
       +
                       self._textPath = _TextPath(path, **pathArgs)

     

       481
       +
                       assert sum(bool(line) for line in text) <= 1, (

     

       482
       +
                               'Logic error, __new__ should handle multi-line paths')

     

       483
       +
                       for i, line in enumerate(text):

     

       484
       +
                           if not line: continue

     

       485
       +
                           dy = '{}em'.format(lineOffset + i*lineHeight)

     

       486
       +
                           tspan = TSpan(line, dy=dy, **tspanArgs)

     

       487
       +
                           self._textPath.append(tspan)

     

       488
       +
                       self.append(self._textPath)

     

       489
       +
           @staticmethod

     

       490
       +
           def _handleTextArgument(text, forceMulti=False):

     

       491
       +
               # Handle multi-line text (contains '\n' or is a list of strings)

     

       492
       +
               singleLine = isinstance(text, str)

     

       493
       +
               if isinstance(text, str):

     

       494
       +
                   singleLine = '\n' not in text and not forceMulti

     

       495
       +
                   if singleLine:

     

       496
       +
                       text = (text,)

     

       497
       +
                   else:

     

       498
       +
                       text = tuple(text.splitlines())

     

       499
       +
                       singleLine = False

     

       500
       +
               else:

     

       501
       +
                   singleLine = False

     

       502
       +
                   text = tuple(text)

     

       503
       +
               return text, singleLine

     

       504
        
           def writeContent(self, idGen, isDuplicate, outputFile, dryRun):

     

       505
        
               if dryRun:

     

       506
        
                   return

     
···

       516
        
               for child in children:

     

       517
        
                   child.writeSvgElement(idGen, isDuplicate, outputFile, dryRun)

     

       518
        
           def appendLine(self, line, **kwargs):

     

       519
       +
               if self._textPath is not None:

     

       520
       +
                   raise ValueError('appendLine is not supported for text on a path')

     

       521
        
               self.append(TSpan(line, **kwargs))

     

       522
        
       

     

       523
       +
       class _TextPath(DrawingParentElement):

     

       524
       +
           TAG_NAME = 'textPath'

     

       525
       +
           hasContent = True

     

       526
       +
           def __init__(self, path, **kwargs):

     

       527
       +
               super().__init__(xlink__href=path, **kwargs)

     

       528
       +
       

     

       529
        
       class _TextContainingElement(DrawingBasicElement):

     

       530
        
           ''' A private parent class used for elements that only have plain text

     

       531
        
               content. '''

     
···

       537
        
               if dryRun:

     

       538
        
                   return

     

       539
        
               outputFile.write(self.escapedText)

     

       0
        
       
     

       540
        
       

     

       541
        
       class TSpan(_TextContainingElement):

     

       542
        
           ''' A line of text within the Text element. '''

+18 -5

examples/example1.svg

···

       2
        
       <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
        
            width="400" height="200" viewBox="-100.0 -50.0 200 100">

     

       4
        
       <defs>

     

       5
       -
       <marker markerWidth="4.0" markerHeight="4.0" viewBox="-0.1 -0.5 1.0 1.0" orient="auto" id="d0">

     

       0
        
       
     

       6
        
       <path d="M-0.1,0.5 L-0.1,-0.5 L0.9,0 Z" fill="red" />

     

       7
        
       </marker>

     

       8
        
       </defs>

     

       9
        
       <path d="M-80,45 L70,49 L95,-49 L-90,-40" fill="#eeee00" stroke="black" />

     

       10
       -
       <rect x="0" y="-50" width="40" height="50" fill="#1248ff">

     

       11
        
       <title>Our first rectangle</title>

     

       12
        
       </rect>

     

       13
        
       <circle cx="-40" cy="10" r="30" fill="red" stroke-width="2" stroke="black" />

     

       14
       -
       <path d="M-30,-5 l60,-30 h-70 Z" stroke-width="2" stroke="green" fill="black" fill-opacity="0.5" />

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       15
        
       <circle cx="60" cy="20" r="20" stroke-dasharray="73.30382858376184 52.35987755982988" stroke-dashoffset="-31.41592653589793" stroke="red" stroke-width="5" fill="red" fill-opacity="0.2" />

     

       16
        
       <path d="M70.0,2.679491924311229 A20,20,0,1,0,59.99999999999999,40.0" stroke="green" stroke-width="3" fill="none" />

     

       17
        
       <path d="M59.99999999999999,40.0 A20,20,0,1,1,70.0,2.679491924311229" stroke="blue" stroke-width="1" fill="black" fill-opacity="0.3" />

     

       18
       -
       <path d="M20,40 L20,27 L0,20" stroke="red" stroke-width="2" fill="none" marker-end="url(#d0)" />

     

       19
       -
       <path d="M30,20 L0,10" stroke="red" stroke-width="2" fill="none" marker-end="url(#d0)" />

     

       20
        
       </svg>

···

       2
        
       <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
        
            width="400" height="200" viewBox="-100.0 -50.0 200 100">

     

       4
        
       <defs>

     

       5
       +
       <path d="M-10,-20 C30,10,30,-50,70,-20" stroke-width="2" stroke="lime" fill="black" fill-opacity="0.2" id="d0" />

     

       6
       +
       <marker markerWidth="4.0" markerHeight="4.0" viewBox="-0.1 -0.5 1.0 1.0" orient="auto" id="d1">

     

       7
        
       <path d="M-0.1,0.5 L-0.1,-0.5 L0.9,0 Z" fill="red" />

     

       8
        
       </marker>

     

       9
        
       </defs>

     

       10
        
       <path d="M-80,45 L70,49 L95,-49 L-90,-40" fill="#eeee00" stroke="black" />

     

       11
       +
       <rect x="-80" y="-50" width="40" height="50" fill="#1248ff">

     

       12
        
       <title>Our first rectangle</title>

     

       13
        
       </rect>

     

       14
        
       <circle cx="-40" cy="10" r="30" fill="red" stroke-width="2" stroke="black" />

     

       15
       +
       <use xlink:href="#d0" />

     

       16
       +
       <text x="-10" y="-35" font-size="8" fill="blue" dy="0em">Basic text</text>

     

       17
       +
       <text font-size="8" text-anchor="start"><textPath xlink:href="#d0" startOffset="0">

     

       18
       +
       <tspan dy="0.4em">Path text</tspan>

     

       19
       +
       </textPath></text>

     

       20
       +
       <g>

     

       21
       +
       <text font-size="8" text-anchor="end"><textPath xlink:href="#d0" startOffset="100%">

     

       22
       +
       <tspan dy="0em" dx="-1">Multi-line</tspan>

     

       23
       +
       </textPath></text>

     

       24
       +
       <text font-size="8" text-anchor="end"><textPath xlink:href="#d0" startOffset="100%">

     

       25
       +
       <tspan dy="1em" dx="-1">text</tspan>

     

       26
       +
       </textPath></text>

     

       27
       +
       </g>

     

       28
        
       <circle cx="60" cy="20" r="20" stroke-dasharray="73.30382858376184 52.35987755982988" stroke-dashoffset="-31.41592653589793" stroke="red" stroke-width="5" fill="red" fill-opacity="0.2" />

     

       29
        
       <path d="M70.0,2.679491924311229 A20,20,0,1,0,59.99999999999999,40.0" stroke="green" stroke-width="3" fill="none" />

     

       30
        
       <path d="M59.99999999999999,40.0 A20,20,0,1,1,70.0,2.679491924311229" stroke="blue" stroke-width="1" fill="black" fill-opacity="0.3" />

     

       31
       +
       <path d="M20,40 L20,27 L0,20" stroke="red" stroke-width="2" fill="none" marker-end="url(#d1)" />

     

       32
       +
       <path d="M30,20 L0,10" stroke="red" stroke-width="2" fill="none" marker-end="url(#d1)" />

     

       33
        
       </svg>