turf.js字典——查询turf库的所有方法及用途
turf.js官方文档:http://turfjs.org/
turf.js字典
的正确打开方式:
- 根据
方法-功能表
查询到所需的方法 - 去turf官方文档直接搜索该方法,获取其详细使用说明
方法-功能表:
方法 | 功能 |
---|---|
point | 坐标->坐标点对象 |
polygon | 多个坐标->多边形 |
along | 获取线上指定距离的点 |
area | 计算多边形面积 |
bbox | 返回折线边界框 |
bboxPolygon | bbox转为多边形 |
bearing | 计算两点间角度 |
center | 计算多个点的中心点 |
centerOfMass | 计算多边形的中心点 |
centroid | 使用多点平均值计算中心点 |
destination | 点1+角度+距离->点2 |
distance | 计算两点间距离 |
envelope | 多点->包括所有点的矩形 |
length | 计算折线长度 |
midpoint | 两点->中间点 |
pointOnFeature | 返回多边形内任意一点 |
polygonTangents | 点+多边形->切线 |
pointToLineDistance | 点+线->最小距离 |
rhumbBearing | 两点->方位角 |
rhumbDestination | 点1+等角线+距离->点2 |
rhumbDistance | 两点->沿恒向线的距离 |
square | 多边形bbox->包含此多边形的最小的正方形bbox |
greatCircle | 两点->lineString/MultiLineString表示的大圆航线 |
cleanCoords | 折线/多点->删除冗余坐标 |
flip | 坐标[x,y]->坐标[y,x] |
rewind | 多边形的坐标倒序 |
round | 数字保留n位小数 |
turncate | 修改点坐标的精度(几位小数) |
bboxClip | 多边形+bbox边界框+裁剪->bbox内的多边形 |
bezierSpline | 折线+贝塞尔算法->曲线 |
buffer | 点+半径->缓冲区(圆) |
circle | 点+半径->多边形(圆) |
clone | 拷贝对象(点/线/形) |
concave | 一组点->一或多个凹壳多边形 |
convex | 一组点->一或多个凸壳多边形 |
difference | 两个多边形->裁剪出非交集部分 |
dissolve | 多边形->分解出多个多边形(如矩形) |
intersect | 多个多边形->交点 |
lineOffset | 线->平移后的线 |
polygonSmooth | 棱角多边形->平滑多边形 |
simpify | 简化多边形 |
tesselate | 多边形->其内部的三角形 |
transformRotate | 旋转多边形 |
transformTranslate | 平移多边形 |
transformScale | 缩放多边形 |
union | 组合多个多边形 |
voronoi | 多组点+每个点的边界框->大的边界框(包括所有点) |
combine | 将点/线/…合并 |
explode | 点集/线/多边形->所有点的位置 |
flatten | 多边形+多边形->去除交集部分后的多边形 |
lineToPolygon | 折线->返回多边形 |
polygonize | 折线->变为多边形 |
polygonToLine | 多边形->折线 |
kinks | 线/多边形->自相交的点 |
lineArc | 点+两个方向+距离->圆弧 |
lineChunk | 折线定长切成段 |
lineIntersect | 多个线/多个多边形->相交点 |
lineOverlap | 多个线/多个多边形->重叠线 |
lineSegment | 从(多)线串或(多)多边形创建两顶点线串线段的要素集合。 |
lineSlice | 线+线上两点(可不在线上)->两点间线 |
lineSliceAlong | 获取一条直线、沿直线到起点的指定距离以及沿直线到停止点的指定距离,并返回这些点之间直线的一个子段。 |
lineSplit | 用一条线将另一条线切成两段 |
mask | 遮罩+多边形->带多边形孔的遮罩外环(去除交集部分后的部分) |
nearestPointOnLine | 点+线->点距离线最近的点(线上) |
sector | 点+半径+两个方向->扇区 |
shortestPath | 两点+障碍物->不碰障碍物的最短路径 |
unkinkPolygon | 扭曲的多边形->未扭曲的多边形 |
featureCollection | 多个要素创建集合 |
feature | 一个特征(坐标点) |
geometryCollection | 多个特征集合 |
lineString | 位置点数组->线 |
multiLineString | 多个线 |
multiPoint | 多个点 |
multiPolygon | 多个多边形 |
randomPosition | 返回边界框中的随机位置 |
randomPoint | 边界框+数量n->返回随机点列表 |
randomLineString | 边界框+数量n->返回随机线列表 |
randomPolygon | 边界框+数量n->返回随机多边形列表 |
sample | 点/线/多边形列表 + 数量n->返回n个随机对象 |
interpolate | 获取一组点,并使用反距离加权(IDW)方法在网格上估计它们的“属性”值。 |
isobands | 采用正方形或矩形栅格特征点特征集合(具有z值)和值打断数组,并生成填充等高线。 |
isolines | 获取具有z值的点要素的栅格要素集合和值打断数组,并生成等值线。 |
planepoint | 将三角形平面作为多边形和三角形内的一个点,并返回该点的z值。多边形应具有属性a、b和c,这些属性定义其三个角的值。或者,如果每个三角形点的值不作为属性提供,则可以通过它们各自的第三坐标提供它们的z值。 |
tin | 一组点->不规则三角网(作为多边形集合返回) |
pointsWithinPolygon | 一组点+(多)多边形->多边形内的点 |
tag | 一组点/多边形/多角形执行空间连接->连接后的图形(组) |
hexGrid | bbox边界+六边形/三角形边长 -> 边界内,充满六边形/三角形的网格列表 |
pointGrid | bbox边界+点间距 -> 边界内,充满点的网格列表 |
squareGrid | bbox边界+矩形边长 -> 边界内,充满矩形的网格列表 |
triangleGrid | bbox边界+单元格维度 -> 边界内,充满三角形的网格列表 |
nearestPoint | 一组点+参考点 -> 返回距离参考点最近的点 |
collect | 将点的FeatureCollection中的指定特性合并到多边形的FeatureCollection中。给定点的inProperty和多边形的outProperty,这将查找每个多边形内的每个点,收集这些点的inProperty值,并将它们作为数组添加到多边形的outProperty。 |
clustersDbscan | 获取一组点,并根据https://en.wikipedia.org/wiki/DBSCAN 数据聚类算法。 |
clustersKmeans | 一组点+K-means ->将他们划分为簇 |
coordAll | 从任何GeoJSON对象(如线、多边形)中获取所有坐标 |
coordEach | 迭代任何GeoJSON对象中的坐标,类似于Array.forEach() |
coordReduce | 减少任何GeoJSON对象中的坐标,类似于Array.Reduce() |
featureEach | 迭代任何GeoJSON对象中的特性,类似于Array.forEach。 |
featureReduce | 减少任何 GeoJSON 对象中的特征,类似于 Array.reduce()。 |
flattenEach | 迭代任何 GeoJSON 对象中的扁平特征,类似于 Array.forEach。 |
flattenReduce | 减少任何 GeoJSON 对象中的扁平特征,类似于 Array.reduce()。 |
getCoord | 从点特征、几何图形或单个坐标展开坐标 |
getCoords | 从特征、几何对象或数组展开坐标 |
getCeom | 从特征或几何对象获取几何 |
getType | 获取 GeoJSON 对象的类型,Geometry 类型优先。 |
geomEach | 迭代任何 GeoJSON 对象中的每个几何图形,类似于 Array.forEach() |
geomReduce | 减少任何 GeoJSON 对象中的几何图形,类似于 Array.reduce()。 |
porpEach | 迭代任何 GeoJSON 对象中的属性,类似于 Array.forEach() |
propReduce | 将任何 GeoJSON 对象中的属性缩减为单个值,类似于 Array.reduce 的工作方式。然而,在这种情况下,我们懒惰地运行归约,因此所有属性的数组是不必要的。 |
segmentEach | 迭代任何 GeoJSON 对象中的 2 顶点线段,类似于 Array.forEach() (Multi)Point 几何不包含线段,因此在此操作期间将忽略它们。 |
segmentReduce | 减少任何 GeoJSON 对象中的 2 顶点线段,类似于 Array.reduce() (Multi)Point 几何不包含线段,因此在此操作期间将忽略它们。 |
getCluster | 获取集群 |
clusterEach | 群集 |
clusterReduce | 减少GeoJSON特性中的集群,类似于Array.Reduce() |
collectionOf | 强制执行对Turf的FeatureCollection输入类型的期望。在内部使用geojsonType来判断几何体类型。 |
containsNumber | 检查坐标是否包含数字 |
geojsonType | 强制执行对Turf的GeoJSON对象类型的期望。 |
featureOf | 强制执行对Turf的功能输入类型的期望。在内部使用geojsonType来判断几何体类型。 |
booleanClockwise | 取一个环并返回true或false,无论环是顺时针还是逆时针。 |
booleanConcave | 取一个多边形并返回true或false以判断它是否凹。 |
booleanContains | 如果第二个几何体完全包含在第一个几何体中,则Boolean contains返回True。两个几何图形的内部必须相交,并且次几何图形(几何图形b)的内部和边界不得与主几何图形(几何图形a)的外部相交。Boolean contains返回与中的@turf/Boolean完全相反的结果。 |
booleanCrosses | 如果交集产生的几何体的尺寸比两个源几何体的最大尺寸小一个,并且交集集位于两个源几何体的内部,则布尔交叉返回True。 |
booleanDisjoint | 如果两个几何图形的交集为空集,则布尔不相交返回(TRUE)。 |
booleanEqual | 确定同一类型的两个几何图形是否具有相同的X、Y坐标值。看到了吗http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm |
booleanIntersects | 布尔相交返回(TRUE)两个几何相交。 |
booleanOverlap | 比较相同尺寸的两个几何图形,如果它们的交集导致两个几何图形不同但尺寸相同,则返回true。它适用于多边形/多边形、线串/线串、多点/多点、多重线串/多重线串和多重多边形/多重多边形。 |
booleanParallel | 如果line1的每个段与line2的对应段平行,则布尔并行返回True |
booleanPointInPolygon | 获取一个点和一个多边形或多多边形,并确定该点是否位于多边形内。多边形可以是凸的或凹的。函数说明了漏洞。 |
booleanPointOnLine | 如果点在直线上,则返回true。接受一个可选参数以忽略linestring的开始和结束顶点。 |
booleanWithin | 如果第一个几何体完全在第二个几何体中,则Boolean within返回true。两个几何图形的内部必须相交,并且主几何图形(几何图形a)的内部和边界不得与次几何图形(几何图形b)的外部相交。Boolean within返回与@turf/Boolean contains完全相反的结果。 |
bearingToAzimuth | 从北线方向(正顺时针)转换任何方位角,并返回0-360度(正顺时针)之间的角度,0为北线 |
convertArea | 将区域转换为请求的单位。有效单位:公里、公里、米、米、厘米、毫米、英亩、英里、码、英尺、英寸、公顷 |
convertLength | 将长度转换为请求的单位。有效单位:英里、英里、英寸、码、米、米、公里、厘米、英尺 |
degreesToRadians | 将角度(度)转换为弧度 |
lengthToRadians | 将距离测量值(假设为球形地球)从真实世界单位转换为弧度有效单位:英里、英里、英寸、码、米、米、公里、厘米、英尺 |
lengthToDegrees | 将距离测量值(假设为球形地球)从真实世界单位转换为度有效单位:英里、英里、英寸、码、米、米、厘米、公里、英尺 |
radiansToLength | 将距离测量值(假设为球形地球)从弧度转换为更友好的单位。有效单位:英里、英里、英寸、码、米、米、公里、厘米、英尺 |
radiansToDegrees | 将弧度角度转换为度 |
toMercator | 将WGS84 GeoJSON对象转换为墨卡托(EPSG:900913)投影 |
toWgs84 | 将墨卡托(EPSG:900913)GeoJSON对象转换为WGS84投影 |