本节将会详细介绍与QGIS地图控件交互所需要的一些常用对象与函数。
同时,本节开始,将会大量加QGIS的Python API文档的介绍,毕竟看API文档才是学习功能的最佳途径。
获取API文档
打开QGIS的Python API文档,只需要在QGIS的「Help」菜单下面,选择「API Documentation」就可以了,如下图。需要注意的是Python的API和C++的API是一致的(因为底层都是C++开发的),所以,这API文档也是一样的,看到API文档里面有C++的指针不要惊讶。
打开之后,默认是最新版本的API,需要根据你的QGIS版本选择对应的API版本进行查看。
QgsInterface类
在API文档里面,找到QgsInterface类(擅于用浏览器的搜索功能),这个类就是Python插件与QGIS软件中的控件进行交互的直接接口。来看一下这个类的官方说明。
QgsMapCanvas类
我们找到QgsInterface这个类里面的 MapCanvas 方法(擅于用浏览器的搜索功能):
它返回一个QgsMapCanvas的指针,也就是地图控件了。因此,为了获取QGIS地图控件,我们可以在QGIS的Python控制台输入如下代码:
canvas = qgis.utils.iface.mapCanvas()