matplotlib.backend_bases

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

RendererBase

Абстрактный базовый класс для обработки операций рисования/рендеринга.

FigureCanvasBase

Уровень абстракции, который отделяет Figure от бэкенд-специфичных деталей, таких как область рисования пользовательского интерфейса.

GraphicsContextBase

Абстрактный базовый класс, предоставляющий цвета, стили линий и т. д.

Event

Базовый класс для всей обработки событий Matplotlib. Производные классы, такие как KeyEvent и MouseEvent, хранят метаданные, такие как нажатые клавиши и кнопки, координаты x и y в пикселях и координатах Axes.

ShowBase

Базовый класс для класса Show каждого интерактивного бэкенда; вызываемый объект «show» затем устанавливается в Show.__call__.

ToolContainerBase

Базовый класс для класса панели инструментов каждого интерактивного бэкенда.

classmatplotlib.backend_bases.CloseEvent(name, canvas, guiEvent=None)[source]

Bases: matplotlib.backend_bases.Event

Событие, срабатывающее при закрытии фигуры.

classmatplotlib.backend_bases.DrawEvent(name, canvas, renderer)[source]

Bases: matplotlib.backend_bases.Event

Событие, срабатывающее при операции рисования на холсте.

В большинстве бэкендов обратные вызовы, подписные на это событие, будут вызываться после завершения рендеринга, но перед обновлением экрана. Любые дополнительные художники, нарисованные на рендере холста, будут отражены без явного вызова blit.

Предупреждение

Вызов canvas.draw и canvas.blit в этих обратных вызовах может быть небезопасен со всеми бэкендами и может вызвать бесконечную рекурсию.

У DrawEvent есть ряд специальных атрибутов помимо тех, которые определены родительским классом Event.

Атрибуты

rendererRendererBase

Рендер для события рисования.

classmatplotlib.backend_bases.Event(name, canvas, guiEvent=None)[source]

Bases: object

Событие Matplotlib.

Ниже определены и показаны атрибуты со значениями по умолчанию. Подклассы могут определять дополнительные атрибуты.

Атрибуты

namestr

Имя события.

canvasFigureCanvasBase

Бэкенд-специфический экземпляр холста, генерирующий событие.

guiEvent

Событие графического интерфейса, вызвавшее событие Matplotlib.

classmatplotlib.backend_bases.FigureCanvasBase(figure=None)[source]

Основания: object

Поверхность холста, на которую отрисовывается рисунок.

Атрибуты

figurematplotlib.figure.Figure

Экземпляр фигуры высокого уровня.

blit(bbox=None)[source]

Отобразить область холста в рамках bbox (по умолчанию весь холст).

свойствоbutton_pick_id

button_press_event(x, y, button, dblclick=False, guiEvent=None)[source]

Обработка событий нажатия кнопки мыши.

Производные классы бэкенда должны вызывать эту функцию при любом нажатии кнопки мыши. (x, y) — координаты на холсте ((0, 0) — нижний левый угол). Кнопка и клавиша определены в MouseEvent.

Этот метод вызовет все функции, связанные с 'button_press_event', с экземпляром MouseEvent.

button_release_event(x, y, button, guiEvent=None)[source]

Обработка событий отпускания кнопки мыши.

Производные классы бэкенда должны вызывать эту функцию при отпускании любой кнопки мыши.

Этот метод вызовет все функции, связанные с 'button_release_event', с экземпляром MouseEvent.

Параметры

xfloat

Координаты на холсте, где 0=слева.

yfloat

Координаты на холсте, где 0=снизу.

guiEvent

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

свойствоcallbacks

close_event(guiEvent=None)[source]

Передает CloseEvent всем функциям, подключенным к close_event.

свойствоdevice_pixel_ratio

Отношение физических к логическим пикселям, используемым для холста на экране.

По умолчанию это 1, что означает одинаковый размер физических и логических пикселей. Подклассы, поддерживающие экраны с высоким разрешением, могут установить это свойство, чтобы указать, что это отношение отличается. Все взаимодействия Matplotlib, кроме тех, которые работают непосредственно с холстом, остаются в логических пикселях.

draw(*args, **kwargs)[source]

Отрисовка Figure.

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

draw_event(renderer)[source]

Передает DrawEvent всем функциям, подключенным к draw_event.

draw_idle(*args, **kwargs)[source]

Запросить перерисовку виджета, как только управление вернется в цикл событий GUI.

Даже если несколько вызовов draw_idle произойдут до возвращения управления в цикл событий GUI, рисунок будет отрисован только один раз.

Примечания

Бэкэнды могут переопределить метод и реализовать свою стратегию для предотвращения многократной отрисовки.

enter_notify_event(guiEvent=None, xy=None)[source]

Обработка событий входа указателя мыши в область холста.

Производные классы бэкенда должны вызывать эту функцию при входе в область холста.

Параметры

guiEvent

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

xy(float, float)

Координаты указателя при входе в область холста.

events=['resize_event', 'draw_event', 'key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event', 'pick_event', 'figure_enter_event', 'figure_leave_event', 'axes_enter_event', 'axes_leave_event', 'close_event']

filetypes={'eps': 'Encapsulated Postscript', 'jpeg': 'Joint Photographic Experts Group', 'jpg': 'Joint Photographic Experts Group', 'pdf': 'Portable Document Format', 'pgf': 'PGF code for LaTeX', 'png': 'Portable Network Graphics', 'ps': 'Postscript', 'raw': 'Raw RGBA bitmap', 'rgba': 'Raw RGBA bitmap', 'svg': 'Scalable Vector Graphics', 'svgz': 'Scalable Vector Graphics', 'tif': 'Tagged Image File Format', 'tiff': 'Tagged Image File Format'}

fixed_dpi=None

flush_events()[source]

Очистить события графического интерфейса для фигуры.

