chaco.abstract_plot_data module

Defines the base class for plot data.

class chaco.abstract_plot_data.AbstractPlotData

Bases: traits.has_traits.HasTraits

Defines the interface for data providers to Plot.

data_changed = Event

Indicates that some of the data has changed. The event object must be a dict with keys “added”, “removed”, “changed” and values that are lists of strings. This event is used by consumers of this data.

del_data(name)

Deletes the array specified by name, or raises a KeyError if the named array does not exist.

If the instance is not writable, then this must do nothing.

get_data(name)

Returns the data or data source associated with name.

If there is no data or data source associated with the name, this method returns None.

list_data()

Returns a list of valid names to use for get_data().

These names are generally strings but can also be integers or any other hashable type.

selectable = Bool(True)

Can consumers (Plots) set selections?

set_data(name, new_data, generate_name=False)

Sets the specified array as the value for either the specified name or a generated name.

If the instance’s writable attribute is True, then this method sets the data associated with the given name to the new value, otherwise it does nothing.

Parameters

  • name (string) – The name of the array whose value is to be set.

  • new_data (array) – The array to set as the value of name.

  • generate_name (Boolean) – If True, a unique name of the form ‘seriesN’ is created for the array, and is used in place of name. The ‘N’ in ‘seriesN’ is one greater the largest N already used.

Returns

Return type

The name under which the array was set.

set_selection(name, selection)

Sets the selection on the specified data.

This method informs the class that Chaco has selected a portion of the data.

Parameters

  • name (string) – Name of an array

  • selection (array of Booleans) – Indicates whether the data in the cooresponding position of the array named by name is selected.

update(*args, **kwargs)
update_data(*args, **kwargs)

Update a set of data values, firing only one data_changed event.

This function has the same signature as the dictionary update() method.

writable = Bool(True)

Can consumers (Plots) write data back through this interface using set_data()?