Учебное руководство: Печать веб-карты и экспорт выходного документа в формате PDF с помощью ArcPy

Уровень сложности: СреднийТребования к данным: ArcGIS.com

В этом руководстве вы создадите веб-приложение, с помощью которого конечный пользователь может переместиться в область интереса и щелкнуть кнопку Печать. В результате будет получен пригодный для печати документ в формате PDF, содержащий выходные векторные данные для слоев сервиса.

Экспорт из веб-приложения с использованием готового сервиса Инструменты печати и его клиентского виджета печати в ArcGIS API for JavaScript может выводить высококачественное изображение слоев сервиса. Возможно, вы захотите получить на выходе векторные данные. Например, векторные выходные данные в PDF поддерживают в приложении просмотра PDF следующие функции: переключение видимости слоев, просмотр атрибутов объектов и просмотр координат карты. В веб-приложении, которое вы построите, вы получите векторные эквиваленты сервисной базовой карты World Topographic. Векторный поднабор небольшой области базовой карты World Topographic открыт для общего доступа.

Примечание:

Для того чтобы создать выходной документ, содержащий локальные векторные данные вместо изображения слоев сервисов, у вас должен быть доступ к соответствующим векторным данным.

Код, закрепленный в веб-приложении за кнопкой Печать, использует Задачу Печати ArcGIS API for JavaScript Print Task. Вы создадите скрипт Python, который будет опубликован как сервис геообработки и будет использоваться Задачей печати. Скрипт Python использует функцию ConvertWebMapToMapDocument в модуле arcpy.mapping, что позволяет вставлять все элементы веб-карты в промежуточный шаблон документа карты. Этот шаблон содержит векторные эквиваленты всех возможных слоев в картографическом сервисе. В модуле arcpy.mapping также предусмотрена функциональная возможность удаления слоев сервисов – без удаления локальных векторных данных из шаблона документа карты – и экспорта в документ PDF.

На выходе будет получен документ PDF в формате для печати, содержащий локальные векторные данные вместо изображения слоев сервиса.

Для выполнения этого учебного руководства, вы должны быть знакомы с модулем arcpy.mapping, ArcGIS API for JavaScript, ArcMap и ArcGIS Server. Вам также следует ознакомиться с печатью в веб-приложениях. Полезны следующие темы:

• Печать в веб-приложениях
• Расширенные функции печати для веб-карт

Получение векторных данных

Загрузите сжатый файл, который содержит векторные данные, используемые в промежуточном шаблоне документа карты. Прежде чем вы это сделаете, необходимо убедиться в наличии структуры папок в том местоположении, где ArcGIS Server может видеть документы шаблонов карт и данные, которые будут использоваться в веб-приложении. Подразумевается, что у вас уже есть папка, зарегистрированная на ArcGIS Server. Более подробно о регистрации данных на ArcGIS Server, см. в следующих разделах:

• Сделайте ваши данные доступными для ArcGIS Server
• О регистрации данных в ArcGIS Server
• Регистрация данных в ArcGIS Server с помощью ArcMap

Подсказка:

При использовании шаблонов документов карт в функции ConvertWebMapToMapDocument рекомендуется использовать данные, которые зарегистрированы на ArcGIS Server. Если вы решите использовать не зарегистрированные данные, то шаблоны документов карт и данные будут упакованы и скопированы на сервер. Во время упаковки данные могут перемещаться и использоваться в качестве источника с относительными к структуре папок путями, которые не может разрешить ConvertWebMapToMapDocument. Более подробно см. ConvertWebMapToMapDocument.

1. Откройте новый, пустой сеанс ArcMap.
2. В окне Каталог, перейдите к своей зарегистрированной папке.
3. Создайте новую папку в зарегистрированном каталоге с именем BasicTutorial.
4. В веб-браузере перейдите по ссылке Загрузка World Topographic Map Template.
5. Загрузите сжатый файл World Topographic Map Template на свой компьютер, щелкнув кнопки Открыть > Загрузить.
6. При появлении запроса, выберите Сохранить как и сохраните сжатый файл в папке BasicTutorial в зарегистрированной директории.
7. В ArcMap откройте инструмент геообработки Распаковать.

   Инструмент распакует сжатый шаблон карты в зарегистрированную папку. Параметром in_package будет только что загруженный сжатый файл. Параметром output_folder будет папка BasicTutorial в вашей зарегистрированной папке.

8. Щелкните на OK, чтобы запустить инструмент.

Документ карты WorldTopo_103Templatev2_288k_to_1k.mxd теперь готов для использования в веб-приложении.

Создание скрипта Python

Создайте скрипт Python, который будет использоваться в качестве пользовательского сервиса геообработки для печати.

