`matplotlib.legend_handler`#

デフォルトの凡例ハンドラー。

重要

これは、ほとんどのエンドユーザーが必要としない低レベルの凡例 API です。

このドキュメントを読む前に、レジェンドガイドをよく理解しておくことをお勧めします。

凡例ハンドラーは、次のシグネチャを持つ呼び出し可能なオブジェクトであることが期待されます。

legend_handler(legend, orig_handle, fontsize, handlebox)

ここで、 legendは凡例自体、orig_handleは元のプロット、fontsizeはピクセル単位のフォントサイズ、handleboxは OffsetBox インスタンスです。呼び出し内で、関連するアーティストを (凡例および/または orig_handleから関連するプロパティを使用して) 作成し、それらをハンドルボックスに追加する必要があります。アーティストは、フォントサイズに応じてスケーリングする必要があります (サイズはピクセル単位であることに注意してください。つまり、これは dpi スケーリングされた値です)。

このモジュールには、次のメソッドを持つ基本クラス (HandlerBase) から派生したいくつかの凡例ハンドラークラスの定義が含まれています。

def legend_artist(self, legend, orig_handle, fontsize, handlebox)

クラス matplotlib.legend_handler. HandlerBase ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [ソース] #

デフォルトの凡例ハンドラーの基本クラス。

派生クラスは、次のシグネチャを持つcreate_artistsメソッドをオーバーライドすることを目的としています。

def create_artists(self, legend, orig_handle,
                   xdescent, ydescent, width, height, fontsize,
                   trans):

オーバーライドされたメソッドは、必要に応じて fontsize によってスケーリングされる指定された寸法 (xdescent、ydescent、幅、高さ) に収まる、指定された変換のアーティストを作成する必要があります。

Adjust_drawing_area ( legend , orig_handle , xdescent , ydescent , width , height , fontsize ) [source] #

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

legend_artist ( legend , orig_handle , fontsize , handlebox ) [source] #

この HandlerBase が指定された元のアーティスト/ハンドルに対して生成するアーティストを返します。

パラメータ:

伝説Legend: これらのレジェンドアーティストが作成されているレジェンド。
orig_handlematplotlib.artist.Artistなど: これらのレジェンドアーティストが作成されるオブジェクト。
フォントサイズint: ピクセル単位のフォントサイズ。作成されるアーティストは、指定されたフォントサイズに従ってスケーリングする必要があります。
ハンドルボックスmatplotlib.offsetbox.OffsetBox: この伝説のエントリのアーティストを保持するために作成されたボックス。メソッドで作成されたアーティストは、legend_artistこのメソッド内のこのハンドルボックスに追加する必要があります。

update_prop ( legend_handle , orig_handle , legend ) [ソース] #

クラス matplotlib.legend_handler. HandlerCircleCollection ( yoffsets =なし,サイズ=なし, ** kwargs ) [ソース] #

s のハンドラCircleCollection。

パラメータ:

numpoints int: 凡例エントリに表示するポイントの数。
float のyoffsets配列: 凡例エントリの各ポイントの y オフセットの長さnumpointsリスト。
**kwargs: に転送されたキーワード引数HandlerNpoints。

create_collection ( orig_handle , size , offsets , offset_transform ) [source] #

クラス matplotlib.legend_handler. HandlerErrorbar ( xerr_size = 0.5 , yerr_size =なし, marker_pad = 0.3 , numpoints =なし, ** kwargs ) [source] #

エラーバーのハンドラー。

パラメータ:

marker_pad float: 凡例エントリのポイント間のパディング。
numpoints int: 凡例エントリに表示するポイントの数。
**kwargs: に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

get_err_size ( legend , xdescent , ydescent , width , height , fontsize ) [source] #

クラス matplotlib.legend_handler. HandlerLine2D ( marker_pad = 0.3 , numpoints =なし, ** kwargs ) [source] #

Line2Dインスタンスのハンドラー。

こちらもご覧ください

HandlerLine2DCompound: ラインに 1 つのアーティストを使用し、マーカーに別のアーティストを使用した、以前のハンドラーの実装。

パラメータ:

marker_pad float: 凡例エントリのポイント間のパディング。
numpoints int: 凡例エントリに表示するポイントの数。
**kwargs: に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

クラス matplotlib.legend_handler. HandlerLine2DCompound ( marker_pad = 0.3 , numpoints =なし, ** kwargs ) [source] #

Line2D線のみのアーティストとマーカーのみのアーティストの組み合わせに依存する、インスタンスの元のハンドラー。将来廃止される可能性があります。

パラメータ:

marker_pad float: 凡例エントリのポイント間のパディング。
numpoints int: 凡例エントリに表示するポイントの数。
**kwargs: に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

クラス matplotlib.legend_handler. HandlerLineCollection ( marker_pad = 0.3、 numpoints =なし、 ** kwargs ) [source] #

