Add inline snippet to LngLatBounds.contains (#9548)

mapbox · Apr 20, 2020 · 4ed7ca8 · 4ed7ca8
1 parent c625efa
commit 4ed7ca8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/geo/lng_lat_bounds.js b/src/geo/lng_lat_bounds.js
@@ -216,6 +216,15 @@ class LngLatBounds {
     *
     * @param {LngLatLike} lnglat geographic point to check against.
     * @returns {boolean} True if the point is within the bounding box.
+    * @example
+    * var llb = new mapboxgl.LngLatBounds(
+    *   new mapboxgl.LngLat(-73.9876, 40.7661),
+    *   new mapboxgl.LngLat(-73.9397, 40.8002)
+    * );
+    *
+    * var ll = new mapboxgl.LngLat(-73.9567, 40.7789);
+    *
+    * llb.contains(ll); // = true
     */
     contains(lnglat: LngLatLike) {
         const {lng, lat} = LngLat.convert(lnglat);