Public Member Functions
def	__init__ (self, xmin, xmax, ymin, ymax, d, kwds)

def	__repr__ (self)

def	SVG (self)

Public Attributes
	axis_attr

	d

	flipx

	flipy

	height

	last_window

	minusInfinity

	text_attr

	width

	x

	x2labels

	xlabels

	xlogbase

	xminiticks

	xticks

	xtitle

	y

	y2labels

	ylabels

	ylogbase

	ymax

	yminiticks

	yticks

	ytitle

Static Public Attributes
dictionary	axis_defaults = {}

float	minitick_length = 0.75

dictionary	text_defaults = {"stroke":"none", "fill":"black", "font-size":5}

int	text_xaxis_offset = 1.

int	text_xtitle_offset = 6.

int	text_yaxis_offset = 2.

int	text_ytitle_offset = 12.

float	tick_length = 1.5

Detailed Description

Definition at line 873 of file svgfig.py.

Constructor & Destructor Documentation

◆ init()

def svgfig.Frame.__init__	(	self,
		xmin,
		xmax,
		ymin,
		ymax,
		d,
		kwds
	)

Acts like Fig, but draws a coordinate frame around the data. You also need to supply plot ranges.

Frame(xmin, xmax, ymin, ymax, obj, obj, obj..., keyword options...)

