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	[ '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 \| список меток \| объект 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 и цветовая шкала. В этом случае не используйте параметры системы координат.

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

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

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