Скрипт Python в пользовательском сервисе геообработки для печати выполняет функцию ConvertWebMapToMapDocument, которая преобразует веб-карту (в формате JSON) в документ карты. Затем скрипт удаляет слои сервисов в документе карты, оставляя векторные слои, которые соответствуют сервисному слою в веб-карте JSON. Веб-карта JSON также содержит экстент карты в веб-приложении. Наконец, скрипт экспортирует документ карты в документ PDF.

1. Откройте любой Python IDE, например, IDLE (который поставляется с ArcGIS Desktop).
2. Скопируйте и вставьте следующий код в новый скрипт Python:

import arcpy
import os
import uuid

# Input Web Map json
Web_Map_as_JSON = arcpy.GetParameterAsText(0)

# The template location in the server data store
templateMxd = r"\\MyComputer\MyDataStore\BasicTutorial\v103\WorldTopo_103Templatev2_288k_to_1k.mxd"
   
# Convert the Web Map to a map document
result = arcpy.mapping.ConvertWebMapToMapDocument(Web_Map_as_JSON, templateMxd)
mxd = result.mapDocument

# Reference the data frame that contains the web map
# Note: ConvertWebMapToMapDocument renames the active data frame in the template_mxd "Webmap"
df = arcpy.mapping.ListDataFrames(mxd, 'Webmap')[0]

# Remove the service layer
# This will just leave the vector layers from the template
for lyr in arcpy.mapping.ListLayers(mxd, data_frame=df):
    if lyr.isServiceLayer:
        arcpy.mapping.RemoveLayer(df, lyr)
        
# Use the uuid module to generate a GUID as part of the output name
# This will ensure a unique output name
output = 'WebMap_{}.pdf'.format(str(uuid.uuid1()))
Output_File = os.path.join(arcpy.env.scratchFolder, output)

# Export the Web Map
arcpy.mapping.ExportToPDF(mxd, Output_File) 

# Set the output parameter to be the output file of the server job
arcpy.SetParameterAsText(1, Output_File)

# Clean up - delete the map document reference
filePath = mxd.filePath
del mxd, result
os.remove(filePath)

3. Измените переменную templateMxd, чтобы она представляла путь UNC к папке в вашей зарегистрированной папке, содержащей шаблоны документов карты.

Примечание:

Если ArcGIS Server, ArcMap и зарегистрированная папка находятся на одном и том же компьютере, то пути UNC к зарегистрированной папке не требуются. Вместо них могут использоваться абсолютные пути.

4. Сохраните скрипт Python. Назовите скрипт BasicTutorial.py. Сохраните его в папку с именем WebApp в директории зарегистрированной папки.

Создание инструмента-скрипта Python

Создайте пользовательский инструмент геообработки, который будет запускать скрипт BasicTutorial.py.

1. В окне Каталог в ArcMap перейдите к папке WebApp в директории зарегистрированной папки.
2. Щелкните правой кнопкой мыши папку WebApp и выберите Новый > Набор инструментов.
3. Назовите набор инструментов BasicTutorial.
4. Щелкните правой кнопкой набор инструментов BasicTutorial и выберите Описание элемента.
5. В диалоговом окне Описание элемента заполните опции Теги и Краткая информация любым текстом по вашему выбору. Дополнительно, заполните другие описания опций.
6. Щелкните Сохранить и закройте диалоговое окно Описание элемента.
7. В окне Каталога щелкните правой кнопкой набор инструментов BasicTutorial и выберите Добавить > Скрипт.
8. В диалоговом окне Добавить скрипт введите BasicTutorial и для Имя, и для Надпись.
9. Щелкните Далее.
10. Для параметра Файл скрипта перейдите к папке WebApp в зарегистрированной директории и выберите BasicTutorial.py.
11. Щелкните Далее.
12. Добавьте два параметра в инструмент-скрипт.
    1. Добавьте параметр Web_Map_as_JSON.

       Этот параметр получает представление JSON о состоянии карты для экспорта, как только она отобразится в веб-приложении. Свойства должны соответствовать следующему снимку экрана:

       

    2. Добавьте параметр Output_File.

       Это – выходной файл, который будет создан. Свойства должны соответствовать следующему снимку экрана:

       

       Внимание:

       Имена параметров Web_Map_as_JSON и Output_File должны быть указаны с точностью до буквы, как показано, чтобы они совпали с подписью инструмента Задача печати в ArcGIS Web API.

    3. Щелкните Готово в диалоговом окне Добавить скрипт.
13. Щелкните правой кнопкой инструмент-скрипт BasicTutorial и щелкните Описание элемента.
14. В диалоговом окне Описание элемента заполните опции Теги и Краткая информация любым текстом по вашему выбору. Также заполните любым текстом опцию Объяснение диалога для всех четырех параметров в разделе Синтаксис диалогового окна Описание элемента. Дополнительно, заполните другие описания опций.

Выполнение инструмента

Для того, чтобы в окне Результаты появился результат, который можно опубликовать на ArcGIS Server, инструмент должен выполниться успешно.

