Jede Werkzeugseite in der ArcGIS Pro-Werkzeugreferenz weist dieselbe Struktur auf. Wenn Sie mit der Struktur vertraut sind, können Sie jedes Werkzeug mühelos verwenden.
Elemente einer Werkzeugreferenzseite
Unabhängig davon, ob Sie nach einer Werkzeugseite suchen oder zu ihr navigieren, indem Sie deren Toolbox gefolgt von deren Toolset erweitern und deren Seite laden, werden folgende Elemente angezeigt.
Zusammenfassung und Abbildung
Die Zusammenfassung ist eine kurze Beschreibung zur Funktionsweise des Werkzeugs. Sie kann Links zu ausführlicheren Informationen zur Funktionsweise des Werkzeugs enthalten. In einigen Fällen folgt eine Abbildung auf die Zusammenfassung, anhand derer die Funktionsweise des Werkzeugs ebenfalls erläutert wird.
Verwendung
Der Abschnitt "Verwendung" enthält Hinweise und Erklärungen zur Verwendung des Werkzeugs. Wenn sich die Hinweise auf einen bestimmten Parameter beziehen, wird die Parameterbeschriftung, die im Werkzeugdialogfeld angezeigt wird, verwendet und nicht der Parametername, der in der Syntax angezeigt und in Python genutzt wird. Der Zusammenhang zwischen Parameterbeschriftung und dem -namen ist normalerweise offensichtlich; in einigen Fällen wird jedoch der Name angegeben, um Verwechslungen zu vermeiden.
Syntax (enthält eine Parameterliste)
Der Abschnitt "Syntax" enthält das Format und den Satz von Parametern, die zum Ausführen des Werkzeugs in Python erforderlich sind. Im Anschluss daran finden Sie eine Tabelle, in der alle Parameter mit ihren Namen, Erklärungen und Datentypen aufgeführt sind. Eine detaillierte Erläuterung dieses Abschnitts einer Werkzeugreferenzseite finden Sie unter Werkzeugsyntax.
Codebeispiel
Der Abschnitt "Codebeispiel" umfasst mindestens ein Beispiel, in dem die Ausführung und Verwendung des Werkzeugs in Python veranschaulicht wird.
Umgebungen
Der Abschnitt "Umgebungen" ist eine Liste der Umgebungseinstellungen, die vom Werkzeug berücksichtigt werden. Klicken Sie auf einen beliebigen Link in der Liste, um die entsprechende Referenzseite aufzurufen. Wenn eine bestimmte Umgebungseinstellung für das Werkzeug eine besondere Bedeutung hat, werden möglicherweise weitere Informationen zu dieser Einstellung angeführt.
Lizenzinformationen
Der Abschnitt "Lizenzierungsinformationen" enthält Details dazu, ob das Werkzeug in bestimmten Lizenzierungsstufen ausgeführt wird, und enthält Hinweise dazu, ob eine Erweiterung erforderlich ist. ArcGIS for Desktop Basic: Ja bedeutet beispielsweise, dass das Werkzeug mit einer ArcGIS Desktop Basic-Lizenz ausgeführt wird, wohingegen ArcGIS for Desktop Basic: 3D Analyst erforderlich bedeutet, dass es nur dann ausgeführt wird, wenn die 3D Analyst-Erweiterung mit der ArcGIS Desktop Basic-Lizenz verwendet wird.
Werkzeugsyntax
Der Abschnitt "Syntax" einer Werkzeugreferenzseite enthält Details zu jedem Werkzeugparameter. Er stellt auch die Syntax zur Verwendung des Werkzeugs in Python bereit.
Werkzeugname und -aliasname
Die erste Zeile unter der Überschrift "Syntax" enthält die Werkzeugsignatur. Für Python wird anstelle der Beschriftung der Name des Werkzeugs verwendet.
- Die Werkzeugbeschriftung wird am oberen Rand des Werkzeugdialogfeldes angezeigt.
- In Python wird der Toolbox-Aliasname hinter dem Werkzeugnamen angegeben (durch einen Unterstrich getrennt). Beispiel: In Python wird das Werkzeug Symmetrische Differenz SymDiff_analysis angegeben.
Parametertabelle
Der Werkzeugsignatur folgt die Parametertabelle mit drei Spalten: Parameter, Erläuterung und Datentyp. Die Zeilen in der Parametertabelle entsprechen immer der Parameterreihenfolge (wie bei der Werkzeugsignatur).
Hinweis:
In der Parameterhilfe in den Themen für Geoverarbeitungswerkzeuge werden Parameter häufig im Kontext von Python beschrieben. Dies gilt besonders für Boolesche Parameter und Zeichenfolge-Parameter mit Schlagwörtern. Die Parameterhilfe zur Nutzung des Werkzeugs über das Werkzeugdialogfeld wird angezeigt, indem Sie mit der Maus auf die Informationsschaltfläche 
neben dem Parameter zeigen.
In einem Werkzeugdialogfeld können Parameter in einer anderen Reihenfolge als der tatsächlichen Parameterreihenfolge angezeigt werden. Das heißt, in seltenen Fällen entspricht die Reihenfolge der Parameter im Dialogfeld des Werkzeugs möglicherweise nicht der Reihenfolge in der Parametertabelle. Verwenden Sie für Python immer die Reihenfolge in der Parametertabelle.
Werkzeugparameter können erforderlich oder optional sein. Auf optionale Parameter folgt im Dialogfeld des Werkzeugs die Angabe "(optional)".
| Parametertyp | Beschreibung |
|---|---|
Erforderlich | Für erforderliche Parameter müssen Sie Werte angeben. Diese Parameter sind stets die ersten Parameter im Befehl. |
Optional | Diese Parameter stehen stets hinter den erforderlichen Parametern. Wenn Sie keinen Wert für einen optionalen Parameter angeben, wird der Standardwert berechnet und verwendet. Der Standardwert wird in der Spalte "Erläuterung" beschrieben. |
Optionale Parameternamen können in Python hilfreich sein, um Befehle abzukürzen. Statt andere nicht verwendete optionale Parameter mit leeren Anführungszeichen ("") oder einem Nummernzeichen ("#") zu überspringen, kann der Parameter explizit mit dem Parameternamen festgelegt werden.
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)Parameternamen im Vergleich zu Parameterbeschriftungen
Die Parameterbeschriftung wird im Dialogfeld des Werkzeugs verwendet. Der Parametername wird in der Parametertabelle verwendet. Die Beziehung zwischen der Parameterbeschriftung und dem Namen ist normalerweise offensichtlich; in einigen Fällen wird jedoch der Parametername angegeben, um Verwechslungen zu vermeiden.
Parameter, die Listen akzeptieren
Die Syntax der Liste von Parametern, die eine Werteliste akzeptieren, folgt dem Parameternamen, wie unten dargestellt.
| Darstellung | Beschreibung |
|---|---|
| Einfache Liste: Einfache Listen sind MultiValue-Parameter. |
| Liste aus Listen: Der Datentyp ist "Value Table". |
Eine einfache Liste enthält eine Liste einzelner Werte. Im Beispiel oben weist der Parameter Distances den Datentyp "Double" auf (in der Spalte "Datentyp"). Sie können diese Liste mit einer der folgenden Methoden bezeichnen:
# Method 1: A list of numbers dist = [10.0, 20.0, 30.0]
# Method 2: A list of strings dist = ["10.0", "20.0", "30.0"]
# Method 3: String representation of a list dist = "10.0; 20.0; 30.0"Der Datentyp einer Liste aus Listen ist "Value Table". Im Beispiel oben ist der Parameter in_features eine Liste aus Listen, in der eine einzelne Liste den Pfad zu einem Feature-Dataset oder einem Layer und einer optionalen Ganzzahlrangstufe enthält. Sie können diesen Parameter mit einer der folgenden Methoden bezeichnen:
# Method 1: A list of lists inFeatures = [["counties", 2], ["parcels", 1], ["state"]]
# Method 2: A list of strings inFeatures = ["counties 2", "parcels 1", "state"]
# Method 3: String representation, each list separated by a semicolon inFeatures = "counties 2; parcels 1; state"Spalte "Erläuterung"
Diese Spalte stellt weitere Informationen zur Verwendung und Einstellung eines Parameters bereit, einschließlich Schlüsselwortoptionen.
Schlüsselwörter sind Zeichenfolgen. Beim Aufrufen des Werkzeugs werden sie immer in Anführungszeichen gesetzt. Das Werkzeug Feld hinzufügen umfasst z. B. Schlüsselwörter für den folgenden Feldtyp:# Add a field named IDField with data type of long
arcpy.AddField_management("Parks", "IDField", "LONG", field_is_nullable="NULLABLE",
field_is_required="NON_REQUIRED")
Datentyp
Jedem Werkzeugparameter ist ein Datentyp zugewiesen.Einige einfache Datentypen sind Zeichenfolgen (eine beliebige alphanumerische Zeichenkette), boolesche Variablen (wahr oder falsch) und ganze Zahlen (Ganzzahlwerte zwischen -2.147.483.648 und 2.147.483.647). Darüber hinaus gibt es noch viele weitere spezielle Datentypen für die Daten in ArcGIS, beispielsweise "Koordinatensystem" und "Ausdehnung".
Abgeleitete Ausgabe
Abgeleitete Parameter sind Ausgabe-Parameter, die nicht als Werte im Dialogfeld eines Werkzeugs oder als Argumente in Python eingegeben werden. Werkzeuge haben in folgenden Fällen abgeleitete Ausgaben:
- Das Werkzeug berechnet einen Wert, der von dem Werkzeug ausgegeben wird, wie z. B. das Werkzeug Anzahl erhalten, mit dem die Anzahl von Datensätzen in einer Tabelle ermittelt wird.
- Das Werkzeug ändert Eingabe-Datasets, wie z. B. das Werkzeug Feld berechnen, mit dem Feldwerte geändert werden.
- Ausgabe-Datasets, deren Name oder Position anhand von Eingabe-Parametern oder anderen bekannten Positionen ermittelt wird, wie das Werkzeug Feature-Class in Feature-Class, mit dem der Ausgabepfad anhand der Parameter für Workspace und Name der Feature-Class ermittelt wird.
Verwenden von Objekten zur Skripterstellung
Werkzeugparameter werden normalerweise mit einfachen Textzeichenfolgen definiert. Dataset-Namen, Pfade, Schlüsselwörter, Feldnamen, Toleranzen und Domänennamen können mit einer Zeichenfolge in Anführungszeichen angegeben werden.
Einige Parameter sind mithilfe von einfachen Zeichenfolgen jedoch schwieriger zu definieren, da es sich hierbei um komplexere Parameter handelt, die viele Eigenschaften erfordern. Anstatt diese Parameter mit langen, komplizierten Textzeichenfolgen zu definieren, können Sie Klassen verwenden (z. B. SpatialReference, ValueTable und Point-Klassen). Die Dokumentation jedes Werkzeugs enthält ein Skriptbeispiel, in dem beschrieben wird, wie die einzelnen Werkzeugparameter definiert und verwendet werden.
Im folgenden Beispiel wird ein SpatialReference-Objekt erstellt und zum Definieren des Ausgabe-Koordinatensystems einer Feature-Class verwendet, die mit dem Werkzeug Feature-Class erstellen erstellt wurde.
import arcpy
inputWorkspace = "c:/temp"
outputName = "rivers.shp"
prjFile = "c:/projections/North America Equidistant Conic.prj"
spatialRef = arcpy.SpatialReference(prjFile)
# Run CreateFeatureclass using the spatial reference object
arcpy.CreateFeatureclass_management(inputWorkspace, outputName, "POLYLINE",
"", "", "", spatialRef)Bei vielen Workflows der Geoverarbeitung möchten Sie eventuell bestimmte Vorgänge mit Koordinaten- und Geometriedaten ausführen, jedoch keine (temporäre) Feature-Class erstellen, diese mit Cursorn füllen, die Feature-Class verwenden und dann die vorläufige Feature-Class wieder löschen. Sie können anstelle von Eingabe und Ausgabe auch Geometrieobjekte verwenden und so die Geoverarbeitung vereinfachen. Geometrieobjekte können von Grund auf neu mit Multipoint-, PointGeometry-, Polygon- oder Polyline-Classes erstellt werden.