You are reading an old version of the documentation (v2.2.2). For the latest version see https://matplotlib.org/stable/api/matplotlib_configuration_api.html
Version 2.2.2
matplotlib
Fork me on GitHub

The top level matplotlib module

matplotlib.use(arg, warn=True, force=False)[source]

Set the matplotlib backend to one of the known backends.

The argument is case-insensitive. warn specifies whether a warning should be issued if a backend has already been set up. force is an experimental flag that tells matplotlib to attempt to initialize a new backend by reloading the backend module.

Note

This function must be called before importing pyplot for the first time; or, if you are not using pyplot, it must be called before importing matplotlib.backends. If warn is True, a warning is issued if you try and call this after pylab or pyplot have been loaded. In certain black magic use cases, e.g. pyplot.switch_backend(), we are doing the reloading necessary to make the backend switch work (in some cases, e.g., pure image backends) so one can set warn=False to suppress the warnings.

To find out which backend is currently set, see matplotlib.get_backend().

matplotlib.get_backend()[source]

Return the name of the current backend.

matplotlib.rcParams

An instance of RcParams for handling default matplotlib values.

matplotlib.rc_context(rc=None, fname=None)[source]

Return a context manager for managing rc settings.

This allows one to do:

with mpl.rc_context(fname='screen.rc'):
    plt.plot(x, a)
    with mpl.rc_context(fname='print.rc'):
        plt.plot(x, b)
    plt.plot(x, c)

The ‘a’ vs ‘x’ and ‘c’ vs ‘x’ plots would have settings from ‘screen.rc’, while the ‘b’ vs ‘x’ plot would have settings from ‘print.rc’.

A dictionary can also be passed to the context manager:

with mpl.rc_context(rc={'text.usetex': True}, fname='screen.rc'):
    plt.plot(x, a)

The ‘rc’ dictionary takes precedence over the settings loaded from ‘fname’. Passing a dictionary only is also valid. For example a common usage is:

with mpl.rc_context(rc={'interactive': False}):
    fig, ax = plt.subplots()
    ax.plot(range(3), range(3))
    fig.savefig('A.png', format='png')
    plt.close(fig)
matplotlib.rc(group, **kwargs)[source]

Set the current rc params. Group is the grouping for the rc, e.g., for lines.linewidth the group is lines, for axes.facecolor, the group is axes, and so on. Group may also be a list or tuple of group names, e.g., (xtick, ytick). kwargs is a dictionary attribute name/value pairs, e.g.,:

rc('lines', linewidth=2, color='r')

sets the current rc params and is equivalent to:

rcParams['lines.linewidth'] = 2
rcParams['lines.color'] = 'r'

The following aliases are available to save typing for interactive users:

Alias Property
‘lw’ ‘linewidth’
‘ls’ ‘linestyle’
‘c’ ‘color’
‘fc’ ‘facecolor’
‘ec’ ‘edgecolor’
‘mew’ ‘markeredgewidth’
‘aa’ ‘antialiased’

Thus you could abbreviate the above rc command as:

rc('lines', lw=2, c='r')

Note you can use python’s kwargs dictionary facility to store dictionaries of default parameters. e.g., you can customize the font rc as follows:

font = {'family' : 'monospace',
        'weight' : 'bold',
        'size'   : 'larger'}

rc('font', **font)  # pass in the font dict as kwargs

This enables you to easily switch between several configurations. Use matplotlib.style.use('default') or rcdefaults() to restore the default rc params after changes.

matplotlib.rc_file(fname)[source]

Update rc params from file.

matplotlib.rcdefaults()[source]

Restore the rc params from Matplotlib’s internal defaults.

See also

rc_file_defaults
Restore the rc params from the rc file originally loaded by Matplotlib.
matplotlib.style.use
Use a specific style file. Call style.use('default') to restore the default style.
matplotlib.rc_file_defaults()[source]

Restore the rc params from the original rc file loaded by Matplotlib.

class matplotlib.RcParams(*args, **kwargs)[source]

A dictionary object including validation

validating functions are defined and associated with rc parameters in matplotlib.rcsetup

find_all(pattern)[source]

Return the subset of this RcParams dictionary whose keys match, using re.search(), the given pattern.

Note

