matplotlib.pyplot.colorbar

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

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

Параметры:

mappable

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

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

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

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

Оси, на которые будет нарисована шкала цвета. Если None, то создаются новые оси, и место для них будет взято из осей, указанных в ax.

axAxes или итерируемый объект или numpy.ndarray осей, необязательно

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

По умолчанию используется ось, содержащая используемый для создания шкалы цвета mappable.

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

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

Возвращает:

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'). Эти значения устанавливаются для данной цветовой палитры с помощью методов set_under и set_over colormap.

extendfrac{None, 'auto', length, lengths}

Если установлено как None, длины треугольных расширений шкалы цвета для минимальных и максимальных значений будут составлять 5% от длины внутренней шкалы цвета (это значение по умолчанию).

Если установлено как 'auto', длины треугольных расширений шкалы цвета будут такими же, как у внутренних прямоугольников (если spacing установлен в 'uniform') или такими же, как у соседних внутренних прямоугольников (если spacing установлен в 'proportional').

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

extendrectbool

Если False, минимальные и максимальные расширения шкалы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.

spacing{'uniform', 'proportional'}

Для дискретных шкал цвета (BoundaryNorm или контуров), 'uniform' дает каждому цвету одинаковое пространство; 'proportional' делает пространство пропорциональным интервалу данных.

ticksNone или список из меток или Locator

Если None, метки определяются автоматически из входных данных.

formatNone или str или Formatter

Если None, используется ScalarFormatter. Поддерживаются строковые форматы, например, "%4.2e" или "{x:.2e}". Вместо этого может быть передан альтернативный Formatter.

drawedgesbool

Определяет, нужно ли рисовать линии на границах цветов.

labelstr

Метка по длинной оси шкалы цвета.

boundaries, valuesNone или последовательность

Если не установлено, цветовая палитра будет отображаться в масштабе от 0 до 1. Если последовательности, values должны иметь длину на 1 меньше, чем boundaries. Для каждого участка, ограниченного соседними значениями в boundaries, используется цвет, сопоставленный соответствующему значению в values. Обычно используется только для индексированных цветов (т.е. norm=NoNorm()) или других необычных случаев.

Примечания

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

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

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

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

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

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