Skip to content

Commit 5801ebb

Browse files
fix 几何分析apidoc review by luox
1 parent 4ec4b6f commit 5801ebb

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

src/common/util/GeometryAnalysis.js

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ export class GeometryAnalysis extends Events {
8484
/**
8585
* @function GeometryAnalysis.prototype.isIdentical
8686
* @version 11.2.0
87-
* @description 几何对象相等分析, 传入要素坐标系需一致。
87+
* @description 几何对象相等分析传入要素坐标系需一致。
8888
* @param {GeoJSONFeature} feature - 要素。
8989
* @param {GeoJSONFeature} compareFeature - 对比要素。
90-
* @param {number} [tolerance=1e-6] - 节点容限值
90+
* @param {number} [tolerance=1e-6] - 要素节点容限值
9191
* @returns {boolean} 要素是否完全相等。
9292
*/
9393
isIdentical(feature, compareFeature, tolerance = 1e-6) {
@@ -102,7 +102,7 @@ export class GeometryAnalysis extends Events {
102102
* @description 几何对象是否相交分析,传入要素坐标系需一致。
103103
* @param {GeoJSONFeature} feature - 要素。
104104
* @param {GeoJSONFeature} compareFeature - 对比要素。
105-
* @param {number} [tolerance=1e-6] - 节点容限值
105+
* @param {number} [tolerance=1e-6] - 要素节点容限值
106106
* @returns {boolean} 要素是否相交。
107107
*/
108108
hasIntersection(feature, compareFeature, tolerance = 1e-6) {
@@ -117,7 +117,7 @@ export class GeometryAnalysis extends Events {
117117
* @description 几何对象边界是否接触分析,传入要素坐标系需一致。
118118
* @param {GeoJSONFeature} feature - 要素。
119119
* @param {GeoJSONFeature} compareFeature - 对比要素。
120-
* @param {number} [tolerance=1e-6] - 节点容限值
120+
* @param {number} [tolerance=1e-6] - 要素节点容限值
121121
* @returns {boolean} 几何对象边界是否接触。
122122
*/
123123
hasTouch(feature, compareFeature, tolerance = 1e-6) {
@@ -222,8 +222,8 @@ export class GeometryAnalysis extends Events {
222222
* @param {number} startY - 线起点 Y 坐标。
223223
* @param {number} endX - 线终点 X 坐标。
224224
* @param {number} endY - 线终点 Y 坐标。
225-
* @param {string} [featureUnit='DEGREE'] - 线坐标的单位,默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
226-
* @param {string} [unit='DEGREE'] - 结果距离单位,默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
225+
* @param {string} [featureUnit='DEGREE'] - 线坐标的单位,默认值为 DEGREE, 支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
226+
* @param {string} [unit='DEGREE'] - 结果距离单位,默认值为 DEGREE支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
227227
* @returns {number} 点到线段的距离。如果点到线段的垂足不在线段上,则返回点到线段较近的端点的距离。
228228
*/
229229
distanceToLineSegment(x, y, startX, startY, endX, endY, featureUnit = Unit.DEGREE, unit = Unit.DEGREE) {
@@ -267,7 +267,7 @@ export class GeometryAnalysis extends Events {
267267
* @function GeometryAnalysis.prototype.computeConcaveHullPoints
268268
* @version 11.2.0
269269
* @description 点数组凹闭包计算。
270-
* @param {Array|FeatureCollection} points - 点坐标数组,支持的形式为 [[x, y]], [{x, y}], 点要素数组, 也支持 FeatureCollection。
270+
* @param {Array|FeatureCollection} points - 点坐标数组,支持的形式为 [[x, y]][{x, y}]点要素数组也支持 FeatureCollection。
271271
* @param {number} angle - 凹包内最小角度。
272272
* @returns {GeoJSONFeature} 结果要素。
273273
*/
@@ -314,7 +314,7 @@ export class GeometryAnalysis extends Events {
314314
* @param {number} top - 矩形上坐标。
315315
* @param {number} right - 矩形右坐标。
316316
* @param {number} bottom - 矩形下坐标。
317-
* @param {number} [tolerance=1e-6] - 节点容限值
317+
* @param {number} [tolerance=1e-6] - 要素节点容限值
318318
* @returns {boolean} 要素是否与矩形相交。
319319
*/
320320
isIntersectRegionWithRect(feature, left, top, right, bottom, tolerance = 1e-6) {
@@ -377,8 +377,8 @@ export class GeometryAnalysis extends Events {
377377
* @function GeometryAnalysis.prototype.computeGeodesicArea
378378
* @version 11.2.0
379379
* @description 计算坐标为经纬度的面要素面积。
380-
* @param {GeoJSONFeature} feature - 面要素, 坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
381-
* @param {string} [unit='SquareMeter'] - 结果面积单位, 默认值为 SquareMeter,支持的值有:"SquareKiloMeter","SquareFoot","SquareYard","SquareMile","SquareMeter"。
380+
* @param {GeoJSONFeature} feature - 面要素坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
381+
* @param {string} [unit='SquareMeter'] - 结果面积单位默认值为 SquareMeter,支持的值有:"SquareKiloMeter""SquareFoot""SquareYard""SquareMile""SquareMeter"。
382382
* @returns {number} 面积大小,单位与设置单位一致。
383383
*/
384384

@@ -402,7 +402,7 @@ export class GeometryAnalysis extends Events {
402402
* @version 11.2.0
403403
* @description 线要素光滑分析。
404404
* @param {GeoJSONFeature} feature - 线要素。
405-
* @param {number} [smoothness=2] - 有效范围为大于等于2,设置为小于2的值会抛出异常光滑系数越大,线对象节点数越多,也就越光滑。 建议取值范围为[2,10]。
405+
* @param {number} [smoothness=2] - 有效范围为大于等于2,设置为小于2的值会抛出异常光滑系数越大,线对象节点数越多,也就越光滑。 建议取值范围为[2,10]。
406406
* @returns {GeoJSONFeature} 光滑处理后的线要素。
407407
*/
408408
smooth(feature, smoothness = 2) {
@@ -421,22 +421,22 @@ export class GeometryAnalysis extends Events {
421421
/**
422422
* @function GeometryAnalysis.prototype.computeGeodesicDistance
423423
* @version 11.2.0
424-
* @description 计算测地线长度, 坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
424+
* @description 计算测地线长度坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
425425
* @param {Array} xArray - x 坐标数组。
426426
* @param {Array} yArray - y 坐标数组。
427427
* @param {number} majorAxis - 测地线所在椭球体的长轴,单位为米。
428428
* @param {number} flatten - 测地线所在椭球体的扁率。
429-
* @param {string} [unit='METER'] - 结果长度单位, 默认值为 METER, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT"。
429+
* @param {string} [unit='METER'] - 结果长度单位默认值为 METER支持的值有: "METER""KILOMETER""INCH""FOOT"。
430430
* @returns {number} 测地线的长度。
431431
*/
432432
/**
433433
* @function GeometryAnalysis.prototype.computeGeodesicDistance
434434
* @version 11.2.0
435-
* @description 计算测地线长度, 坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
436-
* @param {Array|FeatureCollection} points - 点坐标数组, 支持的形式为 [[x, y]], [{x, y}], 点要素数组, 也支持 FeatureCollection。
435+
* @description 计算测地线长度坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
436+
* @param {Array|FeatureCollection} points - 点坐标数组支持的形式为 [[x, y]][{x, y}]点要素数组也支持 FeatureCollection。
437437
* @param {number} majorAxis - 测地线所在椭球体的长轴,单位为米。
438438
* @param {number} flatten - 测地线所在椭球体的扁率。
439-
* @param {string} [unit='METER'] - 结果长度单位, 默认值为 METER, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT"。
439+
* @param {string} [unit='METER'] - 结果长度单位默认值为 METER支持的值有: "METER""KILOMETER""INCH""FOOT"。
440440
* @returns {number} 测地线的长度。
441441
*/
442442
computeGeodesicDistance(xArray, yArray, majorAxis, flatten, unit = Unit.METER) {
@@ -465,8 +465,8 @@ export class GeometryAnalysis extends Events {
465465
* @description 根据距离获取线要素的平行线,线可为折线。
466466
* @param {GeoJSONFeature} feature - 线要素。
467467
* @param {number} distance - 平行线距离。
468-
* @param {string} [featureUnit='DEGREE'] - 线要素距离单位, 默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
469-
* @param {string} [unit='DEGREE'] - 平行线距离单位, 默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
468+
* @param {string} [featureUnit='DEGREE'] - 线要素距离单位默认值为 DEGREE支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
469+
* @param {string} [unit='DEGREE'] - 平行线距离单位默认值为 DEGREE支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
470470
* @returns {GeoJSONFeature} 结果为与线要素相隔传入距离长度的平行线要素。
471471
*/
472472
computeParallel(feature, distance, featureUnit = Unit.DEGREE, unit = Unit.DEGREE) {
@@ -495,7 +495,7 @@ export class GeometryAnalysis extends Events {
495495
* @function GeometryAnalysis.prototype.computeConvexHullPoints
496496
* @version 11.2.0
497497
* @description 点数组的凸闭包计算,即最小外接多边形。
498-
* @param {Array|FeatureCollection} points - 点坐标数组, 支持的形式为 [[x, y]], [{x, y}], 点要素数组, 也支持 FeatureCollection。
498+
* @param {Array|FeatureCollection} points - 点坐标数组支持的形式为 [[x, y]][{x, y}]点要素数组也支持 FeatureCollection。
499499
* @returns {GeoJSONFeature} 最小外接多边形要素。
500500
*/
501501
computeConvexHullPoints(xArray, yArray) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy