svgfig.SVG Class Reference

Classes
class	SVGDepthIterator
	nested class More...

Public Member Functions
def	__contains__ (self, value)
def	__delitem__ (self, ti)
def	__eq__ (self, other)
def	__getitem__ (self, ti)
def	__init__ (self, t_sub, attr)
def	__iter__ (self)
def	__ne__ (self, other)
def	__repr__ (self)
def	__setitem__ (self, ti, value)
def	__str__ (self)
def	append (self, x)
def	breadth_first (self, depth_limit=None)
def	clone (self, shallow=False)
def	depth_first (self, depth_limit=None)
	end nested class More...
def	extend (self, x)
def	firefox (self, fileName=None, encoding="utf-8")
def	inkscape (self, fileName=None, encoding="utf-8")
def	inkview (self, fileName=None, encoding="utf-8")
def	interpret_fileName (self, fileName=None)
def	items (self, sub=True, attr=True, text=True)
def	keys (self, sub=True, attr=True, text=True)
def	prepend (self, x)
def	save (self, fileName=None, encoding="utf-8", compresslevel=None)
def	standalone_xml (self, indent=" ", newl="\n")
def	tree (self, depth_limit=None, sub=True, attr=True, text=True, tree_width=20, obj_width=80)
def	values (self, sub=True, attr=True, text=True)
def	xml (self, indent=" ", newl="\n", depth_limit=None, depth=0)

Public Attributes
	attr
	sub
	t

Private Member Functions
def	__standalone_xml (self, indent, newl)

Detailed Description

A tree representation of an SVG image or image fragment.

SVG(t, sub, sub, sub..., attribute=value)

t                       required             SVG type name
sub                     optional list        nested SVG elements or text/Unicode
attribute=value pairs   optional keywords    SVG attributes

In attribute names, "__" becomes ":" and "_" becomes "-".

SVG in XML

<g id="mygroup" fill="blue">
    <rect x="1" y="1" width="2" height="2" />
    <rect x="3" y="3" width="2" height="2" />
</g>

SVG in Python

>>> svg = SVG("g", SVG("rect", x=1, y=1, width=2, height=2), \ 
...                SVG("rect", x=3, y=3, width=2, height=2), \ 
...           id="mygroup", fill="blue")

Sub-elements and attributes may be accessed through tree-indexing:

>>> svg = SVG("text", SVG("tspan", "hello there"), stroke="none", fill="black")
>>> svg[0]
<tspan (1 sub) />
>>> svg[0, 0]
'hello there'
>>> svg["fill"]
'black'

Iteration is depth-first:

>>> svg = SVG("g", SVG("g", SVG("line", x1=0, y1=0, x2=1, y2=1)), \
...                SVG("text", SVG("tspan", "hello again")))
... 
>>> for ti, s in svg:
...     print ti, repr(s)
... 
(0,) <g (1 sub) />
(0, 0) <line x2=1 y1=0 x1=0 y2=1 />
(0, 0, 'x2') 1
(0, 0, 'y1') 0
(0, 0, 'x1') 0
(0, 0, 'y2') 1
(1,) <text (1 sub) />
(1, 0) <tspan (1 sub) />
(1, 0, 0) 'hello again'

Use "print" to navigate:

>>> print svg
None                 <g (2 sub) />
[0]                      <g (1 sub) />
[0, 0]                       <line x2=1 y1=0 x1=0 y2=1 />
[1]                      <text (1 sub) />
[1, 0]                       <tspan (1 sub) />

Definition at line 62 of file svgfig.py.

Constructor & Destructor Documentation

def svgfig.SVG.__init__	(		self,
			t_sub,
			attr
	)

Definition at line 123 of file svgfig.py.

  def __init__(self, *t_sub, **attr):
    if len(t_sub) == 0: raise TypeError("SVG element must have a t (SVG type)")

    # first argument is t (SVG type)
    self.t = t_sub[0]
    # the rest are sub-elements
    self.sub = list(t_sub[1:])
    
    # keyword arguments are attributes
    # need to preprocess to handle differences between SVG and Python syntax
    self.attr = attr_preprocess(attr)

Member Function Documentation

def svgfig.SVG.__contains__	(		self,
			value
	)

