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 Отображаемый объект `matplotlib.cm.ScalarMappable` (то есть `Image`, `ContourSet` и т.д.), к которому относится цветовая шкала. Этот аргумент является обязательным для метода `Figure.colorbar`, но необязательным для функции `pyplot.colorbar`, которая устанавливает значение по умолчанию в текущее изображение. Обратите внимание, что можно создать `ScalarMappable` «на лету», чтобы создать цветовые шкалы, не привязанные к ранее нарисованному элементу, например: fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax) `caxAxes object, optional` Оси, на которых будет отображена цветовая шкала. `axAxes, list of Axes, optional` Родительские оси, из которых будет взято пространство для новых осей цветовой шкалы. Если задан список осей, все они будут изменены для размещения осей цветовой шкалы. `use_gridspecbool, optional` Если cax равно `None`, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec равно `True`, cax создается как экземпляр Subplot с использованием модуля `gridspec`.
Возвращаемое значение:	`colorbarColorbar` См. также базовый класс `ColorbarBase`.

mappable

Отображаемый объект matplotlib.cm.ScalarMappable (то есть Image, ContourSet и т.д.), к которому относится цветовая шкала. Этот аргумент является обязательным для метода Figure.colorbar, но необязательным для функции pyplot.colorbar, которая устанавливает значение по умолчанию в текущее изображение.

Обратите внимание, что можно создать ScalarMappable «на лету», чтобы создать цветовые шкалы, не привязанные к ранее нарисованному элементу, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

caxAxes object, optional

Оси, на которых будет отображена цветовая шкала.

axAxes, list of Axes, optional

Родительские оси, из которых будет взято пространство для новых осей цветовой шкалы. Если задан список осей, все они будут изменены для размещения осей цветовой шкалы.

use_gridspecbool, optional

Если cax равно None, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec равно True, cax создается как экземпляр Subplot с использованием модуля gridspec.

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

colorbarColorbar: См. также базовый класс ColorbarBase.

Примечания

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

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

Свойство	Описание
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	{'neither', 'both', 'min', 'max'} Если не 'neither', создать указательные концы для значений вне диапазона. Эти значения устанавливаются для данной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	{None, 'auto', длина, длины} Если None, оба минимальные и максимальные треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если 'auto', делает треугольные расширения цветовой шкалы одинаковой длины, как внутренние прямоугольники (когда spacing установлен в 'uniform') или такой же длины, как соответствующие смежные внутренние прямоугольники (когда spacing установлен в 'proportional'). Если скалярное значение, указывает длину минимальных и максимальных треугольных расширений цветовой шкалы как долю от длины внутренней цветовой шкалы. Также может быть задана двухэлементная последовательность дробей, указывающая длины минимального и максимального расширений цветовой шкалы соответственно как долю от длины внутренней цветовой шкалы.
extendrect	bool Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} Равномерное распределение задаёт каждому дискретному цвету одинаковое пространство; пропорциональное распределение делает пространство пропорциональным интервалу данных.
ticks	None или список меток или локатор Если None, метки определяются автоматически из входных данных.
format	None или строка или форматировщик Если None, используется `ScalarFormatter`. Если задана строка формата, например '%.3f', она используется. Вместо этого может быть задан альтернативный объект `Formatter`.
drawedges	bool Выводить ли линии на границах цветов.
label	строка Метка по длинной оси цветовой шкалы.

Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда 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 и цветовая шкала. В этом случае не используйте никакие из параметров осей.

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

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

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