matplotlib.legend_handler

Стандартные обработчики легенды.

Важно

Это низкоуровневый API легенд, который большинству конечных пользователей не нужен.

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

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

legend_handler(legend, orig_handle, fontsize, handlebox)

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

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

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

classmatplotlib.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) и которые, при необходимости, масштабированы относительно fontsize.

Параметры:

xpadfloat, необязательно: Отступ в x-направлении.
ypadfloat, необязательно: Отступ в y-направлении.
update_funcвызываемый объект, необязательно: Функция для обновления свойств обработчика легенды из другого обработчика легенды, используемая методом update_prop.

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

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

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

Параметры:

legendLegend: Легенда, для которой создаются объекты легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются объекты легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), внутри которого должны поместиться создаваемые объекты легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые объекты легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к объектам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

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

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

Параметры:

legendLegend: Легенда, для которой создаются объекты легенды.
orig_handlematplotlib.artist.Artist или аналогичный: Объект, для которого создаются объекты легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые объекты должны быть масштабированы в соответствии с заданным размером шрифта.
handleboxOffsetBox: Область, созданная для хранения объектов легенды данной записи. Объекты, созданные в методе legend_artist, должны быть добавлены в эту область внутри этого метода.

update_prop(legend_handle, orig_handle, legend)[source]

classmatplotlib.legend_handler.HandlerCircleCollection(yoffsets=None, sizes=None, **kwargs)[source]

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

Параметры:

numpointsint: Количество точек для отображения в записи легенды.
yoffsetsмассив чисел с плавающей точкой: Список длиной numpoints с y-смещениями каждой точки в записи легенды.
**kwargs: Ключевые аргументы, переданные в HandlerNpoints.

create_collection(orig_handle, sizes, offsets, offset_transform)[source]

END_OF_DOCUMENT_MARKER

classmatplotlib.legend_handler.HandlerErrorbar(xerr_size=0.5, yerr_size=None, marker_pad=0.3, numpoints=None, **kwargs)[source]

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

Параметры:

marker_padfloat: Отступ между точками в записи легенды.
numpointsint: Количество точек для отображения в записи легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerBase.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), внутри которого должны размещаться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в поле обработчика к экранным координатам.

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

classmatplotlib.legend_handler.HandlerLine2D(marker_pad=0.3, numpoints=None, **kwargs)[source]

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

См. также

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

Параметры:

marker_padfloat: Отступ между точками в записи легенды.
numpointsint: Количество точек для отображения в записи легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerBase.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), внутри которого должны размещаться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в поле обработчика к экранным координатам.

классmatplotlib.legend_handler.HandlerLine2DCompound(marker_pad=0.3, numpoints=None, **kwargs)[source]

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

Параметры:

marker_padfloat: Отступ между точками в записи легенды.
numpointsint: Количество точек для отображения в записи легенды.
**kwargs: Ключевые аргументы, передаваемые обработчику HandlerBase.

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

Возвращает сгенерированные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в котором должны размещаться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в поле обработчика к экранным координатам.

классmatplotlib.legend_handler.HandlerLineCollection(marker_pad=0.3, numpoints=None, **kwargs)[source]

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

Параметры:

marker_padfloat: Отступ между точками в записи легенды.
numpointsint: Количество точек для отображения в записи легенды.
**kwargs: Ключевые аргументы, передаваемые обработчику HandlerBase.

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

Возвращает сгенерированные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в котором должны размещаться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в поле обработчика к экранным координатам.

get_numpoints(legend)[source]

классmatplotlib.legend_handler.HandlerNpoints(marker_pad=0.3, numpoints=None, **kwargs)[source]

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

Параметры:

marker_padfloat: Отступ между точками в записи легенды.
numpointsint: Количество точек для отображения в записи легенды.
**kwargs: Ключевые аргументы, передаваемые обработчику HandlerBase.

get_numpoints(legend)[source]

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

классmatplotlib.legend_handler.HandlerNpointsYoffsets(numpoints=None, yoffsets=None, **kwargs)[source]

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

Параметры:

numpointsint: Количество точек для отображения в записи легенды.
yoffsetsмассив чисел с плавающей точкой: Список длиной numpoints смещений по оси y для каждой точки в записи легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerNpoints.

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

классmatplotlib.legend_handler.HandlerPatch(patch_func=None, **kwargs)[source]

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

Параметры:

patch_funcвызываемая функция, необязательно

Функция, создающая элемент графического ключа легенды. patch_func должна иметь сигнатуру:

