API Reference for Enthought Tool Suite 3.0.1

Variables

• LabelPositionTrait

  Specifies the position of a label relative to its target. This can be one of the text strings indicated, or a tuple or list of floats representing the (x_offset, y_offset) in screen space of the label's lower left corner.

  LabelPositionTrait = Trait('top right', Enum('bottom', 'left', 'right', 'top', 'top right', 'top left', 'bottom left', 'bottom right'), Tuple, List)
  
  

Classes

• DataLabel - A label on a point in data space, optionally with an arrow to the point.

Function summary

• draw_arrow(gc, pt1, pt2, color, arrowhead_size = 10.0, offset1 = 0, offset2 = 0, arrow = None, minlen = 0, maxlen = inf)

Functions

• draw_arrow(gc, pt1, pt2, color, arrowhead_size = 10.0, offset1 = 0, offset2 = 0, arrow = None, minlen = 0, maxlen = inf)

  Renders an arrow from pt1 to pt2. If gc is None, then just returns the arrow object.

  Parameters

  gc : graphics context

  where to render the arrow

  pt1 : point

  the origin of the arrow

  pt2 : point

  where the arrow is pointing

  color : a 3- or 4-tuple of color value

  the color to use for the arrow stem and head

  arrowhead_size : number

  screen units corresponding to the length of the arrowhead

  offset1 : number

  the amount of space from the start of the arrow to pt1

  offset2 : number

  the amount of space from the tip of the arrow to pt2

  arrow : object

  an opaque object returned by previous calls to draw_arrow. If this argument is provided, all other arguments (except gc) are ignored

  minlen: number or None

  the minimum length of the arrow; if the arrow is shorter than this, it will not be drawn

  maxlen: number or None

  the maximum length of the arrow; if the arrow is longer than this, it will not be drawn

  Returns

  An 'arrow' (opaque object) which can be passed in to subsequent calls to this method to short-circuit some of the computation. Even if an arrow is not drawn (due to minlen/maxlen restrictions), an arrow will be returned.

Imported Names

© Copyright 2002-2008 Enthought, Inc.