Obtener información de plantillas de diseño (Servidor)

Resumen

Devuelve el contenido de las plantillas de diseño en formato JSON. Los archivos de diseño (.pagx) ubicados en una carpeta se utilizan como plantillas de diseño.

Uso

• Esta herramienta se ha diseñado para su publicación como tarea de geoprocesamiento en un servicio de impresión. También se utiliza en el servicio PrintingTools preconfigurado.

• La salida de esta herramienta es una cadena de caracteres con formato JSON. La cadena de caracteres es una lista de archivos .pagx disponibles y contiene además la información siguiente:

  • El tamaño y las unidades del diseño de página
  • El tamaño de un marco de mapa
    • Si hay varios marcos de mapa en el diseño, se devuelve la información solo para el marco de mapa denominado WEBMAP_MAP_FRAME.
  • La disponibilidad de los siguientes elementos de diseño:
    • Elemento de leyenda
    • Elemento de texto de título
    • Elemento de texto de derechos de autor
    • Elemento de texto de autor
    • Elementos de texto personalizados, así como los nombres y los valores existentes
    • Elemento de flecha de norte
    • Elemento de barra de escala
    • Agrupar elemento
    • Elemento de texto dinámico
    • Marco de tabla
    • Marco de gráfico

  Nota:

  Los tamaños se devuelven en la unidad guardada con el archivo de diseño.

  Ejemplo de JSON de salida

  [{
    "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
      }
  ] 
  }
  }]

• Utilice la misma ubicación de carpeta que la que utiliza la herramienta Exportar mapa web asociada.

• Para obtener más información, consulte Imprimir en aplicaciones web en la ayuda de ArcGIS Enterprise.

Parámetros

Cuadro de diálogo

Etiqueta	Explicación	Tipo de datos
Carpeta de plantillas de diseño (Opcional)	Ruta completa a la carpeta en la que se encuentran los archivos de diseño (.pagx) que se utilizarán como plantillas de diseño. La ubicación predeterminada es <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
Id. de elemento de diseño (Opcional)	El Id. del portal (en formato JSON) del elemento de diseño que se utilizará para las plantillas. Utilice el formato {"id": "<portal-id>"}.	String

Salida derivada

Etiqueta	Explicación	Tipo de datos
Cadena de caracteres de JSON	Una cadena de caracteres de JSON con formato La cadena de caracteres es una lista de archivos (.pagx) disponibles e información adicional. Consulte las sugerencias de uso de la herramienta para obtener más información.	String

Python

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

Nombre	Explicación	Tipo de datos
Layout_Templates_Folder (Opcional)	Ruta completa a la carpeta en la que se encuentran los archivos de diseño (.pagx) que se utilizarán como plantillas de diseño. La ubicación predeterminada es <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.	Folder
Layout_Item_ID (Opcional)	El Id. del portal (en formato JSON) del elemento de diseño que se utilizará para las plantillas. Utilice el formato {"id": "<portal-id>"}.	String

Salida derivada

Nombre	Explicación	Tipo de datos
Output_JSON	Una cadena de caracteres de JSON con formato La cadena de caracteres es una lista de archivos (.pagx) disponibles e información adicional. Consulte las sugerencias de uso de la herramienta para obtener más información.	String

Muestra de código

Ejemplo de GetLayoutTemplatesInfo (ventana de Python)

El script siguiente devuelve una lista de metadatos para cada diseño.

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

Entornos

Esta herramienta no utiliza ningún entorno de geoprocesamiento.

Información de licenciamiento

• Basic: Sí
• Standard: Sí
• Advanced: Sí