matplotlib.pyplot.figlegend

matplotlib.pyplot.figlegend(*args, **kwargs) [source]

Размещает легенду на рисунке.

Для создания легенды из существующих элементов на каждом осях:

figlegend()

Для создания легенды для списка линий и меток:

figlegend(
    (line1, line2, line3),
    ('label1', 'label2', 'label3'),
    loc='upper right')

Эти параметры также можно указать в виде ключевых слов:

figlegend(
    handles=(line1, line2, line3),
    labels=('label1', 'label2', 'label3'),
    loc='upper right')

Параметры:	handleslist of Artist, optional Список элементов (линии, области) для добавления в легенду. Используйте его вместе с labels, если требуется полный контроль над отображением в легенде, и автоматический механизм, описанный выше, недостаточен. Длина элементов и меток должна быть одинаковой в этом случае. Если это не так, они усекаются до меньшей длины. labelslist of str, optional Список меток для отображения рядом с элементами. Используйте его вместе с handles, если требуется полный контроль над отображением в легенде, и автоматический механизм, описанный выше, недостаточен.
Возвращает:	matplotlib.legend.Legend instance
Другие параметры:	locstr or pair of floats, default: rcParams["legend.loc"] (default: 'best') ('best' for axes, 'upper right' for figures) Положение легенды. Строки 'upper left', 'upper right', 'lower left', 'lower right' размещают легенду в соответствующем углу осей/рисунок. Строки 'upper center', 'lower center', 'center left', 'center right' размещают легенду в центре соответствующей грани осей/рисунка. Строка 'center' размещает легенду в центре осей/рисунка. Строка 'best' размещает легенду в месте, среди девяти определённых мест, с минимальным перекрытием с другими нарисованными элементами. Этот вариант может быть довольно медленным для графиков с большим количеством данных; скорость построения графиков может быть улучшена, если указать конкретное местоположение. Положение также может быть 2-кортежем, задающим координаты левого нижнего угла легенды в координатах осей (в этом случае bbox_to_anchor будет проигнорирован). Для обратной совместимости, 'center right' (но не другое местоположение) также может быть написано 'right', и каждое "строковое" местоположение также может быть задано как числовое значение: Строка местоположения Код местоположения 'best' 0 'upper right' 1 'upper left' 2 'lower left' 3 'lower right' 4 'right' 5 'center left' 6 'center right' 7 'lower center' 8 'upper center' 9 'center' 10 bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats Прямоугольник, используемый для позиционирования легенды совместно с loc. По умолчанию axes.bbox (если вызов как метод Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольное размещение легенды. Координаты Bbox интерпретируются в системе координат, заданной bbox_transform, с преобразованием по умолчанию осей или фигуры, в зависимости от того, какой legend вызывается. Если задан 4-кортеж или BboxBase, то он задаёт прямоугольник (x, y, width, height) в котором размещается легенда. Чтобы разместить легенду в лучшем месте в нижнем правом квадранте осей (или фигуры): loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5) 2-кортеж (x, y) помещает угол легенды, указанный loc, в x, y. Например, чтобы поместить верхний правый угол легенды в центр осей (или фигуры), можно использовать следующие ключевые слова: loc='upper right', bbox_to_anchor=(0.5, 0.5) ncolinteger Количество столбцов в легенде. По умолчанию 1. propNone or matplotlib.font_manager.FontProperties or dict Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие matplotlib.rcParams. fontsizeint or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} Размер шрифта легенды. Если значение является числом, размер будет абсолютным размером шрифта в пунктах. Строковые значения относительны к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан. numpointsNone or int Количество маркеров на точке в легенде при создании элемента легенды для Line2D (линии). По умолчанию None, что означает использование rcParams["legend.numpoints"] (по умолчанию: 1). scatterpointsNone or int Количество маркеров на точке в легенде при создании элемента легенды для PathCollection (графика рассеяния). По умолчанию None, что означает использование rcParams["legend.scatterpoints"] (по умолчанию: 1). scatteryoffsetsiterable of floats Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для элемента легенды графика рассеяния. 0.0 — в основании текста легенды, 1.0 — вверху. Чтобы нарисовать все маркеры на одной высоте, установите в [0.5]. По умолчанию [0.375, 0.5, 0.3125]. markerscaleNone or int or float Относительный размер маркеров легенды по сравнению с исходными. По умолчанию None, что означает использование rcParams["legend.markerscale"] (по умолчанию: 1.0). markerfirstbool Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды. По умолчанию True. frameonNone or bool Нужно ли рисовать легенду на области (рамке). По умолчанию None, что означает использование rcParams["legend.frameon"] (по умолчанию: True). fancyboxNone or bool Нужно ли включить скругленные углы вокруг FancyBboxPatch, которые составляют фон легенды. По умолчанию None, что означает использование rcParams["legend.fancybox"] (по умолчанию: True). shadowNone or bool Нужно ли рисовать тень за легендой. По умолчанию None, что означает использование rcParams["legend.shadow"] (по умолчанию: False). framealphaNone or float Альфа-прозрачность фона легенды. По умолчанию None, что означает использование rcParams["legend.framealpha"] (по умолчанию: 0.8). Если shadow активирован, и framealpha None, значение по умолчанию игнорируется. facecolorNone or "inherit" or color Цвет фона легенды. По умолчанию None, что означает использование rcParams["legend.facecolor"] (по умолчанию: 'inherit'). Если "inherit", используйте rcParams["axes.facecolor"] (по умолчанию: 'white'). edgecolorNone or "inherit" or color Цвет рамки фона легенды. По умолчанию None, что означает использование rcParams["legend.edgecolor"] (по умолчанию: '0.8'). Если "inherit", используйте rcParams["axes.edgecolor"] (по умолчанию: 'black'). mode{"expand", None} Если mode установлен в "expand", легенда будет горизонтально расширена, чтобы заполнить область осей (или bbox_to_anchor если определяет размер легенды). bbox_transformNone or matplotlib.transforms.Transform Преобразование для ограничивающей рамки (bbox_to_anchor). Для значения None (по умолчанию) будет использоваться преобразование осей transAxes. titlestr or None Заголовок легенды. По умолчанию без заголовка (None). title_fontsize: str или None Размер шрифта заголовка легенды. По умолчанию - размер шрифта по умолчанию. borderpadfloat or None Доля пробела внутри рамки легенды в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.borderpad"] (по умолчанию: 0.4). labelspacingfloat or None Вертикальное расстояние между элементами легенды в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.labelspacing"] (по умолчанию: 0.5). handlelengthfloat or None Длина элементов легенды в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.handlelength"] (по умолчанию: 2.0). handletextpadfloat or None Отступ между элементом легенды и текстом в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.handletextpad"] (по умолчанию: 0.8). borderaxespadfloat or None Отступ между осями и рамкой легенды в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.borderaxespad"] (по умолчанию: 0.5). columnspacingfloat or None Интервал между столбцами в единицах размера шрифта. По умолчанию None, что означает использование rcParams["legend.columnspacing"] (по умолчанию: 2.0). handler_mapdict or None Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет словарь обработчиков по умолчанию, найденный в matplotlib.legend.Legend.get_legend_handler_map().

Примечания

Не все типы элементов поддерживаются командой легенды. Подробности см. в Руководстве по легендам.