esys.pyvisi.renderers.gnuplot.offset

Package esys :: Package pyvisi :: Package renderers :: Package gnuplot :: Module offset_plot :: Class OffsetPlot

[show private | hide private]

Type OffsetPlot

object --+            
         |            
      Item --+        
             |        
          Item --+    
                 |    
              Plot --+
                     |
                    OffsetPlot

Offset plot

Method Summary
	`__init__(self, scene)` Initialisation of OffsetPlot class
	`getLineStyle(self)` Gets the current linestyle of the OffsetPlot
	`render(self)` Does OffsetPlot object specific rendering stuff
	`setData(self, *dataList)` Sets the data to the given plot object.
	`setLineStyle(self, linestyle)` Sets the linestyle of the OffsetPlot
Inherited from Plot
	`setLabel(self, axis, label)` Set the label of a given axis
	`setTitle(self, title)` Set the plot title
	`setXAxisRange(self, xMin, xMax)` Set the range of the x axis
	`setXLabel(self, label)` Set the label of the x-axis
	`setYAxisRange(self, yMin, yMax)` Set the range of the y axis
	`setYLabel(self, label)` Set the label of the y-axis
	`setZAxisRange(self, zMin, zMax)` Set the range of the z axis
	`setZLabel(self, label)` Set the label of the z-axis
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

init(self, scene)
(Constructor)

Initialisation of OffsetPlot class

Parameters:: scene - the scene with which to associate the OffsetPlot
(type=Scene object)

Overrides:: esys.pyvisi.renderers.gnuplot.plot.Plot.__init__

getLineStyle(self)

Gets the current linestyle of the OffsetPlot

Returns:: the linestyle as a string

render(self)

Does OffsetPlot object specific rendering stuff

Overrides:: esys.pyvisi.item.Item.render

setData(self, *dataList)

Sets the data to the given plot object.

Parameters:: dataList - list of data objects to plot
(type=tuple)

Overrides:: esys.pyvisi.renderers.gnuplot.plot.Plot.setData

setLineStyle(self, linestyle)

Sets the linestyle of the OffsetPlot

Linestyles may be either a word in the Gnuplot style, or a symbol shortcut in the Matlab style. Some of the options do not have a Matlab equivalent but do have a Gnuplot equivalent, or vice versa.

What this method does, is take the linestyles possible as defined by PyVisi, and then does some conversion as best it can to get the relevant output from (in this case) gnuplot.

Possible linestyles are:

lines ('-')
points ('o')
linespoints ('-o')
dots ('.')
dotted (':')
dashes ('--')
dotdashes ('-.')

Parameters:: linestyle - the style to use for the lines
(type=string)

Generated by Epydoc 2.1 on Thu Apr 27 11:16:26 2006

http://epydoc.sf.net