Skip to content

Commit 9f6ef0a

Browse files
fix 几何分析apidoc review by luox
1 parent dd7d869 commit 9f6ef0a

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
@@ -85,10 +85,10 @@ export class GeometryAnalysis extends Events {
8585
/**
8686
* @function GeometryAnalysis.prototype.isIdentical
8787
* @version 11.2.0
88-
* @description 几何对象相等分析, 传入要素坐标系需一致。
88+
* @description 几何对象相等分析传入要素坐标系需一致。
8989
* @param {GeoJSONFeature} feature - 要素。
9090
* @param {GeoJSONFeature} compareFeature - 对比要素。
91-
* @param {number} [tolerance=1e-6] - 节点容限值
91+
* @param {number} [tolerance=1e-6] - 要素节点容限值
9292
* @returns {boolean} 要素是否完全相等。
9393
*/
9494
isIdentical(feature, compareFeature, tolerance = 1e-6) {
@@ -103,7 +103,7 @@ export class GeometryAnalysis extends Events {
103103
* @description 几何对象是否相交分析,传入要素坐标系需一致。
104104
* @param {GeoJSONFeature} feature - 要素。
105105
* @param {GeoJSONFeature} compareFeature - 对比要素。
106-
* @param {number} [tolerance=1e-6] - 节点容限值
106+
* @param {number} [tolerance=1e-6] - 要素节点容限值
107107
* @returns {boolean} 要素是否相交。
108108
*/
109109
hasIntersection(feature, compareFeature, tolerance = 1e-6) {
@@ -118,7 +118,7 @@ export class GeometryAnalysis extends Events {
118118
* @description 几何对象边界是否接触分析,传入要素坐标系需一致。
119119
* @param {GeoJSONFeature} feature - 要素。
120120
* @param {GeoJSONFeature} compareFeature - 对比要素。
121-
* @param {number} [tolerance=1e-6] - 节点容限值
121+
* @param {number} [tolerance=1e-6] - 要素节点容限值
122122
* @returns {boolean} 几何对象边界是否接触。
123123
*/
124124
hasTouch(feature, compareFeature, tolerance = 1e-6) {
@@ -223,8 +223,8 @@ export class GeometryAnalysis extends Events {
223223
* @param {number} startY - 线起点 Y 坐标。
224224
* @param {number} endX - 线终点 X 坐标。
225225
* @param {number} endY - 线终点 Y 坐标。
226-
* @param {string} [featureUnit='DEGREE'] - 线坐标的单位,默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
227-
* @param {string} [unit='DEGREE'] - 结果距离单位,默认值为 DEGREE, 支持的值有: "METER", "KILOMETER", "INCH", "FOOT", "DEGREE"。
226+
* @param {string} [featureUnit='DEGREE'] - 线坐标的单位,默认值为 DEGREE, 支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
227+
* @param {string} [unit='DEGREE'] - 结果距离单位,默认值为 DEGREE支持的值有: "METER""KILOMETER""INCH""FOOT""DEGREE"。
228228
* @returns {number} 点到线段的距离。如果点到线段的垂足不在线段上,则返回点到线段较近的端点的距离。
229229
*/
230230
distanceToLineSegment(x, y, startX, startY, endX, endY, featureUnit = Unit.DEGREE, unit = Unit.DEGREE) {
@@ -268,7 +268,7 @@ export class GeometryAnalysis extends Events {
268268
* @function GeometryAnalysis.prototype.computeConcaveHullPoints
269269
* @version 11.2.0
270270
* @description 点数组凹闭包计算。
271-
* @param {Array|FeatureCollection} points - 点坐标数组,支持的形式为 [[x, y]], [{x, y}], 点要素数组, 也支持 FeatureCollection。
271+
* @param {Array|FeatureCollection} points - 点坐标数组,支持的形式为 [[x, y]][{x, y}]点要素数组也支持 FeatureCollection。
272272
* @param {number} angle - 凹包内最小角度。
273273
* @returns {GeoJSONFeature} 结果要素。
274274
*/
@@ -315,7 +315,7 @@ export class GeometryAnalysis extends Events {
315315
* @param {number} top - 矩形上坐标。
316316
* @param {number} right - 矩形右坐标。
317317
* @param {number} bottom - 矩形下坐标。
318-
* @param {number} [tolerance=1e-6] - 节点容限值
318+
* @param {number} [tolerance=1e-6] - 要素节点容限值
319319
* @returns {boolean} 要素是否与矩形相交。
320320
*/
321321
isIntersectRegionWithRect(feature, left, top, right, bottom, tolerance = 1e-6) {
@@ -378,8 +378,8 @@ export class GeometryAnalysis extends Events {
378378
* @function GeometryAnalysis.prototype.computeGeodesicArea
379379
* @version 11.2.0
380380
* @description 计算坐标为经纬度的面要素面积。
381-
* @param {GeoJSONFeature} feature - 面要素, 坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
382-
* @param {string} [unit='SquareMeter'] - 结果面积单位, 默认值为 SquareMeter,支持的值有:"SquareKiloMeter","SquareFoot","SquareYard","SquareMile","SquareMeter"。
381+
* @param {GeoJSONFeature} feature - 面要素坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84)。
382+
* @param {string} [unit='SquareMeter'] - 结果面积单位默认值为 SquareMeter,支持的值有:"SquareKiloMeter""SquareFoot""SquareYard""SquareMile""SquareMeter"。
383383
* @returns {number} 面积大小,单位与设置单位一致。
384384
*/
385385

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

0 commit comments

Comments
 (0)