描述
以 JavaScript 对象表示法 (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": ""} ] } }]
工具应使用相关导出 Web 地图工具使用的同一文件夹位置。
有关更多信息,请参阅 ArcGIS Enterprise 帮助中的在 Web 应用程序中打印。
语法
GetLayoutTemplatesInfo({Layout_Templates_Folder})
参数 | 说明 | 数据类型 |
Layout_Templates_Folder (可选) |
用作布局模板的布局文件(.pagx 文件)所在的文件夹的完整路径。默认位置为 <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates。 | Folder |
派生输出
名称 | 说明 | 数据类型 |
Output_JSON | JSON 格式的字符串。字符串是可用布局文件(.pagx 文件)列表及其他信息。有关详细信息,请参阅工具使用提示。 | 字符串 |
代码示例
以下脚本将返回每个布局的元数据列表。
import arcpy
arcpy.GetLayoutTemplatesInfo_server(r'C:\Data\MyLayouts')
环境
此工具不使用任何地理处理环境。
许可信息
- Basic: 是
- Standard: 是
- Advanced: 是