x in svg == True iff x is an attribute in svg.

Definition at line 168 of file svgfig.py.

References svgfig.SVG.attr.

  def __contains__(self, value):
    """x in svg == True iff x is an attribute in svg."""
    return value in self.attr

def svgfig.SVG.__delitem__	(		self,
			ti
	)

Index is a list that descends tree, returning a sub-element if
it ends with a number and an attribute if it ends with a string.

Definition at line 157 of file svgfig.py.

  def __delitem__(self, ti):
    """Index is a list that descends tree, returning a sub-element if
    it ends with a number and an attribute if it ends with a string."""
    obj = self
    if isinstance(ti, (list, tuple)):
      for i in ti[:-1]: obj = obj[i]
      ti = ti[-1]

    if isinstance(ti, (int, long, slice)): del obj.sub[ti]
    else: del obj.attr[ti]

def svgfig.SVG.__eq__	(		self,
			other
	)

x == y iff x represents the same SVG as y.

Definition at line 172 of file svgfig.py.

References svgfig.SVG.attr, triggerObjects_cff.id, svgfig.SVG.sub, AlignmentMonitorMuonSystemMap1D::MyCSCDetId.t, and svgfig.SVG.t.

Referenced by SequenceTypes._UnarySequenceOperator.__ne__().

  def __eq__(self, other):
    """x == y iff x represents the same SVG as y."""
    if id(self) == id(other): return True
    return isinstance(other, SVG) and self.t == other.t and self.sub == other.sub and self.attr == other.attr

def svgfig.SVG.__getitem__	(		self,
			ti
	)

Index is a list that descends tree, returning a sub-element if
it ends with a number and an attribute if it ends with a string.

Definition at line 135 of file svgfig.py.

  def __getitem__(self, ti):
    """Index is a list that descends tree, returning a sub-element if
    it ends with a number and an attribute if it ends with a string."""
    obj = self
    if isinstance(ti, (list, tuple)):
      for i in ti[:-1]: obj = obj[i]
      ti = ti[-1]

    if isinstance(ti, (int, long, slice)): return obj.sub[ti]
    else: return obj.attr[ti]

def svgfig.SVG.__iter__

(

self

)

Definition at line 246 of file svgfig.py.

References svgfig.SVG.depth_first().

  def __iter__(self): return self.depth_first()

def svgfig.SVG.__ne__	(		self,
			other
	)

x != y iff x does not represent the same SVG as y.

Definition at line 177 of file svgfig.py.

  def __ne__(self, other):
    """x != y iff x does not represent the same SVG as y."""
    return not (self == other)

def svgfig.SVG.__repr__

(

self

)

Definition at line 284 of file svgfig.py.

References svgfig.SVG.xml().

Referenced by data_sources.json_file.__str__().

  def __repr__(self): return self.xml(depth_limit=0)

def svgfig.SVG.__setitem__	(		self,
			ti,
			value
	)

Index is a list that descends tree, returning a sub-element if
it ends with a number and an attribute if it ends with a string.

Definition at line 146 of file svgfig.py.

  def __setitem__(self, ti, value):
    """Index is a list that descends tree, returning a sub-element if
    it ends with a number and an attribute if it ends with a string."""
    obj = self
    if isinstance(ti, (list, tuple)):
      for i in ti[:-1]: obj = obj[i]
      ti = ti[-1]

    if isinstance(ti, (int, long, slice)): obj.sub[ti] = value
    else: obj.attr[ti] = value

def svgfig.SVG.__standalone_xml (   self,   indent,   newl  )

private

Definition at line 372 of file svgfig.py.

References join(), svgfig.SVG.sub, AlignmentMonitorMuonSystemMap1D::MyCSCDetId.t, and svgfig.SVG.t.

  def __standalone_xml(self, indent, newl):
    output = [u"<%s" % self.t]

    for n, v in self.attr.items():
      if isinstance(v, dict):
        v = "; ".join(["%s:%s" % (ni, vi) for ni, vi in v.items()])
      elif isinstance(v, (list, tuple)):
        v = ", ".join(v)
      output.append(u" %s=\"%s\"" % (n, v))

    if len(self.sub) == 0:
      output.append(u" />%s%s" % (newl, newl))
      return output

    elif self.t == "text" or self.t == "tspan" or self.t == "style":
      output.append(u">")

    else:
      output.append(u">%s%s" % (newl, newl))

    for s in self.sub:
      if isinstance(s, SVG): output.extend(s.__standalone_xml(indent, newl))
      else: output.append(unicode(s))

    if self.t == "tspan": output.append(u"</%s>" % self.t)
    else: output.append(u"</%s>%s%s" % (self.t, newl, newl))

    return output

