Skip To Content

Anatomie de la page de référence d'un outil

La page de chaque outil dans la rubrique Référence des outils ArcGIS Pro respecte la même structure. Apprenez à connaître la structure et vous serez en mesure d'utiliser n'importe quel outil facilement.

Eléments de la page de référence d'un outil

Que vous recherchiez une page d'outil ou que vous y accédiez en développant sa boîte à outils, puis son jeu d'outils, puis cliquiez pour charger sa page, voici ce que vous y trouverez.

Résumé et illustration

Le résumé est une brève description des fonctions de l'outil. Il peut contenir des liens vers des descriptions plus approfondies du fonctionnement de l'outil. Dans d'autres cas, le résumé est suivi d'une illustration qui explique les fonctions de l'outil.

Utilisation

La section Utilisation contient des remarques et des clarifications cruciales concernant l'utilisation de l'outil. Lorsque les remarques font référence à un paramètre particulier, l'étiquette du paramètre (qui apparaît dans la boîte de dialogue de l'outil) est utilisée plutôt que le nom du paramètre (qui apparaît dans la syntaxe et est utilisé dans Python). La relation entre l'étiquette et le nom du paramètre est généralement évidente, mais dans certains cas, le nom est indiqué pour éviter toute confusion.

Syntaxe (inclut la liste des paramètres)

La section Syntaxe indique le format et l'ensemble des paramètres qui sont obligatoires pour exécuter l'outil dans Python. Vous trouverez à sa suite un tableau répertoriant tous les paramètres avec leurs noms, des explications et les types de données (valeur). Reportez-vous à la section Syntaxe d'outil décodée ci-dessous pour une explication détaillée de cette section de la page de référence d'un outil.

Exemple de code

La section Exemple de code comprend un ou plusieurs exemples illustrant le mode d'exécution et d'utilisation de l'outil dans Python.

Environnements

La section Environnements est une liste des paramètres d’environnement que l’outil respecte. Cliquez sur un lien de la liste pour accéder à sa page de référence. Si un paramètre d'environnement en particulier est important pour l'outil, des informations supplémentaires concernant ce paramètre peuvent être fournies.

Informations de licence

La section Informations de licence explique si l'outil s'exécute à des niveaux de licence en particulier et stipule si une extension est requise. Par exemple, ArcGIS for Desktop Basic : oui signifie que cet outil s'exécute avec une licence ArcGIS Desktop Basic, tandis que ArcGIS for Desktop Basic : requiert 3D Analyst signifie qu'il ne s'exécute que si l'extension 3D Analyst est utilisée avec la licence ArcGIS Desktop Basic.

Syntaxe d'outil décodée

La section Syntaxe de la page de référence d'un outil offre des informations sur chaque paramètre d'outil. Cela fournit également la syntaxe pour utiliser l’outil dans Python.

Nom et alias d'outil

La première ligne qui se trouve sous l'en-tête de la syntaxe contient la signature de l'outil. Dans Python, le nom de l'outil est utilisé à la place de l'étiquette de l'outil.

  • L'étiquette de l'outil apparaît en haut de la boîte de dialogue de l'outil.
  • Dans Python, l'alias de la boîte à outils suit le nom d'outil. Ils sont séparés par un trait de soulignement. Par exemple, dans Python, l'outil Différence symétrique est identifié sous la forme SymDiff_analysis.

Table des paramètres