def patch_func(legend=legend, orig_handle=orig_handle,
               xdescent=xdescent, ydescent=ydescent,
               width=width, height=height, fontsize=fontsize)

Впоследствии, созданный элемент будет иметь метод update_prop и к нему будет применено соответствующее преобразование.

**kwargs

Ключевые аргументы, передаваемые в HandlerBase.

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

Возвращает элементы легенды, сгенерированные.

Параметры:

legendLegend: Легенда, для которой создаются элементы легенды.
orig_handleArtist или подобное: Объект, для которого создаются элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в который должны поместиться элементы легенды.
fontsizeint: Размер шрифта в пикселях. Элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к элементам легенды. Обычно из единичных координат в области обработчика в экранные координаты.

классmatplotlib.legend_handler.HandlerPathCollection(yoffsets=None, sizes=None, **kwargs)[source]

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

Параметры:

numpointsint: Количество точек для отображения в записи легенды.
yoffsetsмассив чисел с плавающей точкой: Список длиной numpoints смещений по оси y для каждой точки в записи легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerNpoints.

create_collection(orig_handle, sizes, offsets, offset_transform)[source]

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

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

Параметры:

xpadfloat, необязательно: Отступ в направлении оси X.
ypadfloat, необязательно: Отступ в направлении оси Y.
update_funccallable, необязательно: Функция для обновления свойств обработчика легенды из другого обработчика легенды, используемая методом update_prop.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются элементы.
orig_handleArtist или подобный: Объект, для которого создаются элементы.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в который должны поместиться элементы.
fontsizeint: Размер шрифта в пикселях. Элементы легенды будут масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к элементам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

classmatplotlib.legend_handler.HandlerRegularPolyCollection(yoffsets=None, sizes=None, **kwargs)[source]

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

Параметры:

numpointsint: Количество точек для отображения в записи легенды.
yoffsetsмассив чисел с плавающей точкой: Список длиной numpoints со смещениями по оси Y для каждой точки в записи легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerNpoints.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются элементы.
orig_handleArtist или подобный: Объект, для которого создаются элементы.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в который должны поместиться элементы.
fontsizeint: Размер шрифта в пикселях. Элементы легенды будут масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к элементам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

create_collection(orig_handle, sizes, offsets, offset_transform)[source]

get_numpoints(legend)[source]

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

update_prop(legend_handle, orig_handle, legend)[source]

END_OF_DOCUMENT_MARKER

classmatplotlib.legend_handler.HandlerStem(marker_pad=0.3, numpoints=None, bottom=None, yoffsets=None, **kwargs)[source]

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

Параметры:

marker_padfloat, по умолчанию: 0.3: Отступ между точками в элементе легенды.
numpointsint, необязательно: Количество точек, отображаемых в элементе легенды.
bottomfloat, необязательно
yoffsetsмассив чисел с плавающей точкой, необязательно: Список длины numpoints с отступами по оси y для каждой точки в элементе легенды.
**kwargs: Ключевые аргументы, передаваемые в HandlerNpointsYoffsets.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в котором должны поместиться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

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

classmatplotlib.legend_handler.HandlerStepPatch(xpad=0.0, ypad=0.0, update_func=None)[source]

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

Параметры:

xpadfloat, необязательно: Отступ в направлении оси x.
ypadfloat, необязательно: Отступ в направлении оси y.
update_funcвызываемая функция, необязательно: Функция для обновления свойств обработчика легенды из другого обработчика легенды, используемая update_prop.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются эти элементы.
orig_handleArtist или аналогичный: Объект, для которого создаются эти элементы.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в котором должны поместиться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

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

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

Параметры:

ndivideint, по умолчанию: 1: Количество разделов для деления области легенды. Если None, используется длина входного кортежа.
padfloat, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4): Отступ в единицах доли размера шрифта.
**kwargs: Ключевые аргументы, передаваемые в HandlerBase.

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

Возвращает созданные элементы легенды.

Параметры:

legendLegend: Легенда, для которой создаются элементы легенды.
orig_handleArtist или аналогичный: Объект, для которого создаются элементы легенды.
xdescent, ydescent, width, heightint: Прямоугольник (xdescent, ydescent, width, height), в который должны помещаться создаваемые элементы легенды.
fontsizeint: Размер шрифта в пикселях. Создаваемые элементы легенды должны быть масштабированы в соответствии с заданным размером шрифта.
transTransform: Преобразование, применяемое к создаваемым элементам легенды. Обычно от единичных координат в области обработчика к экранным координатам.

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

END_OF_DOCUMENT_MARKER