Spec-Zone.ru › Matplotlib 3.5

matplotlib

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

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

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

Параметры
backendstr

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

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

или строка в формате: module://my.module.name.

Переключение на интерактивный бэкенд невозможно, если уже запущена независимая очередь событий (например, переключение на GTK3Agg, если уже открыто окно TkAgg). Переключение на неинтерактивный бэкенд всегда возможно.

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

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

См. также

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

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

См. также

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

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

matplotlib.is_interactive()[source]

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

Примечание

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

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

matplotlib.rcParams[source]

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

classmatplotlib.RcParams(*args, **kwargs)[source]

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

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

Список rcParams:

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

См. также

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

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

Примечание

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

END_OF_DOCUMENT_MARKER
matplotlib.rc_context(rc=None, fname=None)

Возвращает контекстный менеджер для временного изменения 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's 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, сначала ищется в $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.colormaps[source]

Контейнер для цветовых карт, известных Matplotlib по имени.

Экспериментально

Хотя мы ожидаем, что API будет окончательным, мы формально отмечаем его как экспериментальный для 3.5, так как хотим сохранить возможность дальнейшей адаптации API для 3.6, если это будет необходимо.

Универсальный экземпляр реестра — matplotlib.colormaps. Пользователям не нужно создавать ColormapRegistry самостоятельно.

Доступ для чтения использует интерфейс типа словаря, сопоставляющий имена с Colormap:

import matplotlib as mpl
cmap = mpl.colormaps['viridis']

Возвращаемые Colormap — копии, поэтому их изменение не повлияет на глобальное определение цветовой карты.

Дополнительные цветовые карты могут быть добавлены с помощью ColormapRegistry.register:

mpl.colormaps.register(my_colormap)

Разное

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.5.1/api/matplotlib_configuration_api.html

Spec-Zone.ru

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