matplotlib.pyplot.colorbar #
- matplotlib.pyplot. colorbar ( mappable = None , cax = None , ax = None , ** kwargs ) [source] #
カラーバーをプロットに追加します。
- パラメータ:
- マッピング可能
このカラーバーによって記述される
matplotlib.cm.ScalarMappable
(つまり、AxesImage
、 など)。ContourSet
この引数は、メソッドでは必須ですが、現在のイメージにデフォルトを設定する関数ではFigure.colorbar
オプションです 。pyplot.colorbar
ScalarMappable
「オンザフライ」を作成して、以前に描画されたアーティストに関連付けられていないカラーバーを生成できることに注意してください。fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
- cax
Axes
、オプション カラーバーが描画される軸。
- ax
Axes
、軸のリスト、オプション caxが Noneの場合、新しいカラーバー軸のスペースが奪われる 1 つ以上の親軸。caxが設定されている場合、これは効果がありません。
- use_gridspec bool、オプション
caxがの場合
None
、新しいcaxが Axes のインスタンスとして作成されます。axが Subplot のインスタンスで、use_gridspecが の場合True
、caxはモジュールを使用して Subplot のインスタンスとして作成されgridspec
ます。
- 戻り値:
- カラーバー
Colorbar
- カラーバー
- その他のパラメータ:
- location None または {'left', 'right', 'top', 'bottom'}
カラーバー軸が作成される、親軸に対する相対的な位置。また、カラーバーの方向も決定します (左右のカラーバーは垂直、上下のカラーバーは水平)。None の場合、位置は、 設定されている場合は方向から取得されます (垂直カラーバーが右側に、水平カラーバーが下部にある)、または方向が設定されていない場合はデフォルトで「右」になります。
- 向きNone または {'vertical', 'horizontal'}
カラーバーの向き。カラーバーの位置を設定することをお勧めします。これにより、方向 も決定されます。位置と向きに互換性のない値を渡すと、例外が発生します。
- 分数浮動小数点数、デフォルト: 0.15
カラーバーに使用する元の軸の割合。
- 縮小フロート、デフォルト: 1.0
カラーバーのサイズに掛ける分数。
- アスペクトフロート、デフォルト: 20
長い寸法と短い寸法の比率。
- パッドフロート、デフォルト: 垂直の場合は 0.05、水平の場合は 0.15
カラーバーと新しいイメージ軸の間の元の軸の割合。
- アンカー(フロート、フロート)、オプション
カラーバー軸のアンカー ポイント。垂直の場合、デフォルトは (0.0, 0.5) です。(0.5, 1.0) 水平の場合。
- panchor (float、float)、またはFalse、オプション
カラーバーの親軸のアンカー ポイント。Falseの場合、親軸のアンカーは変更されません。垂直の場合、デフォルトは (1.0, 0.5) です。(0.5, 0.0) 水平の場合。
- 拡張{'どちらでもない', '両方', '最小', '最大'}
範囲外の値には尖った端を作成します (「どちらでもない」場合を除く)。これらは、カラーマップの set_under および set_over メソッドを使用して、特定のカラーマップに対して設定されます。
- extendfrac {なし、「自動」、長さ、長さ}
Noneに設定すると、三角形のカラー バー拡張の最小値と最大値の両方が、内部カラー バーの長さの 5% になります (これが既定の設定です)。
'auto' に設定すると、三角形のカラー バーの拡張部分が内部ボックスと同じ長さ (間隔が 'uniform' に設定されている場合) またはそれぞれの隣接する内部ボックスと同じ長さ (間隔が 'proportional' に設定されている場合) になります。
スカラーの場合、三角形のカラー バー拡張の最小値と最大値の両方の長さを、内部カラー バーの長さの割合として示します。2 要素の分数列を指定することもできます。これは、最小および最大のカラー バー拡張の長さをそれぞれ内部カラー バーの長さの分数として示します。
- ブール値を拡張
Falseの場合、最小および最大のカラーバー拡張は三角形になります (デフォルト)。Trueの場合、拡張は長方形になります。
- 間隔{'uniform', 'proportional'}
個別のカラーバー (
BoundaryNorm
または等高線) の場合、'uniform' は各色に同じスペースを与えます。'proportional' は、スペースをデータ間隔に比例させます。- ticksなしまたは目盛りのリストまたはロケータ
None の場合、ティックは入力から自動的に決定されます。
- format None または str または Formatter
None の場合
ScalarFormatter
は使用されます。"%4.2e"
や などのフォーマット文字列"{x:.2e}"
がサポートされています。代わりに代替案Formatter
が提示される場合があります。- ドローエッジブール
色の境界に線を引くかどうか。
- ラベル文字列
カラーバーの長軸のラベル。
- 境界、値なしまたはシーケンス
設定されていない場合、カラーマップは 0 ~ 1 のスケールで表示されます。シーケンスの場合、値の長さは境界より 1 小さくなければなりません。境界内の隣接するエントリによって区切られた各領域に対して、値内の対応する値にマップされた色が使用されます。通常、インデックス付きの色 (つまり
norm=NoNorm()
) またはその他の異常な状況でのみ役立ちます。
ノート
mappableが の場合
ContourSet
、その拡張kwarg が自動的に含まれます。収縮kwarg は、軸に対してカラーバーをスケーリングする簡単な方法を提供します。caxが指定されている場合、カラーバーのサイズが決定され、シュリンクとアスペクトのkwargs は無視されることに注意してください。
より正確に制御するために、マップ可能オブジェクトとカラーバーが描画される軸オブジェクトの位置を手動で指定できます。この場合、軸プロパティ kwargs を使用しないでください。
一部のベクター グラフィックス ビューア (svg および pdf) では、カラーバーのセグメント間に白いギャップが表示されることが知られています。これは、Matplotlib ではなく、ビューアのバグによるものです。回避策として、セグメントを重ねてカラーバーをレンダリングできます。
cbar = colorbar() cbar.solids.set_edgecolor("face") draw()
ただし、これは、半透明の画像 (アルファ < 1) やカラーバーの拡張など、他の状況ではマイナスの結果をもたらします。したがって、この回避策はデフォルトでは使用されません (issue #1188 を参照)。