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, если вам нужен полный контроль над отображением в легенде, и автоматический механизм, описанный выше, недостаточен. Длина handles и labels должна быть одинаковой. В противном случае они будут усечены до меньшей длины. labelslist of str, optional Список меток для отображения рядом с элементами. Используйте вместе с handles, если вам нужен полный контроль над отображением в легенде, и автоматический механизм, описанный выше, недостаточен.
Возвращаемые значения:	Legend
Другие параметры:	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 'верхний правый' 1 'верхний левый' 2 'нижний левый' 3 'нижний правый' 4 'правый' 5 'центр слева' 6 'центр справа' 7 'нижний центр' 8 'верхний центр' 9 'центр' 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) ncolint, default: 1 Количество столбцов в легенде. propNone or matplotlib.font_manager.FontProperties or dict Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие значения matplotlib.rcParams. fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} Размер шрифта легенды. Если значение является числовым, размер будет абсолютным размером шрифта в пунктах. Строковые значения относительны к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не задан. labelcolorstr or list Устанавливает цвет текста в легенде. Может быть строкой, представляющей цвет (например, 'red'), или списком таких строк. Цвет метки также можно настроить, чтобы он соответствовал цвету линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec'). numpointsint, default: rcParams["legend.numpoints"] (default: 1) Количество точек маркера в легенде при создании записи для Line2D (линии). scatterpointsint, default: rcParams["legend.scatterpoints"] (default: 1) Количество точек маркера в легенде при создании записи для PathCollection (диаграммы рассеяния). scatteryoffsetsiterable of floats, default: [0.375, 0.5, 0.3125] Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды диаграммы рассеяния. 0.0 - внизу текста легенды, 1.0 - вверху. Чтобы нарисовать все маркеры на одной высоте, установите значение в [0.5]. markerscalefloat, default: rcParams["legend.markerscale"] (default: 1.0) Относительный размер маркеров легенды по сравнению с первоначально нарисованными. markerfirstbool, default: True Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды. frameonbool, default: rcParams["legend.frameon"] (default: True) Следует ли рисовать легенду на области (рамке). fancyboxbool, default: rcParams["legend.fancybox"] (default: True) Следует ли включать закругленные углы вокруг FancyBboxPatch, что формирует фон легенды. shadowbool, default: rcParams["legend.shadow"] (default: False) Следует ли рисовать тень за легендой. framealphafloat, default: rcParams["legend.framealpha"] (default: 0.8) Альфа-прозрачность фона легенды. Если shadow активирован, и framealpha None, значение по умолчанию игнорируется. facecolor"inherit" or color, default: rcParams["legend.facecolor"] (default: 'inherit') Цвет фона легенды. Если "inherit", использовать rcParams["axes.facecolor"] (по умолчанию: 'white'). edgecolor"inherit" or color, default: rcParams["legend.edgecolor"] (default: '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_fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: rcParams["legend.title_fontsize"] (default: None) Размер шрифта заголовка легенды. borderpadfloat, default: rcParams["legend.borderpad"] (default: 0.4) Пробел внутри границы легенды, в единицах размера шрифта. labelspacingfloat, default: rcParams["legend.labelspacing"] (default: 0.5) Вертикальное расстояние между записями легенды, в единицах размера шрифта. handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0) Длина дескрипторов легенды, в единицах размера шрифта. handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8) Отступ между дескриптором легенды и текстом, в единицах размера шрифта. borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5) Отступ между осями и границей легенды, в единицах размера шрифта. columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0) Интервал между столбцами, в единицах размера шрифта. handler_mapdict or None Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Это handler_map обновляет словарь обработчиков по умолчанию, найденный в matplotlib.legend.Legend.get_legend_handler_map.

Примечания

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

Примеры использования matplotlib.pyplot.figlegend