Spec-Zone.ru › Matplotlib 3.4

matplotlib

Управление бэкендом

matplotlib.use(backend, *, force=True)[source]

Выбор бэкенда для отрисовки и интеграции с графическим интерфейсом.

Параметры:
backendstr

Бэкенд для переключения. Это может быть одно из стандартных имён бэкендов (регистр не учитывается):

  • интерактивные бэкенды: GTK3Agg, GTK3Cairo, MacOSX, nbAgg, Qt4Agg, Qt4Cairo, Qt5Agg, Qt5Cairo, TkAgg, TkCairo, WebAgg, WX, WXAgg, WXCairo
  • неинтерактивные бэкенды: agg, cairo, pdf, pgf, ps, svg, template

или строка вида: module://my.module.name.

forcebool, по умолчанию: True

Если True (по умолчанию), вызовет ImportError, если бэкенд не может быть настроен (либо из-за неудачного импорта, либо из-за того, что уже запущена несовместимая графическая среда); если False, проигнорирует ошибку.

См. также

Бэкенды
matplotlib.get_backend
matplotlib.get_backend()[source]

Возвращает имя текущего бэкенда.

См. также

matplotlib.use
matplotlib.interactive(b)[source]

Устанавливает, нужно ли перерисовывать после каждой команды построения графика (например, pyplot.xlabel).

matplotlib.is_interactive()[source]

Возвращает, нужно ли перерисовывать после каждой команды построения графика.

Примечание

Эта функция предназначена только для использования в бэкендах. Конечные пользователи должны использовать pyplot.isinteractive вместо неё.

Значения по умолчанию и стили

matplotlib.rcParams

Экземпляр RcParams для управления значениями по умолчанию Matplotlib.

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

Объект словаря, включающий валидацию.

Функции валидации определены и связаны с параметрами rc в matplotlib.rcsetup.

