Customizable options

Functions related to check, set and reset the plot customizable options. For graphical explanation check the first figure of the Tutorial.

pyrangeyes.print_options(return_keys=False)

Prints the customizable features default values and description.

pyrangeyes.reset_options(varname='all')

Reset the deafault value for one, some or all plot layout variables to their original vlaue.

Parameters:

varname ({str, list}, default 'all') – Name of the variable/ to reset the value.

Examples

>>> import pyrangeyes as pre

>>> pre.reset_options()

>>> pre.reset_options('all')

>>> pre.reset_options('tag_bkg')

>>> pre.reset_options(['title_size', 'tag_background'])

pyrangeyes.set_options(varname, value=None)

Define some feature options of the plot layout.

Parameters:

• varname ({str, dict}) – Name of the variable to change, or dictionary with the {variable: value} pairs. To check the available customizable options use pre.print_default().

• value – New value of the variable to be assigned to varname if needed.

Examples

>>> import pyrangeyes as pre

>>> pre.set_options('plot_background', 'magenta')

>>> pre.set_options('title_size', 20)

>>> pre.set_options({'plot_background': 'magenta', 'title_size': 20})