LineCollectionインスタンスのハンドラー。

パラメータ:

marker_pad float: 凡例エントリのポイント間のパディング。
numpoints int: 凡例エントリに表示するポイントの数。
**kwargs: に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

get_numpoints (凡例) [ソース] #

クラス matplotlib.legend_handler. HandlerNpoints ( marker_pad = 0.3 , numpoints =なし, ** kwargs ) [source] #

凡例エントリにnumpointsポイントを表示する凡例ハンドラー。

パラメータ:

marker_pad float: 凡例エントリのポイント間のパディング。
numpoints int: 凡例エントリに表示するポイントの数。
**kwargs: に転送されたキーワード引数HandlerBase。

get_numpoints (凡例) [ソース] #

get_xdata ( legend , xdescent , ydescent , width , height , fontsize ) [source] #

クラス matplotlib.legend_handler. HandlerNpointsYoffsets ( numpoints = None , yoffsets = None , ** kwargs ) [source] #

凡例にnumpointsを表示し、それらを y 方向に個別にオフセットできるようにする凡例ハンドラー。

パラメータ:

numpoints int: 凡例エントリに表示するポイントの数。
float のyoffsets配列: 凡例エントリの各ポイントの y オフセットの長さnumpointsリスト。
**kwargs: に転送されたキーワード引数HandlerNpoints。

get_ydata ( legend , xdescent , ydescent , width , height , fontsize ) [source] #

クラス matplotlib.legend_handler. HandlerPatch ( patch_func = None , ** kwargs ) [source] #

Patchインスタンスのハンドラー。

パラメータ:

patch_func呼び出し可能、オプション

凡例キーアーティストを作成する関数。 patch_funcには署名が必要です。

def patch_func(legend=legend, orig_handle=orig_handle,
               xdescent=xdescent, ydescent=ydescent,
               width=width, height=height, fontsize=fontsize)

その後、作成されたアーティストのupdate_prop メソッドが呼び出され、適切な変換が適用されます。

**kwargs

に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

クラス matplotlib.legend_handler. HandlerPathCollection ( yoffsets =なし,サイズ=なし, ** kwargs ) [ソース] #

PathCollectionによって使用されるのハンドラscatter。

パラメータ:

numpoints int: 凡例エントリに表示するポイントの数。
float のyoffsets配列: 凡例エントリの各ポイントの y オフセットの長さnumpointsリスト。
**kwargs: に転送されたキーワード引数HandlerNpoints。

create_collection ( orig_handle , size , offsets , offset_transform ) [source] #

クラス matplotlib.legend_handler. HandlerPolyCollection ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [ソース] #

およびでPolyCollection使用されるのハンドラ。fill_betweenstackplot

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

クラス matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets =なし,サイズ=なし, ** kwargs ) [ソース] #

s のハンドラRegularPolyCollection。

パラメータ:

numpoints int: 凡例エントリに表示するポイントの数。
float のyoffsets配列: 凡例エントリの各ポイントの y オフセットの長さnumpointsリスト。
**kwargs: に転送されたキーワード引数HandlerNpoints。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

create_collection ( orig_handle , size , offsets , offset_transform ) [source] #

get_numpoints (凡例) [ソース] #

get_sizes ( legend , orig_handle , xdescent , ydescent , width , height , fontsize ) [source] #

update_prop ( legend_handle , orig_handle , legend ) [ソース] #

クラス matplotlib.legend_handler. HandlerStem ( marker_pad = 0.3 , numpoints =なし, bottom =なし, yoffsets =なし, ** kwargs ) [source] #

によって生成されたプロットのハンドラstem。

パラメータ:

marker_pad float、デフォルト: 0.3: 凡例エントリのポイント間のパディング。
numpoints int、オプション: 凡例エントリに表示するポイントの数。
ボトムフロート、オプション
float のyoffsets配列、オプション: 凡例エントリの各ポイントの y オフセットの長さnumpointsリスト。
**kwargs: に転送されたキーワード引数HandlerNpointsYoffsets。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

get_ydata ( legend , xdescent , ydescent , width , height , fontsize ) [source] #

クラス matplotlib.legend_handler. HandlerStepPatch ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [ソース] #

StepPatchインスタンスのハンドラー。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

クラス matplotlib.legend_handler. HandlerTuple ( ndivide = 1 , pad = None , ** kwargs ) [source] #

タプルのハンドラー。

パラメータ:

ndivide int、デフォルト: 1: 凡例領域を分割するセクションの数。None の場合、入力タプルの長さを使用します。
パッドフロート、デフォルト: rcParams["legend.borderpad"](デフォルト: 0.4): フォントサイズの分数単位のパディング。
**kwargs: に転送されたキーワード引数HandlerBase。

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [source] #

matplotlib.legend_handler. update_from_first_child ( tgt , src ) [ソース] #

matplotlib.legend_handler#

`matplotlib.legend_handler`#