xmin, xmax      required        minimum and maximum x values (in the objs' coordinates)
ymin, ymax      required        minimum and maximum y values (in the objs' coordinates)
obj             optional list   drawing primatives
keyword options keyword list    options defined below

The following are keyword options, with their default values:

x, y            20, 5         upper-left corner of the Frame in SVG coordinates
width, height   75, 80        width and height of the Frame in SVG coordinates
flipx, flipy    False, True   flip the sign of the coordinate axis
minusInfinity   -1000         if an axis is logarithmic and an object is plotted at 0 or
                          a negative value, -1000 will be used as a stand-in for NaN
xtitle          None          if a string, label the x axis
xticks          -10           request ticks according to the standard tick specification
                          (see help(Ticks))
xminiticks      True          request miniticks according to the standard minitick
                          specification
xlabels         True          request tick labels according to the standard tick label
                          specification
xlogbase        None          if a number, the axis and transformation are logarithmic
                          with ticks at the given base (10 being the most common)
(same for y)
text_attr       {}            a dictionary of attributes for label text
axis_attr       {}            a dictionary of attributes for the axis lines

Definition at line 887 of file svgfig.py.

   def __init__(self, xmin, xmax, ymin, ymax, *d, **kwds):
     """Acts like Fig, but draws a coordinate frame around the data. You also need to supply plot ranges.
 
     Frame(xmin, xmax, ymin, ymax, obj, obj, obj..., keyword options...)
 
     xmin, xmax      required        minimum and maximum x values (in the objs' coordinates)
     ymin, ymax      required        minimum and maximum y values (in the objs' coordinates)
     obj             optional list   drawing primatives
     keyword options keyword list    options defined below
 
     The following are keyword options, with their default values:
 
     x, y            20, 5         upper-left corner of the Frame in SVG coordinates
     width, height   75, 80        width and height of the Frame in SVG coordinates
     flipx, flipy    False, True   flip the sign of the coordinate axis
     minusInfinity   -1000         if an axis is logarithmic and an object is plotted at 0 or
                                   a negative value, -1000 will be used as a stand-in for NaN
     xtitle          None          if a string, label the x axis
     xticks          -10           request ticks according to the standard tick specification
                                   (see help(Ticks))
     xminiticks      True          request miniticks according to the standard minitick
                                   specification
     xlabels         True          request tick labels according to the standard tick label
                                   specification
     xlogbase        None          if a number, the axis and transformation are logarithmic
                                   with ticks at the given base (10 being the most common)
     (same for y)
     text_attr       {}            a dictionary of attributes for label text
     axis_attr       {}            a dictionary of attributes for the axis lines
     """
 
     self.xmin, self.xmax, self.ymin, self.ymax = xmin, xmax, ymin, ymax
     self.d = list(d)
     defaults = {"x":20, "y":5, "width":75, "height":80, "flipx":False, "flipy":True, "minusInfinity":-1000, \
                 "xtitle":None, "xticks":-10, "xminiticks":True, "xlabels":True, "x2labels":None, "xlogbase":None, \
                 "ytitle":None, "yticks":-10, "yminiticks":True, "ylabels":True, "y2labels":None, "ylogbase":None, \
                 "text_attr":{}, "axis_attr":{}}
     defaults.update(kwds)
     kwds = defaults
 
     self.x = kwds["x"]; del kwds["x"]
     self.y = kwds["y"]; del kwds["y"]
     self.width = kwds["width"]; del kwds["width"]
     self.height = kwds["height"]; del kwds["height"]
     self.flipx = kwds["flipx"]; del kwds["flipx"]
     self.flipy = kwds["flipy"]; del kwds["flipy"]
     self.minusInfinity = kwds["minusInfinity"]; del kwds["minusInfinity"]
     self.xtitle = kwds["xtitle"]; del kwds["xtitle"]
     self.xticks = kwds["xticks"]; del kwds["xticks"]
     self.xminiticks = kwds["xminiticks"]; del kwds["xminiticks"]
     self.xlabels = kwds["xlabels"]; del kwds["xlabels"]
     self.x2labels = kwds["x2labels"]; del kwds["x2labels"]
     self.xlogbase = kwds["xlogbase"]; del kwds["xlogbase"]
     self.ytitle = kwds["ytitle"]; del kwds["ytitle"]
     self.yticks = kwds["yticks"]; del kwds["yticks"]
     self.yminiticks = kwds["yminiticks"]; del kwds["yminiticks"]
     self.ylabels = kwds["ylabels"]; del kwds["ylabels"]
     self.y2labels = kwds["y2labels"]; del kwds["y2labels"]
     self.ylogbase = kwds["ylogbase"]; del kwds["ylogbase"]
 
     self.text_attr = dict(self.text_defaults)
     self.text_attr.update(kwds["text_attr"]); del kwds["text_attr"]
 
     self.axis_attr = dict(self.axis_defaults)
     self.axis_attr.update(kwds["axis_attr"]); del kwds["axis_attr"]
 
     if len(kwds) != 0:
       raise TypeError("Frame() got unexpected keyword arguments %s" % kwds.keys())
 

Member Function Documentation

◆ repr()

def svgfig.Frame.__repr__ ( self )

Definition at line 884 of file svgfig.py.

References svgfig.Fig.d, svgfig.Plot.d, and svgfig.Frame.d.

Referenced by data_sources.json_file.__str__(), and datamodel.Object.__str__().

   def __repr__(self):
     return "<Frame (%d items)>" % len(self.d)
 

◆ SVG()

def svgfig.Frame.SVG ( self )

Apply the window transformation and return an SVG object.

Definition at line 956 of file svgfig.py.

   def SVG(self):
     """Apply the window transformation and return an SVG object."""
 
     self.last_window = window(self.xmin, self.xmax, self.ymin, self.ymax, x=self.x, y=self.y, width=self.width, height=self.height, \
                               xlogbase=self.xlogbase, ylogbase=self.ylogbase, minusInfinity=self.minusInfinity, flipx=self.flipx, flipy=self.flipy)
 
     left = YAxis(self.ymin, self.ymax, self.xmin, self.yticks, self.yminiticks, self.ylabels, self.ylogbase, None, None, None, self.text_attr, **self.axis_attr)
     right = YAxis(self.ymin, self.ymax, self.xmax, self.yticks, self.yminiticks, self.y2labels, self.ylogbase, None, None, None, self.text_attr, **self.axis_attr)
     bottom = XAxis(self.xmin, self.xmax, self.ymin, self.xticks, self.xminiticks, self.xlabels, self.xlogbase, None, None, None, self.text_attr, **self.axis_attr)
     top = XAxis(self.xmin, self.xmax, self.ymax, self.xticks, self.xminiticks, self.x2labels, self.xlogbase, None, None, None, self.text_attr, **self.axis_attr)
 
     left.tick_start = -self.tick_length
     left.tick_end = 0
     left.minitick_start = -self.minitick_length
     left.minitick_end = 0.
     left.text_start = self.text_yaxis_offset
 
     right.tick_start = 0.
     right.tick_end = self.tick_length
     right.minitick_start = 0.
     right.minitick_end = self.minitick_length
     right.text_start = -self.text_yaxis_offset
     right.text_attr["text-anchor"] = "start"
 
     bottom.tick_start = 0.
     bottom.tick_end = self.tick_length
     bottom.minitick_start = 0.
     bottom.minitick_end = self.minitick_length
     bottom.text_start = -self.text_xaxis_offset
 
     top.tick_start = -self.tick_length
     top.tick_end = 0.
     top.minitick_start = -self.minitick_length
     top.minitick_end = 0.
     top.text_start = self.text_xaxis_offset
     top.text_attr["dominant-baseline"] = "text-after-edge"
 
     output = Fig(*self.d).SVG(self.last_window)
     output.prepend(left.SVG(self.last_window))
     output.prepend(bottom.SVG(self.last_window))
     output.prepend(right.SVG(self.last_window))
     output.prepend(top.SVG(self.last_window))
 
     if self.xtitle != None:
       output.append(SVG("text", self.xtitle, transform="translate(%g, %g)" % ((self.x + self.width/2.), (self.y + self.height + self.text_xtitle_offset)), dominant_baseline="text-before-edge", **self.text_attr))
     if self.ytitle != None:
       output.append(SVG("text", self.ytitle, transform="translate(%g, %g) rotate(-90)" % ((self.x - self.text_ytitle_offset), (self.y + self.height/2.)), **self.text_attr))
     return output
     

Member Data Documentation

◆ axis_attr

svgfig.Frame.axis_attr

Definition at line 950 of file svgfig.py.

◆ axis_defaults

dictionary svgfig.Frame.axis_defaults = {}

static

Definition at line 875 of file svgfig.py.

◆ d

svgfig.Frame.d

Definition at line 919 of file svgfig.py.

Referenced by svgfig.Frame.__repr__(), svgfig.Path.__repr__(), svgfig.Poly.__repr__(), svgfig.Text.__repr__(), svgfig.TextGlobal.__repr__(), svgfig.Dots.__repr__(), svgfig.XErrorBars.__repr__(), svgfig.YErrorBars.__repr__(), svgfig.Poly.Path(), svgfig.Path.SVG(), svgfig.Text.SVG(), svgfig.TextGlobal.SVG(), svgfig.Dots.SVG(), svgfig.XErrorBars.SVG(), and svgfig.YErrorBars.SVG().

◆ flipx

svgfig.Frame.flipx

Definition at line 931 of file svgfig.py.

◆ flipy

svgfig.Frame.flipy

Definition at line 932 of file svgfig.py.

◆ height

svgfig.Frame.height

Definition at line 930 of file svgfig.py.

Referenced by TkAlMap.TkAlMap.draw_cms_prelim(), presentation.PageLayout.fit(), TkAlMap.TkAlMap.load_geometry(), and svgfig.Dots.SVG().

◆ last_window

svgfig.Frame.last_window

Definition at line 959 of file svgfig.py.

◆ minitick_length

float svgfig.Frame.minitick_length = 0.75

static

Definition at line 878 of file svgfig.py.

◆ minusInfinity

svgfig.Frame.minusInfinity

Definition at line 933 of file svgfig.py.

◆ text_attr

svgfig.Frame.text_attr

Definition at line 947 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ text_defaults

dictionary svgfig.Frame.text_defaults = {"stroke":"none", "fill":"black", "font-size":5}

static

Definition at line 874 of file svgfig.py.

Referenced by svgfig.CurveAxis.__init__().

◆ text_xaxis_offset

int svgfig.Frame.text_xaxis_offset = 1.

static

Definition at line 879 of file svgfig.py.

◆ text_xtitle_offset

int svgfig.Frame.text_xtitle_offset = 6.

static

Definition at line 881 of file svgfig.py.

◆ text_yaxis_offset

int svgfig.Frame.text_yaxis_offset = 2.

static

Definition at line 880 of file svgfig.py.

◆ text_ytitle_offset

int svgfig.Frame.text_ytitle_offset = 12.

static

Definition at line 882 of file svgfig.py.

◆ tick_length

float svgfig.Frame.tick_length = 1.5

static

Definition at line 877 of file svgfig.py.

◆ width

svgfig.Frame.width

Definition at line 929 of file svgfig.py.

Referenced by python.rootplot.utilities.Hist.__init_TGraph(), python.rootplot.root2matplotlib.Hist.bar(), python.rootplot.root2matplotlib.Hist.barh(), python.rootplot.utilities.Hist.delete_bin(), TkAlMap.TkAlMap.draw_cms_prelim(), presentation.PageLayout.fit(), TkAlMap.TkAlMap.load_geometry(), and svgfig.Dots.SVG().

◆ x

svgfig.Frame.x

◆ x2labels

svgfig.Frame.x2labels

Definition at line 938 of file svgfig.py.

◆ xlabels

svgfig.Frame.xlabels

Definition at line 937 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ xlogbase

svgfig.Frame.xlogbase

Definition at line 939 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ xminiticks

svgfig.Frame.xminiticks

Definition at line 936 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ xticks

svgfig.Frame.xticks

Definition at line 935 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ xtitle

svgfig.Frame.xtitle

Definition at line 934 of file svgfig.py.

◆ y

svgfig.Frame.y

Definition at line 928 of file svgfig.py.

◆ y2labels

svgfig.Frame.y2labels

Definition at line 944 of file svgfig.py.

◆ ylabels

svgfig.Frame.ylabels

Definition at line 943 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ ylogbase

svgfig.Frame.ylogbase

Definition at line 945 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ ymax

svgfig.Frame.ymax

Definition at line 918 of file svgfig.py.

Referenced by svgfig.YAxis.__repr__(), svgfig.Axes.__repr__(), svgfig.VGrid.__repr__(), svgfig.Grid.__repr__(), and svgfig.Axes.SVG().

◆ yminiticks

svgfig.Frame.yminiticks

Definition at line 942 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ yticks

svgfig.Frame.yticks

Definition at line 941 of file svgfig.py.

Referenced by svgfig.Axes.SVG().

◆ ytitle

svgfig.Frame.ytitle

Definition at line 940 of file svgfig.py.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __repr__()

◆ SVG()

Member Data Documentation

◆ axis_attr

◆ axis_defaults

◆ d

◆ flipx

◆ flipy

◆ height

◆ last_window

◆ minitick_length

◆ minusInfinity

◆ text_attr

◆ text_defaults

◆ text_xaxis_offset

◆ text_xtitle_offset

◆ text_yaxis_offset

◆ text_ytitle_offset

◆ tick_length

◆ width

◆ x

◆ x2labels

◆ xlabels

◆ xlogbase

◆ xminiticks

◆ xticks

◆ xtitle

◆ y

◆ y2labels

◆ ylabels

◆ ylogbase

◆ ymax

◆ yminiticks

◆ yticks

◆ ytitle

◆ init()

◆ repr()