Class enthought.​chaco.​plot.​Plot

Contents:
• Base classes
• Attributes
• Methods

Inherits from

• DataView: enthought.chaco.data_view.DataView

Attributes

• auto_colors

  List of colors to cycle through when auto-coloring is requested. Picked and ordered to be red-green color-blind friendly, though should not be an issue for blue-yellow.

  auto_colors = List([ 'green', 'lightgreen', 'blue', 'lightblue', 'red', 'pink', 'darkgray', 'silver' ])
  
  

• color_mapper

  Optional mapper for the color axis. Not instantiated until first use; destroyed if no color plots are on the plot.

  color_mapper = Instance(AbstractColormap)
  
  

• data

  The PlotData instance that drives this plot.

  data = Instance(AbstractPlotData)
  
  

• datasources

  Mapping of data names from self.data to their respective datasources.

  datasources = Dict(Str, Instance(AbstractDataSource))
  
  

• default_index

  The default index to use when adding new subplots.

  default_index = Instance(AbstractDataSource)
  
  

• legend

  The legend on the plot.

  legend = Instance(Legend)
  
  

• legend_alignment

  Convenience attribute for legend.align; can be "ur", "ul", "ll", "lr".

  legend_alignment = Property
  
  

• plots

  Mapping of plot names to lists of plot renderers.

  plots = Dict(Str, List)
  
  

• title

  The title of the plot.

  title = Property
  
  

• title_angle

  title_angle = Delegate('_title', prefix = 'angle', modify = True)
  
  

• title_color

  title_color = Delegate('_title', prefix = 'color', modify = True)
  
  

• title_font

  The font to use for the title.

  title_font = Str('swiss 16')
  
  

• title_position

  Convenience attribute for title.overlay_position; can be "top", "bottom", "left", or "right".

  title_position = Property
  
  

• title_text

  Use delegates to expose the other PlotLabel attributes of the plot title

  title_text = Delegate('_title', prefix = 'text', modify = True)
  
  

Method summary

• __init__(self, data = None, **kwtraits)
• __title_changed(self, old, new)
• contour_plot(self, data, type = 'line', name = None, poly_cmap = None, xbounds = None, ybounds = None, origin = None, **styles)
• delplot(self, *names)
• hideplot(self, *names)
• img_plot(self, data, name = None, colormap = None, xbounds = None, ybounds = None, origin = None, **styles)
• plot(self, data, type = 'line', name = None, index_scale = 'linear', value_scale = 'linear', origin = None, **styles)
• showplot(self, *names)

Methods

• __init__(self, data = None, **kwtraits)
• __title_changed(self, old, new)
• contour_plot(self, data, type = 'line', name = None, poly_cmap = None, xbounds = None, ybounds = None, origin = None, **styles)

  Adds contour plots to this Plot object.

  Parameters

  data : string

  The name of the data array in self.plot_data, which must be floating point data.

  type : comma-delimited string of "line", "poly"

  The type of contour plot to add. If the value is "poly" and no colormap is provided, then a ValueError is thrown.

  name : string

  The name of the plot; if omitted, then a name is generated.

  poly_cmap : string

  The name of the color-map function to call (in chaco.default_colormaps) or an AbstractColormap instance to use for contour poly plots (ignored for contour line plots)

  xbounds, ybounds : tuples of (low, high) in data space

  Bounds where this image resides.

  origin : string

  Which corner the origin of this plot should occupy:

  "bottom left", "top left", "bottom right", "top right"

  styles : series of keyword arguments

  Attributes and values that apply to one or more of the plot types requested, e.g.,'line_color' or 'line_width'.

• delplot(self, *names)

  Removes the named sub-plots.

• hideplot(self, *names)

  Convenience function to sets the named plots to be invisible. Their renderers are not removed, and they are still in the list of plots.

• img_plot(self, data, name = None, colormap = None, xbounds = None, ybounds = None, origin = None, **styles)

  Adds image plots to this Plot object.

  If data has shape (N, M, 3) or (N, M, 4), then it is treated as RGB or RGBA (respectively) and colormap is ignored.

  If data is an array of floating-point data, and no colormap is provided, then a ValueError is thrown.

  Data should be in row-major order, so that xbounds corresponds to data's second axis, and ybounds corresponds to the first axis.

  Parameters

  data : string

  The name of the data array in self.plot_data

  name : string

  The name of the plot; if omitted, then a name is generated.

  xbounds, ybounds : tuples of (low, high)

  Bounds in data space where this image resides.

  origin : string

  Which corner the origin of this plot should occupy:

  "bottom left", "top left", "bottom right", "top right"

  styles : series of keyword arguments

  Attributes and values that apply to one or more of the plot types requested, e.g.,'line_color' or 'line_width'.

• plot(self, data, type = 'line', name = None, index_scale = 'linear', value_scale = 'linear', origin = None, **styles)

  Adds a new sub-plot using the given data and plot style.

  Parameters

  data : string, tuple(string), list(string)

  The data to be plotted. The type of plot and the number of arguments determines how the arguments are interpreted:

  one item: (line/scatter)

  The data is treated as the value and self.default_index is used as the index. If default_index does not exist, one is created from arange(len(data))

  two or more items: (line/scatter)

  Interpreted as (index, value1, value2, ...). Each index,value pair forms a new plot of the type specified.

  two items: (cmap_scatter)

  Interpreted as (value, color_values). Uses default_index.

  three or more items: (cmap_scatter)

  Interpreted as (index, val1, color_val1, val2, color_val2, ...)

  type : comma-delimited string of "line", "scatter", "cmap_scatter"

  The types of plots to add.

  name : string

  The name of the plot. If None, then a default one is created (usually "plotNNN").

  index_scale : string

  The type of scale to use for the index axis. If not "linear", then a log scale is used.

  value_scale : string

  The type of scale to use for the value axis. If not "linear", then a log scale is used.

  origin : string

  Which corner the origin of this plot should occupy:

  "bottom left", "top left", "bottom right", "top right"

  styles : series of keyword arguments

  attributes and values that apply to one or more of the plot types requested, e.g.,'line_color' or 'line_width'.

  Examples

  plot("my_data", type="line", name="myplot", color=lightblue)
  
  plot(("x-data", "y-data"), type="scatter")
  
  plot(("x", "y1", "y2", "y3"))
  

  Returns

  [str] -> list of names of the new plots created

• showplot(self, *names)

  Convenience function to sets the named plots to be visible.