matplotlib.legend_handler

Этот модуль определяет обработчики легенды по умолчанию.

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

Обработчики легенды должны быть вызываемым объектом со следующим сигнатуром.

legend_handler(legend, orig_handle, fontsize, handlebox)

Где legend — сама легенда, orig_handle — исходный график, fontsize — размер шрифта в пикселях, а handlebox — экземпляр OffsetBox. Внутри вызова вы должны создать соответствующие элементы управления (используя соответствующие свойства из legend и/или orig_handle) и добавить их в handlebox. Элементы управления должны быть масштабированы в соответствии с размером шрифта (обратите внимание, что размер указан в пикселях, то есть это значение, масштабированное с учетом dpi).

Этот модуль включает определение нескольких классов обработчиков легенды, унаследованных от базового класса (HandlerBase) с последующим методом:

def legend_artist(self, legend, orig_handle, fontsize, handlebox)

class matplotlib.legend_handler.HandlerBase(xpad=0.0, ypad=0.0, update_func=None) [source]

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

Производные классы предназначены для переопределения метода create_artists, который имеет следующий синтаксис:

def create_artists(self, legend, orig_handle,
                   xdescent, ydescent, width, height, fontsize,
                   trans):

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

adjust_drawing_area(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize) [source]

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

legend_artist(self, legend, orig_handle, fontsize, handlebox) [source]

Возвращает элемент управления, который этот HandlerBase генерирует для заданного исходного элемента управления/обработчика.

Параметры:

legend : matplotlib.legend.Legend instance Легенда, для которой создаются элементы легенды. orig_handle : matplotlib.artist.Artist or similar Объект, для которого создаются элементы легенды. fontsize : float or int Размер шрифта в пикселях. Создаваемые элементы управления должны быть масштабированы в соответствии с заданным размером шрифта. handlebox : matplotlib.offsetbox.OffsetBox instance Область, которая была создана для размещения элементов управления этой записи легенды. Элементы управления, созданные в методе legend_artist, должны быть добавлены в эту handlebox внутри этого метода.

update_prop(self, legend_handle, orig_handle, legend) [source]

class matplotlib.legend_handler.HandlerCircleCollection(yoffsets=None, sizes=None, **kw) [source]

Обработчик для CircleCollections.

create_collection(self, orig_handle, sizes, offsets, transOffset) [source]

class matplotlib.legend_handler.HandlerErrorbar(xerr_size=0.5, yerr_size=None, marker_pad=0.3, numpoints=None, **kw) [source]

Обработчик для Errorbars.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

get_err_size(self, legend, xdescent, ydescent, width, height, fontsize) [source]

class matplotlib.legend_handler.HandlerLine2D(marker_pad=0.3, numpoints=None, **kw) [source]

Обработчик для Line2D экземпляров.

Параметры:	marker_pad : float Отступ между точками в записи легенды. numpoints : int Количество точек для отображения в записи легенды.

Примечания

Любые другие ключевые слова передаются методу HandlerNpoints.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

class matplotlib.legend_handler.HandlerLineCollection(marker_pad=0.3, numpoints=None, **kw) [source]

Обработчик для LineCollection экземпляров.

Параметры:	marker_pad : float Отступ между точками в записи легенды. numpoints : int Количество точек для отображения в записи легенды.

Примечания

Любые другие ключевые слова передаются методу HandlerNpoints.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

get_numpoints(self, legend) [source]

class matplotlib.legend_handler.HandlerNpoints(marker_pad=0.3, numpoints=None, **kw) [source]

Обработчик легенды, который отображает numpoints точек в записи легенды.

Параметры:	marker_pad : float Отступ между точками в записи легенды. numpoints : int Количество точек для отображения в записи легенды.

Примечания

Любые другие ключевые слова передаются методу HandlerBase.

get_numpoints(self, legend) [source]

get_xdata(self, legend, xdescent, ydescent, width, height, fontsize) [source]

class matplotlib.legend_handler.HandlerNpointsYoffsets(numpoints=None, yoffsets=None, **kw) [source]

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

Параметры:	numpoints : int Количество точек для отображения в записи легенды. yoffsets : array of floats Список длинной numpoints смещений по оси y для каждой точки в записи легенды.

Примечания

Любые другие ключевые аргументы передаются в HandlerNpoints.

get_ydata(self, legend, xdescent, ydescent, width, height, fontsize) [source]

class matplotlib.legend_handler.HandlerPatch(patch_func=None, **kw) [source]

Обработчик для экземпляров Patch.

Параметры:	patch_func : callable, optional Функция, создающая элемент графического ключа легенды. patch_func должна иметь сигнатуру: def patch_func(legend=legend, orig_handle=orig_handle, xdescent=xdescent, ydescent=ydescent, width=width, height=height, fontsize=fontsize) После этого созданный элемент вызовет метод update_prop и будет применено соответствующее преобразование.

Примечания

Любые другие ключевые аргументы передаются в HandlerBase.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

class matplotlib.legend_handler.HandlerPathCollection(yoffsets=None, sizes=None, **kw) [source]

Обработчик для PathCollections, используемых в scatter.

create_collection(self, orig_handle, sizes, offsets, transOffset) [source]

class matplotlib.legend_handler.HandlerPolyCollection(xpad=0.0, ypad=0.0, update_func=None) [source]

Обработчик для PolyCollection, используемого в fill_between и stackplot.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

class matplotlib.legend_handler.HandlerRegularPolyCollection(yoffsets=None, sizes=None, **kw) [source]

Обработчик для RegularPolyCollections.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

create_collection(self, orig_handle, sizes, offsets, transOffset) [source]

get_numpoints(self, legend) [source]

get_sizes(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize) [source]

update_prop(self, legend_handle, orig_handle, legend) [source]

class matplotlib.legend_handler.HandlerStem(marker_pad=0.3, numpoints=None, bottom=None, yoffsets=None, **kw) [source]

Обработчик для графиков, созданных с помощью stem.

Параметры:	marker_pad : float Отступ между точками в записи легенды. По умолчанию 0.3. numpoints : int, optional Количество точек для отображения в записи легенды. bottom : float, optional yoffsets : array of floats, optional Список длинной numpoints смещений по оси y для каждой точки в записи легенды.

Примечания

Любые другие ключевые аргументы передаются в HandlerNpointsYoffsets.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

get_ydata(self, legend, xdescent, ydescent, width, height, fontsize) [source]

class matplotlib.legend_handler.HandlerTuple(ndivide=1, pad=None, **kwargs) [source]

Обработчик для Кортежей.

Дополнительные ключевые аргументы передаются в HandlerBase.

Параметры:	ndivide : int, optional Количество разделов для разбиения области легенды. Если None, используется длина входного кортежа. По умолчанию 1. pad : float, optional Если None, используется legend.borderpad по умолчанию. В единицах доли размера шрифта. По умолчанию None.

create_artists(self, legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans) [source]

matplotlib.legend_handler.update_from_first_child(tgt, src) [source]