def svgfig.SVG.__str__

(

self

)

Print (actually, return a string of) the tree in a form useful for browsing.

Definition at line 286 of file svgfig.py.

References tree.Tree.tree, SimpleTreeProducer.SimpleTreeProducer.tree, eventstfile.Events.tree, CSCTFanalyzer.tree, CSCTFAnalyzer.tree, core.TreeAnalyzerNumpy.TreeAnalyzerNumpy.tree, HcalTestHistoManager.tree, TreeWriterForEcalCorrection.tree, TkOfflineVariables.tree, AlignmentIORootBase.tree, HIPTwoBodyDecayAnalyzer.tree, KVFTest.tree, EcalPerEvtMatacqAnalyzer.tree, CheckSecondary.tree, EcalDeadChannelRecoveryNN< DetIdT >::MultiLayerPerceptronContext.tree, TreeSaver.tree, EcalMatacqAnalyzer.tree, PhysicsTools::TreeReader.tree, IsoTrackCalibration.tree, KinematicVertex.tree, IsoTrackCalib.tree, KinematicParticle.tree, and svgfig.SVG.tree().

Referenced by edmStreamStallGrapher.Point.__repr__(), BeautifulSoup.Tag.__repr__(), BeautifulSoup.Tag.__unicode__(), and BeautifulSoup.Tag.prettify().

  def __str__(self):
    """Print (actually, return a string of) the tree in a form useful for browsing."""
    return self.tree(sub=True, attr=False, text=False)

def svgfig.SVG.append	(		self,
			x
	)

Appends x to the list of sub-elements (drawn last, overlaps
other primatives).

Definition at line 181 of file svgfig.py.

Referenced by diclist.diclist.add(), Vispa.Views.PropertyView.PropertyView.addProperty(), and BeautifulSoup.Tag.setString().

  def append(self, x):
    """Appends x to the list of sub-elements (drawn last, overlaps
    other primatives)."""
    self.sub.append(x)

def svgfig.SVG.breadth_first	(		self,
			depth_limit = None
	)

Not implemented yet.  Any ideas on how to do it?

Returns a breadth-first generator over the SVG.  If depth_limit
is a number, stop recursion at that depth.

Definition at line 239 of file svgfig.py.

  def breadth_first(self, depth_limit=None):
    """Not implemented yet.  Any ideas on how to do it?

    Returns a breadth-first generator over the SVG.  If depth_limit
    is a number, stop recursion at that depth."""
    raise NotImplementedError("Got an algorithm for breadth-first searching a tree without effectively copying the tree?")

def svgfig.SVG.clone	(		self,
			shallow = False
	)

Deep copy of SVG tree.  Set shallow=True for a shallow copy.

Definition at line 195 of file svgfig.py.

  def clone(self, shallow=False):
    """Deep copy of SVG tree.  Set shallow=True for a shallow copy."""
    if shallow:
      return copy.copy(self)
    else:
      return copy.deepcopy(self)

def svgfig.SVG.depth_first	(		self,
			depth_limit = None
	)

end nested class

Returns a depth-first generator over the SVG.  If depth_limit
is a number, stop recursion at that depth.

Definition at line 234 of file svgfig.py.

Referenced by svgfig.SVG.__iter__(), and svgfig.SVG.tree().

  def depth_first(self, depth_limit=None):
    """Returns a depth-first generator over the SVG.  If depth_limit
    is a number, stop recursion at that depth."""
    return self.SVGDepthIterator(self, (), depth_limit)

def svgfig.SVG.extend	(		self,
			x
	)

Extends list of sub-elements by a list x.

Definition at line 191 of file svgfig.py.