Список параметров rc:

  • backend
  • backend_fallback
  • toolbar
  • interactive
  • timezone
  • webagg.port
  • webagg.address
  • webagg.open_in_browser
  • webagg.port_retries
  • lines.linewidth
  • lines.linestyle
  • lines.color
  • lines.marker
  • lines.markerfacecolor
  • lines.markeredgecolor
  • lines.markeredgewidth
  • lines.markersize
  • lines.antialiased
  • lines.dash_joinstyle
  • lines.solid_joinstyle
  • lines.dash_capstyle
  • lines.solid_capstyle
  • lines.dashed_pattern
  • lines.dashdot_pattern
  • lines.dotted_pattern
  • lines.scale_dashes
  • markers.fillstyle
  • pcolor.shading
  • pcolormesh.snap
  • patch.linewidth
  • patch.edgecolor
  • patch.force_edgecolor
  • patch.facecolor
  • patch.antialiased
  • hatch.color
  • hatch.linewidth
  • hist.bins
  • boxplot.notch
  • boxplot.vertical
  • boxplot.whiskers
  • boxplot.bootstrap
  • boxplot.patchartist
  • boxplot.showmeans
  • boxplot.showcaps
  • boxplot.showbox
  • boxplot.showfliers
  • boxplot.meanline
  • boxplot.flierprops.color
  • boxplot.flierprops.marker
  • boxplot.flierprops.markerfacecolor
  • boxplot.flierprops.markeredgecolor
  • boxplot.flierprops.markeredgewidth
  • boxplot.flierprops.markersize
  • boxplot.flierprops.linestyle
  • boxplot.flierprops.linewidth
  • boxplot.boxprops.color
  • boxplot.boxprops.linewidth
  • boxplot.boxprops.linestyle
  • boxplot.whiskerprops.color
  • boxplot.whiskerprops.linewidth
  • boxplot.whiskerprops.linestyle
  • boxplot.capprops.color
  • boxplot.capprops.linewidth
  • boxplot.capprops.linestyle
  • boxplot.medianprops.color
  • boxplot.medianprops.linewidth
  • boxplot.medianprops.linestyle
  • boxplot.meanprops.color
  • boxplot.meanprops.marker
  • boxplot.meanprops.markerfacecolor
  • boxplot.meanprops.markeredgecolor
  • boxplot.meanprops.markersize
  • boxplot.meanprops.linestyle
  • boxplot.meanprops.linewidth
  • font.family
  • font.style
  • font.variant
  • font.stretch
  • font.weight
  • font.size
  • font.serif
  • font.sans-serif
  • font.cursive
  • font.fantasy
  • font.monospace
  • text.color
  • text.usetex
  • text.latex.preamble
  • text.latex.preview
  • text.hinting
  • text.hinting_factor
  • text.kerning_factor
  • text.antialiased
  • mathtext.cal
  • mathtext.rm
  • mathtext.tt
  • mathtext.it
  • mathtext.bf
  • mathtext.sf
  • mathtext.fontset
  • mathtext.default
  • mathtext.fallback_to_cm
  • mathtext.fallback
  • image.aspect
  • image.interpolation
  • image.cmap
  • image.lut
  • image.origin
  • image.resample
  • image.composite_image
  • contour.negative_linestyle
  • contour.corner_mask
  • contour.linewidth
  • errorbar.capsize
  • xaxis.labellocation
  • yaxis.labellocation
  • axes.axisbelow
  • axes.facecolor
  • axes.edgecolor
  • axes.linewidth
  • axes.spines.left
  • axes.spines.right
  • axes.spines.bottom
  • axes.spines.top
  • axes.titlesize
  • axes.titlelocation
  • axes.titleweight
  • axes.titlecolor
  • axes.titley
  • axes.titlepad
  • axes.grid
  • axes.grid.which
  • axes.grid.axis
  • axes.labelsize
  • axes.labelpad
  • axes.labelweight
  • axes.labelcolor
  • axes.formatter.limits
  • axes.formatter.use_locale
  • axes.formatter.use_mathtext
  • axes.formatter.min_exponent
  • axes.formatter.useoffset
  • axes.formatter.offset_threshold
  • axes.unicode_minus
  • axes.prop_cycle
  • axes.autolimit_mode
  • axes.xmargin
  • axes.ymargin
  • axes.zmargin
  • polaraxes.grid
  • axes3d.grid
  • scatter.marker
  • scatter.edgecolors
  • date.epoch
  • date.autoformatter.year
  • date.autoformatter.month
  • date.autoformatter.day
  • date.autoformatter.hour
  • date.autoformatter.minute
  • date.autoformatter.second
  • date.autoformatter.microsecond
  • date.converter
  • date.interval_multiples
  • legend.fancybox
  • legend.loc
  • legend.numpoints
  • legend.scatterpoints
  • legend.fontsize
  • legend.title_fontsize
  • legend.markerscale
  • legend.shadow
  • legend.frameon
  • legend.framealpha
  • legend.borderpad
  • legend.labelspacing
  • legend.handlelength
  • legend.handleheight
  • legend.handletextpad
  • legend.borderaxespad
  • legend.columnspacing
  • legend.facecolor
  • legend.edgecolor
  • xtick.top
  • xtick.bottom
  • xtick.labeltop
  • xtick.labelbottom
  • xtick.major.size
  • xtick.minor.size
  • xtick.major.width
  • xtick.minor.width
  • xtick.major.pad
  • xtick.minor.pad
  • xtick.color
  • xtick.labelcolor
  • xtick.minor.visible
  • xtick.minor.top
  • xtick.minor.bottom
  • xtick.major.top
  • xtick.major.bottom
  • xtick.labelsize
  • xtick.direction
  • xtick.alignment
  • ytick.left
  • ytick.right
  • ytick.labelleft
  • ytick.labelright
  • ytick.major.size
  • ytick.minor.size
  • ytick.major.width
  • ytick.minor.width
  • ytick.major.pad
  • ytick.minor.pad
  • ytick.color
  • ytick.labelcolor
  • ytick.minor.visible
  • ytick.minor.left
  • ytick.minor.right
  • ytick.major.left
  • ytick.major.right
  • ytick.labelsize
  • ytick.direction
  • ytick.alignment
  • grid.color
  • grid.linestyle
  • grid.linewidth
  • grid.alpha
  • figure.titlesize
  • figure.titleweight
  • figure.figsize
  • figure.dpi
  • figure.facecolor
  • figure.edgecolor
  • figure.frameon
  • figure.autolayout
  • figure.max_open_warning
  • figure.raise_window
  • figure.subplot.left
  • figure.subplot.right
  • figure.subplot.bottom
  • figure.subplot.top
  • figure.subplot.wspace
  • figure.subplot.hspace
  • figure.constrained_layout.use
  • figure.constrained_layout.hspace
  • figure.constrained_layout.wspace
  • figure.constrained_layout.h_pad
  • figure.constrained_layout.w_pad
  • savefig.dpi
  • savefig.facecolor
  • savefig.edgecolor
  • savefig.orientation
  • savefig.jpeg_quality
  • savefig.format
  • savefig.bbox
  • savefig.pad_inches
  • savefig.directory
  • savefig.transparent
  • tk.window_focus
  • ps.papersize
  • ps.useafm
  • ps.usedistiller
  • ps.distiller.res
  • ps.fonttype
  • pdf.compression
  • pdf.inheritcolor
  • pdf.use14corefonts
  • pdf.fonttype
  • pgf.texsystem
  • pgf.rcfonts
  • pgf.preamble
  • svg.image_inline
  • svg.fonttype
  • svg.hashsalt
  • docstring.hardcopy
  • path.simplify
  • path.simplify_threshold
  • path.snap
  • path.sketch
  • path.effects
  • agg.path.chunksize
  • keymap.fullscreen
  • keymap.home
  • keymap.back
  • keymap.forward
  • keymap.pan
  • keymap.zoom
  • keymap.save
  • keymap.quit
  • keymap.quit_all
  • keymap.grid
  • keymap.grid_minor
  • keymap.yscale
  • keymap.xscale
  • keymap.all_axes
  • keymap.help
  • keymap.copy
  • animation.html
  • animation.embed_limit
  • animation.writer
  • animation.codec
  • animation.bitrate
  • animation.frame_format
  • animation.html_args
  • animation.ffmpeg_path
  • animation.ffmpeg_args
  • animation.avconv_path
  • animation.avconv_args
  • animation.convert_path
  • animation.convert_args
  • _internal.classic_mode

