pyyeti.datacursor.DataCursor.on

DataCursor.on(ax=None, figs=None, callbacks=True, reset=True)[source]

Turns on and (re-)initializes the DataCursor for current figures.

Parameters:

  • ax (axes object(s) or None or -1; optional) – Axes object or list of axes objects as created by matplotlib.pyplot.subplot() (for example). If None, all axes on all selected figures will be automatically included. Takes precedence over the figs input. If -1, leave this setting as specified during instantiation.

  • figs (figure object(s) or None or -1; optional) – Alternative to the ax input. If ax is not input, figs specifies a figure object or list of figure objects as created by matplotlib.pyplot.figure(). If None, all applicable figures will be automatically included. If -1, leave this setting as specified during instantiation.

  • callbacks (bool or str; optional) – If False, call-backs are not turned on. If True, all call- backs are turned on. If ‘key_only’, only the key-press call-back is turned on (used for pausing; see pause()).

  • reset (bool; optional) – If True, the points and other data members are reset to empty lists. Otherwise, if reset is False, your new data will be appended on to your previous data.

Returns:

None