tkplot_tkinter プログラム仕様
MatplotlibのプロットをTkinterアプリケーションに統合するためのユーティリティクラスを提供します。
このモジュールは、MatplotlibのFigureをTkinterウィンドウに埋め込み、表示を管理するための tkPlot_tkinter クラスを定義します。Matplotlibの基本的なプロット機能と、 TkinterベースのGUI操作を組み合わせることができます。
tkplot_tkinter.py ライブラリ ドキュメント
- class tklib.tkgraphic.tkplot_tkinter.tkPlot_tkinter(plt, parent=None, title=None)[ソース]
ベースクラス:
tkObjectMatplotlibのプロットをTkinterウィンドウに埋め込み、表示を管理するクラスです。
このクラスはtkObjectを継承し、MatplotlibのFigureをTkinterのキャンバスに表示するための 基本的な機能と、Matplotlibの主要な関数をラップするメソッドを提供します。 ユーザーは、このクラスを使ってMatplotlibのプロットをTkinterアプリケーションに シームレスに統合できます。
- add_canvas(fig=None, parent=None)[ソース]
MatplotlibのFigureをTkinterキャンバスに埋め込み、表示します。
指定されたFigureをTkinterウィンドウに配置し、Matplotlibのナビゲーションツールバーも追加します。 これにより、パン、ズーム、保存などのMatplotlib標準機能が利用可能になります。 このメソッドは、プロットの表示をセットアップする上で中心的な役割を果たします。
- パラメータ:
fig (matplotlib.figure.Figure or None) -- 埋め込むMatplotlibのFigureオブジェクト。Noneの場合、self.fig が使用されます。
parent (tkinter.Tk or tkinter.Widget or None) -- キャンバスを配置する親Tkinterウィジェット。Noneの場合、self.parent が使用されます。
- 戻り値:
作成されたFigureCanvasTkAggオブジェクト。
- 戻り値の型:
matplotlib.backends.backend_tkagg.FigureCanvasTkAgg
- add_toolbar()[ソース]
親ウィンドウにカスタムツールバーフレームを追加します。
このツールバーは、Tkinterウィジェットを追加するためのコンテナとして機能し、 ユーザーが独自のボタンやコントロールをプロットウィンドウに追加できるようにします。
- 戻り値:
なし
- 戻り値の型:
None
- add_toolbar_button(text, command=None)[ソース]
カスタムツールバーにボタンを追加します。
このボタンは、add_toolbar で作成されたフレームに配置されます。 command 引数を使用して、ボタンクリック時の動作を定義できます。
- パラメータ:
text (str) -- ボタンに表示するテキスト。
command (callable or None) -- ボタンがクリックされたときに実行される関数。 引数を取らない関数である必要があります。
- 戻り値:
作成されたTkinterボタンウィジェット。
- 戻り値の型:
tkinter.Button
- axes(*args, **kwargs)[ソース]
現在のFigureに新しいAxesを追加するか、既存のAxesを現在のAxesに設定します。
Matplotlibの plt.axes() をラップします。 これにより、特定の座標系（Axes）に対してプロットコマンドを実行できます。
- パラメータ:
args -- plt.axes() に渡される位置引数。
kwargs -- plt.axes() に渡されるキーワード引数。
- 戻り値:
作成または設定されたAxesオブジェクト。
- 戻り値の型:
matplotlib.axes.Axes
- create_window(fig)[ソース]
プロット表示用のウィンドウをセットアップします。
現在はツールバーの追加のみを行います。将来的にウィンドウの構成要素を追加する際に使用されます。
- パラメータ:
fig (matplotlib.figure.Figure) -- 表示するMatplotlibのFigureオブジェクト。
- 戻り値:
なし
- 戻り値の型:
None
- draw()[ソース]
プロットを再描画します。
内部的には update メソッドを呼び出します。 これは、Matplotlibの plt.draw() に相当する機能を提供し、 キャンバスの内容を更新します。
- 戻り値:
なし
- 戻り値の型:
None
- get_current_fig_manager()[ソース]
Matplotlibの現在のFigureManagerを取得します。
このマネージャーは、Figureのウィンドウやイベントハンドリングを管理します。
- 戻り値:
現在のFigureManagerオブジェクト。
- 戻り値の型:
matplotlib.backend_bases.FigureManagerBase
- legend(ax, line_inf_list=None, draggable=True, **kwargs)[ソース]
指定されたAxesに凡例を追加します。
line_inf_list が指定された場合、その情報に基づいて凡例を作成します。 凡例はドラッグ可能に設定することができます。 このメソッドは、Matplotlibの ax.legend() 機能を拡張します。
- パラメータ:
ax (matplotlib.axes.Axes) -- 凡例を追加するAxesオブジェクト。
line_inf_list (list[list[matplotlib.lines.Line2D]] or None) -- 凡例に表示するラインオブジェクトのリストのリスト。sum() で結合されます。 Noneの場合、ax.legend() のデフォルトの動作に従います（自動的に検出可能なハンドルを使用）。
draggable (bool) -- 凡例をマウスでドラッグ可能にするかどうか。Trueの場合、凡例を自由に移動できます。
kwargs -- ax.legend() に渡される追加のキーワード引数（例: loc, ncol, fontsize）。
- 戻り値:
作成された凡例オブジェクト。
- 戻り値の型:
matplotlib.legend.Legend
- pause(t)[ソース]
プロットを更新し、指定された時間だけ一時停止します。
このメソッドは、アニメーションや逐次的なプロット更新において、 各フレーム間の間隔を設けるのに役立ちます。
- パラメータ:
t (float) -- 一時停止する時間（秒）。
- 戻り値:
なし
- 戻り値の型:
None
- show()[ソース]
プロットを表示し、ウィンドウを更新します。
内部的には update メソッドを呼び出し、最新のプロット状態を反映させます。 これは、プロットの初期表示や、変更後の表示更新に使用されます。
- 戻り値:
なし
- 戻り値の型:
None
- subplots(ny, nx, figsize=(8, 6), dpi=100, tight_layout=True, **kwargs)[ソース]
複数のサブプロットを持つFigureを作成します。
指定された行数(ny)と列数(nx)に基づいてサブプロットを配置し、それらを内部リストに格納します。 作成されたFigureとAxesのリストを返します。 tight_layout がTrueの場合、制約付きレイアウトが有効になり、サブプロットの配置が自動調整されます。
- パラメータ:
- 戻り値:
(Figureオブジェクト, Axesオブジェクトのリスト) のタプル。
- 戻り値の型:
- subplots_adjust(**kwargs)[ソース]
サブプロットのレイアウトパラメータを手動で調整します。
Matplotlibの plt.subplots_adjust() をラップします。 サブプロット間のスペースや余白を細かく制御したい場合に使用します。
- パラメータ:
kwargs -- plt.subplots_adjust() に渡される追加のキーワード引数（例: left, right, bottom, top, wspace, hspace）。
- 戻り値:
なし
- 戻り値の型:
None