matplotlib.backend_managers#

クラス matplotlib.backend_managers. ToolEvent (名前送信者ツールデータ=なし) [ソース] #

拠点:object

ツール操作 (追加/削除) のイベント。

クラス matplotlib.backend_managers. ToolManager (=なし) [ソース] #

拠点:object

Figure でのユーザー インタラクション (キーの押下、ツールバーのクリックなど) によってトリガーされるアクションのマネージャー。

属性:
figureFigure

キャンバスを保持する図。

キープレスロックLockDraw

LockDrawcanvaskey_press_event がロックされているかどうかを知るオブジェクト。

メッセージロックLockDraw

LockDrawメッセージが書き込み可能かどうかを知るオブジェクト。

プロパティ active_toggle #

現在切り替え中のツール。

add_tool ( name , tool , * args , ** kwargs ) [source] #

にツールを追加しますToolManager

成功した場合、 がツールの名前tool_trigger_{name}で ある新しいイベントを追加します。ツールがトリガーされるたびにイベントが発生します。{name}

パラメータ:
名前文字列

ID として扱われるツールの名前は一意である必要があります。

ツールタイプ

追加するツールのクラス。サブクラスが現在のキャンバス クラスに登録されている場合は、代わりにサブクラスが使用されます。

こちらもご覧ください

matplotlib.backend_tools.ToolBase

ツールの基本クラス。

ノート

args と kwargs はツール コンストラクターに直接渡されます。

プロパティ キャンバス#

FigureManager が管理するキャンバス。

プロパティ 番号

キャンバスを保持する図。

get_tool ( name , warn = True ) [ソース] #

指定された名前のツール オブジェクトを返します。

便宜上、これはツール オブジェクトを通過させます。

パラメータ:
名前str またはToolBase

ツールの名前、またはツール自体。

warn bool、デフォルト: True

指定された名前のツールが存在しない場合に警告を発するかどうか。

戻り値:
ToolBaseまたはなし

指定された名前のツールが存在しない場合はツールまたは None。

get_tool_keymap (名前) [ソース] #

指定されたツールに関連付けられたキーマップを返します。

パラメータ:
名前文字列

ツールの名前。

戻り値:
str のリスト

ツールに関連付けられたキーのリスト。

message_event (メッセージ送信者=なし) [ソース] #

を発行しToolManagerMessageEventます。

remove_tool (名前) [ソース] #

name という名前のツールを削除します。

パラメータ:
名前文字列

ツールの名前。

set_figure ( figure , update_tools = True ) [ソース] #

指定された図をツールにバインドします。

パラメータ:
Figure
update_tools bool、デフォルト: True

ツールに Figure の更新を強制します。

toolmanager_connect ( s , func ) [ソース] #

イベントを文字列sfuncに接続します。

パラメータ:
s str

イベントの名前。次のイベントが認識されます。

  • 「ツール_メッセージ_イベント」

  • 「tool_removed_event」

  • 'tool_added_event'

ツールが追加されるたびに、新しいイベントが作成されます

  • 「tool_trigger_TOOLNAME」。TOOLNAME はツールの ID です。

関数呼び出し可能

署名付きの toolmanager イベントのコールバック関数:

def func(event: ToolEvent) -> Any
戻り値:
シド

接続のコールバック ID。これは で使用できます toolmanager_disconnect

toolmanager_disconnect ( cid ) [ソース] #

コールバック ID cidを切断します。

使用例:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
プロパティ ツール#

ディクテーション マッピング ツール名 -> 制御ツール。

trigger_tool ( name , sender = None , canvasevent = None , data = None ) [source] #

ツールをトリガーし、tool_trigger_{name}イベントを発行します。

パラメータ:
名前文字列

ツールの名前。

送信者オブジェクト

ツールをトリガーしたいオブジェクト。

canvaseventイベント

元のキャンバス イベントまたはなし。

データオブジェクト

トリガー時にツールに渡す追加データ。

update_keymap (名前キー) [ソース] #

指定したツールに関連付けるキーマップを設定します。

パラメータ:
名前文字列

ツールの名前。

キーstr または str のリスト

ツールに関連付けるキー。

クラス matplotlib.backend_managers. ToolManagerMessageEvent (名前送信者メッセージ) [ソース] #

拠点:object

toolmanager からのメッセージを運ぶイベント。

メッセージは通常、ツールバーによってユーザーに表示されます。

クラス matplotlib.backend_managers. ToolTriggerEvent ( name , sender , tool , canvasevent = None , data = None ) [source] #

拠点:ToolEvent

ツールがトリガーされたことを通知するイベント。