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')

Параметры:	handles : sequence of Artist, optional Список элементов управления (линий, областей) для добавления в легенду. Используйте вместе с labels, если необходимо полное управление тем, что отображается в легенде, и автоматический механизм, описанный выше, недостаточен. Длина элементов управления и меток должна быть одинаковой в этом случае. Если это не так, они усекаются до меньшей длины. labels : sequence of strings, optional Список меток для отображения рядом с элементами управления. Используйте вместе с handles, если необходимо полное управление тем, что отображается в легенде, и автоматический механизм, описанный выше, недостаточен.
Возвращаемое значение:	matplotlib.legend.Legend instance
Другие параметры:	loc : str or pair of floats, default: rcParams["legend.loc"] ('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_anchor : BboxBase, 2-tuple, or 4-tuple of floats Прямоугольник, используемый для размещения легенды в сочетании с loc. По умолчанию axes.bbox (если вызвано как метод для Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольное размещение легенды. Координаты прямоугольника интерпретируются в системе координат, заданной 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) ncol : integer Количество столбцов в легенде. По умолчанию 1. prop : None or matplotlib.font_manager.FontProperties or dict Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие matplotlib.rcParams. fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} Управляет размером шрифта легенды. Если значение является числовым, размер будет абсолютным размером шрифта в пунктах. Строковые значения относительны к текущему размеру шрифта по умолчанию. Этот аргумент используется только в том случае, если prop не указан. numpoints : None or int Определяет количество точек маркеров в легенде при создании записи легенды для Line2D (линия). По умолчанию None, которое будет принимать значение из rcParams["legend.numpoints"]. scatterpoints : None or int Количество точек маркеров в легенде при создании записи легенды для PathCollection (график рассеяния). По умолчанию None, которое будет принимать значение из rcParams["legend.scatterpoints"]. scatteryoffsets : iterable of floats Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды графика рассеяния. 0.0 находится у основания текста легенды, а 1.0 — вверху. Чтобы отобразить все маркеры на одной высоте, установите значение [0.5]. По умолчанию [0.375, 0.5, 0.3125]. markerscale : None or int or float Относительный размер маркеров легенды по сравнению с первоначально отрисованными. По умолчанию None, которое будет принимать значение из rcParams["legend.markerscale"]. markerfirst : bool Если True, маркер легенды помещается слева от метки легенды. Если False, маркер легенды помещается справа от метки легенды. По умолчанию True. frameon : None or bool Управление отображением легенды на области (рамке). По умолчанию None, которое будет принимать значение из rcParams["legend.frameon"]. fancybox : None or bool Управление включением скругленных углов вокруг FancyBboxPatch, которые составляют фоновый прямоугольник легенды. По умолчанию None, которое будет принимать значение из rcParams["legend.fancybox"]. shadow : None or bool Управление отображением тени за легендой. По умолчанию None, которое будет принимать значение из rcParams["legend.shadow"]. framealpha : None or float Управление альфа-прозрачностью фона легенды. По умолчанию None, которое будет принимать значение из rcParams["legend.framealpha"]. Если тень активирована и framealpha None, значение по умолчанию игнорируется. facecolor : None or "inherit" or a color spec Управление цветом фона легенды. По умолчанию None, которое будет принимать значение из rcParams["legend.facecolor"]. Если "inherit", оно будет принимать значение rcParams["axes.facecolor"]. edgecolor : None or "inherit" or a color spec Управление цветом границы фонового прямоугольника легенды. По умолчанию None, которое будет принимать значение из rcParams["legend.edgecolor"] Если "inherit", оно будет принимать значение rcParams["axes.edgecolor"]. mode : {"expand", None} Если mode установлено в "expand", легенда будет расширена по горизонтали, чтобы заполнить область осевого графика (или bbox_to_anchor если определяет размер легенды). bbox_transform : None or matplotlib.transforms.Transform Преобразование для рамки (bbox_to_anchor). Для значения None (по умолчанию) используется преобразование осевого графика transAxes. title : str or None Заголовок легенды. По умолчанию заголовок отсутствует (None). title_fontsize: str или None Размер шрифта заголовка легенды. По умолчанию — размер шрифта по умолчанию. borderpad : float or None Дробное отступы внутри границы легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.borderpad"]. labelspacing : float or None Вертикальное расстояние между записями легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.labelspacing"]. handlelength : float or None Длина элементов управления легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.handlelength"]. handletextpad : float or None Отступ между элементом управления легенды и текстом. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.handletextpad"]. borderaxespad : float or None Отступ между осевым графиком и границей легенды. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.borderaxespad"]. columnspacing : float or None Интервал между столбцами. Измеряется в единицах размера шрифта. По умолчанию None, которое будет принимать значение из rcParams["legend.columnspacing"]. handler_map : dict or None Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Это handler_map обновляет словарь обработчиков по умолчанию, который находится в matplotlib.legend.Legend.get_legend_handler_map().

Примечания

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