QGIS-3.28-二次开发手册.pdf_pyqgis-startup脚本资源-CSDN文库

需积分: 5 172 浏览量 2024-03-17 10:31:38 上传评论 1 收藏 1.36MB PDF 举报

QGIS-3.28-桌面端用户手册.pdf QGIS-3.28-新手引导指南.pdf QGIS-3.28-Server用户手册.pdf QGIS-3.28-二次开发手册.pdf QGIS-3.28-新手引导手册.pdf ### QGIS 3.28 二次开发手册关键知识点概览 #### 一、PyQGIS 开发者手册概述 **1.1 脚本编写：Python 控制台** 在 QGIS 中，Python 控制台是进行脚本编写的重要工具之一。它允许开发者直接在 QGIS 环境中执行 Python 代码，方便测试和调试功能。控制台提供了丰富的 API，使得用户能够轻松地访问 QGIS 的核心功能和数据。 **1.2 Python 插件** - **1.2.1 处理插件（Processing Plugins）** Processing 插件框架为 QGIS 提供了强大的数据处理能力。开发者可以通过创建自定义的处理算法来扩展 QGIS 的功能。这些算法可以被集成到图形用户界面（GUI）中，也可以通过命令行或脚本方式调用。 - **1.3 在 QGIS 启动时运行 Python 代码** - **1.3.1 startup.py 文件** 可以在 QGIS 安装目录下的 `python` 文件夹中放置一个名为 `startup.py` 的文件。这个文件将在每次启动 QGIS 时自动执行，可用于初始化环境或设置默认配置等。 - **1.3.2 PYQGIS_STARTUP 环境变量** 通过设置环境变量 `PYQGIS_STARTUP`，可以指定一个或多个 Python 脚本文件的路径，在 QGIS 启动时执行这些脚本。 - **1.3.3 --code 参数** 当启动 QGIS 时，可以通过命令行参数 `--code` 直接传递 Python 代码字符串，QGIS 将立即执行该代码。 - **1.3.4 为 Python 添加额外参数** 在某些情况下，可能需要向 Python 解释器传递额外的参数。这可以通过修改 QGIS 的启动脚本来实现。 **1.4 Python 应用程序** - **1.4.1 使用 PyQGIS 在独立脚本中** 开发者可以将 PyQGIS 库导入到独立的 Python 脚本中，并利用其提供的功能来处理地理空间数据。这种方式非常适合批处理任务或者自动化工作流。 - **1.4.2 使用 PyQGIS 在自定义应用程序中** PyQGIS 不仅可以在 QGIS 内部使用，还可以作为外部 Python 项目的库。开发者可以在自己的 GUI 或 Web 应用程序中集成 QGIS 的强大功能。 - **1.4.3 运行自定义应用程序** 要运行包含 PyQGIS 的自定义应用程序，需要确保 Python 环境中已安装了必要的依赖库，并且正确配置了 QGIS 的路径。 **1.5 关于 PyQt 和 SIP 的技术笔记** PyQt 和 SIP 是 PyQGIS 使用的关键组件。PyQt 是一套用于创建 GUI 的 Python 绑定库，而 SIP 则是用于创建 PyQt 和其他 Qt 绑定库的工具。理解这两者的原理对于深入掌握 PyQGIS 非常重要。 #### 二、加载项目与解决路径问题 **2.1 解决错误的路径问题** 在加载 QGIS 项目时，可能会遇到路径不正确的问题。这通常是因为相对路径和绝对路径的使用不当导致的。为了解决这一问题，开发者可以使用 QGIS 提供的一些函数，如 `QgsDataSourceUri` 和 `QgsProject.instance().writeEntry()` 来动态调整路径。 **2.2 使用标志加快加载速度** 当处理大型项目时，加载时间可能会变得很长。为了提高效率，可以使用一些标志来优化加载过程。例如，可以使用 `QgsVectorLayer.LayerOption` 或 `QgsRasterLayer.LayerOption` 来跳过某些耗时的操作，比如栅格图层的重采样。 #### 三、加载图层 **3.1 矢量图层** 矢量图层是 QGIS 中最常见的图层类型之一，主要用于表示点、线、面等地理要素。要加载矢量图层，可以使用 `QgsVectorLayer` 类。该类提供了多种方法来读取和操作矢量数据。 - **创建矢量图层** ```python layer = QgsVectorLayer("path/to/your/file.shp", "layer_name", "ogr") ``` - **添加矢量图层到项目** ```python if not layer.isValid(): print("Layer failed to load!") else: QgsProject.instance().addMapLayer(layer) ``` **3.2 栅格图层** 栅格图层用于表示连续表面，如地形高程、卫星图像等。加载栅格图层的过程与矢量图层类似，但使用的是 `QgsRasterLayer` 类。 - **创建栅格图层** ```python raster_layer = QgsRasterLayer("path/to/your/file.tif", "raster_layer_name") ``` - **添加栅格图层到项目** ```python if not raster_layer.isValid(): print("Raster layer failed to load!") else: QgsProject.instance().addMapLayer(raster_layer) ``` **3.3 QgsProject 实例** `QgsProject` 类是管理项目的核心类，它包含了所有图层和其他项目的设置。通过 `QgsProject.instance()` 方法可以获得当前项目的实例。 - **获取 QgsProject 实例** ```python project = QgsProject.instance() ``` - **添加图层到 QgsProject 实例** ```python project.addMapLayer(layer) ``` - **移除图层** ```python project.removeMapLayer(layer.id()) ``` #### 四、访问目录（TOC） **4.1 QgsProject 类** `QgsProject` 类不仅用于管理图层，还负责管理整个项目的数据结构。通过该类的方法，可以轻松地访问目录中的各项内容，如图层列表、地图注记等。 - **获取所有图层** ```python layers = project.mapLayers().values() ``` - **按名称查找图层** ```python layer = project.mapLayersByName("layer_name")[0] ``` - **移动图层顺序** ```python project.layerTreeRoot().insertChildNode(index, node) ``` 以上内容概括了 QGIS 3.28 二次开发手册中的关键知识点。这些知识点涵盖了从基础的 Python 控制台使用到更高级的图层管理和项目加载等内容。通过理解和应用这些知识点，开发者可以有效地利用 QGIS 的强大功能进行地理空间数据分析和处理。

