arbitragelab.util.indexed_highlight

This module houses the extension HighlightingDataCursor class to support cluster by cluster highlighting.

Module Contents

Classes

IndexedHighlight

This class extends HighlightingDataCursor to add support for

class IndexedHighlight(axes, **kwargs)

Bases: arbitragelab.util.data_cursor.HighlightingDataCursor

This class extends HighlightingDataCursor to add support for highlighting of cluster groups.

default_annotation_kwargs

default_keybindings

enabled

update(event, annotation)

On each update event, this method will loop through all SubPlot objects and the group of points corresponding to the current selected object will be highlighted.

show_highlight(artist)

Show or create a highlight for a givent artist.

create_highlight(artist)

Create a new highlight for the given artist.

__call__(event)

Create or update annotations for the given event. (This is intended to be a callback connected to matplotlib’s pick event.)

event_info(event)

Get a dict of info for the artist selected by “event”.

annotate(ax, **kwargs)

Draws the annotation box for the given axis ax. Additional kwargs are passed on to annotate.

hide()

Hides all annotation artists associated with the DataCursor. Returns self to allow “chaining”. (e.g. datacursor.hide().disable())

show()

Display all hidden data cursors. Returns self to allow chaining.

disable()

Disconnects all callbacks and disables interactivity. Any existing annotations will continue to be visible (and draggable, if applicable). This has no effect if the datacursor has not been enabled. Returns self to allow “chaining”. (e.g. datacursor.hide().disable())

enable()

Connects callbacks and makes artists pickable. If the datacursor has already been enabled, this function has no effect.