From 1edd528c699b1b15a6a2eba0cd0dad84f6655419 Mon Sep 17 00:00:00 2001 From: Isaque Borges Date: Sat, 30 Mar 2024 17:44:13 -0300 Subject: [PATCH 1/4] Improve boolean-intersects docs --- CHANGELOG.md | 2 +- packages/turf-boolean-intersects/README.md | 15 +++++++++++---- packages/turf-boolean-intersects/index.ts | 15 +++++++++++---- 3 files changed, 23 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc6f4a457..3a29305ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,7 +59,7 @@ We intend to keep making breaking changes before 7.0.0 is fully released. If you - [`@turf/polygon-smooth`](polygon-smooth) Clean up a typo (#2293) - [`@turf/nearest-point-on-line`](nearest-point-on-line) Clean up typescript types (#2296) - [`@turf/boolean-touches`](boolean-touches) Add boolean-touches to docs (#2431) -- [`@turf/boolean-equals`](boolean-equals) Improve docs (#2412) +- [`@turf/boolean-equal`](boolean-equal) Improve docs (#2412) - Remove Bower references (#2146) - Fix typo in README (#2313) diff --git a/packages/turf-boolean-intersects/README.md b/packages/turf-boolean-intersects/README.md index b6f0c74fd..607b21548 100644 --- a/packages/turf-boolean-intersects/README.md +++ b/packages/turf-boolean-intersects/README.md @@ -4,7 +4,7 @@ ## booleanIntersects -Boolean-intersects returns (TRUE) two geometries intersect. +Boolean-intersect returns (TRUE) if the intersection of the two geometries is NOT an empty set. ### Parameters @@ -14,10 +14,17 @@ Boolean-intersects returns (TRUE) two geometries intersect. ### Examples ```javascript -var point = turf.point([2, 2]); -var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]); +var point1 = turf.point([2, 2]); +var point2 = turf.point([1, 2]); +var line = turf.lineString([[1, 1], [1, 3], [1, 4]]); -turf.booleanIntersects(line, point); +//addToMap +var addToMap = [point1, point2, line]; + +turf.booleanIntersects(line, point1); +//=false + +turf.booleanIntersects(line, point2); //=true ``` diff --git a/packages/turf-boolean-intersects/index.ts b/packages/turf-boolean-intersects/index.ts index 2f2ba1d1d..eb3547fc3 100644 --- a/packages/turf-boolean-intersects/index.ts +++ b/packages/turf-boolean-intersects/index.ts @@ -3,17 +3,24 @@ import { booleanDisjoint } from "@turf/boolean-disjoint"; import { flattenEach } from "@turf/meta"; /** - * Boolean-intersects returns (TRUE) two geometries intersect. + * Boolean-intersect returns (TRUE) if the intersection of the two geometries is NOT an empty set. * * @name booleanIntersects * @param {Geometry|Feature} feature1 GeoJSON Feature or Geometry * @param {Geometry|Feature} feature2 GeoJSON Feature or Geometry * @returns {boolean} true/false * @example - * var point = turf.point([2, 2]); - * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]); + * var point1 = turf.point([2, 2]); + * var point2 = turf.point([1, 2]); + * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]); * - * turf.booleanIntersects(line, point); + * //addToMap + * var addToMap = [point1, point2, line]; + * + * turf.booleanIntersects(line, point1); + * //=false + * + * turf.booleanIntersects(line, point2); * //=true */ function booleanIntersects( From b7d07a533e844e4f40004d46a73fcec85f00d2d7 Mon Sep 17 00:00:00 2001 From: Isaque Borges Date: Sat, 30 Mar 2024 17:59:02 -0300 Subject: [PATCH 2/4] Improving boolean-intersects docs --- packages/turf-boolean-intersects/README.md | 2 +- packages/turf-boolean-intersects/index.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/turf-boolean-intersects/README.md b/packages/turf-boolean-intersects/README.md index 607b21548..c5cd4376c 100644 --- a/packages/turf-boolean-intersects/README.md +++ b/packages/turf-boolean-intersects/README.md @@ -4,7 +4,7 @@ ## booleanIntersects -Boolean-intersect returns (TRUE) if the intersection of the two geometries is NOT an empty set. +Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set. ### Parameters diff --git a/packages/turf-boolean-intersects/index.ts b/packages/turf-boolean-intersects/index.ts index eb3547fc3..72922d6ee 100644 --- a/packages/turf-boolean-intersects/index.ts +++ b/packages/turf-boolean-intersects/index.ts @@ -3,7 +3,7 @@ import { booleanDisjoint } from "@turf/boolean-disjoint"; import { flattenEach } from "@turf/meta"; /** - * Boolean-intersect returns (TRUE) if the intersection of the two geometries is NOT an empty set. + * Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set. * * @name booleanIntersects * @param {Geometry|Feature} feature1 GeoJSON Feature or Geometry From 58065285afec8914f1db1b430819818791bb47e3 Mon Sep 17 00:00:00 2001 From: Isaque Borges Date: Sat, 30 Mar 2024 18:06:05 -0300 Subject: [PATCH 3/4] adding boolean-intersects to documentation.yml --- documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation.yml b/documentation.yml index 671d6b572..f94a53e42 100644 --- a/documentation.yml +++ b/documentation.yml @@ -139,6 +139,7 @@ toc: - booleanCrosses - booleanDisjoint - booleanEqual + - booleanIntersects - booleanOverlap - booleanParallel - booleanPointInPolygon From 102180b2aad7f505430a52cec0383f458795a0a6 Mon Sep 17 00:00:00 2001 From: Isaque Borges Date: Sat, 30 Mar 2024 18:46:07 -0300 Subject: [PATCH 4/4] moved addtomap to end and colored markers --- packages/turf-boolean-intersects/README.md | 8 +++++--- packages/turf-boolean-intersects/index.ts | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/packages/turf-boolean-intersects/README.md b/packages/turf-boolean-intersects/README.md index c5cd4376c..3bcf5cc5b 100644 --- a/packages/turf-boolean-intersects/README.md +++ b/packages/turf-boolean-intersects/README.md @@ -18,14 +18,16 @@ var point1 = turf.point([2, 2]); var point2 = turf.point([1, 2]); var line = turf.lineString([[1, 1], [1, 3], [1, 4]]); -//addToMap -var addToMap = [point1, point2, line]; - turf.booleanIntersects(line, point1); //=false turf.booleanIntersects(line, point2); //=true + +//addToMap +var addToMap = [point1, point2, line]; +point1.properties['marker-color'] = '#f00' +point2.properties['marker-color'] = '#0f0' ``` Returns **[boolean][3]** true/false diff --git a/packages/turf-boolean-intersects/index.ts b/packages/turf-boolean-intersects/index.ts index 72922d6ee..ceb1ae006 100644 --- a/packages/turf-boolean-intersects/index.ts +++ b/packages/turf-boolean-intersects/index.ts @@ -14,14 +14,16 @@ import { flattenEach } from "@turf/meta"; * var point2 = turf.point([1, 2]); * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]); * - * //addToMap - * var addToMap = [point1, point2, line]; - * * turf.booleanIntersects(line, point1); * //=false * * turf.booleanIntersects(line, point2); * //=true + * + * //addToMap + * var addToMap = [point1, point2, line]; + * point1.properties['marker-color'] = '#f00' + * point2.properties['marker-color'] = '#0f0' */ function booleanIntersects( feature1: Feature | Geometry,