1. В окне Каталога щелкните правой кнопкой инструмент-скрипт BasicTutorial и щелкните Открыть.
2. Оставьте входной параметр Web_Map_as_JSON пустым.

   Подсказка:

   Для публикации можно оставить входной параметр Web_Map_as_JSON пустым, поскольку интерфейс ArcGIS API for JavaScript уже содержит веб-карту JSON в веб-приложении. Входной параметр Web_Map_as_JSON может быть оставлен пустым при условии, что скрипт Python был написан таким образом, чтобы он мог работать и при пустом входном параметре. Например, скрипт не ищет слои веб-карт по имени.

3. Щелкните OK и ожидайте завершения работы инструмента.

Теперь результат готов для публикации как в качестве сервиса геообработки.

Публикация результата

Если вы не знакомы с публикацией сервисов геообработки, см. следующие разделы:

• Что такое сервис геообработки?
• Краткий обзор по разработке и предоставлению общего доступа к сервисам геообработки
• Краткий обзор по публикации сервисов геообработки
• Словарь основных терминов по сервисам геообработки

Для публикации результата выполните следующие шаги:

1. Откройте окно Результаты.
2. Разверните строку Текущий сеанс.
3. Щелкните правой кнопкой мыши результат геообработки BasicTutorial и выберите Общий доступ как > Сервис геообработки.
4. Включите Опубликовать сервис.
5. Щелкните Далее.
6. Выберите издательское или административное подключение к компьютеру с ArcGIS Server.
7. Щелкните Далее.
8. Щелкните Далее.
9. Нажмите кнопку Продолжить.
10. В диалоговом окне Редактор сервиса щелкните Опубликовать.

Теперь сервис геообработки подготовлен для использования в ArcGIS API for JavaScript.

Пример кода ArcGIS API for JavaScript

Используйте следующий пример кода, чтобы создать ваше приложение.

В расположенном ниже примере кода ArcGIS API for JavaScript измените URL на сервис геообработки, который вы создали, чтобы он совпадал с именем сервера. Он упоминается на следующей строке:

var printUrl = "https://MyServer:6443/arcgis/rest/services/BasicTutorial/GPServer/BasicTutorial";

Код для BasicTutorial.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
  <head>
    <title>Webmap Printing</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=7,IE=9" />
    <meta name="viewport" content="initial-scale=1, maximum-scale=1,user-scalable=no"/>
    <link rel="stylesheet" type="text/css" href="http://serverapi.arcgisonline.com/jsapi/arcgis/3.0/js/dojo/dijit/themes/claro/claro.css">
    <script src="http://serverapi.arcgisonline.com/jsapi/arcgis/?v=3.0"></script>
    <script type="text/javascript" language="Javascript">
      dojo.require("esri.map");
      dojo.require("esri.tasks.PrintTask");
      var printTask, params;

      function init() {
        // set the extent of the web app to same extent as the template map document
        var startExtent = new esri.geometry.Extent({
          "xmin" : -13043333,
          "ymin" : 3836078,
          "xmax" : -13030585,
          "ymax" : 3853683,
          "spatialReference" : {
            "wkid" : 102100
          }
        });

        var map = new esri.Map("map", {
          extent : startExtent
        });

        // add tiled map service to webmap
        var tiledUrl = "http://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer";
        var tiledLayer = new esri.layers.ArcGISTiledMapServiceLayer(tiledUrl);
        map.addLayer(tiledLayer);
        var printUrl = "http://MyServer:6080/arcgis/rest/services/BasicTutorial/GPServer/BasicTutorial";
        printTask = new esri.tasks.PrintTask(printUrl, {
          async : true
        });
        params = new esri.tasks.PrintParameters();
        params.map = map;
      }

      function print() {
        var ptemplate = new esri.tasks.PrintTemplate();
        // use the extent of the webmap in the output PDF
        ptemplate.preserveScale = false;
        params.template = ptemplate;
        printTask.execute(params, printComplete);
      }

      function printComplete(result) {
        window.open(result.url);
      }


      dojo.addOnLoad(init);

    </script>
  </head>
  <body class="claro">
    <input type="button" id="print" value="Print" onclick="print();"/>
    <div id="map" style="width:1000px; height:600px; border:1px solid #000;"></div>
  </body>
</html>

Запуск веб-приложения

Запустите созданное веб-приложение. Обратитесь к документации ArcGIS API for JavaScript за инструкциями по запуску веб-приложений, если это необходимо. Ниже приведен снимок экрана веб-приложения:

Увеличьте интересующую вас область и нажмите кнопку Печать. Появится выходной документ PDF. На выходе будет получен документ PDF в формате для печати, содержащий локальные векторные данные, которые были помещены в шаблоны компоновки вместо изображения слоев сервисов. Ниже приведен образец полученного на выходе документа:

Этим учебное руководство по печати и экспорту веб-карт с использованием arcpy.mapping завершается. Дополнительные сведения см. в Руководстве: Расширенные возможности печати и экспорта веб-карт.