matplotlib.pyplot.colorbar

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

Добавление цветовой шкалы к графику.

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

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

аргументы:

mappable: объект отображения Image, ContourSet и т. д., к которому применяется цветовая шкала; этот аргумент обязателен для метода colorbar(), но необязателен для функции colorbar(), которая устанавливает значение по умолчанию для текущего изображения.

ключевые аргументы:

cax: None | объект осей, на котором будет отображаться цветовая шкала
ax: None | родительский объект осей, от которого будет «отщипываться» место для новых осей цветовой шкалы. Если задан список осей, все они будут изменены для размещения осей цветовой шкалы.
use_gridspec: False | Если cax равно None, создается новый объект cax как экземпляр Axes. Если ax является экземпляром Subplot, а use_gridspec равно True, cax создается как экземпляр Subplot с использованием модуля grid_spec.

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

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

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

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

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

Свойство

Описание

boundaries

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

values

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

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

Обратите внимание, что ключевой аргумент shrink предоставляет простой способ предотвратить, например, чтобы вертикальная цветовая шкала была выше осей объекта отображения, к которому она прикреплена; но это ручной метод, требующий некоторого проб и ошибок. Если цветовая шкала слишком высокая (или горизонтальная цветовая шкала слишком широкая), используйте меньшее значение shrink.

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

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

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

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