leaflet-rotate 0.5.0 → 0.5.1

package/README.md

@@ -26,7 +26,7 @@ Load Leaflet first, then the plugin. For example, using the published CDN build:
 ```html
 <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9/dist/leaflet.css">
 <script src="https://unpkg.com/leaflet@1.9/dist/leaflet.js"></script>
-<script src="https://unpkg.com/leaflet-rotate@0.5.0/dist/leaflet-rotate.js"></script>
+<script src="https://unpkg.com/leaflet-rotate@0.5.1/dist/leaflet-rotate.js"></script>
 ```
 
 Or if you want to test it with [`2.0.0-alpha.1`](https://github.com/Leaflet/Leaflet/releases/tag/v2.0.0-alpha.1):
@@ -35,7 +35,7 @@ Or if you want to test it with [`2.0.0-alpha.1`](https://github.com/Leaflet/Leaf
 <link rel="stylesheet" href="https://unpkg.com/leaflet@2.0.0-alpha.1/dist/leaflet.css">
 <script src="https://unpkg.com/leaflet@2.0.0-alpha.1/dist/leaflet-global-src.js"></script>
 <script>globalThis.L = globalThis.leaflet;</script>
-<script src="https://unpkg.com/leaflet-rotate@0.5.0/dist/leaflet-rotate.js"></script>
+<script src="https://unpkg.com/leaflet-rotate@0.5.1/dist/leaflet-rotate.js"></script>
 ```
 
 Now, you can enable rotation in the map options. Bearing and pitch values are in degrees:
@@ -60,10 +60,13 @@ console.log(map.getBearing(), map.getPitch());
 | `rotate` | `false` | Enables map rotation and pitch. |
 | `bearing` | `0` | Initial map bearing, in degrees. |
 | `pitch` | `0` | Initial map pitch, in degrees (clamped to `0`–`85`). |
+| `pitchMaxDistance` | `3` | Far plane for pitched maps, in multiples of the map height: farther areas (and anything beyond the horizon) are not loaded and are covered by the `.leaflet-pitch-sky` element. Lower values load fewer tiles. |
 | `rotateControl` | `true` | Adds the rotation control. Set to `false` to hide it, or pass options such as `{ closeOnZeroBearing: false }`. |
 | `shiftKeyRotate` | `true` | Enables bearing changes with Shift + mouse wheel. |
-| `pitchDrag` | `true` | Enables bearing and pitch changes with Ctrl + mouse drag. |
+| `pitchDrag` | `true` | Enables bearing and pitch changes with Ctrl + mouse drag or right-button drag. |
 | `touchRotate` | `false` | Enables rotation with a two-finger touch gesture. |
+| `touchPitch` | `false` | Enables pitch changes by dragging two fingers vertically. |
+| `compassBearing` | `false` | Makes the bearing follow the device compass. On iOS, enable it from a user gesture (e.g. `map.compassBearing.enable()` in a button click) so that the orientation permission can be requested. |
 
 #### Map methods and events
 
@@ -71,14 +74,22 @@ console.log(map.getBearing(), map.getPitch());
 | --- | --- |
 | `map.setBearing(degrees, options?)` | Sets the bearing. Use `{ animate: true, duration: 0.5 }` for an animated change; `duration` is in seconds. |
 | `map.getBearing()` | Returns the current bearing in degrees. |
-| `map.setPitch(degrees)` | Sets the pitch, clamped to `0`–`85` degrees. |
+| `map.setPitch(degrees, options?)` | Sets the pitch, clamped to `0`–`85` degrees. Accepts the same animation options as `setBearing`. |
 | `map.getPitch()` | Returns the current pitch in degrees. |
+| `map.resetNorth(options?)` | Animates the bearing back to `0` (pass `{ animate: false }` to skip the animation). |
+| `map.resetNorthPitch(options?)` | Animates both bearing and pitch back to `0`. |
 | `rotate` event | Fired when the bearing changes. |
 | `pitch` event | Fired when the pitch changes. |
 
 #### Rotation control
 
-The control is available as `L.Control.Rotate` or `L.control.rotate(options)`. The map option `rotateControl` adds it automatically; its `position` follows Leaflet control positions, and `closeOnZeroBearing` (default `true`) hides it when the bearing is zero.
+The control is available as `L.Control.Rotate` or `L.control.rotate(options)`. Click it to reset bearing and pitch (`map.resetNorthPitch()`), drag it horizontally to rotate and vertically to change the pitch. The map option `rotateControl` adds it automatically.
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `position` | `'topleft'` | Leaflet control position. |
+| `closeOnZeroBearing` | `true` | Hides the control when both bearing and pitch are zero. |
+| `visualizePitch` | `true` | Tilts the icon with the pitch; when `false`, clicking only resets the bearing and dragging only rotates. |
 
 #### Marker options
 
@@ -119,6 +130,6 @@ Initial changes to this project have been apported by comparing the following br
 ---
 
 **Compatibile with:**
-[![Leaflet 1.x compatible!](https://img.shields.io/badge/Leaflet-1.9-1EB300.svg?style=flat)](http://leafletjs.com/reference.html) [![Leaflet 2.x compatible!](https://img.shields.io/badge/Leaflet-2.0.0--alpha.1-1EB300.svg?style=flat)](http://leafletjs.com/reference.html)
+[![Leaflet 1.9.4 compatible!](https://img.shields.io/badge/Leaflet-1.9.4-1EB300.svg?style=flat)](http://leafletjs.com/reference.html) [![Leaflet 2.x compatible!](https://img.shields.io/badge/Leaflet-2.0.0--alpha.1-1EB300.svg?style=flat)](http://leafletjs.com/reference.html)
 
 **Contributors:** [IvanSanchez](https://github.com/IvanSanchez), [Fnicollet](https://github.com/fnicollet/Leaflet/tree/rotate-master), [Hyperknot](https://github.com/hyperknot), [Raruto](https://github.com/Raruto/leaflet-rotate)