Referenced by MatrixUtil.WF.__init__(), Config.Process.extend(), Config.Process.load(), and Mixins._ValidatingParameterListBase.setValue().

  def extend(self, x):
    """Extends list of sub-elements by a list x."""
    self.sub.extend(x)

def svgfig.SVG.firefox	(		self,
			fileName = None,
			encoding = "utf-8"
	)

View in "firefox", assuming that program is available on your system.

fileName        default=None            note that any file named _default_fileName will be
                                    overwritten if no fileName is specified. If the extension
                                    is ".svgz" or ".gz", the output will be gzipped
encoding        default="utf-8"       file encoding (default is Unicode)

Definition at line 461 of file svgfig.py.

References svgfig.SVG.interpret_fileName(), and svgfig.SVG.save().

  def firefox(self, fileName=None, encoding="utf-8"):
    """View in "firefox", assuming that program is available on your system.

    fileName        default=None            note that any file named _default_fileName will be
                                            overwritten if no fileName is specified. If the extension
                                            is ".svgz" or ".gz", the output will be gzipped
    encoding        default="utf-8"       file encoding (default is Unicode)
    """
    fileName = self.interpret_fileName(fileName)
    self.save(fileName, encoding)
    os.spawnvp(os.P_NOWAIT, "firefox", ("firefox", fileName))

def svgfig.SVG.inkscape	(		self,
			fileName = None,
			encoding = "utf-8"
	)

View in "inkscape", assuming that program is available on your system.

fileName        default=None            note that any file named _default_fileName will be
                                    overwritten if no fileName is specified. If the extension
                                    is ".svgz" or ".gz", the output will be gzipped
encoding        default="utf-8"       file encoding (default is Unicode)

Definition at line 449 of file svgfig.py.

References svgfig.SVG.interpret_fileName(), and svgfig.SVG.save().

  def inkscape(self, fileName=None, encoding="utf-8"):
    """View in "inkscape", assuming that program is available on your system.

    fileName        default=None            note that any file named _default_fileName will be
                                            overwritten if no fileName is specified. If the extension
                                            is ".svgz" or ".gz", the output will be gzipped
    encoding        default="utf-8"       file encoding (default is Unicode)
    """
    fileName = self.interpret_fileName(fileName)
    self.save(fileName, encoding)
    os.spawnvp(os.P_NOWAIT, "inkscape", ("inkscape", fileName))

def svgfig.SVG.inkview	(		self,
			fileName = None,
			encoding = "utf-8"
	)

View in "inkview", assuming that program is available on your system.

fileName        default=None            note that any file named _default_fileName will be
                                    overwritten if no fileName is specified. If the extension
                                    is ".svgz" or ".gz", the output will be gzipped
encoding        default="utf-8"       file encoding (default is Unicode)

Definition at line 437 of file svgfig.py.

References svgfig.SVG.interpret_fileName(), and svgfig.SVG.save().

  def inkview(self, fileName=None, encoding="utf-8"):
    """View in "inkview", assuming that program is available on your system.

    fileName        default=None            note that any file named _default_fileName will be
                                            overwritten if no fileName is specified. If the extension
                                            is ".svgz" or ".gz", the output will be gzipped
    encoding        default="utf-8"       file encoding (default is Unicode)
    """
    fileName = self.interpret_fileName(fileName)
    self.save(fileName, encoding)
    os.spawnvp(os.P_NOWAIT, "inkview", ("inkview", fileName))

def svgfig.SVG.interpret_fileName	(		self,
			fileName = None
	)

Definition at line 401 of file svgfig.py.

Referenced by svgfig.SVG.firefox(), svgfig.SVG.inkscape(), svgfig.SVG.inkview(), and svgfig.SVG.save().

  def interpret_fileName(self, fileName=None):
    if fileName == None:
      fileName = _default_fileName
    if re.search("windows", platform.system(), re.I) and not os.path.isabs(fileName):
      fileName = _default_directory + os.sep + fileName
    return fileName

def svgfig.SVG.items	(		self,
			sub = True,
			attr = True,
			text = True
	)

Get a recursively-generated list of tree-index, sub-element/attribute pairs.

If sub == False, do not show sub-elements.
If attr == False, do not show attributes.
If text == False, do not show text/Unicode sub-elements.