Интерактивные бэкэнды должны переопределить этот метод.

get_default_filename()[source]

Возвращает строку, включающую расширение, подходящую для использования в качестве имени файла по умолчанию.

classmethodget_default_filetype()[source]

Возвращает формат файла сохранения по умолчанию, указанный в rcParams["savefig.format"] (по умолчанию: 'png').

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

classmethodget_supported_filetypes()[source]

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

classmethodget_supported_filetypes_grouped()[source]

Возвращает словарь форматов файлов сохранения, поддерживаемых данным бэкэндом, где ключи — это имена типов файлов, такие как «Группа экспертов по совместной фотосъемке», а значения — список расширений имён файлов, используемых для этого типа файла, таких как ['jpg', 'jpeg'].

get_width_height(*, physical=False)[source]

Возвращает ширину и высоту фигуры в целочисленных точках или пикселях.

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

Parameters

physicalbool, default: False

Указывает, возвращать ли истинные физические пиксели или логические пиксели. Физические пиксели могут использоваться бэкендами, поддерживающими HiDPI, но всё ещё настраивающими холст с использованием его фактического размера.

Returns

width, heightint

Размер фигуры в точках или пикселях в зависимости от бэкэнда.

get_window_title()[source]

[Устарело] Возвращает текст заголовка окна, содержащего фигуру, или None, если окно отсутствует (например, в бэкенде PS).

Заметки

Устарело начиная с версии 3.4.

grab_mouse(ax)[source]

Устанавливает дочерний Axes, который захватывает события мыши.

Обычно вызывается самими виджетами. Вызов этого метода, если мышь уже захвачена другим объектом Axes, является ошибкой.

inaxes(xy)[source]

Возвращает самый верхний видимый Axes, содержащий точку xy.

Parameters

xy(float, float)

(x, y) позиций пикселей слева/снизу холста.

Returns

Axes или None

Самый верхний видимый объект Axes, содержащий точку, или None, если объект Axes отсутствует.

is_saving()[source]

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

key_press_event(key, guiEvent=None)[source]

Передаёт KeyEvent всем функциям, подключённым к key_press_event.

key_release_event(key, guiEvent=None)[source]

Передаёт KeyEvent всем функциям, подключённым к key_release_event.

leave_notify_event(guiEvent=None)[source]

Обработчик событий для выхода курсора мыши с холста.

Производные классы бэкендов должны вызывать эту функцию при выходе с холста.

Parameters

guiEvent

Родное событие UI, которое сгенерировало событие Matplotlib.

motion_notify_event(x, y, guiEvent=None)[source]

Обработка событий перемещения мыши.

Производные классы бэкендов должны вызывать эту функцию при любых событиях перемещения мыши.

Этот метод вызовет все функции, подключенные к событию 'motion_notify_event', с экземпляром MouseEvent.

Параметры

xfloat

Координаты на холсте, где 0=слева.

yfloat

Координаты на холсте, где 0=внизу.

guiEvent

Родное UI-событие, которое сгенерировало событие Matplotlib.

mpl_connect(s, func)[source]

Связывает функцию func с событием s.

Параметры

sstr

Один из следующих идентификаторов событий:

• 'button_press_event'
• 'button_release_event'
• 'draw_event'
• 'key_press_event'
• 'key_release_event'
• 'motion_notify_event'
• 'pick_event'
• 'resize_event'
• 'scroll_event'
• 'figure_enter_event',
• 'figure_leave_event',
• 'axes_enter_event',
• 'axes_leave_event'
• 'close_event'.

funccallable

Функция обратного вызова, которая должна иметь следующий вид:

def func(event: Event) -> Any

Для событий расположения (нажатие и отпускание кнопок и клавиш), если курсор находится над осями, атрибут inaxes события будет установлен на Axes, над которым находится курсор, а также атрибуты xdata и ydata будут установлены на координаты курсора в координатах данных. См. KeyEvent и MouseEvent для получения дополнительной информации.

Возвращаемое значение

cid

Идентификатор подключения, который можно использовать с FigureCanvasBase.mpl_disconnect.

Примеры

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = canvas.mpl_connect('button_press_event', on_press)

mpl_disconnect(cid)[source]

Отключает обработчик с id cid.

Примеры

cid = canvas.mpl_connect('button_press_event', on_press)
# ... later
canvas.mpl_disconnect(cid)

new_timer(interval=None, callbacks=None)[source]

Создаёт новый подкласс, специфичный для бэкенда, класса Timer.

Это полезно для получения периодических событий через собственный цикл событий бэкенда. Реализовано только для бэкендов с GUI.

Параметры

intervalint

Интервал таймера в миллисекундах.

callbackslist[tuple[callable, tuple, dict]]

Последовательность (func, args, kwargs), где func(*args, **kwargs) будет выполняться таймером каждые interval.

Обработчики, которые возвращают False или 0, будут удалены из таймера.

Примеры

>>> timer = fig.canvas.new_timer(callbacks=[(f1, (1,), {'a': 3})])

pick(mouseevent)[source]

pick_event(mouseevent, artist, **kwargs)[source]

Обработка событий выбора.

Этот метод будет вызываться элементами, которые были выбраны, и будет вызывать обработчики PickEvent, зарегистрированные слушателями.

Обратите внимание, что элементы по умолчанию не могут быть выбраны (см. Artist.set_picker).

print_figure(filename, dpi=None, facecolor=None, edgecolor=None, orientation='portrait', format=None, *, bbox_inches=None, pad_inches=None, bbox_extra_artists=None, backend=None, **kwargs)[source]

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

Параметры

filenamestr или объект пути или файла

Файл, в который сохраняется рисунок.

dpifloat, по умолчанию: rcParams["savefig.dpi"] (по умолчанию: 'figure')

Точки на дюйм для сохранения рисунка.

facecolorцвет или 'auto', по умолчанию: rcParams["savefig.facecolor"] (по умолчанию: 'auto')

