chaco.abstract_overlay module

Abstract base class for plot decorators and overlays.

This class is primarily used so that tools can easily distinguish between data-related plot items and the decorators on them.

class chaco.abstract_overlay.AbstractOverlay(component=None, *args, **kw)

Bases: chaco.plot_component.PlotComponent

The base class for overlays and underlays of the plot area.

The only default additional feature of an overlay is that it implements an overlay() drawing method that overlays this component on top of another, without the components necessarily having an object containment-ownership relationship.

bgcolor = "transparent"

The background color (overrides PlotComponent). Typically, an overlay does not render a background.

component = Instance(Component)

The component that this object overlays. This can be None. By default, if this object is called to draw(), it tries to render onto this component.

draw_layer = "overlay"

The default layer that this component draws into.

overlay(other_component, gc, view_bounds=None, mode='normal')

Draws this component overlaid on another component.