Definition at line 248 of file svgfig.py.

Referenced by betterConfigParser.BetterConfigParser.exists(), crabConfigParser.CrabConfigParser.getSectionLines(), svgfig.SVG.keys(), python.rootplot.core.Options.kwarg_list(), and svgfig.SVG.values().

  def items(self, sub=True, attr=True, text=True):
    """Get a recursively-generated list of tree-index, sub-element/attribute pairs.

    If sub == False, do not show sub-elements.
    If attr == False, do not show attributes.
    If text == False, do not show text/Unicode sub-elements.
    """
    output = []
    for ti, s in self:
      show = False
      if isinstance(ti[-1], (int, long)):
        if isinstance(s, basestring): show = text
        else: show = sub
      else: show = attr

      if show: output.append((ti, s))
    return output

def svgfig.SVG.keys	(		self,
			sub = True,
			attr = True,
			text = True
	)

Get a recursively-generated list of tree-indexes.

If sub == False, do not show sub-elements.
If attr == False, do not show attributes.
If text == False, do not show text/Unicode sub-elements.

Definition at line 266 of file svgfig.py.

References PixelDCSObject< T >.items, tensorflow::TBBSession::ExecutorsAndKeys.items, tensorflow::NTSession::ExecutorsAndKeys.items, argparse.HelpFormatter._Section.items, python.rootplot.argparse.HelpFormatter._Section.items, and svgfig.SVG.items().

Referenced by psClasses.queueList.__init__(), psClasses.queueList.smallestQueue(), and psClasses.queueList.thinerQueue().

  def keys(self, sub=True, attr=True, text=True):
    """Get a recursively-generated list of tree-indexes.

    If sub == False, do not show sub-elements.
    If attr == False, do not show attributes.
    If text == False, do not show text/Unicode sub-elements.
    """
    return [ti for ti, s in self.items(sub, attr, text)]

def svgfig.SVG.prepend	(		self,
			x
	)

Prepends x to the list of sub-elements (drawn first may be
overlapped by other primatives).

Definition at line 186 of file svgfig.py.

References svgfig.SVG.sub.

  def prepend(self, x):
    """Prepends x to the list of sub-elements (drawn first may be
    overlapped by other primatives)."""
    self.sub[0:0] = [x]

def svgfig.SVG.save	(		self,
			fileName = None,
			encoding = "utf-8",
			compresslevel = None
	)

Save to a file for viewing.  Note that svg.save() overwrites the file named _default_fileName.

fileName        default=None            note that _default_fileName will be overwritten if
                                    no fileName is specified. If the extension
                                    is ".svgz" or ".gz", the output will be gzipped
encoding        default="utf-8"       file encoding (default is Unicode)
compresslevel   default=None            if a number, the output will be gzipped with that
                                    compression level (1-9, 1 being fastest and 9 most
                                    thorough)

Definition at line 408 of file svgfig.py.

References svgfig.SVG.interpret_fileName(), and svgfig.SVG.standalone_xml().

Referenced by Vispa.Main.TabController.TabController.allowClose(), Vispa.Main.TabController.TabController.checkModificationTimestamp(), svgfig.SVG.firefox(), svgfig.SVG.inkscape(), svgfig.SVG.inkview(), and SpecificationBuilder_cfi.Specification.saveAll().

  def save(self, fileName=None, encoding="utf-8", compresslevel=None):
    """Save to a file for viewing.  Note that svg.save() overwrites the file named _default_fileName.

    fileName        default=None            note that _default_fileName will be overwritten if
                                            no fileName is specified. If the extension
                                            is ".svgz" or ".gz", the output will be gzipped
    encoding        default="utf-8"       file encoding (default is Unicode)
    compresslevel   default=None            if a number, the output will be gzipped with that
                                            compression level (1-9, 1 being fastest and 9 most
                                            thorough)
    """
    fileName = self.interpret_fileName(fileName)

    if compresslevel != None or re.search("\.svgz$", fileName, re.I) or re.search("\.gz$", fileName, re.I):
      import gzip
      if compresslevel == None:
        f = gzip.GzipFile(fileName, "w")
      else:
        f = gzip.GzipFile(fileName, "w", compresslevel)

      f = codecs.EncodedFile(f, "utf-8", encoding)
      f.write(self.standalone_xml())
      f.close()

    else:
      f = codecs.open(fileName, "w", encoding=encoding)
      f.write(self.standalone_xml())
      f.close()

