第十章 获取GIS数据列表和描述信息 ||| 第十二章 异常和错误处理
我们将在本章介绍以下几个案例：
- 下载安装Python加载项
- 创建按钮加载项
- 安装测试加载项
- 创建工具加载项
引言
本章中我们会介绍如何创建，测试，编辑和共享Python编写的加载项。加载项是通过一组设计好的模块化代码库向ArcGIS桌面软件中添加用户界面组件的方式来执行特定操作。界面组件包括按钮，工具，工具条，菜单，组合框，工具选项板以及应用程序扩展。加载项的概念是在ArcGIS 10.0版本中引入的，由.NET或Java来编写。在ArcGIS 10.1版本中加载项可以使用Python来创建。使用Python脚本和XML文件来创建加载项，其中XML文件定义了加载项在用户界面的外观显示。
加载项提供了一种向最终用户分发自定义用户界面的简便方式。不需要安装程序。只要将一个扩展名为.esriaddin的压缩文件复制到一个已知文件夹中，其他工作交给ArcGIS来处理。为了能够进一步简化开发过程，ESRI还提供了一个Python加载项向导。你可以从Esri官网下载安装向导。这也是本章要介绍的第一个案例。
我们还可以创建多个类型的加载项。按钮和工具是最为简单的加载项。点击按钮来执行业务逻辑操作。工具与按钮非常相似，不过工具需要先与地图窗口进行交互后再执行业务逻辑操作。组合框则提供了选项列表让用户进行选择。
我们还可以创建一些容器对象类型加载项，包括菜单，工具条，工具选项卡以及应用程序扩展。菜单是按钮或其他菜单的容器。工具条是按钮，工具，组合框，工具选项板以及菜单的容器。菜单和工具条是最为灵活的加载项容器类型。工具选项板作为工具的容器，不过需要事先添加到工具条中。应用程序扩展是最为复杂的加载项类型，用于协调加载项中其他组件的活动并负责监听和响应应用程序的各种事件，比如从数据库中添加或移除图层事件等。
下载安装Python加载项向导
ESRI提供了一个Python加载项向导工具来简化加载项开发过程。该工具可以从ESRI官网上下载，这也是创建加载项一种很好的方式。
Getting ready
Python加载项向导工具是用来创建加载项中所要文件很好的方式。该工具通过一个可视化的界面来创建加载项中所需的文件。在本案例中，你要下载并安装Python加载项向导。
How to do it...
按照以下步骤来学习如何下载安装Python加载项向导工具：
1.打开浏览器转至Python加载项向导工具页面。
如下图所示，你看到如下页面：
2.点击下载（Download）按钮下载安装文件。
3.在电脑的任意位置创建一个新的文件夹，并命名为Python Add-In Wizard。文件夹的名称不重要，这里只不过便于记忆，你可以使用Python Add-In Wizard或其他名称。
4.将安装文件解压到刚创建的文件夹中。
5.打开解压后的bin文件夹，双击addin_assisant.exe文件执行安装向导程序。如下图所示：
6.双击addin_assiant.exe后会提示你选择一个目录作为加载项项目的根目录：
How it works...
Python加载项向导是一个用来创建ArcGIS桌面软件的加载项的可视化的工具。该工具通过点击操作大大简化了开发过程。在下一个案例中，你就要使用该向导工具来创建简单的ArcGIS桌面软件加载项。
创建按钮加载项
按钮加载项是最简单也是最为常用的类型。使用按钮加载项，点击一次按钮就会执行一次脚本中的功能操作。
Getting ready
创建一个新加载项的第一步就是创建一个加载项项目。使用Python加载项向导工具创建项目，你首先需要选择一个工作目录，然后输入多个项目设置最后点击保存（Save）按钮。创建加载项的过程按照已定义的流程进行，如下图所示：
你需要首先创建一个加载项的容器，该容器可以是工具条也可以是菜单。接下来创建需要添加到容器中的按钮，工具或其他加载项。在本案例中，我们只创建一个按钮加载项。接下来，你需要编辑与按钮关联的Python脚本文件。你还需要测试按钮来确保其工作正常。最后，你还可以将加载项共享给其他人。在本案例中，你将学习如何使用加载项向导工具来创建一个ArcGIS桌面软件的按钮加载项。该按钮将会执行你在之前的案例中创建的一个自定义脚本工具，该工具会从文本文件中导入火情数据并转成一个点要素类。
How to do it...
按照以下步骤来学习如何创建一个按钮加载项：
1.双击addin_assistant.exe文件打开Python加载项向导。
2.创建一个新的项目文件夹，并命名为Wildfire_Addin然后点击OK按钮。
3.项目设置（Project Settings）选项卡会首先被激活，并显示刚才创建的工作目录。默认情况下，ArcMap是被选择的产品，你可以确认一下：
4.项目命名。我们在这里命名为Load Wildfire Data Addin：
5.默认情况下，版本号为0.1。你可以修改为你喜欢的版本号。版本号随着工具的更新或功能增加应该也随着改变。这将会有助于加载项的追踪和共享。
6.名称和版本属性是仅有的两个必选属性。但是添加单位，说明和作者信息是一个好的习惯。如下图所示添加你自己的相关信息：
7.你或许还希望给加载项添加一个图片。你可以在C:\ArcpyBook\Ch11文件中找到wildfire.png图片文件：
8.加载项内容（Add-In Content）选项卡用于定义要创建的多种加载项。在这一步骤中，我们会创建一个工具条来放置按钮加载项用于执行脚本。点击加载项内容（Add-In Content）选项卡：
9.在加载项内容（Add-In Content）选项卡中，右键单击工具条（Toolbars）选择新工具条（New Toolbars）。设置工具条的标题，默认ID并勾选初始化显示（Show Initially）复选框：
工具条加载项虽然不提供任何功能操作，但作为像按钮，工具，组合框，工具选项板以及菜单等加载项的容器是非常的重要。工具条可以浮动或固定。使用Python加载项向导创建一个工具条加载项非常方便。
10.点击保存（Save）按钮。
11.现在，右键单击Wildfire Toolbar选项选择新按钮（New Button）来添加一个按钮：
12.输入按钮标题，类名，ID，工具提示等其他细节信息。你还可以指定按钮控件的图像。我在本案例中没有指定图像，不过你可以尝试一下。这些信息将会保存到加载项配置文件中：
13.点击保存（Save）按钮。
加载项需要一个与之关联的Python脚本文件。该文件默认情况下被命名为WildfireAddin_addin.py，该文件位于工作项目文件夹下的install目录下。
14.我们之前已经创建了一个自定义的ArcToolbox脚本工具来加载一个逗号分隔的文本文件并将火情数据转成要素类。我们将在加载项中使用该脚本。在Windows资源管理器中找到你之前创建的加载项目录。打开Install文件夹找到WildfireAddin_addin.py，并在Python编辑器中打开。
15.找到onClick(self)方法。点击按钮后触发该方法：
import arcpy
import pythonaddins
class ButtonClassImportWildfires(object):
"""Implementation for WildfireAddIn_addin.button (Button)"""
def __init__(self):
self.enabled = True
self.checked = False
def onClick(self):
pass
16.移除onClick事件中的pass语句。
17.第七章创建自定义地理处理工具中我们创建了一个自定义脚本工具从文本文件中导入火情数据并转成要素类。在onClick事件中调用该脚本工具，这样该工具会出现在用户界面中来执行选择文本文件，模板和要素类操作：
def onClick(self):
pythonaddins.GPToolDialog(r'c:\arcpybook\ch7\WildfireTools.tbx', 'LoadWildfires')
18.保存文件。
在下一个案例中，你会学习如何安装新的加载项。
How it works...
正如在案例中一样，Python加载项向导通过一个可视化界面来执行加载项的创建流程。然而在这后面，向导工具创建了加载项有关的一系列文件夹和文件。加载项文件结构相当简单。两个文件夹以及一系列文件构成了加载项文件结构，如下图所示：
Images文件夹中包含了加载项所用到的所有图标和图像文件。在本案例中，我们使用了wildfire.png文件，现在该文件应该位于Images文件夹中。Install文件夹包含了用于执行加载项业务逻辑的脚本文件。你会经常处理此类文件来编写加载项。脚本文件来执行那些需要通过按钮，工具，菜单项来执行的业务逻辑。加载项主文件中的config.xml文件定义了用户界面和所有静态属性，比如名称，作者，版本等信息。双击makeaddin.py会创建一个.esriaddin文件，该文件打包压缩了所有的文件。该文件将会分发给最终用户来安装加载项。
安装并测试加载项
在分发加载项给最终用户前，你需要测试这些加载项。进行测试前需要安装这些加载项。
Getting ready
在加载项工作目录下，makeaddin.py脚本用于将工作目录下的所有文件和文件夹打包压缩到一个<working folder name>.esriaddin形式的文件中。双击该.esriaddin文件打开ESRI ArcGIS加载项安装工具来安装你的加载项。之后你就可以在ArcGIS桌面软件中测试安装的加载项。自定义的工具条或菜单可能已经出现在界面中。如果没有显示显示，在自定义（Customize）菜单下点击加载项管理器（Add-in Manager）。加载项管理器（Add-in Manager）对话框列出了针对当前应用程序下安装的所有加载项。名称，描述和图片等这些在项目设置中输入的加载项信息都会看到。
How to do it...
按照以下步骤来学习如何安装并测试加载项：
1.你的加载项主文件夹下会有一个makeaddin.py的Python脚本文件。该脚本用于创建.esriaddin文件。双击该脚本运行创建一个.esriaddin文件。如下图所示：
2.双击Wildfire_Add-In.esriaddin文件，如下图所示打开Esri ArcGIS加载项安装工具窗口来安装加载项：
3.点击安装加载项（Install Add-In）按钮。如果一切顺利，你会看到如下图所示消息：
4.打开ArcMap来测试加载项。你的加载项已经被激活。如果没有激活，选择自定义|加载项管理器（Customize|Add-In Manager）。如下图所示显示加载项管理器对话框。你会看到你安装的加载项：
5.如果有必要，选择自定义（Customize）按钮。点击工具条（Toolbars）选项卡选择你创建的工具条并添加到程序界面中：
How it works...
安装工具会将加载项安装到默认的加载项文件夹中。默认位置如下：
- Vista/7：
C:\Users\<username>\Documents\ArcGIS\AddIns\Desktop10.1 - XP：
C:\Documents and Settings\<username>\My Documents\ArcGIS\AddIns\Desktop10.1
如下图所示，在默认的加载项文件夹下会创建一个以全局唯一识别符（GUID）命名的子文件夹。加载项就位于该文件夹中。当ArcGIS桌面软件启动时，程序就会搜索这些文件并导入加载项：
加载项文件如下图所示：
默认的加载项文件夹位于你的用户账号中的ArcGIS文件夹中。比如，如果你安装的是ArcGIS 10.1版本，Vista或Window7操作系统中的默认加载项文件夹路径为
C:\user\<username>\Documents\ArcGIS\Addins\Desktop10.1。
你还可以使用一个专用网络驱动器来为用户分发加载项。ArcGIS桌面软件中的加载项管理器添加并维护用于搜索加载项的文件夹列表。在加载项管理器对话框中选择选项（Option）选项卡之后点击添加文件夹（Add Folder）来添加一个网络驱动器到列表中。
创建工具加载项
工具加载项与按钮非常相似，只不过工具需要与地图窗口进行某些交互操作。举个例子，ArcMap中的放大工具就是一个典型示例。工具需要位于在工具条或工具选项板中。工具加载项属性与按钮基本一样。也需要编辑Python脚本。
Getting ready
工具类包含的属性有光标（cursor），可用性（enabled）以及形状（shape）。光标属性集用来设置工具点击时光标的类型，如下图所示，使用整数值来定义相对应的光标类型：
默认情况下，工具都是可用的。不过可以将工具的enabled属性设置为false，则会更改工具的可用性。最后shape属性指定了在地图上绘制的形状类型，包括线，矩形或圆形。这些属性通常是在工具的构造函数中调用_init_函数来设置，如下代码示例所示。self变量指向当前对象（这里指工具）：
def _init_(self):
self.enabled = True
self.cursor = 3
self.shape = 'Rectangle'
工具类中还支持许多相关的函数。所有类都包含一个构造函数用于定义该类的属性。你前面看到的_init_函数就是一个例子。工具中其他重要的函数包括onRectangle()，onCircle()以及onLine()。这些函数与要绘制到地图中的形状有关联。绘制的形状的几何参数会传递给这些函数。还有一些鼠标和键盘操作有关的函数。最后调用deactivate()函数使工具处于非活动状态。
_init_函数用于设置工具的多个属性。在这里，我们解释下工具类中的onRectangle()函数。当在地图中绘制矩形的时候调用该函数。矩形的几何参数传递给函数，同时引用当前工具：
def onRectangle(self,rectangle_geometry):
在本案例中，你会学习如何创建一个工具加载项可以让用户在地图中绘制矩形并在矩形范围内生成随机点。
How to do it...
按照以下步骤使用Python加载项向导创建一个工具加载项：
1.双击addin_assistant.exe文件打开ArcGIS加载项向导。
2.创建一个新项目文件夹并命名为Generate_Random_Points，然后点击OK。
3.在项目设置（Project Settings）选项卡中输入名称，版本，单位，描述和作者属性信息：
4.点击加载项内容（Add-In Content）选项卡。
5.右键单击工具条（Toolbars）选择新工具条（New Toolbars）。
6.工具条标题设置为Random Points Toolbar。
7.右键单击新创建的Random Points Toolbar工具条选择新工具（New Tool）。
8.如下图所示输入工具的信息:
9.点击保存（Save）按钮。向导工具会生成加载项文件夹和文件。
10.打开新加载项工作目录中的Install文件夹，使用IDLE打开Generate_Random_Points_addin.py文件。
11.添加以下代码：
def _init_(selft):
self.enabled = True
self.cursor = 3
self.shape = 'Rectangle'
12.在onRectangle()函数中添加代码实现在绘制到地图中的矩形内部生成随机点：
def onRectangle(self,rectangle_geometry):
extent = rectangle_geometry
arcpy.env.workspace = r"C:\ArcpyBook\Ch11"
if arcpy.Exists('randompts.shp'):
arcpy.Delete_management('randompts.shp')
randompts=arcpy.CreateRandomPoints_management(arcpy.env.workspace, 'randompts.shp',"",extent)
arcpy.RefreshActiveView()
return randompts
13.保存文件。
14.双击makeaddin.py文件生成esriaddin文件。
15.双击Generate_Random_Points.esriaddin文件安装加载项。
16.打开ArcMap，如有必要添加Generate Random Points工具条。
17.在地图中绘制一个矩形来测试加载项。输出结果如下图所示。你的地图显示结果由于点位置的随机性分布会有所不同：
How it works...
工具加载项与按钮非常相似，区别在于工具加载项需要先与地图窗口进行某些交互后才会触发工具执行操作。地图交互包括点击地图，绘制多边形或矩形或者各种鼠标和键盘事件。你可以编写Python代码来响应一个或多个交互事件。在本案例中，你学习了如何编写代码来响应onRectangle()事件。你还在加载项构造函数中设置了光标（cursor）和形状（shape）属性，其中形状（shape）属性指定地图中要绘制的图形形状。
There's more...
你还可以创建许多加载项。组合框加载项提供了可供用户选择的下拉值列表，用户还可以选择输入新值来编辑列表内容。同其他加载项一样，你也需要首先使用Python加载项向导创建一个新项目，然后添加一个新工具条，之后在工具条中添加一个组合框。
工具选项板提供了对相关工具进行分组的方式。该加载项也需要添加到一个已有工具条中。默认情况下，工具选项板中的工具是格网状显示。
菜单加载项作为按钮和其他菜单的容器。菜单除了可以通过ArcGIS桌面软件中的加载项管理器中显示，也可以显示在自定义（Customize）对话框中。
应用程序扩展用于向ArcGIS桌面软件中添加特定的相关功能工具集。比如Spatial Analyst，3D Analyst以及Bussiness Analyst等。通常应用程序扩展负责监听并响应事件。比如说，你创建一个应用程序扩展在用户每次添加一个图层时保存地图文档文件。应用程序扩展还可以协调组件之间的活动。
