matplotlib.pyplot.colorbar

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

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

Параметры

mappable

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

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

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

caxAxes, необязательно

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

axAxes, список осей, необязательно

Одна или несколько родительских осей, из которых будет взято место для новых осей цветовой шкалы, если cax равно None. Это не имеет эффекта, если cax задано.

use_gridspecbool, необязательно

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

Возвращает

colorbarColorbar

Примечания

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

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

locationNone или {'left', 'right', 'top', 'bottom'}

Положение, относительно родительских осей, где создаются оси цветовой шкалы. Оно также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа вертикальные, цветовые шкалы сверху и снизу горизонтальные). Если None, положение будет взято из orientation, если оно задано (вертикальные цветовые шкалы справа, горизонтальные внизу), или по умолчанию будет равно 'right', если orientation не задано.

orientationNone или {'vertical', 'horizontal'}

Ориентация цветовой шкалы. Лучше указать location цветовой шкалы, так как это также определяет orientation; передача несовместимых значений для location и orientation вызывает исключение.

fractionfloat, по умолчанию: 0.15

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

shrinkfloat, по умолчанию: 1.0

Доля, на которую нужно умножить размер цветовой шкалы.

aspectfloat, по умолчанию: 20

Соотношение длинных и коротких измерений.

padfloat, по умолчанию: 0.05, если вертикально, 0.15, если горизонтально

Доля исходных осей между цветовой шкалой и новыми осями изображения.

anchor(float, float), необязательно

Точка привязки осей цветовой шкалы. По умолчанию (0.0, 0.5) для вертикальной; (0.5, 1.0) для горизонтальной.

panchor(float, float) или False, необязательно

Точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей не изменится. По умолчанию (1.0, 0.5) для вертикальной; (0.5, 0.0) для горизонтальной.

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

Свойство	Описание
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	str Подпись на длинной оси цветовой шкалы.

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

Свойство	Описание
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).

Примеры использования matplotlib.pyplot.colorbar