get_plot_prefs

sherpa.ui.get_plot_prefs(plottype, id=None, **kwargs)

Return the preferences for the given plot type.

Added in version 4.16.0.

Parameters:

  • plottype (str) – The type of plt, such as “data”, “model”, or “resid”. The “fit” argument is not supported.

  • id (int or str, optional) – The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id.

Returns:

prefs – Changing the values of this dictionary will change any new data plots. This dictionary will be empty if no plot backend is available.

Return type:

dict

See also

get_data_plot_prefs, get_model_plot_prefs, set_xlinear, set_xlog, set_ylinear, set_ylog

Notes

The meaning of the fields depend on the chosen plot backend. A value of None means to use the default value for that attribute, or not to use that setting.

The “fit” argument can not be used, even though there is a get_fit_plot call. Either use the “data” or “model” arguments to access the desired plot type, or use get_fit_plot() and access the dataplot and modelplot attributes directly.

Examples

After these commands, any data plot will use a green symbol and not display Y error bars.

>>> prefs = get_plot_prefs("data")
>>> prefs['color'] = 'green'
>>> prefs['yerrorbars'] = False