index.d.ts 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. import { BBox, Feature, Geometry, LineString, MultiPoint, Point, Polygon } from "@turf/helpers";
  2. /**
  3. * Boolean-contains returns True if the second geometry is completely contained by the first geometry.
  4. * The interiors of both geometries must intersect and, the interior and boundary of the secondary (geometry b)
  5. * must not intersect the exterior of the primary (geometry a).
  6. * Boolean-contains returns the exact opposite result of the `@turf/boolean-within`.
  7. *
  8. * @name booleanContains
  9. * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  10. * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
  11. * @returns {boolean} true/false
  12. * @example
  13. * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
  14. * var point = turf.point([1, 2]);
  15. *
  16. * turf.booleanContains(line, point);
  17. * //=true
  18. */
  19. export default function booleanContains(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
  20. export declare function isPointInMultiPoint(multiPoint: MultiPoint, pt: Point): boolean;
  21. export declare function isMultiPointInMultiPoint(multiPoint1: MultiPoint, multiPoint2: MultiPoint): boolean;
  22. export declare function isMultiPointOnLine(lineString: LineString, multiPoint: MultiPoint): boolean;
  23. export declare function isMultiPointInPoly(polygon: Polygon, multiPoint: MultiPoint): boolean;
  24. export declare function isLineOnLine(lineString1: LineString, lineString2: LineString): boolean;
  25. export declare function isLineInPoly(polygon: Polygon, linestring: LineString): boolean;
  26. /**
  27. * Is Polygon2 in Polygon1
  28. * Only takes into account outer rings
  29. *
  30. * @private
  31. * @param {Geometry|Feature<Polygon>} feature1 Polygon1
  32. * @param {Geometry|Feature<Polygon>} feature2 Polygon2
  33. * @returns {boolean} true/false
  34. */
  35. export declare function isPolyInPoly(feature1: Feature<Polygon> | Polygon, feature2: Feature<Polygon> | Polygon): boolean;
  36. export declare function doBBoxOverlap(bbox1: BBox, bbox2: BBox): boolean;
  37. /**
  38. * compareCoords
  39. *
  40. * @private
  41. * @param {Position} pair1 point [x,y]
  42. * @param {Position} pair2 point [x,y]
  43. * @returns {boolean} true/false if coord pairs match
  44. */
  45. export declare function compareCoords(pair1: number[], pair2: number[]): boolean;
  46. export declare function getMidpoint(pair1: number[], pair2: number[]): number[];