Inherits from
- BaseTool: enthought.enable.base_tool.BaseTool
Attributes
- axis
The axis that this tool is parallel to.
axis = Enum('index', 'value', 'index_x', 'index_y')
- color
Color of the line.
color = ColorTrait('black') - draw_mode
This tool is drawn as an overlay (overrides BaseTool).
draw_mode = 'overlay'
- inspect_mode
The possible inspection modes of the tool.
- space:
- The tool maps from screen space into the data space of the plot.
- indexed:
- The tool maps from screen space to an index into the plot's index array.
inspect_mode = Enum('space', 'indexed')
- is_interactive
Respond to user mouse events?
is_interactive = Bool(True)
- is_listener
Does the tool respond to updates in the metadata on the data source and update its own position?
is_listener = Bool(False)
- line_style
Dash style of the line.
line_style = LineStyle('solid')
- line_width
Width in pixels of the line.
line_width = Float(1.0)
- metadata_name
The name of the metadata field to listen or write to.
metadata_name = Str('selections')
- visible
This tool is visible (overrides BaseTool).
visible = True
- write_metadata
If interactive, does the line inspector write the current data space point to the appropriate data source's metadata?
write_metadata = Bool(False)
Inherited from base classes
Method summary
- do_layout(self, *args, **kw)
- draw(self, gc, view_bounds = None)
- normal_mouse_leave(self, event)
- normal_mouse_move(self, event)
- overlay(self, component, gc, view_bounds = None, mode = 'normal')
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __init__(self, component = None, **kwtraits)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- deactivate(self, component = None)
- default_traits_view(self)
- dispatch(self, event, suffix)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- get_event_transform(self, event = None, suffix = '')
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- do_layout(self, *args, **kw)
- draw(self, gc, view_bounds = None)
Draws this tool on a graphics context.
Overrides BaseTool.
- normal_mouse_leave(self, event)
Handles the mouse leaving the plot.
- normal_mouse_move(self, event)
Handles the mouse being moved.
- overlay(self, component, gc, view_bounds = None, mode = 'normal')
Draws this component overlaid on a graphics context.