matplotlib.figure.SubFigure.colorbar

SubFigure.colorbar(mappable, cax=None, ax=None, use_gridspec=True, **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 создаётся как экземпляр оси. Если ax размещён с помощью subplotspec и use_gridspec True, тогда cax также размещается с помощью subplotspec.

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

colorbarColorbar

Другие параметры:

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

Положение, относительно родительской оси, где создаётся ось цветковой панели. Оно также определяет orientation цветковой панели (цветковые панели слева и справа вертикальные, сверху и снизу горизонтальные). Если 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 или строка или 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 и цветковая панель. В этом случае не используйте никакие параметры оси kwargs.

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

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

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

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

Подрисунки фигур

Подрисунки фигур