- QGIS Python Programming Cookbook
- Joel Lawhead
- 427字
- 2021-07-23 19:48:51
Navigating the PyQGIS API
The QGIS Python API, also known as PyQGIS, allows you to control virtually every aspect of QGIS. The ability to find the PyQGIS object you need in order to access a particular feature of QGIS is critical to automation.
Getting ready
The PyQGIS API is based on the QGIS C++ API. The C++ API is kept up to date online and is well-documented.
Note
The QGIS API's web page is located at http://qgis.org/api/2.6/modules.html.
Notice the version number, 2.2, in the URL. You can change this version number to the version of QGIS you are using in order to find the appropriate documentation.
The PyQGIS API documentation is not updated frequently because it is nearly identical to the structure of the C++ API. However, the QGIS project on github.com maintains a list of all the PyQGIS classes for the latest version. The PyQGIS 2.6 API is located at https://github.com/qgis/QGIS/blob/master/python/qsci_apis/Python-2.6.api.
You can locate the documented class in the main C++ API and read about it. Then, look up the corresponding Python module and class using the PyQGIS API listing. In most cases, the C++ API name for a class is identical in Python.
In this recipe, we'll locate the PyQGIS class that controls labels in QGIS.
How to do it…
We will perform the following steps to see in which PyQGIS module the QGIS Label object and QgsLabel are located in:
- Go to the QGIS API page at http://qgis.org/api/2.6/index.html.
- Click on the Modules tab.
- Click on the link QGIS Core Library.
- Scroll down the list of modules in alphabetical order until you see QgsLabel.
- Click on the QgsLabel link to access the label object documentation.
- Now, go to the PyQGIS API listing at https://github.com/qgis/QGIS/blob/master/python/qsci_apis/Python-2.6.api.
- Scroll down the alphabetical class listing until you see
qgis.core.QgsLabel.LabelField
.
How it works…
The QGIS API is divided into five distinct categories, as follows:
- Core
- GUI
- Analysis
- Map composer
- Network analysis
Most of the time, it's easy to find the class that targets the functionality you need with most of QGIS being contained in the catch-all Core module. The more you use the API, the quicker you'll be able to locate the objects you need for your scripts.
There's more…
If you're having trouble locating a class containing the keyword you need, you can use the search engine on the QGIS API website.
- What's New in TensorFlow 2.0
- Photoshop智能手機APP UI設(shè)計之道
- 構(gòu)建移動網(wǎng)站與APP:HTML 5移動開發(fā)入門與實戰(zhàn)(跨平臺移動開發(fā)叢書)
- JavaFX Essentials
- Java從入門到精通(第5版)
- Building Mapping Applications with QGIS
- C語言程序設(shè)計案例式教程
- Mastering KnockoutJS
- Java系統(tǒng)化項目開發(fā)教程
- 零基礎(chǔ)入門學(xué)習(xí)Python(第2版)
- Quantum Computing and Blockchain in Business
- ScratchJr趣味編程動手玩:讓孩子用編程講故事
- Python編程基礎(chǔ)教程
- Responsive Web Design with jQuery
- 讓Python遇上Office:從編程入門到自動化辦公實踐