api documentation for turf (v3.0.14)

a JavaScript library for performing geospatial operations with GeoJSON

table of contents

  1. module turf
    1. function turf.along (line, distance, units)
    2. function turf.area (input)
    3. function turf.bbox (geojson)
    4. function turf.bboxPolygon (bbox)
    5. function turf.bearing (start, end)
    6. function turf.bezier (line, resolution, sharpness)
    7. function turf.buffer (feature, radius, units)
    8. function turf.center (layer)
    9. function turf.centroid (features)
    10. function turf.collect (polygons, points, inProperty, outProperty)
    11. function turf.combine (fc)
    12. function turf.concave (points, maxEdge, units)
    13. function turf.convex (featurecollection)
    14. function turf.destination (from, distance, bearing, units)
    15. function turf.difference (p1, p2)
    16. function turf.distance (from, to, units)
    17. function turf.envelope (features)
    18. function turf.explode (geojson)
    19. function turf.feature (geometry, properties)
    20. function turf.featureCollection (features)
    21. function turf.flip (input)
    22. function turf.geometryCollection (geometries, properties)
    23. function turf.hexGrid (bbox, cellSize, units, triangles)
    24. function turf.inside (point, polygon)
    25. function turf.intersect (poly1, poly2)
    26. function turf.isolines (points, z, resolution, breaks)
    27. function turf.kinks (polyIn)
    28. function turf.lineDistance (line, units)
    29. function turf.lineSlice (startPt, stopPt, line)
    30. function turf.lineString (coordinates, properties)
    31. function turf.midpoint (from, to)
    32. function turf.multiLineString (coordinates, properties)
    33. function turf.multiPoint (coordinates, properties)
    34. function turf.multiPolygon (coordinates, properties)
    35. function turf.nearest (targetPoint, points)
    36. function turf.planepoint (point, triangle)
    37. function turf.point (coordinates, properties)
    38. function turf.pointGrid (bbox, cellSize, units)
    39. function turf.pointOnLine (line, pt)
    40. function turf.pointOnSurface (fc)
    41. function turf.polygon (coordinates, properties)
    42. function turf.random (type, count, options)
    43. function turf.sample (featurecollection, num)
    44. function turf.simplify (feature, tolerance, highQuality)
    45. function turf.square (bbox)
    46. function turf.squareGrid (bbox, cellSize, units)
    47. function turf.tag (points, polygons, field, outField)
    48. function turf.tesselate (poly)
    49. function turf.tin (points, z)
    50. function turf.triangleGrid (bbox, cellSize, units)
    51. function turf.union (poly1, poly2)
    52. function turf.within (points, polygons)
    53. object turf
  2. module turf.turf
    1. function turf.turf.along (line, distance, units)
    2. function turf.turf.area (input)
    3. function turf.turf.bbox (geojson)
    4. function turf.turf.bboxPolygon (bbox)
    5. function turf.turf.bearing (start, end)
    6. function turf.turf.bezier (line, resolution, sharpness)
    7. function turf.turf.buffer (feature, radius, units)
    8. function turf.turf.center (layer)
    9. function turf.turf.centroid (features)
    10. function turf.turf.collect (polygons, points, inProperty, outProperty)
    11. function turf.turf.combine (fc)
    12. function turf.turf.concave (points, maxEdge, units)
    13. function turf.turf.convex (featurecollection)
    14. function turf.turf.destination (from, distance, bearing, units)
    15. function turf.turf.difference (p1, p2)
    16. function turf.turf.distance (from, to, units)
    17. function turf.turf.envelope (features)
    18. function turf.turf.explode (geojson)
    19. function turf.turf.feature (geometry, properties)
    20. function turf.turf.featureCollection (features)
    21. function turf.turf.flip (input)
    22. function turf.turf.geometryCollection (geometries, properties)
    23. function turf.turf.hexGrid (bbox, cellSize, units, triangles)
    24. function turf.turf.inside (point, polygon)
    25. function turf.turf.intersect (poly1, poly2)
    26. function turf.turf.isolines (points, z, resolution, breaks)
    27. function turf.turf.kinks (polyIn)
    28. function turf.turf.lineDistance (line, units)
    29. function turf.turf.lineSlice (startPt, stopPt, line)
    30. function turf.turf.lineString (coordinates, properties)
    31. function turf.turf.midpoint (from, to)
    32. function turf.turf.multiLineString (coordinates, properties)
    33. function turf.turf.multiPoint (coordinates, properties)
    34. function turf.turf.multiPolygon (coordinates, properties)
    35. function turf.turf.nearest (targetPoint, points)
    36. function turf.turf.planepoint (point, triangle)
    37. function turf.turf.point (coordinates, properties)
    38. function turf.turf.pointGrid (bbox, cellSize, units)
    39. function turf.turf.pointOnLine (line, pt)
    40. function turf.turf.pointOnSurface (fc)
    41. function turf.turf.polygon (coordinates, properties)
    42. function turf.turf.random (type, count, options)
    43. function turf.turf.sample (featurecollection, num)
    44. function turf.turf.simplify (feature, tolerance, highQuality)
    45. function turf.turf.square (bbox)
    46. function turf.turf.squareGrid (bbox, cellSize, units)
    47. function turf.turf.tag (points, polygons, field, outField)
    48. function turf.turf.tesselate (poly)
    49. function turf.turf.tin (points, z)
    50. function turf.turf.triangleGrid (bbox, cellSize, units)
    51. function turf.turf.union (poly1, poly2)
    52. function turf.turf.within (points, polygons)

