matplotlib.backend_tools

抽象基本クラスは、ツールのプリミティブを定義します。これらのツールは、matplotlib.backend_managers.ToolManager

ToolBase

シンプルなステートレス ツール

ToolToggleBase

ツールには 2 つの状態があり、同時にアクティブにできるトグル ツールは 1 つだけです。 matplotlib.backend_managers.ToolManager

クラス matplotlib.backend_tools. AxisScaleBase ( *引数, ** kwargs )

拠点:ToolToggleBase

線形と対数を切り替える基本ツール。

無効にする(イベント=なし)

トグル ツールを無効にします。

triggertoggledが True の場合にこのメソッドを呼び出します。

これは、さまざまな状況で発生する可能性があります。

• ツールバーのツール ボタンをクリックします。

• に電話しmatplotlib.backend_managers.ToolManager.trigger_toolます。

• 別のToolToggleBase派生ツールがトリガーされます (同じ からToolManager)。

enable (イベント=なし)

トグル ツールを有効にします。

triggertoggledが False の場合にこのメソッドを呼び出します。

トリガー(送信者、イベント、データ=なし)

呼び出しenableまたは値disableに基づいていtoggledます。

クラス matplotlib.backend_tools. ConfigureSubplotsBase ( toolmanager , name )

拠点:ToolBase

サブプロットを構成するための基本ツール。

description = 'サブプロットの構成

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

image = 'サブプロット'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. カーソル(値)

拠点:IntEnum

バックエンドに依存しないカーソル タイプ。

手= 2

MOVE = 4

POINTER = 1

RESIZE_HORIZONTAL = 6

RESIZE_VERTICAL = 7

SELECT_REGION = 3

WAIT = 5

クラス matplotlib.backend_tools. RubberbandBase ( toolmanager , name )

拠点:ToolBase

輪ゴムを描いて取り除きます。

draw_rubberband ( *データ)

輪ゴムを描きます。

このメソッドは、バックエンドごとに実装する必要があります。

remove_rubberband ( )

輪ゴムを外します。

このメソッドは、バックエンドごとに実装する必要があります。

トリガー(送信者、イベント、データ=なし)

呼び出しdraw_rubberbandまたはremove_rubberbandデータに基づく。

クラス matplotlib.backend_tools. SaveFigureBase ( toolmanager , name )

拠点:ToolBase

図形保存のベースツール。

プロパティ default_keymap

description = '図を保存'

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

画像= 'ファイル保存'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. SetCursorBase ( * args , ** kwargs )

拠点:ToolBase

inaxes 中に現在のカーソルに移動します。

ToolToggleBaseこのツールは、すべての派生ツール を追跡set_cursorし、ツールがトリガーされたときに呼び出します。

set_cursor (カーソル)

[非推奨] カーソルを設定します。

ノート

バージョン 3.5 以降非推奨:FigureCanvasBase.set_cursor代わりに使用してください。

set_figure (図)

クラス matplotlib.backend_tools. ToolBack ( toolmanager , name )

拠点:ViewsPositionsBase

ビュー制限スタックを上に戻します。

プロパティ default_keymap

description = '前のビューに戻る

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

image = '戻る'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. ToolBase ( toolmanager , name )

拠点:object

基本ツール クラス。

基本ツールは、メソッドのみを実装triggerするか、メソッドをまったく実装しません。ツールは によってインスタンス化されmatplotlib.backend_managers.ToolManagerます。

プロパティ キャンバス

このツールの影響を受ける Figure のキャンバス、または None。

default_keymap =なし

このツールに関連付けるキーマップ。

list[str]: keypress イベントが で発行されたときにこのツールをトリガーするキーのリストself.figure.canvas。この属性はインスタンスで検索されるため、プロパティにすることができることに注意してください (これは、インスタンス化時に rcParams をロードする組み込みツールなどで使用されます)。

説明=なし

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

破壊( )

[非推奨] ツールを破棄します。

このメソッドは によって呼び出されToolManager.remove_toolます。

ノート

バージョン 3.6 以降非推奨:代わりに tool_removed_event を使用してください。

プロパティ 図

このツールの影響を受ける Figure、または None。

画像=なし

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

プロパティ 名

ツール ID (str、ツール マネージャのツール間で一意である必要があります)。

set_figure (図)

プロパティ ツールマネージャー

このToolManagerツールを制御する 。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolCopyToClipboardBase ( toolmanager , name )

拠点:ToolBase

Figure をクリップボードにコピーするツール。

プロパティ default_keymap

description = 'キャンバスの図をクリップボードにコピー

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー( *引数, ** kwargs )

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolCursorPosition ( * args , ** kwargs )

拠点:ToolBase

現在のポインター位置を含むメッセージを送信します。

このツールはバックグラウンドで実行され、カーソルの位置を報告します。

send_message (イベント)

