Skip to main content

获取布局模板信息 (服务器工具)

汇总

以 JSON 格式返回布局模板的内容。 将文件夹中的布局文件 (.pagx) 用作布局模板。

用法

  • 此工具旨在于打印服务内发布为地理处理任务。 预配置的 PrintingTools 服务也使用该工具。

  • 此工具的输出是格式为 JSON 的字符串。 字符串是一个包含可用 .pagx 文件和以下信息的列表：

    • 页面布局的大小和单位

    • 地图框的大小

      • 如果布局上有多个地图框，则仅返回名为 WEBMAP_MAP_FRAME 的地图框的信息。

    • 以下布局元素的可用性：

      • 图例元素

      • 标题文本元素

      • 版权文本元素

      • 作者文本元素

      • 自定义文本元素及其名称和现有值

      • 指北针元素

      • 比例尺元素

      • 对元素进行分组

      • 动态文本元素

      • 表格框

      • 图表框

    注:

    使用随布局文件保存的单位返回大小。

    样本输出 JSON

    <!--```javascript [{ "layoutTemplate": "A4 Landscape", //布局名称 "pageSize": [29.7, 21], //页面大小 "pageUnits": "CENTIMETER", //页面单位 "activeDataFrameSize": [27.75, 15.91], //地图框大小 "layoutOptions": { "hasAuthorText": true, //可用的预定义 AuthorText "hasCopyrightText": true, //可用的预定义 CopyrightText "hasTitleText": true, //可用的预定义 TitleText "hasLegend": true, //可用的图例元素 "customTextElements": [] //可用的自定义文本元素列表 "mapSurroundInfos": [] //可用的地图整饰要素列表 } }, { "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 } ] } }]

  • 使用相关的导出 Web 地图 工具使用的同一文件夹位置。

  • 有关详细信息，请参阅 ArcGIS Enterprise 帮助中的在 Web 应用程序中打印。

参数

标注 说明 数据类型

布局模板文件夹

（可选）

用作布局模板的布局文件 (.pagx) 所在的文件夹的完整路径。 默认位置为 <install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates。

Folder

布局项目 ID

（可选）

将用于模板的布局项的门户 ID（JSON 格式）。 使用格式 {"id": "<portal-id>"}。

String

派生输出

标注 说明 数据类型

JSON 字符串

JSON 格式的字符串。 字符串是一个包含可用 .pagx 文件及其他信息的列表。 有关详细信息，请参阅工具使用提示。

String

环境

此工具不使用任何地理处理环境。

许可信息

  • 基本: 是
  • 标准: 是
  • 高级: 是