スクリプトでの出力シンボルの設定—ArcMap

スクリプトでのシンボルの設定と ToolValidator クラスでのシンボルの設定
サンプルスクリプト

スクリプトツールのパラメーターのシンボルプロパティを使用すると、単一のレイヤーファイル (*.lyrx) を出力パラメーターに関連付けることができます。スクリプトツールを実行すると、レイヤーファイルからのシンボルを使用して、出力がディスプレイに追加されます。また、スクリプトの symbology コードでシンボルプロパティを設定することもできます。

いずれの場合も、出力パラメーターに関連付けることができるレイヤーファイルは 1 つに限られます。出力が明確に定義されている場合は、1 つのレイヤーファイルだけで十分に機能します。ただし、出力が明確に定義されていない場合もあります。たとえば、出力が 1 つのフィーチャクラスであることがわかっていても、そのフィーチャクラスに含まれるのがポイント、ポリライン、ポリゴンフィーチャのいずれであるかが、ツールが実行されるまで不明な場合などです。レイヤーファイルはジオメトリタイプに依存しています。つまり、1 つのレイヤーファイルで複数のフィーチャタイプをシンボル表示することはできません。このような場合は、ジオメトリタイプごとに 1 つずつ、3 つのレイヤーファイルを用意し、出力ジオメトリタイプに基づいて正しいレイヤーファイルを関連付ける必要があります。次のコードスニペットは、この手法を具体的に示しています。

# Set the symbology of the output. 
output = self.params[1].value
if output:
    desc = arcpy.Describe(output)
    
    if desc.shapeType == "Polygon":
        self.params[2].symbology = "c:/Tools/Extractor/ToolData/polygon.lyr"
    elif desc.shapeType == "Polyline":
        self.params[2].symbology = "c:/Tools/Extractor/ToolData/polyline.lyr"
    else:
        self.params[2].symbology = "c:/Tools/Extractor/ToolData/point.lyr"

上記のスクリプトのロジックは比較的簡単で、ジオメトリ (シェープ) タイプをテストし、その結果に従ってレイヤーファイルを設定します。より複雑なロジックの場合でも、パターンはこれと同じです。

想定される各出力をシンボル表示するレイヤーファイルを作成します。
スクリプトのロジックに基づいて、使用されるレイヤーファイルを特定し、パラメーターのシンボルプロパティを使用してそのファイルの使用を設定します。

スクリプトでのシンボルの設定と ToolValidator クラスでのシンボルの設定

ToolValidator クラスでのツール整合チェックロジックのプログラミングに精通していれば、上記のコードスニペットを updateParameters メソッドに書き換えて使用できることがわかります。実際には、1 つのレイヤーファイルだけを参照する必要がある場合に、スクリプトツールのプロパティまたは initializeParameters メソッドのいずれかで設定を行います。しかし、複数のレイヤーファイルのうちのいずれかにシンボルを設定する必要がある場合は、スクリプトツールで設定してください。この種のロジックを ToolValidator クラスで設定すると、ツールの整合チェックと関係がないロジックによってコードが肥大化し、場合によっては、使用されるレイヤーファイルが、ツールが実行されるまでわからなくなることがあります。

サンプルスクリプト

次に示すスクリプトでは、ポートランド市の公園からの距離に基づいてフィーチャを作成します。入力フィーチャ、距離、および出力フィーチャという 3 つのパラメーターがあります。出力フィーチャは、マップ上で他のフィーチャと簡単に区別できるようにシンボル表示されます (区別しにくいデフォルトシンボル以外のシンボル)。入力フィーチャはポイント、ポリライン、またはポリゴンのいずれかであるため、3 つの異なるレイヤーファイルが必要とされます。

このスクリプトには、移植性を維持するためのコーディングテクニックも含まれています。使用されている移植性を持つテクニックは次のとおりです。

__file__ を使用して、スクリプトファイルへのフルパスを取得
Python の os モジュールを使用して、データへのパスを作成
CreateScratchName 関数を使用して、テンポラリフィーチャクラスを作成

# ExtractData.py
# Description: Script that will extract features from an input layer within a specified
#              distance from a park.
# Parameters:
#  0 - input features
#  1 - distance from parks (linear units)
#  2 - output feature class
import arcpy
import os
arcpy.env.overwriteOutput = True
try:
    # This tool uses a system folder with a Scripts and ToolData subfolder. 
    # You can discover the pathname of this folder using the Python __file__
    # attribute, which is the pathname to the script 
    # (example: 'E:\examples\symbology\scripts\ExtractData.py'.)  You
    # then use the toolSharePath variable to create paths to your 
    # shapefile data and layer files ('E:\examples\symbology\ToolData\points.lyr').
    scriptPath = __file__
    toolSharePath = os.path.dirname(os.path.dirname(scriptPath))
    dataPath = os.path.join(toolSharePath, 'ToolData')
    parkPath = os.path.join(dataPath, 'PortlandParks.shp')
    pointLyrPath = os.path.join(dataPath, 'point.lyr')
    polygonLyrPath = os.path.join(dataPath, 'polygon.lyr')
    polylineLyrPath = os.path.join(dataPath, 'polyline.lyr')
    
    # Buffer the parks by the specified distance.  The output is a scratch
    #  feature class in the same workspace as the output feature class
    arcpy.SetProgressorLabel('Buffering parks ...')
    scrname = arcpy.CreateScratchName('xxx', '', 'featureclass', 
                                      os.path.dirname(arcpy.GetParameterAsText(2)))
    arcpy.Buffer_analysis(parkPath, scrname, arcpy.GetParameterAsText(1))
    # Clip the defined layer with the buffered parks
    arcpy.SetProgressorLabel('Clipping {} ...'.format(arcpy.GetParameterAsText(0)))
    output = arcpy.Clip_analysis(arcpy.GetParameterAsText(0), scrname, 
                                 arcpy.GetParameterAsText(2))
    # Delete the intermediate dataset
    try:
        arcpy.Delete_management(scrname)
    except:
        pass
    # Set the symbology of the output. 
    params = arcpy.GetParameterInfo()
    desc = arcpy.Describe(output)
    if desc.shapeType == 'Polygon':
        params[2].symbology = polygonLyrPath
    elif desc.shapeType == 'Polyline':
        params[2].symbology = polylineLyrPath
    else:
        params[2].symbology = pointLyrPath
except Exception as err:
    arcpy.AddError('An error occurred: {}'.format(err))

スクリプトでのシンボルの設定と ToolValidator クラスでのシンボルの設定

サンプル スクリプト

サンプルスクリプト