Получить информацию шаблонов компоновки (Сервер)

Краткая информация

Возвращает содержимое шаблонов компоновки в формате JSON. Файлы компоновки (файлы .pagx), расположенные в папке, используются в качестве шаблонов компоновки.

Использование

  • Этот инструмент планировалось опубликовать в качестве задачи геообработки в сервисе печати. Он также используется предварительно настроенным сервисом PrintingTools.

  • Выходными данными этого инструмента будет строка в формате JSON. Строка - это список доступных файлов компоновок (файлов .pagx) и следующая информация:

    • Размер компоновки страницы и единицы измерения
    • Размер фрейма карты
      • Если в компоновке несколько фреймов карты, возвращается информация только для фрейма WEBMAP_MAP_FRAME.
    • Наличие следующих элементов компоновки:
      • Элемент Легенда
      • Текстовый элемент заголовка
      • Текстовый элемент авторских прав
      • Текстовый элемент об авторе
      • Пользовательские текстовые элементы, их имена и существующие значения
    Примечание:

    Размеры возвращаются в единицах измерения, хранящихся в файле компоновки.

    Пример выходных данных 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": ""}
        ]  
    }
    }]
  • Используйте ту же папку, что и связанный инструмент Экспорт веб-карты.

  • Более подробную информацию см. в разделе Печать в веб-приложениях документации ArcGIS Enterprise.

Параметры

ПодписьОписаниеТип данных
Папка шаблонов компоновки
(Дополнительный)

Полный путь к папке, где находятся файлы компоновки (файлы .pagx), которые будут использоваться в качестве шаблонов компоновки. Местоположением по умолчанию <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.

Folder
ID элемента компоновки
(Дополнительный)

Идентификатор портала (в формате JSON) элемента компоновки, который будет использоваться для шаблонов. Используйте формат {"id": "<portal-id>"}.

String

Производные выходные данные

ПодписьОписаниеТип данных
Строка JSON

Строка в формате JSON. Строка представляет собой список доступных файлов компоновок (файлов .pagx) и дополнительную информацию. Для получения более полной информации см. рекомендации по использованию инструмента.

String

arcpy.management.GetLayoutTemplatesInfo({Layout_Templates_Folder}, {Layout_Item_ID})
ИмяОписаниеТип данных
Layout_Templates_Folder
(Дополнительный)

Полный путь к папке, где находятся файлы компоновки (файлы .pagx), которые будут использоваться в качестве шаблонов компоновки. Местоположением по умолчанию <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates.

Folder
Layout_Item_ID
(Дополнительный)

Идентификатор портала (в формате JSON) элемента компоновки, который будет использоваться для шаблонов. Используйте формат {"id": "<portal-id>"}.

String

Производные выходные данные

ИмяОписаниеТип данных
Output_JSON

Строка в формате JSON. Строка представляет собой список доступных файлов компоновок (файлов .pagx) и дополнительную информацию. Для получения более полной информации см. рекомендации по использованию инструмента.

String

Пример кода

GetLayoutTemplatesInfo, пример (окно Python)

Следующий скрипт возвращает список метаданных для каждой компоновки.

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

Параметры среды

Этот инструмент не использует параметры среды геообработки