См. также

Файл matplotlibrc
find_all(pattern)[source]

Возвращает подмножество словаря RcParams, ключи которого соответствуют заданному pattern, используя re.search().

Примечание

Изменения в возвращенном словаре не передаются родительскому словарю RcParams.

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

Возвращает контекстный менеджер для временного изменения rcParams.

Параметры:
rcdict

rcParams для временного изменения.

fnamestr или путь-подобный объект

Файл с настройками Matplotlib rc. Если заданы и fname, и rc, настройки из rc имеют приоритет.

См. также

Файл matplotlibrc

Примеры

Передача явных значений через словарь:

with mpl.rc_context({'interactive': False}):
    fig, ax = plt.subplots()
    ax.plot(range(3), range(3))
    fig.savefig('example.png')
    plt.close(fig)

Загрузка настроек из файла:

with mpl.rc_context(fname='print.rc'):
    plt.plot(x, y)  # uses 'print.rc'
matplotlib.rc(group, **kwargs)[source]

Устанавливает текущие rcParams. group — группа для rc, например, для lines.linewidth группой является lines, для axes.facecolor, группой является axes, и так далее. Группа также может быть списком или кортежем имён групп, например, (xtick, ytick). kwargs — словарь пар имя/значение атрибутов, например:

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

устанавливает текущие rcParams и эквивалентно:

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

Доступны следующие псевдонимы для экономии набора текста пользователями в интерактивном режиме:

Псевдоним Свойство
'lw' 'linewidth'
'ls' 'linestyle'
'c' 'color'
'fc' 'facecolor'
'ec' 'edgecolor'
'mew' 'markeredgewidth'
'aa' 'antialiased'

Таким образом, вы можете сократить вышеприведенный вызов до:

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

Обратите внимание, что вы можете использовать функцию словаря python kwargs для хранения словарей параметров по умолчанию. Например, вы можете настроить настройки шрифта rc следующим образом:

font = {'family' : 'monospace',
        'weight' : 'bold',
        'size'   : 'larger'}
rc('font', **font)  # pass in the font dict as kwargs

Это позволяет легко переключаться между несколькими конфигурациями. Используйте matplotlib.style.use('default') или rcdefaults() для восстановления значений по умолчанию rcParams после изменений.

Примечания

Аналогичная функциональность доступна с помощью обычного интерфейса словаря, т. е. rcParams.update({"lines.linewidth": 2, ...}) (но rcParams.update не поддерживает сокращения или группирование).

