turf/documentation.yml
Marc 5d1e0ec2f5
Added new point-to-polygon-distance package (#2735)
Added turf-point-to-polygon-distance package to complement point-to-line functionality. Resolves #1743

---------

Co-authored-by: James Beard <james@smallsaucepan.com>
2024-11-14 14:16:00 +11:00

198 lines
5.0 KiB
YAML

toc:
Measurement:
- along
- area
- bbox
- bboxPolygon
- bearing
- center
- centerOfMass
- centroid
- destination
- distance
- envelope
- length
- midpoint
- pointOnFeature
- polygonTangents
- pointToLineDistance
- pointToPolygonDistance
- rhumbBearing
- rhumbDestination
- rhumbDistance
- square
- greatCircle
Coordinate Mutation:
- cleanCoords
- flip
- rewind
- round
- truncate
Transformation:
- bboxClip
- bezierSpline
- buffer
- circle
- clone
- concave
- convex
- difference
- dissolve
- intersect
- lineOffset
- polygonSmooth
- simplify
- tesselate
- transformRotate
- transformTranslate
- transformScale
- union
- voronoi
Feature Conversion:
- combine
- explode
- flatten
- lineToPolygon
- polygonize
- polygonToLine
Misc:
- kinks
- lineArc
- lineChunk
- lineIntersect
- lineOverlap
- lineSegment
- lineSlice
- lineSliceAlong
- lineSplit
- mask
- nearestPointOnLine
- sector
- shortestPath
- unkinkPolygon
Helper:
- featureCollection
- feature
- geometryCollection
- lineString
- multiLineString
- multiPoint
- multiPolygon
- point
- polygon
Random:
- randomPosition
- randomPoint
- randomLineString
- randomPolygon
Data:
- sample
Interpolation:
- interpolate
- isobands
- isolines
- planepoint
- tin
Joins:
- pointsWithinPolygon
- tag
Grids:
- hexGrid
- pointGrid
- squareGrid
- triangleGrid
Classification:
- nearestPoint
Aggregation:
- collect
- clustersDbscan
- clustersKmeans
Meta:
- coordAll
- coordEach
- coordReduce
- featureEach
- featureReduce
- flattenEach
- flattenReduce
- getCoord
- getCoords
- getGeom
- getType
- geomEach
- geomReduce
- propEach
- propReduce
- segmentEach
- segmentReduce
- getCluster
- clusterEach
- clusterReduce
Assertions:
- collectionOf
- containsNumber
- geojsonType
- featureOf
Booleans:
- booleanClockwise
- booleanConcave
- booleanContains
- booleanCrosses
- booleanDisjoint
- booleanEqual
- booleanIntersects
- booleanOverlap
- booleanParallel
- booleanPointInPolygon
- booleanPointOnLine
- booleanTouches
- booleanWithin
Unit Conversion:
- bearingToAzimuth
- azimuthToBearing
- convertArea
- convertLength
- degreesToRadians
- lengthToRadians
- lengthToDegrees
- radiansToLength
- radiansToDegrees
- toMercator
- toWgs84
paths:
GeoJSON: "https://tools.ietf.org/html/rfc7946#section-3"
GeoJsonProperties: "https://tools.ietf.org/html/rfc7946#section-3.2"
GeometryCollection: "https://tools.ietf.org/html/rfc7946#section-3.1.8"
Point: "https://tools.ietf.org/html/rfc7946#section-3.1.2"
Points: "https://tools.ietf.org/html/rfc7946#section-3.1.2"
(Multi)Point: "https://tools.ietf.org/html/rfc7946#section-3.1.2"
(Multi)Points: "https://tools.ietf.org/html/rfc7946#section-3.1.2"
(Multi)Point(s): "https://tools.ietf.org/html/rfc7946#section-3.1.2"
MultiPoint: "https://tools.ietf.org/html/rfc7946#section-3.1.3"
MultiPoints: "https://tools.ietf.org/html/rfc7946#section-3.1.3"
LineString: "https://tools.ietf.org/html/rfc7946#section-3.1.4"
LineStrings: "https://tools.ietf.org/html/rfc7946#section-3.1.4"
(Multi)LineString: "https://tools.ietf.org/html/rfc7946#section-3.1.4"
(Multi)LineStrings: "https://tools.ietf.org/html/rfc7946#section-3.1.4"
(Multi)LineString(s): "https://tools.ietf.org/html/rfc7946#section-3.1.4"
MultiLineString: "https://tools.ietf.org/html/rfc7946#section-3.1.5"
MultiLineStrings: "https://tools.ietf.org/html/rfc7946#section-3.1.5"
Polygon: "https://tools.ietf.org/html/rfc7946#section-3.1.6"
Polygons: "https://tools.ietf.org/html/rfc7946#section-3.1.6"
(Multi)Polygon: "https://tools.ietf.org/html/rfc7946#section-3.1.6"
(Multi)Polygons: "https://tools.ietf.org/html/rfc7946#section-3.1.6"
(Multi)Polygon(s): "https://tools.ietf.org/html/rfc7946#section-3.1.6"
MultiPolygon: "https://tools.ietf.org/html/rfc7946#section-3.1.7"
MultiPolygons: "https://tools.ietf.org/html/rfc7946#section-3.1.7"
Geometry: "https://tools.ietf.org/html/rfc7946#section-3.1"
Feature: "https://tools.ietf.org/html/rfc7946#section-3.2"
Features: "https://tools.ietf.org/html/rfc7946#section-3.3"
FeatureCollection: "https://tools.ietf.org/html/rfc7946#section-3.3"
Positon: "https://tools.ietf.org/html/rfc7946#section-3.1.1"
GeometryObject: "https://tools.ietf.org/html/rfc7946#section-3.1"
GeoJSONObject: "https://tools.ietf.org/html/rfc7946#section-3"
GeoJSONText: "https://tools.ietf.org/html/rfc7946#section-2"
BBox: "https://tools.ietf.org/html/rfc7946#section-5"
BoundingBox: "https://tools.ietf.org/html/rfc7946#section-5"
Coord: "https://tools.ietf.org/html/rfc7946#section-3.1.1"