Changes to the returned dictionary are not propagated to the parent RcParams dictionary.

msg_backend_obsolete = 'The {} rcParam was deprecated in version 2.2. In order to force the use of a specific Qt binding, either import that binding first, or set the QT_API environment variable.'
msg_depr = '%s is deprecated and replaced with %s; please use the latter.'
msg_depr_ignore = '%s is deprecated and ignored. Use %s instead.'
msg_depr_set = '%s is deprecated. Please remove it from your matplotlibrc and/or style files.'
msg_obsolete = '%s is obsolete. Please remove it from your matplotlibrc and/or style files.'
validate = {'_internal.classic_mode': <function validate_bool at 0x7f9312c2b8c8>, 'agg.path.chunksize': <function validate_int at 0x7f9312c2bd90>, 'animation.avconv_args': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'animation.avconv_path': <function validate_animation_writer_path at 0x7f9312c326a8>, 'animation.bitrate': <function validate_int at 0x7f9312c2bd90>, 'animation.codec': <function validate_string at 0x7f9312c2c6a8>, 'animation.convert_args': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'animation.convert_path': <function validate_animation_writer_path at 0x7f9312c326a8>, 'animation.embed_limit': <function validate_float at 0x7f9312c2ba60>, 'animation.ffmpeg_args': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'animation.ffmpeg_path': <function validate_animation_writer_path at 0x7f9312c326a8>, 'animation.frame_format': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f320>, 'animation.html': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f3c8>, 'animation.html_args': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'animation.writer': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f358>, 'axes.autolimit_mode': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f860>, 'axes.axisbelow': <function validate_axisbelow at 0x7f9312c2bc80>, 'axes.edgecolor': <function validate_color at 0x7f9312c2c598>, 'axes.facecolor': <function validate_color at 0x7f9312c2c598>, 'axes.formatter.limits': <matplotlib.rcsetup.validate_nseq_int object at 0x7f9312c2f7f0>, 'axes.formatter.min_exponent': <function validate_int at 0x7f9312c2bd90>, 'axes.formatter.offset_threshold': <function validate_int at 0x7f9312c2bd90>, 'axes.formatter.use_locale': <function validate_bool at 0x7f9312c2b8c8>, 'axes.formatter.use_mathtext': <function validate_bool at 0x7f9312c2b8c8>, 'axes.formatter.useoffset': <function validate_bool at 0x7f9312c2b8c8>, 'axes.grid': <function validate_bool at 0x7f9312c2b8c8>, 'axes.grid.axis': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f400>, 'axes.grid.which': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f390>, 'axes.hold': <function deprecate_axes_hold at 0x7f9312c2b9d8>, 'axes.labelcolor': <function validate_color at 0x7f9312c2c598>, 'axes.labelpad': <function validate_float at 0x7f9312c2ba60>, 'axes.labelsize': <function validate_fontsize at 0x7f9312c2c840>, 'axes.labelweight': <function validate_string at 0x7f9312c2c6a8>, 'axes.linewidth': <function validate_float at 0x7f9312c2ba60>, 'axes.prop_cycle': <function validate_cycler at 0x7f9312c32598>, 'axes.spines.bottom': <function validate_bool at 0x7f9312c2b8c8>, 'axes.spines.left': <function validate_bool at 0x7f9312c2b8c8>, 'axes.spines.right': <function validate_bool at 0x7f9312c2b8c8>, 'axes.spines.top': <function validate_bool at 0x7f9312c2b8c8>, 'axes.titlepad': <function validate_float at 0x7f9312c2ba60>, 'axes.titlesize': <function validate_fontsize at 0x7f9312c2c840>, 'axes.titleweight': <function validate_string at 0x7f9312c2c6a8>, 'axes.unicode_minus': <function validate_bool at 0x7f9312c2b8c8>, 'axes.xmargin': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f898>, 'axes.ymargin': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f8d0>, 'axes3d.grid': <function validate_bool at 0x7f9312c2b8c8>, 'backend': <function validate_backend at 0x7f9312c2bf28>, 'backend.qt4': <function validate_qt4 at 0x7f9312c2c048>, 'backend.qt5': <function validate_qt5 at 0x7f9312c2c0d0>, 'backend_fallback': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.bootstrap': <function validate_int_or_None at 0x7f9312c2be18>, 'boxplot.boxprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.boxprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.boxprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.capprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.capprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.capprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.flierprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.flierprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.flierprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.flierprops.marker': <function validate_string at 0x7f9312c2c6a8>, 'boxplot.flierprops.markeredgecolor': <function validate_color at 0x7f9312c2c598>, 'boxplot.flierprops.markerfacecolor': <function validate_color_or_auto at 0x7f9312c2c488>, 'boxplot.flierprops.markersize': <function validate_float at 0x7f9312c2ba60>, 'boxplot.meanline': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.meanprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.meanprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.meanprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.meanprops.marker': <function validate_string at 0x7f9312c2c6a8>, 'boxplot.meanprops.markeredgecolor': <function validate_color at 0x7f9312c2c598>, 'boxplot.meanprops.markerfacecolor': <function validate_color at 0x7f9312c2c598>, 'boxplot.meanprops.markersize': <function validate_float at 0x7f9312c2ba60>, 'boxplot.medianprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.medianprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.medianprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.notch': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.patchartist': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.showbox': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.showcaps': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.showfliers': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.showmeans': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.vertical': <function validate_bool at 0x7f9312c2b8c8>, 'boxplot.whiskerprops.color': <function validate_color at 0x7f9312c2c598>, 'boxplot.whiskerprops.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'boxplot.whiskerprops.linewidth': <function validate_float at 0x7f9312c2ba60>, 'boxplot.whiskers': <function validate_whiskers at 0x7f9312c2c9d8>, 'contour.corner_mask': <function validate_bool at 0x7f9312c2b8c8>, 'contour.negative_linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'datapath': <function validate_path_exists at 0x7f9312c2b840>, 'date.autoformatter.day': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.hour': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.microsecond': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.minute': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.month': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.second': <function validate_string at 0x7f9312c2c6a8>, 'date.autoformatter.year': <function validate_string at 0x7f9312c2c6a8>, 'docstring.hardcopy': <function validate_bool at 0x7f9312c2b8c8>, 'errorbar.capsize': <function validate_float at 0x7f9312c2ba60>, 'examples.directory': <function validate_string at 0x7f9312c2c6a8>, 'figure.autolayout': <function validate_bool at 0x7f9312c2b8c8>, 'figure.constrained_layout.h_pad': <function validate_float at 0x7f9312c2ba60>, 'figure.constrained_layout.hspace': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2fa90>, 'figure.constrained_layout.use': <function validate_bool at 0x7f9312c2b8c8>, 'figure.constrained_layout.w_pad': <function validate_float at 0x7f9312c2ba60>, 'figure.constrained_layout.wspace': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2fac8>, 'figure.dpi': <function validate_float at 0x7f9312c2ba60>, 'figure.edgecolor': <function validate_color at 0x7f9312c2c598>, 'figure.facecolor': <function validate_color at 0x7f9312c2c598>, 'figure.figsize': <matplotlib.rcsetup.validate_nseq_float object at 0x7f9312c2f908>, 'figure.frameon': <function validate_bool at 0x7f9312c2b8c8>, 'figure.max_open_warning': <function validate_int at 0x7f9312c2bd90>, 'figure.subplot.bottom': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f9b0>, 'figure.subplot.hspace': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2fa58>, 'figure.subplot.left': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f940>, 'figure.subplot.right': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f978>, 'figure.subplot.top': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2f9e8>, 'figure.subplot.wspace': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2fa20>, 'figure.titlesize': <function validate_fontsize at 0x7f9312c2c840>, 'figure.titleweight': <function validate_string at 0x7f9312c2c6a8>, 'font.cursive': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.family': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.fantasy': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.monospace': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.sans-serif': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.serif': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'font.size': <function validate_float at 0x7f9312c2ba60>, 'font.stretch': <function validate_string at 0x7f9312c2c6a8>, 'font.style': <function validate_string at 0x7f9312c2c6a8>, 'font.variant': <function validate_string at 0x7f9312c2c6a8>, 'font.weight': <function validate_string at 0x7f9312c2c6a8>, 'grid.alpha': <function validate_float at 0x7f9312c2ba60>, 'grid.color': <function validate_color at 0x7f9312c2c598>, 'grid.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'grid.linewidth': <function validate_float at 0x7f9312c2ba60>, 'hatch.color': <function validate_color at 0x7f9312c2c598>, 'hatch.linewidth': <function validate_float at 0x7f9312c2ba60>, 'hist.bins': <function validate_hist_bins at 0x7f9312c32620>, 'image.aspect': <function validate_aspect at 0x7f9312c2c7b8>, 'image.cmap': <function validate_string at 0x7f9312c2c6a8>, 'image.composite_image': <function validate_bool at 0x7f9312c2b8c8>, 'image.interpolation': <function validate_string at 0x7f9312c2c6a8>, 'image.lut': <function validate_int at 0x7f9312c2bd90>, 'image.origin': <function validate_string at 0x7f9312c2c6a8>, 'image.resample': <function validate_bool at 0x7f9312c2b8c8>, 'interactive': <function validate_bool at 0x7f9312c2b8c8>, 'keymap.all_axes': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.back': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.forward': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.fullscreen': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.grid': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.grid_minor': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.home': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.pan': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.quit': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.quit_all': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.save': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.xscale': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.yscale': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'keymap.zoom': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'legend.borderaxespad': <function validate_float at 0x7f9312c2ba60>, 'legend.borderpad': <function validate_float at 0x7f9312c2ba60>, 'legend.columnspacing': <function validate_float at 0x7f9312c2ba60>, 'legend.edgecolor': <function validate_color_or_inherit at 0x7f9312c2c1e0>, 'legend.facecolor': <function validate_color_or_inherit at 0x7f9312c2c1e0>, 'legend.fancybox': <function validate_bool at 0x7f9312c2b8c8>, 'legend.fontsize': <function validate_fontsize at 0x7f9312c2c840>, 'legend.framealpha': <function validate_float_or_None at 0x7f9312c2bb70>, 'legend.frameon': <function validate_bool at 0x7f9312c2b8c8>, 'legend.handleheight': <function validate_float at 0x7f9312c2ba60>, 'legend.handlelength': <function validate_float at 0x7f9312c2ba60>, 'legend.handletextpad': <function validate_float at 0x7f9312c2ba60>, 'legend.labelspacing': <function validate_float at 0x7f9312c2ba60>, 'legend.loc': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f1d0>, 'legend.markerscale': <function validate_float at 0x7f9312c2ba60>, 'legend.numpoints': <function validate_int at 0x7f9312c2bd90>, 'legend.scatterpoints': <function validate_int at 0x7f9312c2bd90>, 'legend.shadow': <function validate_bool at 0x7f9312c2b8c8>, 'lines.antialiased': <function validate_bool at 0x7f9312c2b8c8>, 'lines.color': <function validate_color at 0x7f9312c2c598>, 'lines.dash_capstyle': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c15f28>, 'lines.dash_joinstyle': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c11550>, 'lines.dashdot_pattern': <matplotlib.rcsetup.validate_nseq_float object at 0x7f9312c2f710>, 'lines.dashed_pattern': <matplotlib.rcsetup.validate_nseq_float object at 0x7f9312c2f470>, 'lines.dotted_pattern': <matplotlib.rcsetup.validate_nseq_float object at 0x7f9312c2f748>, 'lines.linestyle': <function _validate_linestyle at 0x7f9312c327b8>, 'lines.linewidth': <function validate_float at 0x7f9312c2ba60>, 'lines.marker': <function validate_string at 0x7f9312c2c6a8>, 'lines.markeredgewidth': <function validate_float at 0x7f9312c2ba60>, 'lines.markersize': <function validate_float at 0x7f9312c2ba60>, 'lines.scale_dashes': <function validate_bool at 0x7f9312c2b8c8>, 'lines.solid_capstyle': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c15f28>, 'lines.solid_joinstyle': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c11550>, 'markers.fillstyle': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f048>, 'mathtext.bf': <function validate_font_properties at 0x7f9312c2c950>, 'mathtext.cal': <function validate_font_properties at 0x7f9312c2c950>, 'mathtext.default': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c11470>, 'mathtext.fallback_to_cm': <function validate_bool at 0x7f9312c2b8c8>, 'mathtext.fontset': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c11080>, 'mathtext.it': <function validate_font_properties at 0x7f9312c2c950>, 'mathtext.rm': <function validate_font_properties at 0x7f9312c2c950>, 'mathtext.sf': <function validate_font_properties at 0x7f9312c2c950>, 'mathtext.tt': <function validate_font_properties at 0x7f9312c2c950>, 'patch.antialiased': <function validate_bool at 0x7f9312c2b8c8>, 'patch.edgecolor': <function validate_color at 0x7f9312c2c598>, 'patch.facecolor': <function validate_color at 0x7f9312c2c598>, 'patch.force_edgecolor': <function validate_bool at 0x7f9312c2b8c8>, 'patch.linewidth': <function validate_float at 0x7f9312c2ba60>, 'path.effects': <function validate_any at 0x7f9312c2b730>, 'path.simplify': <function validate_bool at 0x7f9312c2b8c8>, 'path.simplify_threshold': <matplotlib.rcsetup.ValidateInterval object at 0x7f9312c2fb00>, 'path.sketch': <function validate_sketch at 0x7f9312c32158>, 'path.snap': <function validate_bool at 0x7f9312c2b8c8>, 'pdf.compression': <function validate_int at 0x7f9312c2bd90>, 'pdf.fonttype': <function validate_fonttype at 0x7f9312c2bea0>, 'pdf.inheritcolor': <function validate_bool at 0x7f9312c2b8c8>, 'pdf.use14corefonts': <function validate_bool at 0x7f9312c2b8c8>, 'pgf.debug': <function validate_bool at 0x7f9312c2b8c8>, 'pgf.preamble': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'pgf.rcfonts': <function validate_bool at 0x7f9312c2b8c8>, 'pgf.texsystem': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c2f240>, 'polaraxes.grid': <function validate_bool at 0x7f9312c2b8c8>, 'ps.distiller.res': <function validate_int at 0x7f9312c2bd90>, 'ps.fonttype': <function validate_fonttype at 0x7f9312c2bea0>, 'ps.papersize': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c11518>, 'ps.useafm': <function validate_bool at 0x7f9312c2b8c8>, 'ps.usedistiller': <function validate_ps_distiller at 0x7f9312c2cae8>, 'savefig.bbox': <function validate_bbox at 0x7f9312c320d0>, 'savefig.directory': <function validate_string at 0x7f9312c2c6a8>, 'savefig.dpi': <function validate_dpi at 0x7f9312c2bd08>, 'savefig.edgecolor': <function validate_color at 0x7f9312c2c598>, 'savefig.facecolor': <function validate_color at 0x7f9312c2c598>, 'savefig.format': <function update_savefig_format at 0x7f9312c2ca60>, 'savefig.frameon': <function validate_bool at 0x7f9312c2b8c8>, 'savefig.jpeg_quality': <function validate_int at 0x7f9312c2bd90>, 'savefig.orientation': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c09f98>, 'savefig.pad_inches': <function validate_float at 0x7f9312c2ba60>, 'savefig.transparent': <function validate_bool at 0x7f9312c2b8c8>, 'scatter.marker': <function validate_string at 0x7f9312c2c6a8>, 'svg.fonttype': <function validate_svg_fonttype at 0x7f9312c2cd08>, 'svg.hashsalt': <function validate_string_or_None at 0x7f9312c2bbf8>, 'svg.image_inline': <function validate_bool at 0x7f9312c2b8c8>, 'text.antialiased': <function validate_bool at 0x7f9312c2b8c8>, 'text.color': <function validate_color at 0x7f9312c2c598>, 'text.hinting': <function validate_hinting at 0x7f9312c2cf28>, 'text.hinting_factor': <function validate_int at 0x7f9312c2bd90>, 'text.latex.preamble': <function _listify_validator.<locals>.f at 0x7f9312c2c730>, 'text.latex.preview': <function validate_bool at 0x7f9312c2b8c8>, 'text.latex.unicode': <function validate_bool at 0x7f9312c2b8c8>, 'text.usetex': <function validate_bool at 0x7f9312c2b8c8>, 'timezone': <function validate_string at 0x7f9312c2c6a8>, 'tk.window_focus': <function validate_bool at 0x7f9312c2b8c8>, 'toolbar': <function validate_toolbar at 0x7f9312c2c158>, 'verbose.fileo': <function validate_string at 0x7f9312c2c6a8>, 'verbose.level': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c114a8>, 'webagg.address': <function validate_webagg_address at 0x7f9312c32730>, 'webagg.open_in_browser': <function validate_bool at 0x7f9312c2b8c8>, 'webagg.port': <function validate_int at 0x7f9312c2bd90>, 'webagg.port_retries': <function validate_int at 0x7f9312c2bd90>, 'xtick.alignment': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c114e0>, 'xtick.bottom': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.color': <function validate_color at 0x7f9312c2c598>, 'xtick.direction': <function validate_string at 0x7f9312c2c6a8>, 'xtick.labelbottom': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.labelsize': <function validate_fontsize at 0x7f9312c2c840>, 'xtick.labeltop': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.major.bottom': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.major.pad': <function validate_float at 0x7f9312c2ba60>, 'xtick.major.size': <function validate_float at 0x7f9312c2ba60>, 'xtick.major.top': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.major.width': <function validate_float at 0x7f9312c2ba60>, 'xtick.minor.bottom': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.minor.pad': <function validate_float at 0x7f9312c2ba60>, 'xtick.minor.size': <function validate_float at 0x7f9312c2ba60>, 'xtick.minor.top': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.minor.visible': <function validate_bool at 0x7f9312c2b8c8>, 'xtick.minor.width': <function validate_float at 0x7f9312c2ba60>, 'xtick.top': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.alignment': <matplotlib.rcsetup.ValidateInStrings object at 0x7f9312c114e0>, 'ytick.color': <function validate_color at 0x7f9312c2c598>, 'ytick.direction': <function validate_string at 0x7f9312c2c6a8>, 'ytick.labelleft': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.labelright': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.labelsize': <function validate_fontsize at 0x7f9312c2c840>, 'ytick.left': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.major.left': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.major.pad': <function validate_float at 0x7f9312c2ba60>, 'ytick.major.right': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.major.size': <function validate_float at 0x7f9312c2ba60>, 'ytick.major.width': <function validate_float at 0x7f9312c2ba60>, 'ytick.minor.left': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.minor.pad': <function validate_float at 0x7f9312c2ba60>, 'ytick.minor.right': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.minor.size': <function validate_float at 0x7f9312c2ba60>, 'ytick.minor.visible': <function validate_bool at 0x7f9312c2b8c8>, 'ytick.minor.width': <function validate_float at 0x7f9312c2ba60>, 'ytick.right': <function validate_bool at 0x7f9312c2b8c8>}
matplotlib.rc_params(fail_on_error=False)[source]

