Package topo :: Package plotting :: Module plotgroup :: Class PlotGroup

[frames] | no frames]

Class PlotGroup

source code

Container that has one or more Plots and also knows how to arrange the plots and other special parameters.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

make_plots(self, update=True)
Create and scale the plots, after first executing the PlotGroup's pre_plot_hooks (if update is True) and plot_hooks.

source code

scale_images(self, zoom_factor=None)
Scale the images by the given zoom factor, if appropriate; default is to do nothing.

source code

_generate_plots(self)
Return the list of Plots

source code

_generate_labels(self)

source code

_sort_plots(self)
Sort plots according to their precedence, then alphabetically.

source code

__init__(self, **params)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

_exec_pre_plot_hooks(self, **kw)

source code

_exec_plot_hooks(self, **kw)

source code

_create_images(self, update)
Generate the sorted and scaled list of plots constituting the PlotGroup.

source code

Inherited from param.parameterized.Parameterized: __getstate__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_default, set_dynamic_time_fn, set_param, state_pop, state_push, verbose, warning

Inherited from param.parameterized.Parameterized (private): _add_parameter, _instantiate_param, _set_name, _setup_params

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

pre_plot_hooks = param.HookList(default= [], doc= ...
Commands to execute before updating this plot, e.g.

plot_hooks = param.HookList(default= [], doc= ...
Commands to execute when redrawing a plot rather than regenerating data.

name = <param.parameterized.String object at 0xa9a336c>
String identifier for this object.

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **params)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

Class Variable Details

[hide private]

pre_plot_hooks

Commands to execute before updating this plot, e.g. to calculate sheet views.

The commands can be any callable Python objects, i.e. any x for which x() is valid. The initial value is determined by the template for this plot, but various arguments can be passed, a modified version substituted, etc.

Value:

param.HookList(default= [], doc= """
        Commands to execute before updating this plot, e.g. to calculate sheet vie
ws.
        
        The commands can be any callable Python objects, i.e. any x for
        which x() is valid.  The initial value is determined by the
        template for this plot, but various arguments can be passed, a
        modified version substituted, etc.""")

plot_hooks

Commands to execute when redrawing a plot rather than regenerating data.

E.g, for a plot with data measured once but displayed one sheet or unit at at time, this command will be called whenever the sheet or coordinate of unit to be plotted (or the simulator time) has changed.

Value:

param.HookList(default= [], doc= """
        Commands to execute when redrawing a plot rather than regenerating data.

        E.g, for a plot with data measured once but displayed one
        sheet or unit at at time, this command will be called whenever
        the sheet or coordinate of unit to be plotted (or the
        simulator time) has changed.
        
...

Class PlotGroup

__init__(self, **params) (Constructor)

pre_plot_hooks

plot_hooks

init(self, **params)
(Constructor)