Python アドインツールの作成—ヘルプ

アドインツールの作成

アドインツールの作成

ツールはボタンによく似ています。ただしツールでは、まずデスクトップアプリケーションの表示を使用したユーザによる操作が必要で、このユーザの操作に基づいてビジネスロジックが実行されます。たとえば、ArcMap の [拡大] ツールでは、表示を再描画して指定したエリアのマップコンテンツを拡大する前に、マップ上をクリックするか長方形をドラッグする必要があります。

このトピックでは、Python アドインウィザードを使用して新しいツールバーにツールを作成する方法を、手順に従って説明します。このワークフローを開始する前に、ArcMap のアドインプロジェクトを作成して、プロジェクト設定を指定していることを確認してください。詳細については、「アドインプロジェクトの作成」をご参照ください。このワークフローでは ArcMap のツールを作成する方法を説明しますが、他の ArcGIS for Desktop アプリケーションでも、同じ方法でツールを追加できます。このトピックでは、簡単な [フィッシュネットの作成] ツールを作成する方法を検証します。その後、アドインウィザードで作成された Python クラスを詳しく検証して、ツールに機能を提供するプロパティとメソッドを確認します。

アドインツールの作成する処理は、以下の手順で構成されます。

ツールバーを作成します。
[アドインのコンテンツ] タブをクリックし、アドインのカスタマイズを宣言します。ツールはツールバーに配置できますが、メニューには配置できません。独自のツールバーを作成する手順については、「アドインツールバーの作成」をご参照ください。

ツールを作成します。

新しいツールバーを右クリックして、[新規ツール] を選択します。

ツールには多くのプロパティを設定できます。以下のリストに、すべてのプロパティとその説明を示します。これらのプロパティは、プロジェクトの config.xml ファイルに格納されます。

プロパティ	説明
キャプション（必須）	ツールのキャプションを定義します。次の図は、ArcGIS アドインマネージャに表示されたキャプションを示しています。利用可能なカスタマイズのタイプを判断するのに役立ちます（アドインのタイプが括弧内に示されています）。次の図は、ツールバー上でツールを識別するためにテキストとして使用されているキャプションを示しています。
クラス（必須）	ツールを表す Python クラス。Python クラスは、ツールのビジネスロジックを書き込む場所です。このクラスは、デスクトップアプリケーションでツールをクリックするごとに実行されるため重要です。クラスを構築するときは、Python の命名規則を使用します。Python クラスでは、単語の先頭を大文字にする表記法を使用します。この例では、CreateFishnet というクラスを作成します。
ID（必須）	ツールを識別する一意の名前。1 つのプロジェクトに複数のツールを作成することができるため、この ID を使用して各ツールを区別します。デフォルトの ID を、意味のある値に置き換えると理想的です。ID にスペースを含めることはできません。単語を区切る場合はアンダースコアを使用してください。Python のキーワードも使用しないでください。予約語については、Python のドキュメントをご参照ください。
ツールチップ（オプション）	デスクトップアプリケーションでマウスポインタをツールの上に置いたときに表示される簡単な説明。
メッセージ（オプション）	ツールの動作についてのより詳しい説明。[ツールチップ] プロパティと同様に、メッセージはマウスポインタをツールの上に置いたときに、ツールチップと一緒に表示されます。
画像（オプション）	ツールのシンボル表示に使用する 16 x 16 ピクセルの画像です。指定できる画像形式は、.png、.gif、または *.bmp のいずれかです。画像は、アドインプロジェクトに作成された Images フォルダにコピーされます。

ツールの最後のセクションは、ヘルプの見出しとコンテンツについてです。これらのプロパティでは、ユーザがポップアップヘルプを呼び出したときに表示される情報を設定できます。これらはポップアップトピックとして表示され、ユーザが別の場所をクリックするまで画面上に表示されたままになります。

ポップアップヘルプのセクションは以下のプロパティで構成されます。

プロパティ	説明
見出し（オプション）	ヘルプコンテンツの要約を示します。
コンテンツ（オプション）	ツールのヘルプコンテンツ。

プロパティの入力が完了したら、ウィザードの下部にある [保存] をクリックします。必要なすべてのファイルとフォルダが、作業フォルダ内に作成されます。

Python スクリプトを編集して、ポリゴンのフィッシュネットを作成する機能を含むように Python クラスを更新します。

対象エリアは、マウスのドラッグで四角形を作成して定義します。フィッシュネットのサイズは 10 行 x 10 列に設定します。カスタムツールに機能を追加するには、以下の手順を実行します。

作業フォルダ内の Install フォルダにある、ウィザードが作成した Python スクリプトを編集します。
ウィザードで入力した名前と同じ名前のクラスが存在します。クラス名は config.xml で参照されているため、このクラス名は変更しないでください。クラスの各関数およびプロパティの詳細については、「Tool クラス」をご参照ください。

関数を以下に示すように更新します。

このコードは、ポリゴンのフィッシュネットを 10 行 x 10 列で作成する機能を提供します。

def __init__(self):
    self.enabled = True
    self.cursor = 3
    self.shape = 'Rectangle'
    
def onRectangle(self, rectangle_geometry):
    """Occurs when the rectangle is drawn and the mouse button is released.
    The rectangle is a extent object."""

    extent = rectangle_geometry
    # Create a fishnet with 10 rows and 10 columns.
    if arcpy.Exists(r'in_memory\fishnet'):
        arcpy.Delete_management(r'in_memory\fishnet')
    fishnet = arcpy.CreateFishnet_management(r'in_memory\fishnet',
                            '%f %f' %(extent.XMin, extent.YMin),
                            '%f %f' %(extent.XMin, extent.YMax),
                            0, 0, 10, 10,
                            '%f %f' %(extent.XMax, extent.YMax),'NO_LABELS',
                            '%f %f %f %f' %(extent.XMin, extent.YMin, extent.XMax, extent.YMax), 'POLYGON')
    arcpy.RefreshActiveView()
    return fishnet

スクリプトを保存します。

ツールをテストします。
ツールを作成してスクリプトコードを追加したら、アドインを共有する前に、アドインファイルを作成してテストすることが重要です。これらの手順については、「アドインのテスト」をご参照ください。
アドインを配備および共有します。
アドインの配備と共有の手順については、「アドインの共有とインストール」をご参照ください。

アドイン ツールの作成

関連トピック

アドインツールの作成