class PlotItem - Plotitem represents an item that can be plotted by gnuplot.

Declared in module Gnuplot

Synopsis

class PlotItem:
    def __init__(self, basecommand, **keyw) # Construct a 'PlotItem'.
    def clear_option(self, name) # Clear (unset) a plot option.  No error if option was not set.
    def command(self) # Build the 'plot' command to be sent to gnuplot.
    def get_option(self, name) # Return the setting of an option.  May be overridden.
    def pipein(self, f) # Pipe necessary inline data to gnuplot.
    def set_option(self, with=<class Gnuplot._unset at 14019cc00>, title=<class Gnuplot._unset at 14019cc00>, **keyw) # Set or change a plot option for this PlotItem.

list _option_sequence = ['binary', 'using', 'title', 'with']

Description

For the finest control over the output, you can create PlotItems yourself with additional keyword options, or derive new classes from PlotItem.

Members:

_basecommand: a string holding the elementary argument that must be passed to gnuplot's `plot' command for this item; e.g., sin(x) or "filename.dat".
_options: a dictionary of (<option>,<string>) tuples corresponding to the plot options that have been specified for this object. <option> is the option as specified by the user; <string> is the string that needs to be set in the command line to set that option (or None if no string is needed). E.g., {'title':'Data', with:'linespoints'}.

init(self, basecommand, **keyw)

Construct a 'PlotItem'.

Keyword options:

with=<string>: choose how item will be plotted, e.g., with='points 3 3'.
title=<string>: set the title to be associated with the item in the plot legend.
title=None: choose notitle option (omit item from legend).

Note that omitting the title option is different than setting `title=None'; the former chooses gnuplot's default whereas the latter chooses `notitle'.

command(self)

Build the 'plot' command to be sent to gnuplot.

Build and return the plot command, with options, necessary to display this item.

pipein(self, f)

Pipe necessary inline data to gnuplot.

If the plot command requires data to be put on stdin (i.e., 'plot "-"'), this method should put that data there. Can be overridden in derived classes.

set_option(self, with=<class Gnuplot._unset at 14019cc00>, title=<class Gnuplot._unset at 14019cc00>, **keyw)

Set or change a plot option for this PlotItem.

See documentation for __init__ for information about allowed options. This function should be overridden by derived classes to allow additional options.