Return a matplotlib.RcParams instance from the default matplotlib rc file.

matplotlib.rc_params_from_file(fname, fail_on_error=False, use_default_template=True)[source]

Return matplotlib.RcParams from the contents of the given file.

Parameters:
fname : str

Name of file parsed for matplotlib settings.

fail_on_error : bool

If True, raise an error when the parser fails to convert a parameter.

use_default_template : bool

If True, initialize with default parameters before updating with those in the given file. If False, the configuration class only contains the parameters specified in the file. (Useful for updating dicts.)

matplotlib.matplotlib_fname()[source]

Get the location of the config file.

The file location is determined in the following order

  • $PWD/matplotlibrc

  • $MATPLOTLIBRC if it is a file (or a named pipe, which can be created e.g. by process substitution)

  • $MATPLOTLIBRC/matplotlibrc

  • $MPLCONFIGDIR/matplotlibrc

  • On Linux,

    • $XDG_CONFIG_HOME/matplotlib/matplotlibrc (if $XDG_CONFIG_HOME is defined)
    • or $HOME/.config/matplotlib/matplotlibrc (if $XDG_CONFIG_HOME is not defined)
  • On other platforms,

    • $HOME/.matplotlib/matplotlibrc if $HOME is defined.
  • Lastly, it looks in $MATPLOTLIBDATA/matplotlibrc for a system-defined copy.

matplotlib.interactive(b)[source]

Set interactive mode to boolean b.

If b is True, then draw after every plotting command, e.g., after xlabel

matplotlib.is_interactive()[source]

Return true if plot mode is interactive