index.d.ts 1.1 KB

1234567891011121314151617181920212223
  1. import { Feature, Geometry } from "@turf/helpers";
  2. /**
  3. * Compares two geometries of the same dimension and returns true if their intersection set results in a geometry
  4. * different from both but of the same dimension. It applies to Polygon/Polygon, LineString/LineString,
  5. * Multipoint/Multipoint, MultiLineString/MultiLineString and MultiPolygon/MultiPolygon.
  6. *
  7. * In other words, it returns true if the two geometries overlap, provided that neither completely contains the other.
  8. *
  9. * @name booleanOverlap
  10. * @param {Geometry|Feature<LineString|MultiLineString|Polygon|MultiPolygon>} feature1 input
  11. * @param {Geometry|Feature<LineString|MultiLineString|Polygon|MultiPolygon>} feature2 input
  12. * @returns {boolean} true/false
  13. * @example
  14. * var poly1 = turf.polygon([[[0,0],[0,5],[5,5],[5,0],[0,0]]]);
  15. * var poly2 = turf.polygon([[[1,1],[1,6],[6,6],[6,1],[1,1]]]);
  16. * var poly3 = turf.polygon([[[10,10],[10,15],[15,15],[15,10],[10,10]]]);
  17. *
  18. * turf.booleanOverlap(poly1, poly2)
  19. * //=true
  20. * turf.booleanOverlap(poly2, poly3)
  21. * //=false
  22. */
  23. export default function booleanOverlap(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;