mirrors/PMTiles
1
0
Fork 0
mirror of https://github.com/protomaps/PMTiles.git synced 2026-02-04 02:41:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

js docs: add example on line to include library

Browse Source
This commit is contained in:
Brandon Liu
2022-10-28 18:34:47 +08:00
parent 674e92624d
commit 40679aa2bd
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
js/README.md
View File

@@ -1,8 +1,16 @@
the [PMTiles](https://www.npmjs.com/package/pmtiles) package can be included via script tag or ES6 module. the [PMTiles](https://www.npmjs.com/package/pmtiles) package can be included via script tag or ES6 module:
## Leaflet ```html
<script src="https://unpkg.com/pmtiles@2.4.0/dist/index.js"></script>
```
### Raster tileset As an ES6 module: `npm add pmtiles`
```js
import * as pmtiles from "pmtiles";
```
### Leaflet: Raster tileset
Example of a raster PMTiles archive displayed in Leaflet: Example of a raster PMTiles archive displayed in Leaflet:
@@ -11,10 +19,9 @@ const p = new pmtiles.PMTiles('example.pmtiles')
pmtiles.leafletRasterLayer(p,{attribution:'© <a href="https://openstreetmap.org">OpenStreetMap</a>'}).addTo(map) pmtiles.leafletRasterLayer(p,{attribution:'© <a href="https://openstreetmap.org">OpenStreetMap</a>'}).addTo(map)
```` ````
[Live example](https://protomaps.github.io/PMTiles/examples/leaflet.html) | [Code](https://github.com/protomaps/PMTiles/blob/master/js/examples/leaflet.html) [Live example](https://protomaps.github.io/PMTiles/examples/leaflet.html) | [Code](https://github.com/protomaps/PMTiles/blob/master/js/examples/leaflet.html)
### Vector tileset ### Leaflet: Vector tileset
See [protomaps.js](https://github.com/protomaps/protomaps.js) See [protomaps.js](https://github.com/protomaps/protomaps.js)