matplotlib.pyplot.colorbar

matplotlib.pyplot.colorbar(mappable=None, cax=None, ax=None, **kw) [source]

Добавить цветовую шкалу к графику.

Подписи функций для интерфейса pyplot; все, кроме первой, также являются подписями методов для метода colorbar():

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

Параметры:

Параметры:	mappable : `Image`, `ContourSet` и т. д., к которому относится цветовая шкала; этот аргумент является обязательным для метода Figure `colorbar()`, но необязательным для функции pyplot `colorbar()`, которая устанавливает значение по умолчанию на текущем изображении. `cax : Axes object, optional` Оси, на которые будет нарисована цветовая шкала. `ax : Axes, list of Axes, optional` Родительские оси, из которых будет взято место для новых осей цветовой шкалы. Если задан список осей, все они будут изменены для размещения осей цветовой шкалы. `use_gridspec : bool, optional` Если cax `None`, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec `True`, cax создается как экземпляр Subplot с использованием модуля grid_spec.
Возвращаемое значение:	:class:`~matplotlib.colorbar.Colorbar` экземпляр См. также его базовый класс, `ColorbarBase`. Вызовите метод `set_label()`, чтобы добавить метку к цветовой шкале.

mappable :: Image, ContourSet и т. д., к которому относится цветовая шкала; этот аргумент является обязательным для метода Figure colorbar(), но необязательным для функции pyplot colorbar(), которая устанавливает значение по умолчанию на текущем изображении.
cax : Axes object, optional: Оси, на которые будет нарисована цветовая шкала.
ax : Axes, list of Axes, optional: Родительские оси, из которых будет взято место для новых осей цветовой шкалы. Если задан список осей, все они будут изменены для размещения осей цветовой шкалы.
use_gridspec : bool, optional: Если cax None, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec True, cax создается как экземпляр Subplot с использованием модуля grid_spec.

Возвращаемое значение:

:class:`~matplotlib.colorbar.Colorbar` экземпляр: См. также его базовый класс, ColorbarBase. Вызовите метод set_label(), чтобы добавить метку к цветовой шкале.

Примечания

Дополнительные ключевые аргументы бывают двух типов:

свойства осей:

Свойство	Описание
orientation	вертикальный или горизонтальный
fraction	0.15; часть исходных осей, используемых для цветовой шкалы
pad	0.05 при вертикальной ориентации, 0.15 при горизонтальной; часть исходных осей между цветовой шкалой и новыми осями изображения
shrink	1.0; часть, на которую нужно умножить размер цветовой шкалы
aspect	20; отношение длинных к коротким сторонам
anchor	(0.0, 0.5) при вертикальной ориентации; (0.5, 1.0) при горизонтальной; точка привязки осей цветовой шкалы
panchor	(1.0, 0.5) при вертикальной ориентации; (0.5, 0.0) при горизонтальной; точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей не изменится

свойства цветовой шкалы:

Свойство	Описание
extend	[ 'ничего' \| 'оба' \| 'мин' \| 'макс' ] Если не 'ничего', добавить указатели для значений вне диапазона. Они устанавливаются для данной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	[ None \| 'auto' \| длина \| длины ] Если установлено в None, как минимальные, так и максимальные треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если установлено в 'auto', делает треугольные расширения цветовой шкалы такими же, как внутренние прямоугольники (когда spacing установлен в 'uniform') или такими же, как соответствующие соседние внутренние прямоугольники (когда spacing установлен в 'proportional'). Если скаляр, указывает длину минимальных и максимальных треугольных расширений цветовой шкалы как долю длины внутренней цветовой шкалы. Также можно указать последовательность из двух элементов, указывающих длины минимального и максимального расширений цветовой шкалы соответственно как долю длины внутренней цветовой шкалы.
extendrect	bool Если False, минимальное и максимальное расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	[ 'равномерный' \| 'пропорциональный' ] Равномерное распределение дает каждому дискретному цвету одинаковое пространство; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	[ None \| список меток \| объект Locator ] Если None, метки определяются автоматически из входных данных.
format	[ None \| строка формата \| объект Formatter ] Если None, используется `ScalarFormatter`. Если задана строка формата, например '%.3f', она используется. Вместо нее может быть задан другой объект `Formatter`.
drawedges	bool Рисовать ли линии на границах цветов.

Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда mappable имеет norm=NoNorm()) или других необычных обстоятельствах.

Свойство	Описание
boundaries	None или последовательность
values	None или последовательность, которая должна быть на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в values.

Свойство

Описание

boundaries

None или последовательность

values

None или последовательность, которая должна быть на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в values.

Если mappable является ContourSet, его параметр extend включается автоматически.

Параметр shrink предоставляет простой способ масштабирования цветовой шкалы относительно осей. Обратите внимание, что если задан cax, он определяет размер цветовой шкалы, и параметры shrink и aspect игнорируются.

Для более точного управления вы можете вручную указать позиции объектов осей, на которых нарисованы mappable и цветовая шкала. В этом случае не используйте никакие из параметров осей kwargs.

Изготовлено известно, что некоторые просмотрщики векторной графики (svg и pdf) отображают белые пробелы между сегментами цветовой шкалы. Это связано с ошибками в просмотрщиках, а не в matplotlib. В качестве обходного решения цветовая шкала может быть отображена с наложением сегментов:

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других обстоятельствах. В частности, с полупрозрачными изображениями (alpha < 1) и расширениями цветовой шкалы и по умолчанию не включено (см. вопрос #1188).