Obtenir des informations sur les modèles de mise en page (Serveur)

Synthèse

Renvoie le contenu des mises en page au format JSON. Les fichiers de mise en page (.pagx) figurant dans un dossier sont utilisés comme modèles de mise en page.

Utilisation

• Cet outil est destiné à être publié en tant que tâche de géotraitement dans un service d’impression. Le service préconfiguré PrintingTools l’utilise également.

• Cet outil génère en sortie une chaîne au format JSON. Cette chaîne fournit la liste des fichiers .pagx disponibles, ainsi que les informations suivantes :

  • Taille et unités de la mise en page
  • Taille d’une fenêtre cartographique
    • Si plusieurs fenêtres cartographiques figurent sur la mise en page, l’outil ne renvoie des informations que sur la fenêtre cartographique nommée WEBMAP_MAP_FRAME.
  • La disponibilité des éléments de mise en page suivants :
    • Élément de légende
    • Élément de texte de titre
    • Élément de texte de copyright
    • Élément de texte d’auteur
    • Éléments de texte personnalisés, avec leurs noms et valeurs existantes
    • Élément Flèche d’orientation vers le nord
    • Élément Barre d’échelle
    • Élément Group (Groupe)
    • Élément Texte dynamique
    • Fenêtre de table
    • Fenêtre de diagramme

  Remarque :

  Les tailles sont renvoyées dans l’unité enregistrée avec le fichier de mise en page.

  Exemple de sortie JSON

  [{
    "layoutTemplate": "A4 Landscape",      //name of the layout
    "pageSize": [29.7, 21],                //page size
    "pageUnits": "CENTIMETER",             //page units
    "activeDataFrameSize": [27.75, 15.91], //size of the map frame
    "layoutOptions": {
      "hasAuthorText": true,               //is the predefined AuthorText available
      "hasCopyrightText": true,            //is the predefined CopyrightText available
      "hasTitleText": true,                //is the predefined TitleText available
      "hasLegend": true,                   //is the legend element available
      "customTextElements": []             //available list of custom text elements
      "mapSurroundInfos": [{}]             //available list of map surrounds
    }
  },
  {
    "layoutTemplate": "MyTemplatesWithCustomTextElements",
    "pageSize": [11, 8.5],
    "pageUnits": "INCH",
    "activeDataFrameSize": [6.65, 7.34],
    "layoutOptions": {
      "hasAuthorText": false,
      "hasCopyrightText": true,
      "hasTitleText": true,
      "hasLegend": true,
      "customTextElements": [
        { "CityName": "Redlands" },
        { "MapCenterCoordinates": ""},
        { "SelectedParcelID": ""}
      ],
      "mapSurroundInfos": [
      { 
        "name": "North Arrow",
        "type": "CIMMarkerNorthArrow",
        "visible": true
      }
  ] 
  }
  }]

• Utilisez le même emplacement de dossier que celui utilisé par l’outil Exporter la carte Web.

• Pour plus d’informations, reportez-vous à la section Impression dans les applications web de l’aide ArcGIS Enterprise.

Paramètres

Boîte de dialogue

Étiquette	Explication	Type de données
Dossier des modèles de mise en page (Facultatif)	Le chemin d’accès complet au dossier où se trouvent les fichiers de mise en page (.pagx) qui seront utilisés comme modèles de mise en page. L’emplacement par défaut est <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
ID d’élément de mise en page (Facultatif)	L’ID de portail (au format JSON) de l’élément de mise en page qui sera utilisé pour les modèles. Utilisez le format {"id": "<portal-id>"}.	String

Sortie obtenue

Étiquette	Explication	Type de données
Chaîne JSON	Chaîne au format JSON. Cette chaîne fournit la liste des fichiers .pagx disponibles, ainsi que des informations supplémentaires. Pour plus d’informations, reportez-vous aux conseils d’utilisation de l’outil.	String

Python

arcpy.server.GetLayoutTemplatesInfo({Layout_Templates_Folder}, {Layout_Item_ID})

Nom	Explication	Type de données
Layout_Templates_Folder (Facultatif)	Le chemin d’accès complet au dossier où se trouvent les fichiers de mise en page (.pagx) qui seront utilisés comme modèles de mise en page. L’emplacement par défaut est <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
Layout_Item_ID (Facultatif)	L’ID de portail (au format JSON) de l’élément de mise en page qui sera utilisé pour les modèles. Utilisez le format {"id": "<portal-id>"}.	String

Sortie obtenue

Nom	Explication	Type de données
Output_JSON	Chaîne au format JSON. Cette chaîne fournit la liste des fichiers .pagx disponibles, ainsi que des informations supplémentaires. Pour plus d’informations, reportez-vous aux conseils d’utilisation de l’outil.	String

Exemple de code

Exemple d’utilisation de la fonction GetLayoutTemplatesInfo (fenêtre Python)

Le script suivant renvoie une liste des métadonnées pour chaque mise en page.

import arcpy
arcpy.server.GetLayoutTemplatesInfo(r'C:\Data\MyLayouts')

Environnements

Cet outil n’utilise pas d’environnement de géotraitement.

Informations de licence

• Basic: Oui
• Standard: Oui
• Advanced: Oui