PlotSettingsMixin

class PlasmaCalcs.plotting.plot_settings.PlotSettingsMixin(*args_super, mpl_super=[], **kw)

Bases: object

mixin which provides obj.plot_settings, a PlotSettings object.

Additionally, kwargs in __init__ will be passed to obj.plot_settings,

which will remember all valid plot settings entered into it.

Be sure to put PlotSettingsMixin class ahead of matplotlib classes in MRO,

so that PlotSettingsMixin can properly pop plot settings kwargs.

mpl_super: list of strings, names of matplotlib super() classes (from MPL_KWARGS.keys()).

If provided, pass kwargs for those classes, from self.plot_settings, during super().__int__.

Methods

__init_subclass__(*args_super, **kw)

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

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.