コールしmatplotlib.backend_managers.ToolManager.message_eventます。

set_figure (図)

クラス matplotlib.backend_tools. ToolForward ( toolmanager , name )

拠点:ViewsPositionsBase

ビュー リム スタックを前方に移動します。

プロパティ default_keymap

description = '次のビューに

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

image = '進む'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. ToolFullScreen ( toolmanager , name )

拠点:ToolBase

フルスクリーンを切り替えるツール。

プロパティ default_keymap

description = '全画面表示モードの切り替え'

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolGrid ( toolmanager , name )

拠点:ToolBase

Figure の主なグリッドを切り替えるツール。

プロパティ default_keymap

description = 'メジャーグリッドの切り替え

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolHelpBase ( toolmanager , name )

拠点:ToolBase

プロパティ default_keymap

description = '工具リスト、ショートカット、説明を印刷'

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

static format_shortcut ( key_sequence )

ショートカット文字列を rc config で使用される表記法から、ショートカットを表示するための標準的な表記法に変換します (例: 'ctrl+a' -> 'Ctrl+A')。

画像= 'ヘルプ'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. ToolHome ( toolmanager , name )

拠点:ViewsPositionsBase

元のビュー制限を復元します。

プロパティ default_keymap

description = '元のビューをリセット

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

画像= 'ホーム'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

クラス matplotlib.backend_tools. ToolMinorGrid ( toolmanager , name )

拠点:ToolBase

Figure のメジャー グリッドとマイナー グリッドを切り替えるツール。

プロパティ default_keymap

description = '主グリッドと副グリッドの切り替え

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolPan ( * args )

拠点:ZoomPanBase

左マウスで軸をパンし、右マウスでズームします。

カーソル= 4

ツールがアクティブなときに使用するカーソル。

プロパティ default_keymap

description = '左マウスで軸をパン、右マウスでズーム'

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

画像= '移動'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

radio_group = 'デフォルト'

「ラジオ」のようなツールをグループ化するための属性 (相互に排他的)。

strグループを識別するか、グループに属していない場合はNoneを指定します。

クラス matplotlib.backend_tools. ToolQuit ( toolmanager , name )

拠点:ToolBase

フィギュアマネージャーのdestroyメソッドを呼び出すツール。

プロパティ default_keymap

description = 'フィギュアを

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ToolQuitAll ( toolmanager , name )

拠点:ToolBase

フィギュアマネージャーのdestroyメソッドを呼び出すツール。

プロパティ default_keymap

description = 'すべての図を終了

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

matplotlib.backend_tools. ToolSetCursor

のエイリアスSetCursorBase

クラス matplotlib.backend_tools. ToolToggleBase ( *引数, ** kwargs )

拠点:ToolBase

切り替え可能なツール。

トリガーされるたびに、有効と無効が切り替わります。

パラメータ:

``*args``

ツールが使用する可変長引数。

``**kwargs``

toggled存在し、True の場合、Tool Arbitrary キーワード引数の初期状態を Tool によって消費されるように設定します。

カーソル=なし

ツールがアクティブなときに使用するカーソル。

default_toggled = False

トグル状態のデフォルト。

無効にする(イベント=なし)

トグル ツールを無効にします。

triggertoggledが True の場合にこのメソッドを呼び出します。

これは、さまざまな状況で発生する可能性があります。

• ツールバーのツール ボタンをクリックします。

• に電話しmatplotlib.backend_managers.ToolManager.trigger_toolます。

• 別のToolToggleBase派生ツールがトリガーされます (同じ からToolManager)。

enable (イベント=なし)

トグル ツールを有効にします。

triggertoggledが False の場合にこのメソッドを呼び出します。

radio_group =なし

「ラジオ」のようなツールをグループ化するための属性 (相互に排他的)。

strグループを識別するか、グループに属していない場合はNoneを指定します。

set_figure (図)

プロパティの トグル

切り替えられたツールの状態。

トリガー(送信者、イベント、データ=なし)

呼び出しenableまたは値disableに基づいていtoggledます。

クラス matplotlib.backend_tools. ToolViewsPositions ( * args , ** kwargs )

拠点:ToolBase

ビューと位置の変更を処理するための補助ツール。

バックグラウンドで実行され、図のビューと位置の履歴にアクセスする必要があるすべてのツールで使用される必要があります。

• ToolZoom

• ToolPan

• ToolHome

• ToolBack

• ToolForward

add_figure (図)

現在の Figure をビューと位置のスタックに追加します。

戻る( )

ビューと位置のスタックで 1 ステップ戻ります。

クリア(図)

軸スタックをリセットします。

フォワード( )

ビューと位置のスタックを 1 ステップ進めます。

ホーム( )

スタックから最初のビューと位置を呼び出します。

push_current (図=なし)

現在のビューの制限と位置をそれぞれのスタックにプッシュします。

update_home_views (図=なし)