Цвет заливки области рисунка. Если 'auto', используется текущий цвет заливки области рисунка.

edgecolorцвет или 'auto', по умолчанию: rcParams["savefig.edgecolor"] (по умолчанию: 'auto')

Цвет обводки области рисунка. Если 'auto', используется текущий цвет обводки области рисунка.

orientation{'landscape', 'portrait'}, по умолчанию: 'portrait'

Применяется только для печати PostScript.

formatstr, необязательно

Принудительно задать определенный формат файла. Если не задан, формат определяется из расширения файла filename, и если это не удается, то из rcParams["savefig.format"] (по умолчанию: 'png').

bbox_inches'tight' или Bbox, по умолчанию: rcParams["savefig.bbox"] (по умолчанию: None)

Область ограничительной рамки в дюймах: сохраняется только указанная часть рисунка. Если 'tight', то попытается определить минимальную ограничивающую рамку рисунка.

pad_inchesfloat, по умолчанию: rcParams["savefig.pad_inches"] (по умолчанию: 0.1)

Количество отступа вокруг рисунка, когда bbox_inches равен 'tight'.

bbox_extra_artistsсписок Artist, необязательно

Список дополнительных художников, которые будут учитываться при вычислении минимальной ограничивающей рамки.

backendstr, необязательно

Используйте нестандартный интерфейс для рендеринга файла, например, для рендеринга файла png с интерфейсом "cairo" вместо стандартного "agg", или файла pdf с интерфейсом "pgf" вместо стандартного "pdf". Обратите внимание, что стандартный интерфейс обычно достаточен. См. Встроенные интерфейсы для списка допустимых интерфейсов для каждого формата файла. Пользовательские интерфейсы могут быть указаны как "module://...".

release_mouse(ax)[source]

Освобождение захвата мыши, удерживаемого элементом Axes ax.

Обычно вызывается виджетами. Вы можете вызвать это даже если ax в данный момент не захватил мышь.

required_interactive_framework=None

resize(w, h)[source]

НЕ ИСПОЛЬЗУЕТСЯ: Установка размера холста в пикселях.

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

resize_event()[source]

Передача события изменения размера ResizeEvent всем функциям, подключенным к resize_event.

scroll_event(x, y, step, guiEvent=None)[source]

Обработчик событий прокрутки.

Производные классы интерфейсов должны вызывать эту функцию при любом событии прокрутки колесика. (x, y) — координаты холста ((0, 0) — нижний левый угол). button и key определены в MouseEvent.

Этот метод вызовет все функции, подключенные к событию 'scroll_event', с экземпляром MouseEvent.

propertyscroll_pick_id

set_cursor(cursor)[source]

Установить текущий курсор.

Это может не иметь эффекта, если интерфейс ничего не отображает.

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

Параметры

cursorCursors

Курсор для отображения над холстом. Примечание: некоторые интерфейсы могут изменить курсор для всего окна.

set_window_title(title)[source]

[Устарело] Установить текст заголовка окна, содержащего рисунок. Обратите внимание, что это не окажет никакого влияния, если окно отсутствует (например, интерфейс PS).

Примечания

Устарело начиная с версии 3.4.

start_event_loop(timeout=0)[source]

Запустить блокирующую событийную петлю.

Такая событийная петля используется интерактивными функциями, такими как ginput и waitforbuttonpress, для ожидания событий.

Событийная петля блокируется, пока функция обратного вызова не вызовет stop_event_loop, или не будет достигнуто timeout.

Если timeout равен 0 или отрицательному значению, таймаут никогда не срабатывает.

Только интерактивные бэкэнды должны переопределять этот метод, и он полагается на правильную реализацию flush_events.

Интерактивные бэкэнды должны реализовать это более нативным способом.

stop_event_loop()[source]

Остановить текущую блокирующую событийную петлю.

Интерактивные бэкэнды должны переопределить этот метод, чтобы соответствовать start_event_loop.

supports_blit=False

switch_backends(FigureCanvasClass)[source]

Создает экземпляр FigureCanvasClass.

Используется для переключения бэкэндов, например, для создания FigureCanvasPS из FigureCanvasGTK. Обратите внимание, что глубокое копирование не выполняется, поэтому любые изменения в одном из экземпляров (например, установка размера фигуры или свойств линии) будут отражены в другом.

classmatplotlib.backend_bases.FigureManagerBase(canvas, num)[source]

Bases: object

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

Менеджер фигур используется pyplot для взаимодействия с окном независимым от бэкэнда способом. Это адаптер для реальной (GUI) среды, представляющей визуальную фигуру на экране.

Бэкэнды GUI определяют этот класс для преобразования общих операций, таких как show или resize, в код, специфичный для GUI. Бэкэнды без GUI не поддерживают эти операции и могут просто использовать базовый класс.

Доступны следующие базовые операции:

Операции с окном

• show
• destroy
• full_screen_toggle
• resize
• get_window_title
• set_window_title

Обработка нажатия клавиш и кнопок мыши

Менеджер фигур настраивает стандартную обработку нажатия клавиш и кнопок мыши, подключив key_press_handler к системе событий matplotlib. Это обеспечивает одинаковые сочетания клавиш и действия мыши во всех бэкендах.

Другие операции

Подклассы будут иметь дополнительные атрибуты и функции для доступа к дополнительным функциям. Это, конечно, зависит от бэкэнда. Например, у большинства бэкэндов GUI есть атрибуты window и toolbar, которые обеспечивают доступ к нативным виджетам GUI соответствующей среды.

Атрибуты

canvasFigureCanvasBase

Экземпляр канвы, специфичный для бэкэнда.

numint или str

Номер фигуры.

key_press_handler_idint

Идентификатор обработчика нажатий клавиш по умолчанию при использовании toolmanager. Для отключения стандартной обработки нажатий клавиш используйте:

figure.canvas.mpl_disconnect(
    figure.canvas.manager.key_press_handler_id)

button_press_handler_idint

Идентификатор обработчика нажатия кнопок мыши по умолчанию при использовании toolmanager. Для отключения стандартной обработки нажатий кнопок мыши используйте:

figure.canvas.mpl_disconnect(
    figure.canvas.manager.button_press_handler_id)

button_press(event)[source]

[Устарело] Стандартные действия Matplotlib для дополнительных кнопок мыши.

Примечания

Устарело начиная с версии 3.4.

destroy()[source]

full_screen_toggle()[source]

get_window_title()[source]

Возвращает текст заголовка окна, содержащего фигуру, или None, если окна нет (например, в бэкенде PS).

key_press(event)[source]

[Устарело] Реализует стандартные сочетания клавиш Matplotlib, определённые в Клавиши навигации.

Примечания

Устарело начиная с версии 3.4.

resize(w, h)[source]

Для бэкэндов GUI, изменение размера окна (в пикселях).

set_window_title(title)[source]

Устанавливает текст заголовка окна, содержащего фигуру.

Для бэкэндов без GUI (например, PS) это не имеет эффекта.

show()[source]

Для бэкэндов GUI, отображает окно фигуры и перерисовывает. Для бэкэндов без GUI выбросит исключение, если не используется режим headless (т.е., на Linux с не установленном DISPLAY); это исключение преобразуется в предупреждение в Figure.show.

classmatplotlib.backend_bases.GraphicsContextBase[source]

Bases: object

Абстрактный базовый класс, предоставляющий цвет, стили линий и т. д.

copy_properties(gc)[source]

Копирует свойства из gc в self.

get_alpha()[source]

Возвращает значение альфа-канала, используемое для смешивания. Не поддерживается во всех бэкендах.

get_antialiased()[source]

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

get_capstyle()[source]

Возвращает CapStyle.

get_clip_path()[source]

Возвращает обрезной путь в виде (path, transform), где path — экземпляр Path, а transform — аффинное преобразование, которое нужно применить к пути перед обрезкой.

get_clip_rectangle()[source]

Возвращает обрезной прямоугольник как экземпляр Bbox.

get_dashes()[source]

Возвращает стиль штриховки как пару (смещение, список штрихов).

Список штрихов — это список чётной длины, указывающий время включения и выключения чернил в точках. Дополнительную информацию см. на стр. 107 руководства PostScript blue book.

Значение по умолчанию — (None, None).

get_forced_alpha()[source]

Возвращает, должно ли значение, возвращаемое get_alpha(), переопределять любые другие значения альфа-канала.

get_gid()[source]

Возвращает идентификатор объекта, если он задан, иначе None.

get_hatch()[source]

Возвращает текущий стиль штриховки.

get_hatch_color()[source]

Возвращает цвет штриховки.

get_hatch_linewidth()[source]

Возвращает ширину линии штриховки.

get_hatch_path(density=6.0)[source]

Возвращает Path для текущей штриховки.

get_joinstyle()[source]

Возвращает JoinStyle.

get_linewidth()[source]

Возвращает ширину линии в пунктах.

get_rgb()[source]

Возвращает кортеж из трёх или четырёх чисел с плавающей точкой от 0 до 1.

get_sketch_params()[source]

Возвращает параметры наброска для объекта.

Возвращает

кортеж или None

Кортеж из 3 элементов:

• scale: Амплитуда колебаний перпендикулярно исходной линии.
• length: Длина колебаний вдоль линии.
• randomness: Коэффициент масштабирования, определяющий сжатие или расширение длины.

Может вернуть None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает значение параметра snap, которое может быть:

• True: вершины настраиваются на ближайший центр пикселя
• False: вершины остаются без изменений
• None: (авто) Если путь содержит только прямолинейные отрезки, они округляются до ближайшего центра пикселя

get_url()[source]

Возвращает URL, если он задан, иначе None.

restore()[source]

Восстановление контекста графики из стека — необходимо только для тех бэкэндов, которые сохраняют контексты графики в стеке.

set_alpha(alpha)[source]

Установка значения альфа для смешивания — не поддерживается во всех бэкендах.

Если alpha=None (значение по умолчанию), компоненты альфа переднего и заливки цветов будут использованы для установки их соответствующих прозрачностей (где это применимо); в противном случае alpha переопределит их.

set_antialiased(b)[source]

Установка флага, определяющего, следует ли рисовать объекты с антиалиасингом.

set_capstyle(cs)[source]

Установка способа рисования конечных точек линий.

Параметры

csCapStyle или {'butt', 'projecting', 'round'}

set_clip_path(path)[source]

Установка области обрезки на объект TransformedPath или None.

set_clip_rectangle(rectangle)[source]

Установка области обрезки на Bbox или None.

set_dashes(dash_offset, dash_list)[source]

Установка стиля пунктирной линии для контекста графики.

Параметры

dash_offsetfloat

Смещение (обычно 0).

dash_listarray-like или None

Последовательность чередования длины пунктира и пробела в точках. None означает сплошную линию.

Примечания

См. стр. 107 руководства PostScript blue book для получения дополнительной информации.

set_foreground(fg, isRGBA=False)[source]

Установка цвета переднего плана.

Параметры

fgцвет

isRGBAbool

Если известно, что fg является (r, g, b, a) кортежем, isRGBA можно установить в True для повышения производительности.

set_gid(id)[source]

Установка идентификатора.

set_hatch(hatch)[source]

Установка стиля штриховки (для заливок).

set_hatch_color(hatch_color)[source]

Установка цвета штриховки.

set_joinstyle(js)[source]

Установка способа соединения сегментов линии.

Параметры

jsJoinStyle или {'miter', 'round', 'bevel'}

set_linewidth(w)[source]

