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)[исходный код]
-
Базовые классы:
EventСобытие, возникающее при закрытии рисунка.
- classmatplotlib.backend_bases.DrawEvent(name, canvas, renderer)[исходный код]
-
Базовые классы:
EventСобытие, возникающее при операции рисования на холсте.
В большинстве бэкендов обработчики, подписанные на это событие, вызываются после завершения визуализации, но до обновления экрана. Любые дополнительные объекты artists, нарисованные на средстве визуализации холста, будут отображены без явного вызова
blit.Предупреждение
Вызов
canvas.drawиcanvas.blitв этих обработчиках может быть небезопасен для некоторых бэкендов и привести к бесконечной рекурсии.Помимо атрибутов, определённых в родительском классе
Event, объект DrawEvent имеет ряд специальных атрибутов.- Атрибуты:
-
-
renderer
RendererBase -
Средство визуализации для события рисования.
-
renderer
- classmatplotlib.backend_bases.Event(name, canvas, guiEvent=None)[исходный код]
-
Базовые классы:
objectСобытие Matplotlib.
Определены следующие атрибуты с указанными значениями по умолчанию. В подклассах могут быть определены дополнительные атрибуты.
- Атрибуты:
-
- namestr
-
Имя события.
-
canvas
FigureCanvasBase -
Экземпляр холста, специфичный для бэкенда, который сгенерировал событие.
- guiEvent
-
Событие GUI, вызвавшее событие Matplotlib.
- classmatplotlib.backend_bases.FigureCanvasBase(figure=None)[исходный код]
-
Базовые классы:
objectХолст, на котором отображается рисунок.
- Атрибуты:
-
-
figure
Figure -
Экземпляр рисунка высокого уровня.
-
figure
- blit(bbox=None)[исходный код]
-
Обновить область холста, заданную bbox (по умолчанию — весь холст).
- propertybutton_pick_id
- propertycallbacks
- propertydevice_pixel_ratio
-
Отношение физических пикселей к логическим пикселям, используемым холстом на экране.
По умолчанию это значение равно 1, то есть физические и логические пиксели имеют одинаковый размер. Подклассы, поддерживающие экраны с высоким разрешением, могут задать этому свойству значение, указывающее на то, что это отношение отличается от единицы. Все взаимодействия с Matplotlib, кроме случаев непосредственной работы с холстом, выполняются в логических пикселях.
- draw(*args, **kwargs)[исходный код]
-
Отобразить
Figure.Этот метод должен обходить дерево художников, даже если результат не выводится, поскольку при этом выполняются отложенные операции, к которым пользователям может понадобиться обратиться перед сохранением результата на диск. Например, вычисляются пределы, автоматические пределы и значения делений.
- draw_idle(*args, **kwargs)[исходный код]
-
Запросить перерисовку виджета после возврата управления циклу обработки событий графического интерфейса.
Даже если до возврата управления циклу обработки событий графического интерфейса метод
draw_idleбудет вызван несколько раз, рисунок будет отображён только один раз.Примечания
Бэкенды могут переопределить этот метод и реализовать собственную стратегию предотвращения повторной отрисовки.
- 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', 'webp': 'WebP Image Format'}
- fixed_dpi=None
- flush_events()[исходный код]
-
Обработать события графического интерфейса для рисунка.
Интерактивные бэкенды должны переопределить этот метод.
- get_default_filename()[исходный код]
-
Вернуть подходящее имя файла по умолчанию, включая расширение.
- classmethodget_default_filetype()[исходный код]
-
Вернуть формат файла для savefig по умолчанию, указанный в
rcParams["savefig.format"](по умолчанию:'png').Возвращаемая строка не содержит точки. Этот метод переопределяется в бэкендах, поддерживающих только один тип файлов.
- classmethodget_supported_filetypes()[исходный код]
-
Вернуть словарь форматов файлов savefig, поддерживаемых этим бэкендом.
- classmethodget_supported_filetypes_grouped()[исходный код]
-
Вернуть словарь форматов файлов savefig, поддерживаемых этим бэкендом. Ключи — названия типов файлов, например 'Joint Photographic Experts Group', а значения — списки расширений файлов для соответствующих типов, например ['jpg', 'jpeg'].
- get_width_height(*, physical=False)[исходный код]
-
Вернуть ширину и высоту рисунка в целых пунктах или пикселях.
При использовании рисунка на экранах с высоким разрешением (если бэкенд это поддерживает) округление до целых чисел выполняется после масштабирования на коэффициент плотности пикселей устройства.
- Параметры:
-
- physicalbool, по умолчанию: False
-
Возвращать физические пиксели или логические пиксели. Физические пиксели могут использоваться бэкендами с поддержкой HiDPI, которые при этом настраивают холст в соответствии с его фактическим размером.
- Возвращает:
-
- width, heightint
-
Размер рисунка в пунктах или пикселях, в зависимости от бэкенда.
- grab_mouse(ax)[исходный код]
-
Назначить дочерний элемент
Axes, который перехватывает события мыши.Обычно вызывается самими виджетами. Вызов этого метода приведёт к ошибке, если мышь уже перехвачена другой системой координат Axes.
- inaxes(xy)[исходный код]
-
Вернуть самую верхнюю видимую систему координат
Axes, содержащую точку xy.- Параметры:
-
- xy(float, float)
-
Позиции пикселей (x, y) от левого нижнего угла холста.
- Возвращает:
-
-
Axesили None -
Самую верхнюю видимую систему координат Axes, содержащую точку, или None, если в этой точке нет Axes.
-
- is_saving()[исходный код]
-
Вернуть, выполняется ли в данный момент сохранение средства визуализации в файл, а не отрисовка в экранный буфер.
- manager_class[исходный код]
-
псевдоним для
FigureManagerBase
- mpl_connect(s, func)[исходный код]
-
Привязать функцию 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
Для событий, связанных с местоположением (нажатие/отпускание кнопки мыши и клавиши), если указатель мыши находится над Axes, атрибут
inaxesсобытия будет содержатьAxes, над которой произошло событие; кроме того, атрибуты переменныхxdataиydataбудут содержать положение мыши в координатах данных. Дополнительные сведения см. в описанияхKeyEventиMouseEvent.Примечание
Если func является методом, сохраняется только слабая ссылка на него. Поэтому рисунок не влияет на время жизни связанного объекта. Обычно необходимо следить за тем, чтобы объект оставался доступным в течение всего времени жизни рисунка, сохраняя на него ссылку.
- Возвращает:
-
- 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)[исходный код]
-
Отменить привязку функции обратного вызова с идентификатором cid.
Примеры
cid = canvas.mpl_connect('button_press_event', on_press) # ... later canvas.mpl_disconnect(cid)
- classmethodnew_manager(figure, num)[исходный код]
-
Создать новый менеджер рисунка для figure, используя этот класс холста.
Примечания
Этот метод не следует переопределять в подклассах. Если требуется пользовательская логика создания менеджера, переопределите
FigureManager.create_with_canvas.
- new_timer(interval=None, callbacks=None)[исходный код]
-
Создать новый подкласс
Timer, специфичный для бэкенда.Это полезно для получения периодических событий через собственный цикл обработки событий бэкенда. Реализовано только для бэкендов с графическим интерфейсом.
- Параметры:
-
- 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})])
- 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)[исходный код]
-
Отобразить рисунок в печатном виде. Задать цвета заливки и границы области рисунка. Это полезно, поскольку в некоторых графических интерфейсах фоном области рисунка служит серый цвет, который, вероятно, потребуется заменить при выводе на печать.
- Параметры:
-
- filenamestr or path-like or file-like
-
Файл, в который сохраняется рисунок.
-
dpifloat, по умолчанию:
rcParams["savefig.dpi"](по умолчанию:'figure') -
Разрешение сохранения рисунка в точках на дюйм.
-
facecolorcolor или 'auto', по умолчанию:
rcParams["savefig.facecolor"](по умолчанию:'auto') -
Цвет заливки рисунка. Если задано 'auto', используется текущий цвет заливки рисунка.
-
edgecolorcolor или '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 или 'layout', по умолчанию:
rcParams["savefig.pad_inches"](по умолчанию:0.1) -
Размер отступа в дюймах вокруг рисунка, если bbox_inches задано как 'tight'. Если задано 'layout', используется отступ из механизма компоновки с ограничениями или сжатием; параметр игнорируется, если ни один из этих механизмов не используется.
-
bbox_extra_artistsсписок объектов
Artist, необязательно -
Список дополнительных художников, учитываемых при вычислении точной ограничивающей рамки.
- backendstr, необязательно
-
Использовать для отображения файла нестандартный бэкенд, например отобразить файл png с помощью бэкенда "cairo" вместо стандартного "agg" или файл pdf с помощью бэкенда "pgf" вместо стандартного "pdf". Обратите внимание: обычно стандартного бэкенда достаточно. Список допустимых бэкендов для каждого формата файлов см. в разделе Встроенные бэкенды. Пользовательские бэкенды можно указывать в формате "module://...".
- release_mouse(ax)[исходный код]
-
Освободить захват мыши, удерживаемый системой координат
Axesax.Обычно вызывается виджетами. Этот метод можно вызывать, даже если ax в данный момент не захватывает мышь.
- required_interactive_framework=None
- propertyscroll_pick_id
- set_cursor(cursor)[исходный код]
-
Задать текущий курсор.
Если бэкенд ничего не отображает, это может не дать никакого эффекта.
Если этого требует бэкенд, после установки курсора этот метод должен инициировать обновление в цикле обработки событий бэкенда, поскольку он может вызываться, например, перед длительной задачей, во время которой графический интерфейс не обновляется.
- Параметры:
-
-
cursor
Cursors -
Курсор, отображаемый над холстом. Примечание: некоторые бэкенды могут менять курсор для всего окна.
-
cursor
- start_event_loop(timeout=0)[исходный код]
-
Запустить блокирующий цикл обработки событий.
Такой цикл обработки событий используется интерактивными функциями, например
ginputиwaitforbuttonpress, для ожидания событий.Цикл блокирует выполнение до тех пор, пока функция обратного вызова не вызовет
stop_event_loopили не истечёт время timeout.Если значение timeout равно 0 или меньше, время ожидания не ограничено.
Переопределять этот метод должны только интерактивные бэкенды; для его работы требуется корректная реализация метода
flush_events.Интерактивным бэкендам следует реализовать этот метод с использованием более естественных для них средств.
- stop_event_loop()[исходный код]
-
Остановить текущий блокирующий цикл обработки событий.
Интерактивные бэкенды должны переопределить этот метод в соответствии с
start_event_loop
- supports_blit=False
- classmatplotlib.backend_bases.FigureManagerBase(canvas, num)[исходный код]
-
Базовые классы:
objectНезависимая от backend абстракция контейнера и контроллера фигуры.
Менеджер фигуры используется pyplot для взаимодействия с окном независимо от backend. Он служит адаптером для реального графического интерфейса, отображающего фигуру на экране.
Менеджер фигуры связан с конкретным экземпляром холста, который, в свою очередь, связан с конкретным экземпляром фигуры. Чтобы получить доступ к менеджеру фигуры для заданной фигуры в пользовательском коде, обычно используют
fig.canvas.manager.GUI-backend'ы наследуют этот класс, чтобы преобразовывать общие операции, такие как показ или изменение размера, в код, специфичный для GUI. Backend'ы без GUI не поддерживают эти операции и могут использовать базовый класс.
Доступны следующие базовые операции:
Операции с окном
Обработка нажатий клавиш и кнопок мыши
Менеджер фигуры настраивает обработку нажатий клавиш и кнопок мыши по умолчанию, подключая
key_press_handlerк системе событий matplotlib. Это обеспечивает одинаковые сочетания клавиш и действия мыши во всех backend'ах.Другие операции
Подклассы будут иметь дополнительные атрибуты и функции для доступа к дополнительным возможностям. Разумеется, они зависят от backend. Например, в большинстве GUI-backend'ов есть атрибуты
windowиtoolbar, предоставляющие доступ к собственным виджетам GUI соответствующего фреймворка.- Атрибуты:
-
-
canvas
FigureCanvasBase -
Экземпляр холста, специфичный для backend.
- numint или str
-
Номер фигуры.
- key_press_handler_idint
-
Идентификатор cid обработчика клавиш по умолчанию при использовании toolmanager. Чтобы отключить обработку нажатий клавиш по умолчанию, используйте:
figure.canvas.mpl_disconnect( figure.canvas.manager.key_press_handler_id) - button_press_handler_idint
-
Идентификатор cid обработчика кнопок мыши по умолчанию при использовании toolmanager. Чтобы отключить обработку нажатий кнопок по умолчанию, используйте:
figure.canvas.mpl_disconnect( figure.canvas.manager.button_press_handler_id)
-
canvas
- classmethodcreate_with_canvas(canvas_class, figure, num)[исходный код]
-
Создать менеджер для заданной фигуры с использованием указанного canvas_class.
Backend'ам следует переопределить этот метод, если для настройки холста или менеджера требуются специальные действия.
- destroy()[исходный код]
- full_screen_toggle()[исходный код]
- get_window_title()[исходный код]
-
Вернуть текст заголовка окна, содержащего фигуру.
- classmethodpyplot_show(*, block=None)[исходный код]
-
Показать все фигуры. Этот метод реализует
pyplot.show.Чтобы настроить поведение
pyplot.show, интерактивным backend'ам обычно следует переопределитьstart_main_loop; при необходимости более индивидуальной логики можно также переопределитьpyplot_show.- Параметры:
-
- blockbool, необязательный
-
Следует ли блокировать выполнение, вызывая
start_main_loop. Значение по умолчанию None означает блокировку, если мы не находимся ни в режиме%pylabIPython, ни в режимеinteractive.
- resize(w, h)[исходный код]
-
Для GUI-backend'ов изменить размер окна (в физических пикселях).
- set_window_title(title)[исходный код]
-
Установить текст заголовка окна, содержащего фигуру.
Примеры
>>> fig = plt.figure() >>> fig.canvas.manager.set_window_title('My figure')
- show()[исходный код]
-
Для GUI-backend'ов показать окно фигуры и перерисовать её. Для backend'ов без GUI вызвать исключение, если только программа не работает в безголовом режиме (то есть в Linux с неустановленной переменной DISPLAY); это исключение преобразуется в предупреждение в
Figure.show.
- classmethodstart_main_loop()[исходный код]
-
Запустить основной цикл обработки событий.
Этот метод вызывается методом
FigureManagerBase.pyplot_show, который реализуетpyplot.show. Чтобы настроить поведениеpyplot.show, интерактивным backend'ам обычно следует переопределитьstart_main_loop; при необходимости более индивидуальной логики можно также переопределитьpyplot_show.
- classmatplotlib.backend_bases.GraphicsContextBase[исходный код]
-
Базовые классы:
objectАбстрактный базовый класс, предоставляющий цвет, стили линий и т. д.
- copy_properties(gc)[исходный код]
-
Копирует свойства из gc в текущий объект.
- get_alpha()[исходный код]
-
Возвращает значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.
- get_antialiased()[исходный код]
-
Возвращает значение, указывающее, следует ли использовать сглаживание при отрисовке объекта.
- get_capstyle()[исходный код]
-
Возвращает
CapStyle.
- get_clip_path()[исходный код]
-
Возвращает контур отсечения в виде пары (path, transform), где path — экземпляр
Path, а transform — аффинное преобразование, применяемое к контуру перед отсечением.
- get_clip_rectangle()[исходный код]
-
Возвращает прямоугольник отсечения как экземпляр
Bbox.
- get_dashes()[исходный код]
-
Возвращает стиль штриховки в виде пары (смещение, список штрихов).
Подробности см. в
set_dashes.Значение по умолчанию — (None, None).
- get_forced_alpha()[исходный код]
-
Возвращает значение, указывающее, следует ли использовать значение, заданное функцией get_alpha(), для переопределения любых других значений альфа-канала.
- get_gid()[исходный код]
-
Возвращает идентификатор объекта, если он задан, иначе None.
- get_hatch()[исходный код]
-
Возвращает текущий стиль штриховки.
- get_hatch_color()[исходный код]
-
Возвращает цвет штриховки.
- get_hatch_linewidth()[исходный код]
-
Возвращает толщину линий штриховки.
- get_hatch_path(density=6.0)[исходный код]
-
Возвращает
Pathдля текущей штриховки.
- get_joinstyle()[исходный код]
-
Возвращает
JoinStyle.
- get_linewidth()[исходный код]
-
Возвращает толщину линии в пунктах.
- get_rgb()[исходный код]
-
Возвращает кортеж из трёх или четырёх чисел с плавающей точкой в диапазоне от 0 до 1.
- get_sketch_params()[исходный код]
-
Возвращает параметры эффекта наброска для художника.
- Возвращает:
-
- tuple или
None -
Кортеж из трёх элементов:
-
scale: амплитуда колебаний перпендикулярно исходной линии. -
length: длина колебаний вдоль линии. -
randomness: коэффициент масштабирования, на который длина уменьшается или увеличивается.
Может возвращать
None, если параметры эффекта наброска не заданы. -
- tuple или
- get_snap()[исходный код]
-
Возвращает настройку привязки, которая может принимать следующие значения:
- True: привязывать вершины к центру ближайшего пикселя
- False: оставлять вершины без изменений
- None: (автоматически) если контур содержит только прямолинейные отрезки, округлять до центра ближайшего пикселя
- get_url()[исходный код]
-
Возвращает URL, если он задан, иначе None.
- restore()[исходный код]
-
Восстанавливает графический контекст из стека; требуется только для бэкендов, сохраняющих графические контексты в стеке.
- set_alpha(alpha)[исходный код]
-
Задаёт значение альфа-канала, используемое для смешивания; поддерживается не всеми бэкендами.
Если
alpha=None(значение по умолчанию), значения альфа-канала цветов переднего плана и заливки используются для задания соответствующей прозрачности (если применимо); в противном случаеalphaпереопределяет их.
- set_antialiased(b)[исходный код]
-
Задаёт, следует ли отрисовывать объект со сглаживанием.
- set_capstyle(cs)[исходный код]
-
Задаёт способ отрисовки концов линий.
- Параметры:
-
-
cs
CapStyleили {'butt', 'projecting', 'round'}
-
cs
- set_clip_path(path)[исходный код]
-
Задаёт контур отсечения как
TransformedPathили None.
- set_clip_rectangle(rectangle)[исходный код]
-
Задаёт прямоугольник отсечения как
Bboxили None.
- set_dashes(dash_offset, dash_list)[исходный код]
-
Задаёт стиль штриховки для gc.
- Параметры:
-
- dash_offsetfloat
-
Расстояние в пунктах от начала шаблона штриховки, с которого начинается её отрисовка. Обычно задаётся равным 0.
- dash_listarray-like или None
-
Последовательность штрихов и промежутков между ними в пунктах. Значение None задаёт сплошную линию. В противном случае все значения должны быть неотрицательными (\(\ge 0\)).
Примечания
Дополнительную информацию см. на стр. 666 справочника по языку PostScript.
- set_foreground(fg, isRGBA=False)[исходный код]
-
Задаёт цвет переднего плана.
- Параметры:
-
- fgцвет
- isRGBAbool
-
Если известно, что fg — кортеж
(r, g, b, a), для повышения производительности можно задать isRGBA равным True.
- set_gid(id)[исходный код]
-
Задаёт идентификатор.
- set_hatch(hatch)[исходный код]
-
Задаёт стиль штриховки (для заливок).
- set_hatch_color(hatch_color)[исходный код]
-
Задаёт цвет штриховки.
- set_hatch_linewidth(hatch_linewidth)[исходный код]
-
Задаёт толщину линий штриховки.
- set_joinstyle(js)[исходный код]
-
Задаёт способ отрисовки соединений между отрезками линий.
- Параметры:
-
-
js
JoinStyleили {'miter', 'round', 'bevel'}
-
js
- set_linewidth(w)[исходный код]
-
Задаёт толщину линии в пунктах.
- set_sketch_params(scale=None, length=None, randomness=None)[исходный код]
-
Задаёт параметры эффекта наброска.
- Параметры:
-
- scalefloat, необязательный
-
Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale равен
Noneили не указан, фильтр эффекта наброска не применяется. - lengthfloat, по умолчанию: 128
-
Длина колебаний вдоль линии в пикселях.
- randomnessfloat, по умолчанию: 16
-
Коэффициент масштабирования, на который длина уменьшается или увеличивается.
- set_snap(snap)[исходный код]
-
Задаёт настройку привязки, которая может принимать следующие значения:
- True: привязывать вершины к центру ближайшего пикселя
- False: оставлять вершины без изменений
- None: (автоматически) если контур содержит только прямолинейные отрезки, округлять до центра ближайшего пикселя
- set_url(url)[исходный код]
-
Задаёт URL для ссылок в совместимых бэкендах.
- classmatplotlib.backend_bases.KeyEvent(name, canvas, key, x=0, y=0, guiEvent=None)[исходный код]
-
Базовые классы:
LocationEventСобытие клавиатуры (нажатие или отпускание клавиши).
Помимо атрибутов, определённых в родительских классах
EventиLocationEvent, KeyEvent имеет ряд специальных атрибутов.- Атрибуты:
-
- keyNone или str
-
Нажатая клавиша или клавиши. Может быть None, одним символом Unicode с учётом регистра ("g", "G", "#" и т. д.), специальной клавишей ("control", "shift", "f1", "up" и т. д.) или их сочетанием (например, "ctrl+alt+g", "ctrl+alt+G").
Примечания
Модификаторы добавляются перед нажатой клавишей в следующем порядке: "ctrl", "alt", "super". Исключение составляет случай, когда нажатая клавиша сама является клавишей-модификатором; поэтому "ctrl+alt" и "alt+control" могут быть допустимыми значениями key.
Примеры
def on_key(event): print('you pressed', event.key, event.xdata, event.ydata) cid = fig.canvas.mpl_connect('key_press_event', on_key)
- classmatplotlib.backend_bases.LocationEvent(name, canvas, x, y, guiEvent=None, *, modifiers=None)[исходный код]
-
Базовые классы:
EventСобытие, имеющее экранные координаты.
Помимо атрибутов, определённых в родительском классе
Event, LocationEvent имеет ряд специальных атрибутов.- Атрибуты:
-
- x, yint или None
-
Координаты события в пикселях относительно левого нижнего угла холста.
-
inaxes
Axesили None -
Экземпляр
Axes, над которым находится указатель мыши, если он есть. - xdata, ydatafloat или None
-
Координаты данных указателя мыши в пределах inaxes или None, если указатель не находится над объектом Axes.
- modifiersfrozenset
-
Модификаторы клавиатуры, удерживаемые в данный момент (кроме KeyEvent).
- classmatplotlib.backend_bases.MouseButton(*values)[источник]
-
Базовые классы:
IntEnum- BACK=8[источник]
- FORWARD=9[источник]
- LEFT=1[источник]
- MIDDLE=2[источник]
- RIGHT=3[источник]
- classmatplotlib.backend_bases.MouseEvent(name, canvas, x, y, button=None, key=None, step=0, dblclick=False, guiEvent=None, *, buttons=None, modifiers=None)[источник]
-
Базовые классы:
LocationEventСобытие мыши ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event').
У объекта MouseEvent есть ряд специальных атрибутов в дополнение к атрибутам, определённым в родительских классах
EventиLocationEvent.- Атрибуты:
-
-
buttonNone или
MouseButtonили {'up', 'down'} -
Нажатая кнопка. Для событий прокрутки используются значения 'up' и 'down'.
Обратите внимание: LEFT и RIGHT фактически обозначают «основную» и «вторичную» кнопки. Например, если пользователь поменяет местами левую и правую кнопки («режим для левшей»), физически расположенная справа кнопка будет считаться кнопкой LEFT.
Если это значение не задано, name равно "scroll_event", а step не равно нулю, то оно будет установлено в "up" или "down" в зависимости от знака step.
- buttonsNone или frozenset
-
Для 'motion_notify_event' — кнопки мыши, нажатые в данный момент (множество из нуля или более объектов MouseButton); для других событий — None.
Примечание
Для 'motion_notify_event' этот атрибут точнее, чем атрибут
button(в единственном числе), который получает значение из последнего события 'button_press_event' или 'button_release_event', произошедшего на холсте (поэтому 1. значение может быть неверным, если последнее изменение состояния мыши произошло, когда холст не был в фокусе; и 2. этот атрибут не может сообщить о нажатии нескольких кнопок).Этот атрибут не задаётся для 'button_press_event' и 'button_release_event', поскольку GUI-инструментарии по-разному определяют, сообщать ли состояние кнопки до или после нажатия или отпускания.
Предупреждение
В macOS бэкенды Tk сообщают только об одной кнопке, даже если нажато несколько кнопок.
- keyNone или str
-
Клавиша, нажатая в момент возникновения события мыши, например 'shift'. См.
KeyEvent.Предупреждение
В настоящее время значение этой клавиши определяется по последнему событию 'key_press_event' или 'key_release_event', произошедшему на холсте. Поэтому, если последнее изменение состояния клавиатуры произошло, когда холст не был в фокусе, значение этого атрибута будет неверным. В то же время атрибут
modifiersвсегда должен быть корректным, но он позволяет сообщать только о клавишах-модификаторах. - stepfloat
-
Количество шагов прокрутки (положительное значение для 'up', отрицательное — для 'down'). Применяется только к 'scroll_event'; в остальных случаях по умолчанию равно 0.
- dblclickbool
-
Является ли событие двойным щелчком. Применяется только к 'button_press_event'; в остальных случаях равно False. В частности, не используется для 'button_release_event'.
-
buttonNone или
Примеры
def on_press(event): print('you pressed', event.button, event.xdata, event.ydata) cid = fig.canvas.mpl_connect('button_press_event', on_press)
-
Базовые классы:
objectБазовый класс для курсора навигации, версия 2.
Бэкенды должны реализовать холст, обрабатывающий подключения для событий 'button_press_event' и 'button_release_event'. Дополнительные сведения см. в
FigureCanvasBase.mpl_connect().Кроме того, необходимо определить
save_figure()-
Сохранить текущий рисунок.
-
draw_rubberband()(необязательно) -
Нарисовать прямоугольную «резиновую рамку» для увеличения выбранной области.
-
set_message()(необязательно) -
Отобразить сообщение.
-
set_history_buttons()(необязательно) -
Можно изменить состояние кнопок перехода назад и вперёд в истории, чтобы указать, включены они или отключены.
и переопределить
__init__для настройки панели инструментов — не забыв вызвать инициализатор базового класса. Обычно__init__должна настроить кнопки панели инструментов, связанные с методамиhome,back,forward,pan,zoomиsave_figure, используя стандартные значки из подкаталога "images" в каталоге данных.На этом всё, остальное мы сделаем сами!
-
Перейти назад по стеку пределов просмотра.
Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.
-
Обратный вызов для перетаскивания в режиме панорамирования/масштабирования.
-
Обратный вызов для перетаскивания в режиме масштабирования.
-
Нарисовать прямоугольную резиновую рамку, обозначающую пределы масштабирования.
Обратите внимание, что не гарантируется, что
x0 <= x1иy0 <= y1.
-
Перейти вперёд по стеку пределов просмотра.
Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.
-
Восстановить исходный вид.
Для удобства прямого подключения в качестве обратного вызова GUI, которому часто передаются дополнительные параметры, этот метод принимает произвольные параметры, но не использует их.
-
Переключить инструмент панорамирования/масштабирования.
Панорамирование выполняется левой кнопкой, масштабирование — правой.
-
Обратный вызов при нажатии кнопки мыши в режиме панорамирования/масштабирования.
-
Обратный вызов при нажатии кнопки мыши в режиме масштабирования до прямоугольной области.
-
Добавить текущие пределы просмотра и положение в стек.
-
Обратный вызов при отпускании кнопки мыши в режиме панорамирования/масштабирования.
-
Обратный вызов при отпускании кнопки мыши в режиме масштабирования до прямоугольной области.
-
Удалить резиновую рамку.
-
Сохранить текущий рисунок.
Реализации бэкенда могут по своему усмотрению возвращать абсолютный путь к сохранённому файлу в виде строки.
Если файл не создан, возвращается
None.Если в бэкенде эта функциональность не реализована, возвращается
NavigationToolbar2.UNKNOWN_SAVED_STATUS.- Возвращает:
-
- str или
NavigationToolbar2.UNKNOWN_SAVED_STATUSилиNone -
Путь к сохранённому рисунку. Если рисунок не сохранён, возвращается
None. Если бэкенд не предоставляет эту информацию, возвращаетсяNavigationToolbar2.UNKNOWN_SAVED_STATUS.
- str или
-
Включить или отключить кнопки перехода назад и вперёд.
-
Отобразить сообщение на панели инструментов или в строке состояния.
-
Сбросить стек Axes.
- exceptionmatplotlib.backend_bases.NonGuiException[источник]
-
Базовые классы:
ExceptionВызывается при попытке показать рисунок в бэкенде без GUI.
- classmatplotlib.backend_bases.PickEvent(name, canvas, mouseevent, artist, guiEvent=None, **kwargs)[источник]
-
Базовые классы:
EventСобытие выбора объекта.
Это событие возникает, когда пользователь выбирает на холсте точку, достаточно близкую к объекту Artist, для которого разрешён выбор с помощью
Artist.set_picker.У объекта PickEvent есть ряд специальных атрибутов в дополнение к атрибутам, определённым в родительском классе
Event.- Атрибуты:
-
-
mouseevent
MouseEvent -
Событие мыши, вызвавшее выбор.
-
artist
Artist -
Выбранный объект Artist. Обратите внимание, что по умолчанию объекты Artist нельзя выбирать (см.
Artist.set_picker). - other
-
В зависимости от типа выбранного объекта могут присутствовать дополнительные атрибуты. Например, при выборе объекта
Line2Dмогут определяться иные дополнительные атрибуты, чем при выборе объектаPatchCollection.
-
mouseevent
Примеры
Привяжите функцию
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(f'on pick line: {xdata[ind]:.3f}, {ydata[ind]:.3f}') cid = fig.canvas.mpl_connect('pick_event', on_pick)
- classmatplotlib.backend_bases.RendererBase[источник]
-
Базовые классы:
objectАбстрактный базовый класс для обработки операций рисования/рендеринга.
Для полной функциональности в бэкенде должны быть реализованы следующие методы (хотя одной реализации
draw_pathдостаточно для создания весьма функционального бэкенда):По соображениям оптимизации в бэкенде следует реализовать следующие методы:
- close_group(s)[источник]
-
Закрыть группирующий элемент с меткой s.
Используется только SVG-рендерером.
- draw_gouraud_triangles(gc, triangles_array, colors_array, transform)[источник]
-
Нарисовать набор треугольников Гуро.
- Параметры:
-
-
gc
GraphicsContextBase -
Графический контекст.
- triangles_array(N, 3, 2) array-like
-
Массив из N точек (x, y), задающих треугольники.
- colors_array(N, 3, 4) array-like
-
Массив из N цветов RGBA для каждой точки треугольников.
-
transform
Transform -
Аффинное преобразование, применяемое к точкам.
-
gc
- draw_image(gc, x, y, im, transform=None)[источник]
-
Нарисовать изображение RGBA.
- Параметры:
-
-
gc
GraphicsContextBase -
Графический контекст с информацией об обрезке.
- xfloat
-
Расстояние в физических единицах (то есть точках или пикселях) от левого края холста.
- yfloat
-
Расстояние в физических единицах (то есть точках или пикселях) от нижнего края холста.
-
im(N, M, 4) array of
numpy.uint8 -
Массив пикселей RGBA.
-
transform
Affine2DBase -
Если и только если конкретный бэкенд реализован так, что
option_scale_imageвозвращаетTrue, вdraw_imageможно передать аффинное преобразование (то естьAffine2DBase). Вектор переноса преобразования задаётся в физических единицах (то есть точках или пикселях). Обратите внимание, что преобразование не заменяет x и y и должно применяться до переноса результата на x и y (этого можно добиться, добавив x и y к вектору переноса, заданному параметром transform).
-
gc
- draw_markers(gc, marker_path, marker_trans, path, trans, rgbFace=None)[источник]
-
Нарисовать маркер в каждой вершине path (за исключением контрольных точек).
Базовая реализация (резервный вариант) многократно вызывает
draw_path. Бэкендам может понадобиться переопределить этот метод, чтобы нарисовать маркер один раз и использовать его повторно.- Параметры:
-
-
gc
GraphicsContextBase -
Графический контекст.
-
marker_path
Path -
Контур маркера.
-
marker_trans
Transform -
Аффинное преобразование, применяемое к маркеру.
-
path
Path -
Места, в которых нужно нарисовать маркеры.
-
trans
Transform -
Аффинное преобразование, применяемое к контуру.
- rgbFaceцвет, необязательно
-
gc
- draw_path(gc, path, transform, rgbFace=None)[источник]
-
Нарисовать экземпляр
Pathс помощью заданного аффинного преобразования.
- draw_path_collection(gc, master_transform, paths, all_transforms, offsets, offset_trans, facecolors, edgecolors, linewidths, linestyles, antialiaseds, urls, offset_position)[источник]
-
Нарисовать набор контуров.
Каждый контур сначала преобразуется соответствующим элементом all_transforms (списком матриц размера (3, 3)), а затем — master_transform. После этого контуры сдвигаются на соответствующий элемент offsets, который предварительно преобразуется с помощью offset_trans.
facecolors, edgecolors, linewidths, linestyles и antialiased — это списки, задающие соответствующие свойства.
Параметр offset_position больше не используется, но сохранён для обратной совместимости.
Базовая реализация (резервный вариант) многократно вызывает
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)[источник]
-
Нарисовать четырёхугольную сетку.
Базовая реализация (резервный вариант) преобразует четырёхугольную сетку в контуры, а затем вызывает
draw_path_collection.
- draw_tex(gc, x, y, s, prop, angle, *, mtext=None)[источник]
-
Нарисовать экземпляр TeX.
- Параметры:
-
-
gc
GraphicsContextBase -
Графический контекст.
- xfloat
-
Координата x текста в системе координат отображения.
- yfloat
-
Координата y базовой линии текста в системе координат отображения.
- sstr
-
Текстовая строка TeX.
-
prop
FontProperties -
Свойства шрифта.
- anglefloat
-
Угол поворота в градусах против часовой стрелки.
-
mtext
Text -
Исходный текстовый объект для отрисовки.
-
gc
- draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)[источник]
-
Нарисовать текстовый объект.
- Параметры:
-
-
gc
GraphicsContextBase -
Графический контекст.
- xfloat
-
Координата x текста в системе координат отображения.
- yfloat
-
Координата y базовой линии текста в системе координат отображения.
- sstr
-
Текстовая строка.
-
prop
FontProperties -
Свойства шрифта.
- anglefloat
-
Угол поворота в градусах против часовой стрелки.
- ismathbool or "TeX"
-
Если значение True, использовать парсер mathtext.
-
mtext
Text -
Исходный текстовый объект для отрисовки.
-
gc
Примечания
Примечания для разработчиков бэкендов:
RendererBase.draw_textтакже поддерживает передачу значения "TeX" параметру ismath для использования рендеринга TeX, но это не является обязательным для бэкендов, выполняющих отрисовку, и многие встроенные бэкенды не поддерживают эту возможность. Рендеринг TeX обеспечивается методомdraw_tex.
- flipy()[источник]
-
Вернуть признак того, увеличиваются ли значения y сверху вниз.
Обратите внимание, что это влияет только на отрисовку текста.
- get_canvas_width_height()[источник]
-
Вернуть ширину и высоту холста в системе координат отображения.
- get_image_magnification()[источник]
-
Получить коэффициент увеличения изображений, передаваемых в
draw_image. Позволяет бэкенду использовать для изображений разрешение, отличное от разрешения других графических объектов.
- get_texmanager()[источник]
-
Вернуть экземпляр
TexManager.
- get_text_width_height_descent(s, prop, ismath)[источник]
-
Получить ширину, высоту и нижний вынос (расстояние от нижней границы до базовой линии) строки s со свойствами шрифта
FontPropertiesprop в системе координат отображения.Пробелы в начале и конце s учитываются в возвращаемой ширине.
- new_gc()[источник]
-
Вернуть экземпляр
GraphicsContextBase.
- open_group(s, gid=None)[источник]
-
Открыть группирующий элемент с меткой s и идентификатором gid (если задан).
Используется только SVG-рендерером.
- option_image_nocomposite()[источник]
-
Вернуть признак того, следует ли пропустить объединение изображений в Matplotlib.
Растровые бэкенды обычно должны возвращать False (предоставляя растеризатору на уровне C обработку объединения изображений); векторные бэкенды обычно должны возвращать
not rcParams["image.composite_image"].
- option_scale_image()[источник]
-
Вернуть признак поддержки произвольных аффинных преобразований в
draw_image(поддерживается большинством векторных бэкендов).
- points_to_pixels(points)[источник]
-
Преобразовать точки в единицы системы отображения.
Эту функцию необходимо переопределить (если только у вашего бэкенда нет разрешения dpi, например у PostScript или SVG). Некоторые системы обработки изображений предполагают определённое значение числа пикселей на дюйм:
points to pixels = points * pixels_per_inch/72 * dpi/72
- Параметры:
-
- pointsfloat or array-like
- Возвращает:
-
- Точки, преобразованные в пиксели
- start_filter()[источник]
-
Переключиться на временный рендерер для эффектов фильтрации изображений.
В настоящее время поддерживается только рендерером agg.
- start_rasterizing()[источник]
-
Переключиться на растровый рендерер.
Используется классом
MixedModeRenderer.
- stop_filter(filter_func)[источник]
-
Переключиться обратно на исходный рендерер. Содержимое временного рендерера обрабатывается функцией filter_func и отрисовывается на исходном рендерере как изображение.
В настоящее время поддерживается только рендерером agg.
- stop_rasterizing()[источник]
-
Переключиться обратно на векторный рендерер и нарисовать содержимое растрового рендерера на векторном рендерере как изображение.
Используется классом
MixedModeRenderer.
- classmatplotlib.backend_bases.ResizeEvent(name, canvas)[исходный код]
-
Базовые классы:
EventСобытие, возникающее при изменении размера холста.
Помимо атрибутов, определённых в родительском классе
Event, событие ResizeEvent имеет ряд специальных атрибутов.- Атрибуты:
-
- widthint
-
Ширина холста в пикселях.
- heightint
-
Высота холста в пикселях.
- classmatplotlib.backend_bases.ShowBase[исходный код]
-
Базовые классы:
_BackendПростой базовый класс для создания функции
show()в бэкендах.Подкласс должен переопределять метод
mainloop().
- classmatplotlib.backend_bases.TimerBase(interval=None, callbacks=None)[исходный код]
-
Базовые классы:
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)[исходный код]
-
Зарегистрировать func, чтобы она вызывалась таймером при срабатывании события. Все переданные дополнительные аргументы будут переданы в func.
Функция возвращает func, поэтому её можно использовать как декоратор.
- propertyinterval
-
Интервал между событиями таймера в миллисекундах.
- remove_callback(func, *args, **kwargs)[исходный код]
-
Удалить func из списка обратных вызовов.
Параметры args и kwargs необязательны и используются для различения копий одной и той же функции, зарегистрированных для вызова с разными аргументами. Это поведение устарело. В будущем
*args, **kwargsбольше не будет учитываться; чтобы можно было отдельно удалить конкретный обратный вызов, передайте его вadd_callbackкак объектfunctools.partial.
- propertysingle_shot
-
Должен ли этот таймер останавливаться после однократного срабатывания.
- start(interval=<deprecated parameter>)[исходный код]
-
Запустить объект таймера.
- Параметры:
-
- intervalint, необязательный
-
Интервал таймера в миллисекундах; если указан, заменяет ранее заданный интервал.
- stop()[исходный код]
-
Остановить таймер.
-
- classmatplotlib.backend_bases.ToolContainerBase(toolmanager)[исходный код]
-
Базовые классы:
objectБазовый класс для всех контейнеров инструментов, например панелей инструментов.
- Атрибуты:
-
-
toolmanager
ToolManager -
Инструменты, с которыми этот
ToolContainerдолжен взаимодействовать.
-
toolmanager
- add_tool(tool, group, position=-1)[исходный код]
-
Добавить инструмент в этот контейнер.
- Параметры:
-
- tooltool_like
-
Добавляемый инструмент; см.
ToolManager.get_tool. - groupstr
-
Имя группы, в которую нужно добавить этот инструмент.
- positionint, по умолчанию: -1
-
Позиция инструмента в группе.
- add_toolitem(name, group, position, image, description, toggle)[исходный код]
-
Хук для добавления элемента инструмента в контейнер.
Этот хук должен быть реализован в каждом бэкенде и содержит специфичный для бэкенда код добавления элемента на панель инструментов.
Предупреждение
Этот метод является частью реализации бэкенда, и его не следует вызывать конечным пользователям. Вместо этого им следует вызывать
ToolContainerBase.add_tool.Функция обратного вызова, связанная с событием щелчка по кнопке, должна быть именно
self.trigger_tool(name).- Параметры:
-
- namestr
-
Имя добавляемого инструмента; оно используется как идентификатор инструмента и как подпись кнопок по умолчанию.
- groupstr
-
Имя группы, к которой относится этот инструмент.
- positionint
-
Позиция инструмента в группе; значение -1 помещает его в конец.
- imagestr
-
Имя файла изображения для кнопки или
None. - descriptionstr
-
Описание инструмента, используемое для всплывающих подсказок.
- togglebool
- remove_toolitem(name)[исходный код]
-
Хук для удаления элемента инструмента из контейнера.
Этот хук должен быть реализован в каждом бэкенде и содержит специфичный для бэкенда код удаления элемента с панели инструментов; он вызывается, когда
ToolManagerгенерирует событиеtool_removed_event.Поскольку некоторые инструменты присутствуют в
ToolManager, но отсутствуют вToolContainer, при вызове для инструмента, отсутствующего в контейнере, этот метод ничего не должен делать.Предупреждение
Этот метод является частью реализации бэкенда, и его не следует вызывать конечным пользователям. Вместо этого им следует вызывать
ToolManager.remove_tool.- Параметры:
-
- namestr
-
Имя удаляемого инструмента.
- set_message(s)[исходный код]
-
Отобразить сообщение на панели инструментов.
- Параметры:
-
- sstr
-
Текст сообщения.
- toggle_toolitem(name, toggled)[исходный код]
-
Хук для переключения элемента инструмента без генерации события.
Этот хук должен быть реализован в каждом бэкенде и содержит специфичный для бэкенда код для переключения элемента панели инструментов без генерации события.
Предупреждение
Этот метод является частью реализации бэкенда, и его не следует вызывать конечным пользователям. Вместо этого им следует вызывать
ToolManager.trigger_toolилиToolContainerBase.trigger_tool(эти методы эквивалентны).- Параметры:
-
- namestr
-
Идентификатор переключаемого инструмента.
- toggledbool
-
Следует ли перевести этот инструмент в переключённое состояние.
- trigger_tool(name)[исходный код]
-
Запустить инструмент.
- Параметры:
-
- namestr
-
Имя (идентификатор) инструмента, запускаемого из контейнера.
- matplotlib.backend_bases.button_press_handler(event, canvas=None, toolbar=None)[исходный код]
-
Действия Matplotlib по умолчанию для дополнительных кнопок мыши.
Параметры такие же, как у
key_press_handler, за исключением того, что event является объектомMouseEvent.
- matplotlib.backend_bases.get_registered_canvas_class(format)[исходный код]
-
Вернуть зарегистрированный холст по умолчанию для указанного формата файла. Выполняет отложенный импорт необходимого бэкенда.
- matplotlib.backend_bases.key_press_handler(event, canvas=None, toolbar=None)[исходный код]
-
Реализовать стандартные сочетания клавиш Matplotlib для холста и панели инструментов, описанные в разделе Навигация с помощью клавиатуры.
- Параметры:
-
-
event
KeyEvent -
Событие нажатия или отпускания клавиши.
-
canvas
FigureCanvasBase, по умолчанию:event.canvas -
Экземпляр холста, специфичный для бэкенда. Этот параметр сохранён для обратной совместимости, но, если он задан, всегда должен быть равен
event.canvas. -
toolbar
NavigationToolbar2, по умолчанию:event.canvas.toolbar -
Панель инструментов навигации и управления курсором. Этот параметр сохранён для обратной совместимости, но, если он задан, всегда должен быть равен
event.canvas.toolbar.
-
event
- matplotlib.backend_bases.register_backend(format, backend, description=None)[исходный код]
-
Зарегистрировать бэкенд для сохранения файлов в заданном формате.
- Параметры:
-
- formatstr
-
Расширение файла
- backendимя модуля или класс холста
-
Бэкенд для обработки вывода в файл
- descriptionstr, по умолчанию: ""
-
Описание типа файла.
© 2012–2026 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/backend_bases_api.html