def svgfig.SVG.standalone_xml	(		self,
			indent = "    ",
			newl = "\n"
	)

Get an XML representation of the SVG that can be saved/rendered.

indent      string used for indenting
newl        string used for newlines

Definition at line 357 of file svgfig.py.

References svgfig.canvas(), join(), AlignmentMonitorMuonSystemMap1D::MyCSCDetId.t, and svgfig.SVG.t.

Referenced by svgfig.SVG.save().

  def standalone_xml(self, indent="    ", newl="\n"):
    """Get an XML representation of the SVG that can be saved/rendered.

    indent      string used for indenting
    newl        string used for newlines
    """

    if self.t == "svg": top = self
    else: top = canvas(self)
    return """\
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">

""" + ("".join(top.__standalone_xml(indent, newl)))  # end of return statement

def svgfig.SVG.tree	(		self,
			depth_limit = None,
			sub = True,
			attr = True,
			text = True,
			tree_width = 20,
			obj_width = 80
	)

Print (actually, return a string of) the tree in a form useful for browsing.

If depth_limit == a number, stop recursion at that depth.
If sub == False, do not show sub-elements.
If attr == False, do not show attributes.
If text == False, do not show text/Unicode sub-elements.
tree_width is the number of characters reserved for printing tree indexes.
obj_width is the number of characters reserved for printing sub-elements/attributes.

Definition at line 290 of file svgfig.py.

References svgfig.SVG.depth_first(), join(), and list().

