chaco.tools.highlight_tool module

Defines the HighlightTool class.

class chaco.tools.highlight_tool.HighlightTool(component=None, **traits)

Bases: enable.base_tool.BaseTool

A tool that enables the user to select a plot to be highlighted on the graph by clicking on it.

drag_button = Enum("left", "right")

The mouse button that initiates the selection.

draw_mode = "none"

This tool is not drawn. Overrides BaseTool.

metadata_name = Str("selections")

The name of the data source metadata which controls selections.

normal_left_down(event)

Handles the left mouse button being pressed.

If the left mouse button initiates the selection, this method does so.

normal_right_down(event)

Handles the right mouse button being pressed.

If the right mouse button initiates the selection, this method does so.

threshold = Float(20.0)

Threshold distance for hit-testing.

visible = False

This tool is not visible. Overrides BaseTool.