get_plot_prefs

Context: plotting

Synopsis

Return the preferences for the given plot type.

Syntax

get_plot_prefs(plottype, id=None, **kwargs)

Description

Example

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

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
plottype	str	The type of plt, such as "data", "model", or "resid". The "fit" argument is not supported.
id	int, str, or None, optional	The data set that provides the data. If not given then the default identifier is used, as returned by `get_default_id` .

Return value

The return value from this function is:

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

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.

Changes in CIAO

Added in CIAO 4.16

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.