Referenced by svgfig.SVG.__str__(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer.beginLoop(), MetTreeProducer.MetTreeProducer.declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer.declareVariables(), core.AutoFillTreeProducer.AutoFillTreeProducer.fillTree(), ZJetsTreeAnalyzer.ZJetsTreeAnalyzer.process(), MetTreeProducer.MetTreeProducer.process(), and python.cmstools.EventTree.SetAlias().

  def tree(self, depth_limit=None, sub=True, attr=True, text=True, tree_width=20, obj_width=80):
    """Print (actually, return a string of) the tree in a form useful for browsing.

    If depth_limit == a number, stop recursion at that depth.
    If sub == False, do not show sub-elements.
    If attr == False, do not show attributes.
    If text == False, do not show text/Unicode sub-elements.
    tree_width is the number of characters reserved for printing tree indexes.
    obj_width is the number of characters reserved for printing sub-elements/attributes.
    """

    output = []

    line = "%s %s" % (("%%-%ds" % tree_width) % repr(None), ("%%-%ds" % obj_width) % (repr(self))[0:obj_width])
    output.append(line)

    for ti, s in self.depth_first(depth_limit):
      show = False
      if isinstance(ti[-1], (int, long)):
        if isinstance(s, basestring): show = text
        else: show = sub
      else: show = attr

      if show:
        line = "%s %s" % (("%%-%ds" % tree_width) % repr(list(ti)), ("%%-%ds" % obj_width) % ("    "*len(ti) + repr(s))[0:obj_width])
        output.append(line)

    return "\n".join(output)

def svgfig.SVG.values	(		self,
			sub = True,
			attr = True,
			text = True
	)

Get a recursively-generated list of sub-elements and attributes.

If sub == False, do not show sub-elements.
If attr == False, do not show attributes.
If text == False, do not show text/Unicode sub-elements.

Definition at line 275 of file svgfig.py.

References PixelDCSObject< T >.items, tensorflow::TBBSession::ExecutorsAndKeys.items, tensorflow::NTSession::ExecutorsAndKeys.items, argparse.HelpFormatter._Section.items, python.rootplot.argparse.HelpFormatter._Section.items, and svgfig.SVG.items().

Referenced by genericValidation.ValidationWithPlotsSummaryBase.SummaryItem.value().

  def values(self, sub=True, attr=True, text=True):
    """Get a recursively-generated list of sub-elements and attributes.

    If sub == False, do not show sub-elements.
    If attr == False, do not show attributes.
    If text == False, do not show text/Unicode sub-elements.
    """
    return [s for ti, s in self.items(sub, attr, text)]

def svgfig.SVG.xml	(		self,
			indent = "    ",
			newl = "\n",
			depth_limit = None,
			depth = 0
	)

Get an XML representation of the SVG.

indent      string used for indenting
newl        string used for newlines
If depth_limit == a number, stop recursion at that depth.
depth       starting depth (not useful for users)

print svg.xml()

Definition at line 319 of file svgfig.py.

References join(), svgfig.SVG.sub, AlignmentMonitorMuonSystemMap1D::MyCSCDetId.t, and svgfig.SVG.t.

Referenced by svgfig.SVG.__repr__().

  def xml(self, indent="    ", newl="\n", depth_limit=None, depth=0):
    """Get an XML representation of the SVG.

    indent      string used for indenting
    newl        string used for newlines
    If depth_limit == a number, stop recursion at that depth.
    depth       starting depth (not useful for users)

    print svg.xml()
    """

    attrstr = []
    for n, v in self.attr.items():
      if isinstance(v, dict):
        v = "; ".join(["%s:%s" % (ni, vi) for ni, vi in v.items()])
      elif isinstance(v, (list, tuple)):
        v = ", ".join(v)
      attrstr.append(" %s=%s" % (n, repr(v)))
    attrstr = "".join(attrstr)

    if len(self.sub) == 0: return "%s<%s%s />" % (indent * depth, self.t, attrstr)

    if depth_limit == None or depth_limit > depth:
      substr = []
      for s in self.sub:
        if isinstance(s, SVG):
          substr.append(s.xml(indent, newl, depth_limit, depth + 1) + newl)
        elif isinstance(s, str):
          substr.append("%s%s%s" % (indent * (depth + 1), s, newl))
        else:
          substr.append("%s%s%s" % (indent * (depth + 1), repr(s), newl))
      substr = "".join(substr)

      return "%s<%s%s>%s%s%s</%s>" % (indent * depth, self.t, attrstr, newl, substr, indent * depth, self.t)

    else:
      return "%s<%s (%d sub)%s />" % (indent * depth, self.t, len(self.sub), attrstr)

Member Data Documentation

svgfig.SVG.attr

Definition at line 133 of file svgfig.py.

Referenced by svgfig.SVG.__contains__(), svgfig.SVG.__eq__(), svgfig.Path.__repr__(), svgfig.Curve.__repr__(), svgfig.Poly.__repr__(), svgfig.Text.__repr__(), svgfig.TextGlobal.__repr__(), svgfig.Dots.__repr__(), svgfig.Line.__repr__(), svgfig.LineGlobal.__repr__(), svgfig.VLine.__repr__(), svgfig.HLine.__repr__(), svgfig.Rect.__repr__(), svgfig.Ellipse.__repr__(), svgfig.Ticks.__repr__(), svgfig.CurveAxis.__repr__(), svgfig.LineAxis.__repr__(), svgfig.XAxis.__repr__(), svgfig.YAxis.__repr__(), svgfig.Axes.__repr__(), svgfig.HGrid.__repr__(), svgfig.VGrid.__repr__(), svgfig.Grid.__repr__(), svgfig.Curve.Path(), svgfig.Poly.Path(), svgfig.Rect.Path(), svgfig.Path.SVG(), svgfig.Text.SVG(), svgfig.TextGlobal.SVG(), svgfig.LineGlobal.SVG(), svgfig.Axes.SVG(), svgfig.XErrorBars.SVG(), and svgfig.YErrorBars.SVG().

svgfig.SVG.sub

Definition at line 129 of file svgfig.py.

Referenced by svgfig.SVG.__eq__(), svgfig.SVG.__standalone_xml(), svgfig.SVG.prepend(), and svgfig.SVG.xml().

svgfig.SVG.t

Definition at line 127 of file svgfig.py.

Referenced by svgfig.SVG.__eq__(), svgfig.Curve.Sample.__repr__(), svgfig.SVG.__standalone_xml(), svgfig.SVG.standalone_xml(), and svgfig.SVG.xml().