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 не задан.

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

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 цветовой карты.

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 игнорируются.

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

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

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

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