module turf

function turf.along (line, distance, units)

function turf.area (input)

function turf.bbox (geojson)

function turf.bboxPolygon (bbox)

function turf.bearing (start, end)

function turf.bezier (line, resolution, sharpness)

function turf.buffer (feature, radius, units)

function turf.center (layer)

function turf.centroid (features)

function turf.collect (polygons, points, inProperty, outProperty)

function turf.combine (fc)

function turf.concave (points, maxEdge, units)

function turf.convex (featurecollection)

function turf.destination (from, distance, bearing, units)

function turf.difference (p1, p2)

function turf.distance (from, to, units)

function turf.envelope (features)

function turf.explode (geojson)

function turf.feature (geometry, properties)

function turf.featureCollection (features)

function turf.flip (input)

function turf.geometryCollection (geometries, properties)

function turf.hexGrid (bbox, cellSize, units, triangles)

function turf.inside (point, polygon)

function turf.intersect (poly1, poly2)

function turf.isolines (points, z, resolution, breaks)

function turf.kinks (polyIn)

function turf.lineDistance (line, units)

function turf.lineSlice (startPt, stopPt, line)

function turf.lineString (coordinates, properties)

function turf.midpoint (from, to)

function turf.multiLineString (coordinates, properties)

function turf.multiPoint (coordinates, properties)

function turf.multiPolygon (coordinates, properties)

function turf.nearest (targetPoint, points)

function turf.planepoint (point, triangle)

function turf.point (coordinates, properties)

function turf.pointGrid (bbox, cellSize, units)

function turf.pointOnLine (line, pt)

function turf.pointOnSurface (fc)

function turf.polygon (coordinates, properties)

function turf.random (type, count, options)

function turf.sample (featurecollection, num)

function turf.simplify (feature, tolerance, highQuality)

function turf.square (bbox)

function turf.squareGrid (bbox, cellSize, units)

function turf.tag (points, polygons, field, outField)

function turf.tesselate (poly)

function turf.tin (points, z)

function turf.triangleGrid (bbox, cellSize, units)

function turf.union (poly1, poly2)

function turf.within (points, polygons)

module turf.turf

function turf.turf.along (line, distance, units)

function turf.turf.area (input)

function turf.turf.bbox (geojson)

function turf.turf.bboxPolygon (bbox)

function turf.turf.bearing (start, end)

function turf.turf.bezier (line, resolution, sharpness)

function turf.turf.buffer (feature, radius, units)

function turf.turf.center (layer)

function turf.turf.centroid (features)

function turf.turf.collect (polygons, points, inProperty, outProperty)

function turf.turf.combine (fc)

function turf.turf.concave (points, maxEdge, units)

function turf.turf.convex (featurecollection)

function turf.turf.destination (from, distance, bearing, units)

function turf.turf.difference (p1, p2)

function turf.turf.distance (from, to, units)

function turf.turf.envelope (features)

function turf.turf.explode (geojson)

function turf.turf.feature (geometry, properties)

function turf.turf.featureCollection (features)

function turf.turf.flip (input)

function turf.turf.geometryCollection (geometries, properties)

function turf.turf.hexGrid (bbox, cellSize, units, triangles)

function turf.turf.inside (point, polygon)

function turf.turf.intersect (poly1, poly2)

function turf.turf.isolines (points, z, resolution, breaks)

function turf.turf.kinks (polyIn)

function turf.turf.lineDistance (line, units)

function turf.turf.lineSlice (startPt, stopPt, line)

function turf.turf.lineString (coordinates, properties)

function turf.turf.midpoint (from, to)

function turf.turf.multiLineString (coordinates, properties)

function turf.turf.multiPoint (coordinates, properties)

function turf.turf.multiPolygon (coordinates, properties)

function turf.turf.nearest (targetPoint, points)

function turf.turf.planepoint (point, triangle)

function turf.turf.point (coordinates, properties)

function turf.turf.pointGrid (bbox, cellSize, units)

function turf.turf.pointOnLine (line, pt)

function turf.turf.pointOnSurface (fc)

function turf.turf.polygon (coordinates, properties)

function turf.turf.random (type, count, options)

function turf.turf.sample (featurecollection, num)

function turf.turf.simplify (feature, tolerance, highQuality)

function turf.turf.square (bbox)

function turf.turf.squareGrid (bbox, cellSize, units)

function turf.turf.tag (points, polygons, field, outField)

function turf.turf.tesselate (poly)

function turf.turf.tin (points, z)

function turf.turf.triangleGrid (bbox, cellSize, units)

function turf.turf.union (poly1, poly2)

function turf.turf.within (points, polygons)

[ this document was created with utility2 ]