Установка толщины линии в пунктах.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установка параметров для эффекта "набросок".

Параметры

scalefloat, необязательно

Амплитуда волнообразного отклонения от исходной линии, в пикселях. Если scale равен None или не указан, фильтр наброска не будет применён.

lengthfloat, по умолчанию: 128

Длина волны вдоль линии, в пикселях.

randomnessfloat, по умолчанию: 16

Множитель, с которым масштабируется длина.

set_snap(snap)[source]

Установка режима привязки вершин к ближайшим пикселям:

• True: вершины привязываются к центрам ближайших пикселей
• False: вершины остаются неизменными
• None: (авто) Если путь содержит только прямолинейные отрезки, вершины округляются до ближайших центров пикселей

set_url(url)[source]

Установить URL для ссылок в совместимых бэкендах.

classmatplotlib.backend_bases.KeyEvent(name, canvas, key, x=0, y=0, guiEvent=None)[source]

Bases: matplotlib.backend_bases.LocationEvent

Событие нажатия клавиши (нажатие, отпускание).

Событие KeyEvent имеет ряд специальных атрибутов помимо тех, что определены родительскими классами Event и LocationEvent.

Примечания

Ключи модификаторов будут предварять нажатую клавишу и будут в порядке "ctrl", "alt", "super". Исключение из этого правила — когда нажатая клавиша сама является клавишей-модификатором, поэтому "ctrl+alt" и "alt+control" могут быть допустимыми значениями клавиш.

Примеры

