API Reference for Enthought Tool Suite 3.0.1

Variables

• axes

  axes = make_function(Axes)
  
  

• orientationaxes

  orientationaxes = make_function(OrientationAxesFactory)
  
  

• outline

  outline = make_function(Outline)
  
  

• text

  text = make_function(Text)
  
  

• title

  title = make_function(Title)
  
  

Classes

• Axes - Creates axes for the current (or given) object.
• AxesLikeModuleFactory - Base class for axes and outline
• OrientationAxesFactory - Applies the OrientationAxes mayavi module to the given VTK data object.
• Outline - Creates an outline for the current (or given) object.
• SingletonModuleFactory - Base classe for factories that can find an existing object matching certain criteria instead of building a new one
• Text - Adds a text on the figure
• Title - Creates a title for the figure

Function summary

• colorbar(object = None, title = None, orientation = None)
• scalarbar(object = None, title = None, orientation = None)
• vectorbar(object = None, title = None, orientation = None)
• xlabel(text, object = None)
• ylabel(text, object = None)
• zlabel(text, object = None)

Functions

• colorbar(object = None, title = None, orientation = None)

  Adds a colorbar for the color mapping of the given object.

  If the object has scalar data, the scalar color mapping is represented. Elsewhere the vector color mapping is represented, if available. If no object is specified, the first object with a color map in the scene is used.

  Keyword arguments:

  object:	Optional object to get the color map from
  title:	The title string
  orientation:	Can be 'horizontal' or 'vertical'

• scalarbar(object = None, title = None, orientation = None)

  Adds a colorbar for the scalar color mapping of the given object.

  If no object is specified, the first object with scalar data in the scene is used.

  Keyword arguments:

  object:	Optional object to get the scalar color map from
  title:	The title string
  orientation:	Can be 'horizontal' or 'vertical'

• vectorbar(object = None, title = None, orientation = None)

  Adds a colorbar for the vector color mapping of the given object.

  If no object is specified, the first object with vector data in the scene is used.

  Keyword arguments

  object:	Optional object to get the vector color map from
  title:	The title string
  orientation:	Can be 'horizontal' or 'vertical'

• xlabel(text, object = None)

  Creates a set of axes if there isn't already one, and sets the x label

  Keyword arguments:

  object:	The object to apply the module to, if not the whole scene is searched for a suitable object.

• ylabel(text, object = None)

  Creates a set of axes if there isn't already one, and sets the y label

  Keyword arguments:

  object:	The object to apply the module to, if not the whole scene is searched for a suitable object.

• zlabel(text, object = None)

  Creates a set of axes if there isn't already one, and sets the z label

  Keyword arguments

  object:	The object to apply the module to, if not the whole scene is searched for a suitable object.

Imported Names

© Copyright 2002-2008 Enthought, Inc.