Layout-Vorlageninformationen abrufen (Server)

Zusammenfassung

Gibt den Inhalt von Layout-Vorlagen im JSON-Format zurück. Als Layout-Vorlagen werden Layout-Dateien (.pagx) in einem Ordner verwendet.

Verwendung

• Dieses Werkzeug ist zur Veröffentlichung als Geoverarbeitungs-Task in einem Druckservice bestimmt. Es wird außerdem von dem vorkonfigurierten PrintingTools-Service verwendet.

• Die Ausgabe dieses Werkzeugs ist eine als JSON formatierte Zeichenfolge. Die Zeichenfolge ist eine Liste der verfügbaren .pagx-Dateien und umfasst die folgenden Informationen:

  • Die Größe und die Einheiten des Seitenlayouts
  • Die Größe eines Kartenrahmens
    • Wenn das Layout mehrere Kartenrahmen enthält, werden nur die Informationen für den Kartenrahmen WEBMAP_MAP_FRAME zurückgegeben.
  • Verfügbarkeit der folgenden Layout-Elemente:
    • Legendenelement
    • Titel-Textelement
    • Copyright-Textelement
    • Autor-Textelement
    • Benutzerdefinierte Textelemente und deren Namen und vorhandenen Werte
    • Nordpfeil-Element
    • Maßstabsleisten-Element
    • Gruppenelement
    • Dynamisches Textelement
    • Tabellenrahmen
    • Diagrammrahmen

  Hinweis:

  Die Größen werden in der Einheit zurückgegeben, die mit der Layout-Datei gespeichert wurde.

  Eine Beispiel-Ausgabe-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
      }
  ] 
  }
  }]

• Verwenden Sie denselben Speicherort wie das zugehörige Werkzeug Webkarte exportieren.

• Weitere Informationen finden Sie unter Drucken in Webanwendungen in der ArcGIS Enterprise-Hilfe.

Parameter

Dialogfeld

Beschriftung	Erläuterung	Datentyp
Layout-Vorlagenordner (optional)	Der vollständige Pfad zu dem Ordner, in dem sich die Layout-Dateien (.pagx) befinden, die als Layout-Vorlagen verwendet werden sollen. Das Standardverzeichnis ist <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
Layout-Element-ID (optional)	Die Portal-ID (im JSON-Format) des Layout-Elements, das für Vorlagen verwendet werden soll. Verwenden Sie das Format {"id": "<portal-id>"}.	String

Abgeleitete Ausgabe

Beschriftung	Erläuterung	Datentyp
JSON-Zeichenfolge	Eine JSON-formatierte Zeichenfolge. Bei der Zeichenfolge handelt es sich um eine Liste der verfügbaren .pagx-Dateien mit zusätzlichen Informationen. Weitere Informationen finden Sie in den Verwendungshinweisen für das Werkzeug.	String

Python

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

Name	Erläuterung	Datentyp
Layout_Templates_Folder (optional)	Der vollständige Pfad zu dem Ordner, in dem sich die Layout-Dateien (.pagx) befinden, die als Layout-Vorlagen verwendet werden sollen. Das Standardverzeichnis ist <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
Layout_Item_ID (optional)	Die Portal-ID (im JSON-Format) des Layout-Elements, das für Vorlagen verwendet werden soll. Verwenden Sie das Format {"id": "<portal-id>"}.	String

Abgeleitete Ausgabe

Name	Erläuterung	Datentyp
Output_JSON	Eine JSON-formatierte Zeichenfolge. Bei der Zeichenfolge handelt es sich um eine Liste der verfügbaren .pagx-Dateien mit zusätzlichen Informationen. Weitere Informationen finden Sie in den Verwendungshinweisen für das Werkzeug.	String

Codebeispiel

GetLayoutTemplatesInfo: Beispiel (Python-Fenster)

Das folgende Skript gibt eine Liste der Metadaten für jedes Layout zurück.

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

Umgebungen

Dieses Werkzeug verwendet keine Geoverarbeitungsumgebungen.

Lizenzinformationen

• Basic: Ja
• Standard: Ja
• Advanced: Ja