wegiangb / qgis-class-diagram

Diagram to help you find out main relations in QGIS Python API classes - diagramme pour montrer les principales relations entre les classes QGIS de l'API Python

QGIS diagram

English

Background

Some of our clients where not really satisfied with the overall Qt/QGIS documentation API (C++ based) to find out the most useful classes in Python QGIS API.

Due to this feedback, we made a diagram to displays main classes and relationships between them. We don't pretend to be exhaustive nor wish to be (or we may lose the synthetic view).

Most of the time, the relationship is directly related to the code. Sometimes we choose to not comply to code to show more logical relations (like between QgsProject and QgsMapLayerRegistry)

This document was produced for French. However, as English speakers, you should be able to understand most of the diagram.

You can also use the online browsing sample if you prefer.

Feel free to contact us to for feedback at [email protected] or though issues.

License

The document is under Attribution-ShareAlike 4.0 International (CC by SA 4.0), also mentioned in the doc itself.

You can do what you want with it as long as you give credits to "Thomas Gratier" (Attribution part of the license) and you redistribute modified document with the same license (SA like ShareAlike)

Français

Contexte

Certains de nos clients n'étaient pas très satisfaits par la documentation des API Qt/QGIS (basées sur C++) pour trouver les classes les plus utiles de l'API QGIS Python.

Suite à ce retour, nous avons créé un diagramme qui montre les principales classes et les relations entre elles. Nous n'affirmons pas que ce diagramme est exhaustif ni qu'il a vocation à l'être (au risque de perdre l'aspect relativement synthétique)

La plupart du temps, le lien entre les éléments est lié directement aux classes principales. Quelques fois, nous avons choisi de pas nous conformer à une approche purement code pour mettre en avant certaines relations logiques (comme entre QgsProject et QgsMapLayerRegistry).

Ce document est en Français.

Vous pouvez aussi utilisez le visualisateur en ligne si vous préférez.

Contactez nous pour tout retour via [email protected] ou en ouvrant un demande Github.

Licence

Ce document est sous licence Attribution-ShareAlike 4.0 International (CC by SA 4.0), également mentionnée dans le document lui-même.

Vous pouvez en faire ce que vous voulez aussi longtemps que vous mentionné les crédits à "Thomas Gratier" (partie Attribution de la licence) et que vous redistribuez le document modifié avec la même licence (condition ShareAlike, c'est à dire partage à l'identique)