def on_key(event):
    print('you pressed', event.key, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('key_press_event', on_key)

Атрибуты

keyNone или str

Нажатая клавиша(ы). Может быть None, одиночным регистрозависимым символом Unicode ("g", "G", "#", и т. д.), специальной клавишей ("control", "shift", "f1", "up" и т. д.) или комбинацией вышеперечисленного (например, "ctrl+alt+g", "ctrl+alt+G").

classmatplotlib.backend_bases.LocationEvent(name, canvas, x, y, guiEvent=None)[source]

Bases: matplotlib.backend_bases.Event

Событие, имеющее экранное расположение.

Событие LocationEvent имеет ряд специальных атрибутов помимо тех, что определены родительским классом Event.

Атрибуты

x, yint или None

Расположение события в пикселях от левого нижнего угла холста.

inaxesAxes или None

Экземпляр Axes, если мышь находится над ним, иначе None.

xdata, ydatafloat или None

Координаты данных мыши внутри inaxes, или None, если мышь не находится над осями.

lastevent=None

classmatplotlib.backend_bases.MouseButton(value)[source]

Bases: enum.IntEnum

Перечисление.

BACK=8[source]

FORWARD=9[source]

LEFT=1[source]

MIDDLE=2[source]

RIGHT=3[source]

classmatplotlib.backend_bases.MouseEvent(name, canvas, x, y, button=None, key=None, step=0, dblclick=False, guiEvent=None)[source]

Bases: matplotlib.backend_bases.LocationEvent

Событие мыши ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event').

Событие MouseEvent имеет ряд специальных атрибутов помимо тех, что определены родительскими классами Event и LocationEvent.

Примеры

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('button_press_event', on_press)

Атрибуты

buttonNone или MouseButton или {'up', 'down'}

Нажатая кнопка. 'up' и 'down' используются для событий прокрутки. Обратите внимание, что LEFT и RIGHT фактически относятся к "первичным" и "вторичным" кнопкам, т. е. если пользователь меняет левую и правую кнопки ("леворукое положение"), то кнопка LEFT будет той, которая физически находится справа.

keyNone или str

Нажатая клавиша во время события мыши, например, 'shift'. См. KeyEvent.

Предупреждение

В настоящее время эта клавиша берется из последнего события 'key_press_event' или 'key_release_event', произошедшего в холсте. Таким образом, если последнее изменение состояния клавиатуры произошло, когда холст не был активен, этот атрибут будет неправильным.

stepfloat

Количество шагов прокрутки (положительное для 'up', отрицательное для 'down'). Это относится только к 'scroll_event', в противном случае значение по умолчанию 0.

dblclickbool

Является ли событие двойным щелчком. Это относится только к 'button_press_event' и равно False в противном случае. В частности, он не используется в 'button_release_event'.

classmatplotlib.backend_bases.NavigationToolbar2(canvas)[source]

Базы: object

Базовый класс для курсора навигации, версия 2.

Бэкэнды должны реализовать холст, который обрабатывает подключения для 'button_press_event' и 'button_release_event'. См. FigureCanvasBase.mpl_connect() для получения дополнительной информации.

Они также должны определить

save_figure()

сохранить текущую фигуру

draw_rubberband() (необязательно)

рисовать прямоугольник "резинки" масштабирования по прямоугольнику

set_message() (необязательно)

отобразить сообщение

set_history_buttons() (необязательно)

можно изменить кнопки истории "назад" / "вперед", чтобы указать состояние "отключено" / "включено".

и переопределить __init__ для настройки панели инструментов — не забывая вызвать метод базового класса init. Как правило, __init__ необходимо настроить кнопки панели инструментов, связанные с методами home, back, forward, pan, zoom и save_figure, используя стандартные значки в подкаталоге "images" пути к данным.

И это все, остальное сделаем позже!

back(*args)[source]

Перемещение назад по стеку пределов отображения.

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

configure_subplots(*args)[source]

drag_pan(event)[source]

Обработчик перетаскивания в режиме панорамирования/масштабирования.

drag_zoom(event)[source]

Обработчик перетаскивания в режиме масштабирования.

draw_rubberband(event, x0, y0, x1, y1)[source]

Отрисовка прямоугольника резинки для указания границ масштабирования.

Обратите внимание, что не гарантируется, что x0 <= x1 и y0 <= y1.

forward(*args)[source]

Перемещение вперед по стеку пределов отображения.

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

home(*args)[source]

Восстановление исходного вида.

Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.

mouse_move(event)[source]

pan(*args)[source]

Переключает инструмент панорамирования/масштабирования.

Панорамирование левой кнопкой, масштабирование правой.

press_pan(event)[source]

Обработчик нажатия кнопки мыши в режиме панорамирования/масштабирования.

press_zoom(event)[source]

Обработчик нажатия кнопки мыши в режиме масштабирования по прямоугольнику.

push_current()[source]

Положить текущие пределы отображения и позицию в стек.

release_pan(event)[source]

Обработчик отпускания кнопки мыши в режиме панорамирования/масштабирования.

release_zoom(event)[source]

Обработчик отпускания кнопки мыши в режиме масштабирования по прямоугольнику.

remove_rubberband()[source]

Удалить резинку.

save_figure(*args)[source]

Сохранить текущую фигуру.

set_cursor(cursor)[source]

[Устарело] Установить текущий курсор на одно из значений в Cursors перечислениях.

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

Примечания

Устарело начиная с версии 3.5.

set_history_buttons()[source]

Включить или выключить кнопки «Назад»/«Вперед».

set_message(s)[source]

Отобразить сообщение на панели инструментов или в строке состояния.

toolitems=(('Домой', 'Сбросить исходный вид', 'home', 'home'), ('Назад', 'Назад к предыдущему виду', 'back', 'back'), ('Вперед', 'Вперед к следующему виду', 'forward', 'forward'), (None, None, None, None), ('Панорамирование', 'Левая кнопка панорамирует, правая кнопка масштабирует\nх/у фиксирует ось, CTRL фиксирует аспект', 'move', 'pan'), ('Масштабирование', 'Масштабировать до прямоугольника\nх/у фиксирует ось', 'zoom_to_rect', 'zoom'), ('Подграфики', 'Настроить подграфики', 'subplots', 'configure_subplots'), (None, None, None, None), ('Сохранить', 'Сохранить фигуру', 'filesave', 'save_figure'))

update()[source]

Сбросить стек осей.

zoom(*args)[source]

Переключить режим масштабирования до прямоугольника.

exceptionmatplotlib.backend_bases.NonGuiException[source]

Bases: Exception

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

classmatplotlib.backend_bases.PickEvent(name, canvas, mouseevent, artist, guiEvent=None, **kwargs)[source]

Bases: matplotlib.backend_bases.Event

Событие выбора.

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

Событие PickEvent имеет ряд специальных атрибутов помимо тех, которые определены родительским классом Event.

Примеры

Привяжите функцию on_pick() к событиям выбора, которая выводит координаты выбранной точки данных:

ax.plot(np.rand(100), 'o', picker=5)  # 5 points tolerance

def on_pick(event):
    line = event.artist
    xdata, ydata = line.get_data()
    ind = event.ind
    print('on pick line:', np.array([xdata[ind], ydata[ind]]).T)

cid = fig.canvas.mpl_connect('pick_event', on_pick)

Атрибуты

mouseeventMouseEvent

Событие мыши, которое сгенерировало выбор.

artistmatplotlib.artist.Artist

Выбранный элемент. Обратите внимание, что элементы по умолчанию не выбираемы (см. Artist.set_picker).

other

В зависимости от типа выбранного объекта могут быть присутствовать дополнительные атрибуты; например, выбор Line2D может определять разные дополнительные атрибуты, чем выбор PatchCollection.

classmatplotlib.backend_bases.RendererBase[source]

Bases: object

Абстрактный базовый класс для обработки операций рисования/рендеринга.

Следующие методы должны быть реализованы в бэкенде для полной функциональности (хотя просто реализация draw_path() уже даст высокопроизводительный бэкенд):

• draw_path()
• draw_image()
• draw_gouraud_triangle()

Следующие методы должны быть реализованы в бэкенде по причинам оптимизации:

• draw_text()
• draw_markers()
• draw_path_collection()
• draw_quad_mesh()

close_group(s)[source]

Закрыть элемент группировки с меткой s.

Используется только рендерером SVG.

draw_gouraud_triangle(gc, points, colors, transform)[source]

Отрисовать треугольник с заливкой по методу Гуро.

Параметры

gcGraphicsContextBase

Контекст графики.

points(3, 2) массив-подобный объект

Массив точек (x, y) для треугольника.

colors(3, 4) массив-подобный объект

Цвета RGBA для каждой точки треугольника.

transformmatplotlib.transforms.Transform

Аффинное преобразование, применяемое к точкам.

draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[source]

Отрисовать серию треугольников с заливкой по методу Гуро.

Параметры

points(N, 3, 2) массив-подобный объект

Массив из N точек (x, y) для треугольников.

colors(N, 3, 4) массив-подобный объект

Массив из N цветов RGBA для каждой точки треугольников.

transformmatplotlib.transforms.Transform

Аффинное преобразование, применяемое к точкам.

draw_image(gc, x, y, im, transform=None)[source]

Отрисовать изображение RGBA.

Параметры

gcGraphicsContextBase

Контекст графики с информацией о обрезке.

xскаляр

Расстояние в физических единицах (точках или пикселях) от левой стороны холста.

yскаляр

Расстояние в физических единицах (точках или пикселях) от нижней стороны холста.

im(N, M, 4) массив-подобный объект np.uint8

Массив пикселей RGBA.

transformmatplotlib.transforms.Affine2DBase

Если и только если конкретный бэкенд написан таким образом, что option_scale_image() возвращает True, может быть передано аффинное преобразование (т.е., Affine2DBase) возможно передаётся draw_image(). Вектор сдвига преобразования задан в физических единицах (точках или пикселях). Обратите внимание, что преобразование не переопределяет x и y и должно быть применено перед переводом результата на x и y (это можно сделать, добавив x и y к вектору сдвига, определенному transform).

draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[source]

Отрисовать маркер в каждой из вершин path (исключая контрольные точки).

Это реализация draw_markers по умолчанию, которая делает несколько вызовов draw_path(). Некоторые бэкэнды могут переопределить этот метод, чтобы нарисовать маркер только один раз и повторно использовать его многократно.

Параметры

gcGraphicsContextBase

Контекст графики.

marker_transmatplotlib.transforms.Transform

Аффинное преобразование, применяемое к маркеру.

transmatplotlib.transforms.Transform

Аффинное преобразование, применяемое к пути.

draw_path(gc, path, transform, rgbFace=None)[source]

Отрисовать экземпляр Path с заданным афиным преобразованием.

draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offsetTrans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[source]

Отобразить набор путей, выбирая свойства отрисовки из списков facecolors, edgecolors, linewidths, linestyles и antialiaseds. offsets — список смещений, применяемых к каждому из путей. Смещения в offsets сначала преобразуются с помощью offsetTrans перед применением.

offset_position сейчас не используется, но аргумент сохраняется для обратной совместимости.

Это реализация по умолчанию для draw_path_collection(), которая выполняет несколько вызовов draw_path(). Некоторые бэкэнды могут переопределить это, чтобы отобразить каждый набор данных путей только один раз, а затем обратиться к этому пути несколько раз с различными смещениями, цветами, стилями и т. д. Генераторные методы _iter_collection_raw_paths() и _iter_collection() предназначены для помощи (и стандартизации) реализации в разных бэкэндах. Настоятельно рекомендуется использовать эти генераторы, чтобы изменения в поведении draw_path_collection() можно было внести глобально.

draw_quad_mesh(gc, master_transform, meshWidth, meshHeight, coordinates, offsets, offsetTrans, facecolors, antialiased, edgecolors)[source]

Реализация по умолчанию для draw_quad_mesh(), которая генерирует пути и затем вызывает draw_path_collection().

draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[source]

draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[source]

Отрисовать текст.

Параметры

gcGraphicsContextBase

Контекст графики.

xfloat

Координата x текста в координатах отображения.

yfloat

Координата y базовой линии текста в координатах отображения.

sstr

Строка текста.

propmatplotlib.font_manager.FontProperties

Свойства шрифта.

anglefloat

Угол поворота в градусах против часовой стрелки.

mtextmatplotlib.text.Text

Исходный объект текста для отрисовки.

Примечания

Примечание для разработчиков бэкэндов:

При попытке определить, правильно ли рассчитан прямоугольник обводки (что необходимо для правильного расположения и выравнивания текста), полезно изменить строку в text.py:

if 0: bbox_artist(self, renderer)

на if 1, и тогда прямоугольник обводки будет нарисован вместе с текстом.

flipy()[source]

Возвращает значение, указывающее, увеличиваются ли значения y сверху вниз.

Обратите внимание, что это влияет только на отрисовку текста и изображений.

get_canvas_width_height()[source]

Возвращает ширину и высоту холста в координатах отображения.

get_image_magnification()[source]

Возвращает коэффициент увеличения изображений, передаваемых в draw_image(). Позволяет бэкэнду иметь изображения с разрешением, отличным от других элементов.

get_texmanager()[source]

Возвращает экземпляр TexManager.

get_text_width_height_descent(s, prop, ismath)[source]

Возвращает ширину, высоту и опускание (смещение от нижней части до базовой линии) строки s с FontProperties prop в координатах отображения.

new_gc()[source]

Возвращает экземпляр GraphicsContextBase.

open_group(s, gid=None)[source]

Открывает элемент группирования с меткой s и gid (если задано) в качестве идентификатора.

Используется только рендерером SVG.

option_image_nocomposite()[source]

Возвращает значение, указывающее, нужно ли пропустить композицию изображений Matplotlib.

Рендеры растровых изображений обычно должны возвращать False (позволяя растровому рендереру на C-уровне позаботиться о композиции изображений); векторные рендеры обычно должны возвращать not rcParams["image.composite_image"].

option_scale_image()[source]

Возвращает значение, указывающее, поддерживаются ли произвольные аффинные преобразования в draw_image() (True для большинства векторных рендеров).

points_to_pixels(points)[source]

Преобразует точки в единицы отображения.

Вам нужно переопределить эту функцию (если ваш бэкенд не имеет dpi, например, postscript или svg). Некоторые системы отображения предполагают некоторое значение для пикселей на дюйм:

points to pixels = points * pixels_per_inch/72 * dpi/72

Параметры

pointsfloat или массив-подобный

число с плавающей точкой или массив NumPy чисел с плавающей точкой

Возвращает

Точки, преобразованные в пиксели

start_filter()[source]

Переключается на временный рендер для эффектов фильтрации изображения.

В настоящее время поддерживается только рендером agg.

start_rasterizing()[source]

Переключается на растровый рендер.

Используется MixedModeRenderer.

stop_filter(filter_func)[source]

Возвращается к исходному рендеру. Содержимое временного рендера обрабатывается с помощью filter_func и отображается на исходном рендере в виде изображения.

В настоящее время поддерживается только рендером agg.

stop_rasterizing()[source]

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

Используется MixedModeRenderer.

classmatplotlib.backend_bases.ResizeEvent(name, canvas)[source]

Базовый класс: matplotlib.backend_bases.Event

Событие, срабатывающее при изменении размера холста.

У ResizeEvent есть ряд специальных атрибутов помимо тех, которые определены в родительском классе Event.

Атрибуты

widthint

Ширина холста в пикселях.

heightint

Высота холста в пикселях.

classmatplotlib.backend_bases.ShowBase[source]

Базовый класс: matplotlib.backend_bases._Backend

Простой базовый класс для создания функции show() в бэкендах.

Подкласс должен переопределить метод mainloop().

classmatplotlib.backend_bases.TimerBase(interval=None, callbacks=None)[source]

Bases: object

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

Подклассы должны переопределить следующие методы:

• _timer_start: Специфичный для бэкенда код для запуска таймера.
• _timer_stop: Специфичный для бэкенда код для остановки таймера.

Подклассы могут дополнительно переопределить следующие методы:

• _timer_set_single_shot: Код для установки таймера в режим однократного запуска, если это поддерживается объектом таймера. Если нет, класс Timer сам будет хранить флаг, и метод _on_timer должен быть переопределён для поддержки такого поведения.
• _timer_set_interval: Код для установки интервала таймера, если на объекте таймера есть метод для этого.
• _on_timer: Внутренняя функция, которую должен вызывать любой объект таймера, которая будет обрабатывать задачу выполнения всех установленных обратных вызовов.

Параметры

intervalint, по умолчанию: 1000 мс

Время между таймерными событиями в миллисекундах. Будет храниться как timer.interval.

callbackslist[tuple[callable, tuple, dict]]

Список кортежей (func, args, kwargs), которые будут вызываться при таймерных событиях. Этот список доступен как timer.callbacks и может быть изменён напрямую, или могут использоваться функции add_callback и remove_callback.

add_callback(func, *args, **kwargs)[source]

Регистрирует func для вызова таймером при срабатывании события. Любые дополнительные аргументы будут переданы в func.

Эта функция возвращает func, что позволяет использовать её как декоратор.

propertyinterval

Время между таймерными событиями в миллисекундах.

remove_callback(func, *args, **kwargs)[source]

Удаляет func из списка обратных вызовов.

args и kwargs являются необязательными и используются для различения копий одной и той же функции, зарегистрированных для вызова с разными аргументами. Это поведение устарело. В будущем *args, **kwargs больше не будет учитываться; чтобы сохранить возможность удаления конкретного обратного вызова самостоятельно, передайте его в add_callback как объект functools.partial.

propertysingle_shot

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

start(interval=None)[source]

Запустить объект таймера.

Параметры

intervalint, необязательно

Интервал таймера в миллисекундах; переопределяет ранее установленный интервал, если указан.

stop()[source]

Остановить таймер.

classmatplotlib.backend_bases.ToolContainerBase(toolmanager)[source]

Bases: object

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

Атрибуты

toolmanagerToolManager

Инструменты, с которыми данный ToolContainer хочет взаимодействовать.

add_tool(tool, group, position=- 1)[source]

Добавить инструмент в этот контейнер.

Параметры

tooltool_like

Инструмент для добавления, см. ToolManager.get_tool.

groupstr

Имя группы, к которой нужно добавить инструмент.

positionint, по умолчанию: -1

Позиция в группе для размещения инструмента.

add_toolitem(name, group, position, image, description, toggle)[source]

Добавить элемент инструмента в контейнер.

Этот метод должен быть реализован для каждого бэкэнда.

Обработчик события нажатия кнопки должен быть точно self.trigger_tool(name).

Параметры

namestr

Имя добавляемого инструмента, оно используется в качестве идентификатора инструмента и по умолчанию как метка кнопок.

groupstr

Имя группы, к которой принадлежит этот инструмент.

positionint

Позиция инструмента в группе, если -1, то он добавляется в конец.

imagestr

Имя файла изображения для кнопки или None.

descriptionstr

Описание инструмента, используется для всплывающих подсказок.

togglebool

• True : Кнопка является переключателем (меняет состояние нажатия/сброса при последовательных нажатиях).
• False : Кнопка является обычной кнопкой (возвращается в состояние отжатия после отпускания).

remove_toolitem(name)[source]

Удалить элемент инструмента из ToolContainer.

Этот метод должен быть реализован для каждого бэкэнда.

Вызывается, когда ToolManager отправляет tool_removed_event.

Параметры

namestr

Имя инструмента для удаления.

set_message(s)[source]

Отобразить сообщение на панели инструментов.

Параметры

sstr

Текст сообщения.

toggle_toolitem(name, toggled)[source]

Переключить элемент инструмента без отправки события.

Параметры

namestr

Идентификатор инструмента для переключения.

toggledbool

Установить этот инструмент в переключенное состояние или нет.

trigger_tool(name)[source]

Запустить инструмент.

Параметры

namestr

Имя (идентификатор) инструмента, запущенного внутри контейнера.

matplotlib.backend_bases.button_press_handler(event, canvas=None, toolbar=None)[source]

Стандартные действия Matplotlib для дополнительных кнопок мыши.

Параметры такие же, как для key_press_handler, за исключением того, что event является объектом MouseEvent.

matplotlib.backend_bases.get_registered_canvas_class(format)[source]

Возвращает зарегистрированный по умолчанию холст для заданного формата файла. Обрабатывает отложенный импорт необходимого бэкэнда.

matplotlib.backend_bases.key_press_handler(event, canvas=None, toolbar=None)[source]

Реализует стандартные привязки клавиш Matplotlib для холста и панели инструментов, описанные в Клавишные сочетания для навигации.

Параметры

eventKeyEvent

Событие нажатия/отпускания клавиши.

canvasFigureCanvasBase, по умолчанию: event.canvas

Экземпляр холста, специфичный для бэкэнда. Этот параметр сохраняется для обратной совместимости, но, если он задан, он всегда должен быть равен event.canvas.

toolbarNavigationToolbar2, по умолчанию: event.canvas.toolbar

Панель навигации. Этот параметр сохраняется для обратной совместимости, но, если он задан, он всегда должен быть равен event.canvas.toolbar.

matplotlib.backend_bases.register_backend(format, backend, description=None)[source]

Регистрирует бэкэнд для сохранения в заданном формате файла.

Параметры

formatstr

Расширение файла

backendстрока модуля или класс холста

Бэкэнд для обработки вывода файла

descriptionstr, по умолчанию: ""

Описание типа файла.