https://github.com/jaweilbaum/pyqtlet2
pyqtlet2 extends pyqtlet which initially brought Leaflet maps to PyQt5 and PySide6.
https://github.com/jaweilbaum/pyqtlet2
map pyqt5 pyqt5-map python python-maps
Last synced: 9 months ago
JSON representation
pyqtlet2 extends pyqtlet which initially brought Leaflet maps to PyQt5 and PySide6.
- Host: GitHub
- URL: https://github.com/jaweilbaum/pyqtlet2
- Owner: JaWeilBaum
- License: other
- Created: 2021-02-10T20:49:10.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-19T19:58:41.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T02:52:11.427Z (9 months ago)
- Topics: map, pyqt5, pyqt5-map, python, python-maps
- Language: Python
- Homepage:
- Size: 2.45 MB
- Stars: 41
- Watchers: 2
- Forks: 20
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# pyqtlet2
pyqtlet is a Leaflet map wrapper for Qt bindings. In construction and design, it mimics the [official leaflet api](http://leafletjs.com/reference-1.3.0.html) as much as possible.
## About
This is a fork of the repository pyqtlet from @skylarkdrones. Since the original repository is not further maintained. Since I find this package very useful for a map implementation in the QT environment, I want to further develop this package. If you want to extend this package feel free to get in contact with me or create an Issue/Pull Request with a change!
## Installation
You as a user need to specify the Qt package you want to use. Please check [qtpy](https://github.com/spyder-ide/qtpy) to find out which Qt bindings can be used.
``` bash
pip3 install "pyqtlet2[PyQt5]"
# or
pip3 install "pyqtlet2[PySide6]"
```
If you have multiple Qt bindings installed in your environment, please specify the necessary environment variable inside your code.
``` python
import os
os.environ['QT_API'] = 'pyqt5'
from qtpy import QtGui
```
Check if the installation was successful:
``` bash
# To test whether it is successfully working
python3
>>> from pyqtlet import L, MapWidget
>>> # No errors
```
## Usage
``` python
import os
import sys
os.environ['QT_API'] = 'pyqt5'
from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
from pyqtlet2 import L, MapWidget
class MapWindow(QWidget):
def __init__(self):
# Setting up the widgets and layout
super().__init__()
self.mapWidget = MapWidget()
self.layout = QVBoxLayout()
self.layout.addWidget(self.mapWidget)
self.setLayout(self.layout)
# Working with the maps with pyqtlet
self.map = L.map(self.mapWidget)
self.map.setView([12.97, 77.59], 10)
L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png').addTo(self.map)
self.marker = L.marker([12.934056, 77.610029])
self.marker.bindPopup('Maps are a treasure.')
self.map.addLayer(self.marker)
self.show()
if __name__ == '__main__':
app = QApplication(sys.argv)
widget = MapWindow()
sys.exit(app.exec_())
```
## Additional Leaflet Packages
- Leaflet.draw (Version 0.4.14) - https://github.com/Leaflet/Leaflet.draw
- Leaflet.RotatedMarker (Version 0.2.0) - https://github.com/bbecquet/Leaflet.RotatedMarker
## Using Unimplemented Leaflet Features
At this time, there is none actively adding features to pyqtlet. This means that there
are a lot of Leaflet features that are not implemented in pyqtlet. However, there is still
a way to access these features via the `runJavaScript` api. This allows arbitrary code to
be run within the map window.
For example, if we want to change the marker icon in the above example, add the following
2 lines of code after the `self.map.addLayer(self.marker)` statement.
``` python
# Create a icon called markerIcon in the js runtime.
self.map.runJavaScript('var markerIcon = L.icon({iconUrl: "https://leafletjs.com/examples/custom-icons/leaf-red.png"});')
# Edit the existing python object by accessing it's jsName property
self.map.runJavaScript(f'{self.marker.jsName}.setIcon(markerIcon);')
```
This technique will allow users to use all the features available in leaflet.
## Contributors
A big thank you, goes to all the contributors of this project!
## Contributing
In terms of contributing, there is a lot of work that still needs to be done.
Specifically, there are a lot of leaflet features that need to be ported into pyqtlet. All contributions welcome.