self.home_viewsFigure に存在するすべての軸のエントリがあることを確認します。

update_view ( )

現在のスタック位置から各軸のビュー制限と位置を更新します。現在のスタック位置にない軸が Figure に存在する場合は、それらの軸のホーム ビュー制限を使用し、位置を更新しません。

クラス matplotlib.backend_tools. ToolXScale ( *引数, ** kwargs )

拠点:AxisScaleBase

X 軸の線形スケールと対数スケールを切り替えるツール。

プロパティ default_keymap

description = 'スケールX軸の切り替え

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

set_scale ( ax , scale )

クラス matplotlib.backend_tools. ToolYScale ( * args , ** kwargs )

拠点:AxisScaleBase

Y 軸の線形スケールと対数スケールを切り替えるツール。

プロパティ default_keymap

description = 'スケールY軸の切り替え

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

set_scale ( ax , scale )

クラス matplotlib.backend_tools. ToolZoom ( * args )

拠点:ZoomPanBase

長方形セレクターを使用してズームするためのツール。

カーソル= 3

ツールがアクティブなときに使用するカーソル。

プロパティ default_keymap

description = '長方形にズーム

ツールの説明。

str: ツールがツールバーに含まれている場合に使用されるツールチップ。

image = 'zoom_to_rect'

イメージのファイル名。

str: ツールバーで使用するイメージのファイル名。None の場合、名前はツールバー ボタンのラベルとして使用されます。

radio_group = 'デフォルト'

「ラジオ」のようなツールをグループ化するための属性 (相互に排他的)。

strグループを識別するか、グループに属していない場合はNoneを指定します。

クラス matplotlib.backend_tools. ViewsPositionsBase ( toolmanager , name )

拠点:ToolBase

ToolHome、ToolBackおよびの基本クラスToolForward。

トリガー(送信者、イベント、データ=なし)

このツールが使用されるときに呼び出されます。

このメソッドは によって呼び出されToolManager.trigger_toolます。

パラメータ:

イベントEvent

このツールが呼び出される原因となったキャンバス イベント。

送信者オブジェクト

ツールのトリガーを要求したオブジェクト。

データオブジェクト

追加データ。

クラス matplotlib.backend_tools. ZoomPanBase ( * args )

拠点:ToolToggleBase

ToolZoomとの基本クラスToolPan。

無効にする(イベント=なし)

キャンバスを解放し、プレス/リリース イベントを切断します。

enable (イベント=なし)

プレス/リリース イベントを接続し、キャンバスをロックします。

scroll_zoom (イベント)

トリガー(送信者、イベント、データ=なし)

呼び出しenableまたは値disableに基づいていtoggledます。

matplotlib.backend_tools. add_tools_to_container ( container , tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io ', ['save', 'help']]] )

複数のツールをコンテナーに追加します。

パラメータ:

コンテナコンテナ

backend_bases.ToolContainerBaseツールを追加するオブジェクト。

ツールリスト、オプション

ツールがグループ 1 に表示されるフォームにリストします。詳細については、を参照してください。[[group1, [tool1, tool2 ...]], [group2, [...]]][tool1, tool2, ...]backend_bases.ToolContainerBase.add_tool

matplotlib.backend_tools. add_tools_to_manager ( toolmanager , tools={'back': <class 'matplotlib.backend_tools.ToolBack'> , 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'> , 'cursor': <class 'matplotlib.backend_tools.SetCursorBase' > , 'forward': <class 'matplotlib.backend_tools.ToolForward'> , 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'> , 'grid': <class 'matplotlib.backend_tools.ToolGrid' 'matplotlib.backend_tools.ToolMinorGrid'> , 'help': <class 'matplotlib.backend_tools.ToolHelpBase'> , 'home': <class 'matplotlib.backend_tools.ToolHome'> , 'pan': <class 'matplotlib.backend_tools. ToolPan'> , 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'> , 'quit': <class 'matplotlib.backend_tools.ToolQuit'> , 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'> , '輪ゴム'： <class 'matplotlib.backend_tools.RubberbandBase'> , 'save': <class 'matplotlib.backend_tools.SaveFigureBase' > , ' subplots': <class 'matplotlib.backend_tools.ConfigureSubplotsBase'> , 'viewpos': < class ' matplotlib.backend_tools.ToolViewsPositions '> , 'xscale': <class 'matplotlib. backend_tools.ToolXScale'> , 'yscale': <class 'matplotlib.backend_tools.ToolYScale'> , 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>} )

に複数のツールを追加しますToolManager。

パラメータ:

ツールマネージャーbackend_managers.ToolManager

ツールが追加されるマネージャー。

ツール{str: class_like}、オプション

{name: tool} dict に追加するツール。詳細については、を参照 backend_managers.ToolManager.add_toolしてください。

matplotlib.backend_tools. カーソル

のエイリアスCursors