diff options
Diffstat (limited to 'doc/developer')
| -rw-r--r-- | doc/developer/module/hittekaart_py.rst | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/doc/developer/module/hittekaart_py.rst b/doc/developer/module/hittekaart_py.rst index 052c2b0..f665799 100644 --- a/doc/developer/module/hittekaart_py.rst +++ b/doc/developer/module/hittekaart_py.rst @@ -24,7 +24,7 @@ Example Track.from_file(b"Documents/track.gpx", None), Track.from_coordinates([(45.0, 47.0)]), ] - storage = Storage.Sqlite(b"/tmp/tiles.sqlite") + storage = Storage.OsmAnd(b"/tmp/tiles.sqlite") generate(settings, tracks, HeatmapRenderer(), storage) Input and output @@ -74,15 +74,34 @@ Input and output :return: The created storage. :rtype: Storage - .. staticmethod:: Sqlite(path) + .. staticmethod:: OsmAnd(path) - Output the tiles to the given SQLite database. + Output the tiles to the given SQLite database. The table format is + compatible with OsmAnd. See `the Rust crate`__ for more information. :param path: Path to the database. :type path: bytes :return: The created storage. :rtype: Storage + .. staticmethod:: MbTiles(path, name, description) + + Output the tiles to the given MbTiles database. Optionally, sets the + ``name`` and ``description`` metadata as given. See `the Rust crate`__ + for more information about the format. + + :param path: Path to the database. + :type path: bytes + :param name: Name of the resulting map layer. + :type name: str | None + :param description: Description of the map layer. + :type description: str | None + :return: The created storage. + :rtype: Storage + +.. __: https://docs.rs/hittekaart/latest/hittekaart/storage/struct.OsmAnd.html +.. __: https://docs.rs/hittekaart/latest/hittekaart/storage/struct.MbTiles.html + Renderers --------- |