index.d.ts 582 B

1234567891011121314151617
  1. import { Feature, FeatureCollection, Geometry } from "@turf/helpers";
  2. /**
  3. * Takes one or more features and returns their area in square meters.
  4. *
  5. * @name area
  6. * @param {GeoJSON} geojson input GeoJSON feature(s)
  7. * @returns {number} area in square meters
  8. * @example
  9. * var polygon = turf.polygon([[[125, -15], [113, -22], [154, -27], [144, -15], [125, -15]]]);
  10. *
  11. * var area = turf.area(polygon);
  12. *
  13. * //addToMap
  14. * var addToMap = [polygon]
  15. * polygon.properties.area = area
  16. */
  17. export default function area(geojson: Feature<any> | FeatureCollection<any> | Geometry): number;