资源推荐

资源详情

资源评论

PyQGIS 3.28 developer cookbook

QGIS Project

2024 年 03 月 03 日

Contents

1 简介 1

1.1 Scripting in the Python Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2 Python Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2.1 Processing Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3 Running Python code when QGIS starts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3.1 The startup.py 󰝘le . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3.2 The PYQGIS_STARTUP environment variable . . . . . . . . . . . . . . . . . . . . . . 3

1.3.3 The --code parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3.4 Additional arguments for Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.4 Python Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.4.1 Using PyQGIS in standalone scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.4.2 Using PyQGIS in custom applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.4.3 Running Custom Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.5 Technical notes on PyQt and SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 加载工程 7

2.1 Resolving bad paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.2 Using 󰝙ags to speed up things . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3 Loading Layers 11

3.1 Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3.2 Raster Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

3.3 QgsProject instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4 访问目录 (TOC) 17

4.1 QgsProject 类 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.2 类 QgsLayerTreeGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

5 Using Raster Layers 21

5.1 Layer Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

5.2 Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

5.2.1 Single Band Rasters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

5.2.2 Multi Band Rasters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

5.3 Query Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

5.4 Editing raster data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6 Using Vector Layers 25

6.1 Retrieving information about attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

6.2 Iterating over Vector Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

6.3 选择要素 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

6.3.1 Accessing attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6.3.2 Iterating over selected features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6.3.3 Iterating over a subset of features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6.4 Modifying Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

6.4.1 Add Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

6.4.2 Delete Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

6.4.3 Modify Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

6.4.4 Modifying Vector Layers with an Editing Bu󰝗er . . . . . . . . . . . . . . . . . . . . . . 31

6.4.5 Adding and Removing Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6.5 Using Spatial Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6.6 The QgsVectorLayerUtils class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

6.7 Creating Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6.7.1 From an instance of QgsVectorFileWriter . . . . . . . . . . . . . . . . . . . . . 35

6.7.2 Directly from features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

6.7.3 From an instance of QgsVectorLayer . . . . . . . . . . . . . . . . . . . . . . . . . 37

6.8 Appearance (Symbology) of Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.8.1 Single Symbol Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

6.8.2 Categorized Symbol Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

6.8.3 Graduated Symbol Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

6.8.4 Working with Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

6.8.5 Creating Custom Renderers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

6.9 Further Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

7 Geometry Handling 49

7.1 Geometry Construction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

7.2 Access to Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

7.3 Geometry Predicates and Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

8 Projections Support 55

8.1 Coordinate reference systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

8.2 CRS Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

9 Using the Map Canvas 59

9.1 Embedding Map Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

9.2 Rubber Bands and Vertex Markers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

9.3 Using Map Tools with Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

9.3.1 Select a feature using QgsMapToolIdentifyFeature . . . . . . . . . . . . . . . . . . . . . 63

9.3.2 Add items to map canvas contextual menu . . . . . . . . . . . . . . . . . . . . . . . . . 63

9.4 Writing Custom Map Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

9.5 Writing Custom Map Canvas Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

10 Map Rendering and Printing 67

10.1 Simple Rendering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

10.2 Rendering layers with di󰝗erent CRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

10.3 Output using print layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

10.3.1 Checking layout validity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

10.3.2 Exporting the layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

10.3.3 Exporting a layout atlas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

11 Expressions, Filtering and Calculating Values 73