La table des paramètres suit la signature de l'outil. Elle comporte trois colonnes : Paramètre, Explication et Type de données. Les lignes de la table des paramètres sont toujours dans l'ordre des paramètres (tout comme la signature de l'outil).

La boîte de dialogue d'un outil est capable d'afficher les paramètres dans un ordre différent de l'ordre des paramètres réels. Ainsi, dans de rares cas, l'ordre des paramètres dans la boîte de dialogue d'un outil peut être différent de l'ordre dans la table des paramètres. Pour Python, utilisez toujours l'ordre affiché dans la table des paramètres.

Les paramètres d'outil peuvent être soit obligatoires soit facultatifs. Les paramètres optionnels sont suivis par (en option) sur la boîte de dialogue de l’outil.

Type de paramètreDescription

Obligatoire

Vous devez fournir une valeur pour les paramètres obligatoires. Ces paramètres sont toujours les premiers paramètres de la commande.

Facultatif

Paramètre facultatif : ces paramètres suivent toujours les paramètres obligatoires. Si vous n'entrez pas de valeur pour un paramètre facultatif, la valeur par défaut est calculée et utilisée. La valeur par défaut doit être décrite dans la colonne Explication.

Paramètres obligatoires et facultatifs

Le nom des paramètres facultatifs peut être utile comme raccourci dans Python. Au lieu d'ignorer spécifiquement d'autres paramètres facultatifs non utilisés à l'aide d'un ensemble vide de guillemets ("") ou d'un symbole dièse ("#"), le paramètre peut être défini explicitement à l'aide de son nom.

# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)

Nom de paramètre et étiquette

Une étiquette de paramètre est ce que vous voyez dans la boîte de dialogue de l'outil. Un nom de paramètre est ce que vous voyez dans la table des paramètres. En général, la correspondance entre l'étiquette et le nom du paramètre est évidente, mais dans certains cas, le nom du paramètre est indiqué pour éviter toute confusion.

Paramètres qui acceptent les listes

Pour les paramètres qui acceptent une liste de valeurs, la syntaxe de la liste se trouve après le nom du paramètre, comme illustré ci-dessous.

ApparenceDescription

Liste simple

Liste simple ; les listes simples sont connues comme paramètres multi-valeurs.

Table de valeurs

Liste de listes. Le type de données est Table de valeurs.

Une liste simple contient une liste de valeurs uniques. Dans l'exemple ci-dessus, le type de données du paramètre Distances (affiché dans la colonne Type de données) est Double. Vous pouvez exprimer cette liste à l'aide de l'une des méthodes suivantes :

# 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"

Le type de données d'une liste de listes est Table de valeurs. Dans l'exemple ci-dessus, le paramètre in_features est une liste de listes où une liste individuelle contient le chemin d'accès à un jeu de classes d'entités ou une couche et un classement d'entiers facultatif. Vous pouvez exprimer ce paramètre à l'aide de l'une des méthodes suivantes :

# 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"

Colonne Explication

Les cellules de cette colonne offre des informations complémentaires concernant le rôle d'un paramètre et son mode de configuration, notamment des options de mots-clés.

Les mots clés sont des chaînes ; ils sont toujours entourés de guillemets lors de l’appel de l’outil. Par exemple, l'outil Ajouter un champ possède des mots-clés pour le type de champ suivant :

# Add field idField with data type of long
arcpy.AddField_management("Parks", "idField", "LONG", field_is_nullable="NULLABLE", field_is_required="NON_REQUIRED")

Type de données

Tous les paramètres d'outil disposent d'un type de données associé. Certains types de données simples sont des chaînes (n'importe quel ensemble de caractères alphanumériques), booléens (valeur vraie ou fausse) et longs (valeur entière comprise entre -2 147 483 648 et 2 147 483 647). En plus de ces types de données simples, des dizaines d'autres types de données sont créés spécifiquement pour les données existant dans ArcGIS, comme le système de coordonnées et l'étendue.

Utilisation des objets de script

Les paramètres d'un outil sont généralement définis à l'aide de simples chaînes de texte. Vous pouvez spécifier les noms de jeux de données, les chemins, les mots-clés, les noms de champs, les tolérances et les noms de domaines à l'aide d'une chaîne entre guillemets.

Certains paramètres sont plus difficiles à définir à l'aide de chaînes simples ; ils sont plus complexes et nécessitent de nombreuses propriétés. Au lieu d'utiliser des chaînes de texte longues et compliquées pour définir ces paramètres, vous pouvez utiliser des classes (par exemple, les classes SpatialReference, ValueTable et Point). La documentation de chaque outil contient un exemple de script illustrant comment chaque paramètre de l'outil est défini et utilisé.

Dans l'exemple suivant, un objet SpatialReference est créé et utilisé pour définir le système de coordonnées en sortie d'une nouvelle classe d'entités créée à l'aide de l'outil Créer une classe d'entités.

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)

Dans de nombreux workflows de géotraitement, vous devez éventuellement exécuter une opération spécifique à l'aide d'informations sur les coordonnées et la géométrie, sans vouloir nécessairement créer une nouvelle classe d'entités (temporaire), la remplir avec des curseurs, l'utiliser, puis la supprimer. Les objets géométrie peuvent alors être utilisés en entrée et en sortie afin de simplifier le géotraitement. Les objets géométrie peuvent être créés à partir de zéro à l’aide des classes Multipoint, PointGeometry, Polygonou Polyline .