matplotlib.rcdefaults()[source]

Восстанавливает rcParams из внутреннего стиля по умолчанию Matplotlib.

Список rcParams, помеченных в стиле как исключенные (определенные в matplotlib.style.core.STYLE_BLACKLIST), не обновляется.

См. также

matplotlib.rc_file_defaults
Восстановление rcParams из файла rc, первоначально загруженного Matplotlib.
matplotlib.style.use
Используйте определенный файл стиля. Вызовите style.use('default') для восстановления стиля по умолчанию.
matplotlib.rc_file_defaults()[source]

Восстанавливает rcParams из исходного файла rc, загруженного Matplotlib.

Список rcParams, помеченных в стиле как исключенные (определенные в matplotlib.style.core.STYLE_BLACKLIST), не обновляется.

matplotlib.rc_file(fname, *, use_default_template=True)[source]

Обновляет rcParams из файла.

Список rcParams, помеченных в стиле как исключенные (определенные в matplotlib.style.core.STYLE_BLACKLIST), не обновляется.

Параметры:
fnamestr или путь-подобный объект

Файл с настройками Matplotlib rc.

use_default_templatebool

Если True, инициализируется значениями по умолчанию перед обновлением параметрами из данного файла. Если False, текущая конфигурация сохраняется, и обновляются только параметры, указанные в файле.

matplotlib.rc_params(fail_on_error=False)[source]

Создаёт экземпляр RcParams из файла настроек по умолчанию Matplotlib.

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

Создаёт RcParams из файла fname.

Параметры:
fnamestr или путь-подобный объект

Файл с настройками Matplotlib rc.

fail_on_errorbool

Если True, генерирует ошибку при сбое парсера при преобразовании параметра.

use_default_templatebool

Если True, инициализируется значениями по умолчанию перед обновлением параметрами из данного файла. Если False, класс конфигурации содержит только параметры, указанные в файле. (Полезно для обновления словарей.)

matplotlib.get_configdir()[source]

Возвращает строковый путь каталога конфигурации.

Каталог выбирается следующим образом:

  1. Если переменная среды MPLCONFIGDIR задана, выбирается она.
  2. В Linux сначала проверяется $XDG_CONFIG_HOME, если задан, или $HOME/.config. На других платформах выбирается $HOME/.matplotlib.
  3. Если выбранный каталог существует и доступен для записи, используется он.
  4. В противном случае создаётся временный каталог, и используется он.
END_OF_DOCUMENT_MARKER
matplotlib.matplotlib_fname()[source]

Получить расположение файла конфигурации.

Расположение файла определяется в следующем порядке

  • $PWD/matplotlibrc
  • $MATPLOTLIBRC если это не каталог
  • $MATPLOTLIBRC/matplotlibrc
  • $MPLCONFIGDIR/matplotlibrc
  • В Linux:
    • $XDG_CONFIG_HOME/matplotlib/matplotlibrc (если $XDG_CONFIG_HOME определено)
    • или $HOME/.config/matplotlib/matplotlibrc (если $XDG_CONFIG_HOME не определено)
  • На других платформах - $HOME/.matplotlib/matplotlibrc если $HOME определено
  • Наконец, ищется в $MATPLOTLIBDATA/matplotlibrc, который всегда должен существовать.
matplotlib.get_data_path()[source]

Возвращает путь к данным Matplotlib.

Ведение журнала

matplotlib.set_loglevel(level)[source]

Устанавливает уровень корневого логгера Matplotlib и уровень обработчика корневого логгера, создавая обработчик, если он еще не существует.

Обычно для получения дополнительной отладочной информации следует вызывать set_loglevel("info") или set_loglevel("debug").

Параметры:
level{"notset", "debug", "info", "warning", "error", "critical"}

Уровень журнала обработчика.

Примечания

При первом вызове этой функции к корневому обработчику Matplotlib прикрепляется дополнительный обработчик; этот обработчик используется каждый раз, и эта функция просто манипулирует уровнем логгера и обработчика.

Разное

matplotlib.get_cachedir()[source]

Возвращает строковый путь к каталогу кэша.

Процедура поиска каталога такая же, как для _get_config_dir, за исключением использования $XDG_CACHE_HOME/$HOME/.cache вместо.

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/matplotlib_configuration_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API