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

Résumé

Renvoie le contenu des modèles de mise en page au format JSON (JavaScript Object Notation). Les fichiers de mise en page (fichiers .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 une chaîne au format JSON. Cette chaîne fournit la liste des fichiers de mise en page disponibles (fichiers .pagx), 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.
  • Disponibilité des éléments de mise en page suivants :
    • Elément de légende
    • Elément de texte de titre
    • Elément de texte de droit d'auteur
    • Elément de texte d'auteur
    • Eléments de texte personnalisés, avec leurs noms et valeurs existantes

  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 legend element available
      "customTextElements": []
    }
  },
  {
    "layoutTemplate": "MyTemplatesWithCustomTextElements",
    "pageSize": [11, 8.5],
    "pageUnits": "INCH",
    "activeDataFrameSize": [6.65, 7.34],
    "layoutOptions": {
      "hasAuthorText": false,
      "hasCopyrightText": true,
      "hasTitleText": true,
      "hasLegend": true,
      "customTextElements": [               //available list of custom text elements
        { "CityName": "Redlands" },
        { "MapCenterCoordinates": "" }
        { "SelectedParcelID": ""}
      ]  
  }
  }]

• L'outil doit utiliser le même emplacement de dossier que celui de l'outil Exporter la carte Web.

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

Syntaxe

arcpy.server.GetLayoutTemplatesInfo({Layout_Templates_Folder})

Paramètre	Explication	Type de données
Layout_Templates_Folder (Facultatif)	Chemin d’accès complet au dossier où se trouvent les mises en page (fichiers .pagx) à utiliser comme modèles de mise en page. L’emplacement par défaut est <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder

Sortie dérivée

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

Exemple de code

Exemple d’utilisation de l’outil GetLayoutTemplatesInfo (fenêtre Python)

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

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

Environnements

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

Informations de licence

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