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 The `matplotlib.cm.ScalarMappable` (т.е., `Image`, `ContourSet` и т.д.) описываемое этой цветовой шкалой. Этот аргумент обязателен для метода `Figure.colorbar`, но необязателен для функции `pyplot.colorbar`, которая устанавливает значение по умолчанию для текущего изображения. Обратите внимание, что можно создать `ScalarMappable` "на лету", чтобы создать цветовые шкалы, не прикреплённые к ранее нарисованному объекту, например: fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax) `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 с использованием модуля `gridspec`.
Возвращаемое значение:	`colorbar : Colorbar` См. также его базовый класс `ColorbarBase`. Используйте `set_label`, чтобы добавить подпись к цветовой шкале.

mappable

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

Обратите внимание, что можно создать ScalarMappable "на лету", чтобы создать цветовые шкалы, не прикреплённые к ранее нарисованному объекту, например:

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

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 с использованием модуля gridspec.

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

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	[ 'neither' \| 'both' \| 'min' \| 'max' ] Если не 'neither', создайте остроконечные концы для значений за пределами диапазона. Они устанавливаются для данной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	[ None \| 'auto' \| length \| lengths ] Если установлено в None, оба минимальные и максимальные треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если установлено в 'auto', создаёт треугольные расширения цветовой шкалы с теми же длинами, что и внутренние прямоугольники (когда spacing установлено в 'uniform') или с теми же длинами, что и соответствующие смежные внутренние прямоугольники (когда spacing установлено в 'proportional'). Если скаляр, указывает длину как долю внутренней длины цветовой шкалы для обоих минимального и максимального треугольных расширений цветовой шкалы. Может быть задана последовательность из двух элементов дробей, указывающих длины минимального и максимального расширений цветовой шкалы, соответственно, как долю внутренней длины цветовой шкалы.
extendrect	bool Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	[ 'uniform' \| 'proportional' ] Равномерное распределение даёт каждому дискретному цвету одинаковое место; пропорциональное распределение делает место пропорциональным интервалу данных.
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 kwarg включается автоматически.

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

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

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

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

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