Skip to content

Commit 7892549

Browse files
committed
Update API docs + examples, add changelog entry for 1.5.0
1 parent fbb6ab0 commit 7892549

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ A `google.maps.Circle` replacement for Mapbox GL JS, rendering a "spherical cap"
4646
```javascript
4747
var myCircle = new MapboxCircle({lat: 39.984, lng: -75.343}, 25000, {
4848
editable: true,
49+
minRadius: 1500,
4950
fillColor: '#29AB87'
5051
}).addTo(myMapboxGlMap);
5152

@@ -71,15 +72,15 @@ myCircle.on('contextmenu', function (mapMouseEvent) {
7172
- `radius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Meter radius
7273
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
7374
- `options.editable` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Enable handles for changing center and radius (optional, default `false`)
75+
- `options.minRadius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Minimum radius on user interaction (optional, default `10`)
76+
- `options.maxRadius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Maximum radius on user interaction (optional, default `1100000`)
7477
- `options.strokeColor` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Stroke color (optional, default `'#000000'`)
7578
- `options.strokeWeight` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Stroke weight (optional, default `0.5`)
7679
- `options.strokeOpacity` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Stroke opacity (optional, default `0.75`)
7780
- `options.fillColor` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Fill color (optional, default `'#FB6A4A'`)
7881
- `options.fillOpacity` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Fill opacity (optional, default `0.25`)
7982
- `options.refineStroke` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Adjust circle polygon precision based on radius and zoom
8083
(i.e. prettier circles at the expense of performance) (optional, default `false`)
81-
- `options.minRadius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Minimum radius (optional, default `10`)
82-
- `options.maxRadius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Maximum radius (optional, default `1100000`)
8384
- `options.properties` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Property metadata for Mapbox GL JS circle object (optional, default `{}`)
8485

8586
#### on
@@ -183,6 +184,10 @@ Returns **{sw: {lat: [number](https://developer.mozilla.org/en-US/docs/Web/JavaS
183184

184185
## Changelog
185186

187+
### v. 1.5.0
188+
189+
- Added support for passing `minRadius` and `maxRadius` options to _MapboxCircle_ constructor
190+
186191
### v. 1.4.3
187192

188193
- Bug fix for handling _map.setStyle_ updates

lib/main.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ if (window && typeof window.MapboxCircle === 'function') {
2121
* @example
2222
* var myCircle = new MapboxCircle({lat: 39.984, lng: -75.343}, 25000, {
2323
* editable: true,
24+
* minRadius: 1500,
2425
* fillColor: '#29AB87'
2526
* }).addTo(myMapboxGlMap);
2627
*
@@ -150,15 +151,15 @@ class MapboxCircle {
150151
* @param {number} radius Meter radius
151152
* @param {?Object} options
152153
* @param {?boolean} [options.editable=false] Enable handles for changing center and radius
154+
* @param {?number} [options.minRadius=10] Minimum radius on user interaction
155+
* @param {?number} [options.maxRadius=1100000] Maximum radius on user interaction
153156
* @param {?string} [options.strokeColor='#000000'] Stroke color
154157
* @param {?number} [options.strokeWeight=0.5] Stroke weight
155158
* @param {?number} [options.strokeOpacity=0.75] Stroke opacity
156159
* @param {?string} [options.fillColor='#FB6A4A'] Fill color
157160
* @param {?number} [options.fillOpacity=0.25] Fill opacity
158161
* @param {?boolean} [options.refineStroke=false] Adjust circle polygon precision based on radius and zoom
159162
* (i.e. prettier circles at the expense of performance)
160-
* @param {?number} [options.minRadius=10] Minimum radius
161-
* @param {?number} [options.maxRadius=1100000] Maximum radius
162163
* @param {?Object} [options.properties={}] Property metadata for Mapbox GL JS circle object
163164
* @public
164165
*/

0 commit comments

Comments
 (0)