TextPlotElement

class PlasmaCalcs.plotting.labels.TextPlotElement(txt, **kw_super)

Bases: MoviePlotElement

MoviePlotElement for Text object. see MovieText for updating text over time.

txt: Text object

e.g., the result of plt.text(…) or plt.title(…)

To view or adjust plot settings in self, see self.plot_settings, or help(self.plot_settings).

Methods

__init_subclass__(*args_super, **kw)	appends note about using self.plot_settings, to cls.__doc__.
update_data(data)	update the plot using data['text'].

Attributes

REPR_TEXT_MAX_LEN
ax	axes containing this Text.
fig	figure containing this Text.
text	current text string.
txt	matplotlib.text.Text object

classmethod __init_subclass__(*args_super, **kw)

appends note about using self.plot_settings, to cls.__doc__.

if “PlotSettings” or “plot_settings” appears in cls.__doc__, do NOT append this note;

assuming instead that this means the doc already mentions how to use plot_settings.

property ax

axes containing this Text.

property fig

figure containing this Text.

property text

current text string. Internally stored at self.data[‘text’]

property txt

matplotlib.text.Text object

update_data(data)

update the plot using data[‘text’].

return list of all updated matplotlib Artist objects, for FuncAnimation(…, blit=True),

i.e. [] if self.ax is None else [self.txt].

(FuncAnimation fails to blit any artists not attached to axes,

and self.txt is attached to axes if and only if self.ax is not None)