Инструмент-скрипт - это инструмент геообработки, который запускает какой-либо скрипт или тип файла, который может быть запущен. Эти скрипты запускают инструменты-скрипты, которые используют для этого инструменты геообработки в качестве интерфейса для скрипта. При создании инструмента-скрипта вы задаете параметры, которые требуются скрипту для запуска. Основными параметрами являются входной и выходной наборы данных, имена полей и строки, которые выбираются из списка вариантов. В процессе запуска инструмента-скрипта значения параметров передаются в скрипт и используются им.
Почти все инструменты-скрипты выполняют скрипт Python (.py), который использует ArcPy, пакет сайта Python, который устанавливается вместе с ArcGIS. ArcPy обеспечивает доступ к инструментам геообработки, а также к дополнительным функциям, классам и модулям, которые позволяют создавать как простые, так и сложные рабочие процессы. С помощью ArcPy скрипт может работать с параметрами среды геообработки ArcGIS, обеспечивая такие возможности, как проецирование на лету, поддержка наборов выборки, проверка входных данных, уведомления об ошибках и запись истории.
Инструменты-скрипты также могут запускать скрипт R (.r), использующий библиотеку arcgisbinding R.
Более подробно о R-ArcGIS Bridge
Инструменты-скрипты создаются в наборе инструментов. Чтобы создать инструмент-скрипт, щелкните правой кнопкой на наборе инструментов на панели Каталог и щелкните Новый > Скрипт.
Свойства
Когда вы создаете инструмент-скрипт, диалоговое окно этого инструмента-скрипта появляется со следующими боковыми вкладками:
- Общие
- Параметры
- Выполнение
- Проверка
- Параметры среды
Вкладка Общие
На вкладке Общие содержатся следующие свойства:
- Имя - Внутреннее уникальное идентифицирующее имя инструмента.
- Подпись - Имя инструмента, которое отображается в наборе инструментов и когда инструмент открыт в диалоговом окне инструмента.
- Описание - Краткое описание инструмента, которое отображается при наведении на него курсора.
- Краткая информация - Описание инструмента, которое отображается при наведении курсора на значок справки в диалоговом окне открытого инструмента.
- Иллюстрация - Изображение, которое отображается вместе с краткой информацией инструмента при наведении курсора на значок справки в диалоговом окне открытого инструмента.
- Атрибуты:
- Показать баннер о том, что инструмент изменяет входные данные — отметьте эту опцию, чтобы в верхней части диалогового окна инструмента отображался баннер, указывающий на то, что инструмент изменяет входные данные.
- Не добавлять выходные данные инструмента на карту — Отметьте эту опцию, чтобы автоматически добавлять набор выходных данных инструмента на открытую карту.
Примечание:
Если также отмечена опция геообработки Добавить выходные наборы данных к открытой карте, атрибут свойства инструмента по-прежнему будет учитываться.
- Показать переключатель Включить отмену - Отметьте эту опцию, чтобы отобразить кнопку-переключатель Включить отмену рядом с кнопкой Запустить в диалоговом окне инструмента.
- Показать баннер о том, что инструмент использует кредиты ArcGIS - Отметьте эту опцию, чтобы отобразить баннер в верхней части диалогового окна инструмента, если инструмент использует кредиты.
- Значок - Небольшое изображение, которое отображается при добавлении инструмента на ленту, Панель быстрого доступа или в Галерею анализа.
Можно изменить свойства, введя значения в текстовое поле или щелкнув значок, чтобы найти новый файл изображения, который будет использоваться в качестве иллюстрации или значка.
Примечание:
Если набор инструментов - набор инструментов прежних версий (.tbx), есть, кроме того, свойство для хранения пути к скрипту источника инструмента относительно файла набора инструментов. Если набор инструментов - набор инструментов ArcGIS (.atbx), это поведение управляется по-другому. Если скрипт находится в той же папке, что и файл .atbx или в дочерней папке относительно папки хранения .atbx, сохраняется относительный путь. Если скрипт и файл .atbx полностью разделены, сохраняется абсолютный путь.
Примечание:
Если набор инструментов - набор инструментов прежних версий (.tbx), свойства Краткая информация, Иллюстрация, Значок и Атрибуты не поддерживаются.
Вкладка Параметры
Вкладка Параметры содержит таблицу свойств параметров, где каждая строка представляет собой параметр. По умолчанию эта таблица пустая. Для каждого параметра определите свойства, такие как: подпись, которая будет показана на панели Геообработка, типы данных, которые допустимы для параметров, является ли параметр необходимым или дополнительным. Как минимум задайте параметры Подпись, Имя, Тип данных, Тип и Направление.
| Свойство | Описание |
|---|---|
Подпись | Имя параметра отображается в инструменте. |
Имя | Имя параметра в случае, когда инструмент-скрипт вызывается как функция из другого скрипта Python. |
Тип данных | Определяет тип данных, допустимый для этого параметра. Определяет управление инструментом. Например, если вы выберете Слой объектов, вы можете выбрать слой с активной карты или указать соответствующий класс пространственных объектов. |
Тип | Параметры могут быть обязательными или дополнительными. Если параметр является обязательным (необходимым), необходимо ввести для него значение, иначе инструмент не будет запущен. Если параметр является дополнительным, инструмент будет работать, даже если это значение не задано. |
Направление | Параметры могут быть входными и выходными. Входные параметры описывают существующие данные, которые будут обработаны, или значения, которые используются при обработке. Выходные параметры включают данные, полученные в результате работы инструмента, или значения, которые вычислены в ходе этой работы. |
Описание | Справка по каждому параметру инструмента, в том числе инструкции, информация и допустимые типы данных или значения. Описания параметров отображаются в диалоговом окне инструмента при наведении курсора на кнопку информации |
Категория | При добавлении имени категории соответствующий параметр добавляется в ниспадающую группу в диалоговом окне инструмента. |
Фильтр | Фильтры позволяют задать, какие определенные типы наборов данных, полей, указанных значений или значений в диапазоне допустимы в качестве входных параметров для инструмента. Например, вы можете настроить фильтр для параметра Класс объектов таким образом, что будут использоваться только классы точечных объектов, или вы можете задать числовой параметр, и тогда допустимыми будут только значения от 1 до 10. |
Зависимость | Вы можете настроить так, чтобы один параметр зависел от значения другого параметра. Например, параметр поля зависит от параметра набора данных. |
По умолчанию | Значение, которое задается автоматически для параметра, когда появляется диалоговое окно инструмента. |
Окружающая среда | Значение параметра по умолчанию может быть получено из параметров среды. Когда задан параметр среды, его значение будет использоваться в качестве значения по умолчанию для указанного параметра, когда появляется диалоговое окно инструмента. |
Символы | Пусть к файлу слоя, который определяет символы параметра. Например, вы можете задать для параметра выходного набора данных такие же символы, как и в файле слоя, чтобы заранее определить, как он отобразится на карте после работы инструмента. |
рядом с подписью параметра.Вкладка Выполнение
Вкладка Выполнение содержит свойства, связанные с исходным кодом инструмента-скрипта, или путь к файлу скрипта Python или R-скрипта. Вкладка также содержит опции для встраивания и защиты паролем исходного кода инструмента-скрипта или экспорта исходного кода в новый файл.
Можно встроить исходный код в набор инструментов, или ссылку на внешний файл скрипта. Независимо от расположения исходного кода, вкладка содержит редактор кода, который можно использовать для изменения кода; также можно нажать кнопку Открыть в редакторе скриптов, чтобы открыть код в редакторе скриптов. Можно задать предпочитаемый редактор скриптов в разделе опции геообработки.
Вкладка Проверка
На вкладке Проверка отображается код проверки инструмента-скрипта. Проверка позволяет настроить, как параметры инструментов будут реагировать и взаимодействовать со значениями и другими параметрами инструмента-скрипта. Код проверки написан на языке Python.
Блок кода ToolValidator Python позволяет управлять оформлением, поведением и сообщениями инструмента-скрипта. Можно редактировать код проверки непосредственно из редактора кодов или щелкнув кнопку Открыть в редакторе скриптов, чтобы открыть код проверки в предпочитаемом редакторе скриптов, который можно задать в диалоговом окне опции геообработки.
Вкладка Параметры среды
На вкладке Параметры среды отображаются списки Поддерживаемые среды и Неподдерживаемые среды. Вы можете добавлять или удалять среды, обмениваясь между этими списками. На вкладке Параметры среды диалогового окна инструмента-скрипта будут отображаться только среды из списка Поддерживаемые среды.