11.1 Parsing Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

11.2 Evaluating Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

11.2.1 Basic Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

11.2.2 Expressions with features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

11.2.3 Filtering a layer with expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

11.3 Handling expression errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

12 Reading And Storing Settings 79

13 Communicating with the user 81

13.1 Showing messages. The QgsMessageBar class . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

13.2 Showing progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

13.3 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

13.3.1 QgsMessageLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

13.3.2 The python built in logging module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

14 Authentication infrastructure 87

14.1 简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

14.2 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

14.3 QgsAuthManager the entry point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

14.3.1 Init the manager and set the master password . . . . . . . . . . . . . . . . . . . . . . . . 89

14.3.2 Populate authdb with a new Authentication Con󰝘guration entry . . . . . . . . . . . . . . 89

14.3.3 Remove an entry from authdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

14.3.4 Leave authcfg expansion to QgsAuthManager . . . . . . . . . . . . . . . . . . . . . . . . 91

14.4 Adapt plugins to use Authentication infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . 92

14.5 Authentication GUIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

14.5.1 GUI to select credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

14.5.2 Authentication Editor GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

14.5.3 Authorities Editor GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

15 Tasks - doing heavy work in the background 95

15.1 简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

15.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

15.2.1 Extending QgsTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

15.2.2 Task from function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

15.2.3 Task from a processing algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

16 Developing Python Plugins 103

16.1 Structuring Python Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

16.1.1 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

16.1.2 Writing plugin code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

16.1.3 Documenting plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

16.1.4 Translating plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

16.1.5 Sharing your plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

16.1.6 Tips and Tricks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

16.2 Code Snippets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

16.2.1 How to call a method by a key shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

16.2.2 How to reuse QGIS icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

16.2.3 Interface for plugin in the options dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 113

16.2.4 Embed custom widgets for layers in the layer tree . . . . . . . . . . . . . . . . . . . . . . 115

16.3 IDE settings for writing and debugging plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

16.3.1 Useful plugins for writing Python plugins . . . . . . . . . . . . . . . . . . . . . . . . . . 116

16.3.2 A note on con󰝘guring your IDE on Linux and Windows . . . . . . . . . . . . . . . . . . 116

16.3.3 Debugging using Pyscripter IDE (Windows) . . . . . . . . . . . . . . . . . . . . . . . . 116

16.3.4 Debugging using Eclipse and PyDev . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

16.3.5 Debugging with PyCharm on Ubuntu with a compiled QGIS . . . . . . . . . . . . . . . . 121

16.3.6 Debugging using PDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

16.4 Releasing your plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

16.4.1 Metadata and names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

16.4.2 Code and help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

16.4.3 O󰝚cial Python plugin repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

17 Writing a Processing plugin 127

17.1 Creating from scratch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

17.2 Updating a plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

18 Using Plugin Layers 131

18.1 Subclassing QgsPluginLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

iii

剩余173页未读，继续阅读

评论收藏

内容反馈

kangjiazhuangyuan

粉丝: 21
资源: 4

QGIS-3.28-二次开发手册.pdf

QGIS-3.28-Server用户手册.pdf

QGIS-3.28-桌面端用户手册.pdf

QGIS-OSGeo4W-3.14.0-1-Setup-x86_64.part2.rar

python QGIS二次开发说明文档

qgis-2.8.0-qgis-2.18.27.zip

QGIS-OSGeo4W-3.12.2-2-Setup-x86.exe

QGIS-OSGeo4W-3.16.2-1-Setup-x86-64.exe

QGIS-OSGeo4W-3.10.13-1-Setup-x86-64.exe

QGIS-OSGeo4W-3.16.1-1-Setup-x86_64.exe

QGIS-OSGeo4W-3.16.3-1-Setup-x86_64.exe

QGIS-OSGeo4W-3.4.12-1-Setup-x86_64.exe

QGIS-OSGeo4W-3.16.4-1-Setup-x86_64.rar

QGIS使用手册

QGIS-OSGeo4W-3.10.1-1-Setup-x86_64.exe

QGIS-OSGeo4W-2.12.3-1-Setup-x86_64.rar

QGIS-OSGeo4W-3.16.0-1-Setup-x86_64

QGIS使用說明手冊

qgis-api-doc.haozip02.zip

Qgis学习资料.pdf

qgis-ltr-devel-3.4.15-1.tar.bz2

Learning QGIS, Third Edition

jira二次开发文档

QGIS-OSGeo4W-3.10.0-2-Setup-x86_64

Mastering QGIS(第二版）

QGIScode QGIS-Code-Examples QGIS-Compilation-Guide QGIS-Document

learning qgis(3rd)

Python库 | qgis-plugin-ci-2.1.1.tar.gz

PyPI 官网下载 | qgis-plugin-ci-1.5.1.tar.gz

最新资源