Skip to content

Commit 770a00d

Browse files
[fix]整理jsdoc parameter 少了mapboxgl的部分 review by qiw
1 parent dadd836 commit 770a00d

File tree

45 files changed

+112
-124
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+112
-124
lines changed

build/jsdocs/template/publish.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -556,12 +556,7 @@ exports.publish = function (taffyData, opts, tutorials) {
556556
baseTypes.forEach((reg) => {
557557
linkNames = linkNames.replace(new RegExp(reg, 'ig'), '');
558558
});
559-
return linkNames
560-
.replace(/\|/g, '')
561-
.replace(/\(\)/g, '')
562-
.replace(/(\.<>)/g, '')
563-
.replace(/(\.<>)/g, '')
564-
.replace(/(\.<>)/g, '');
559+
return linkNames.replace(/\|/g, '').replace(/\(/g, '').replace(/\)/g, '').replace(/\./g, '').replace(/</g, '').replace(/>/g, '');
565560
}
566561
function getLinkHref(str) {
567562
const haslink_reg = /<a[^>]*href=["'](?<url>[^"']*?)["'][^>]*>(?<text>[\w\W]*?)<\/a>/g;

build/jsdocs/template/typeLinkExt.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ var mbglapi = "https://www.mapbox.com/mapbox-gl-js/api/";
44
var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/";
55
var classicapi="https://iclient.supermap.io/web/libs/iclient8c/apidoc/files/SuperMap"
66
var geojsonapi = "https://geojson.org";
7-
var geometryapi="https://datatracker.ietf.org/doc/html/rfc7946#section-3.1";
7+
var geometryapi="https://datatracker.ietf.org/doc/html/rfc7946";
88
var helpDocApi = "https://iportal.supermap.io/iportal/help/html/zh/index.htm";
99
var webApi = "https://developer.mozilla.org/zh-CN/docs/Web/";
1010
var threeApi = "https://threejs.org/docs/index.html";
@@ -92,8 +92,8 @@ var typeLinks = {
9292

9393
// GeoJSON
9494
"GeoJSONObject": geojsonapi,
95-
"GeoJSONGeometry": geometryapi,
96-
95+
"GeoJSONGeometry": geometryapi +'#section-3.1',
96+
"GeoJSONFeature": geometryapi + '#section-3.2',
9797
// WebMap 结构
9898
"WebMapSummaryObject": helpDocApi + '#iP/Appendix/WebMap/WebMapSummary.htm',
9999

examples/mapboxgl/04_mathExpressionAnalysisService.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,6 @@
6363
//结果数据集名称,必设
6464
resultGridName: "MathExpressionAnalysis_Result",
6565
deleteExistResultDataset: true
66-
/*//指定数据集中参与栅格代数运算的区域
67-
extractRegion: L.polygon([
68-
[38, 116],
69-
[38, 117],
70-
[42, 117],
71-
[42, 116]
72-
])*/
7366
});
7467
//向iServer发起栅格代数运算请求
7568
mathExpressionAnalysisService.mathExpressionAnalysis(mathExpressionAnalysisParameters, function (serviceResult) {

src/common/commontypes/Bounds.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ export class Bounds {
312312
* var bounds1 = new Bounds(-50,-50,40,40);
313313
* //bounds 改变
314314
* bounds.extend(new LonLat(50,60));
315-
* @param {(GeometryPoint|LonLat|Bounds)} object - 可以是 point、lonlat 和 bounds。
315+
* @param {GeometryPoint|LonLat|Bounds} object - 可以是 point、lonlat 和 bounds。
316316
*/
317317
extend(object) {
318318
var bounds = null;

src/common/iServer/BuffersAnalystJobsParameter.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { MappingParameters } from './MappingParameters';
1313
* @classdesc 缓冲区分析任务参数类。
1414
* @param {Object} options - 参数。
1515
* @param {string} options.datasetName - 数据集名。
16-
* @param {(Bounds|L.Bounds|ol.extent)} [options.bounds] - 分析范围(默认为全图范围)。
16+
* @param {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} [options.bounds] - 分析范围(默认为全图范围)。
1717
* @param {string} [options.distance='15'] - 缓冲距离,或缓冲区半径。
1818
* @param {string} [options.distanceField='pickup_latitude'] - 缓冲区分析距离字段。
1919
* @param {AnalystSizeUnit} [options.distanceUnit=AnalystSizeUnit.METER] - 缓冲距离单位单位。
@@ -30,7 +30,7 @@ export class BuffersAnalystJobsParameter {
3030
this.datasetName = '';
3131

3232
/**
33-
* @member {(Bounds|L.Bounds|ol.extent)} BuffersAnalystJobsParameter.prototype.bounds
33+
* @member {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} BuffersAnalystJobsParameter.prototype.bounds
3434
* @description 分析范围。
3535
*/
3636
this.bounds = '';

src/common/iServer/ChartQueryParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {ChartQueryFilterParameter} from './ChartQueryFilterParameter';
1414
* @param {string} options.queryMode - 海图查询模式类型,支持两种查询方式:海图属性查询("ChartAttributeQuery")和海图空间查询("ChartBoundsQuery")。
1515
* @param {Array.<string>} options.chartLayerNames - 查询的海图图层的名称。
1616
* @param {Array.<ChartQueryFilterParameter>} options.chartQueryFilterParameters - 海图查询过滤参数。包括:物标代码、物标可应用对象的选择(是否查询点、线或面)、属性字段过滤条件。
17-
* @param {(Bounds|L.Bounds|ol.extent)} [options.bounds] - 海图查询范围。当进行海图范围查询时,此参数为必选。
17+
* @param {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} [options.bounds] - 海图查询范围。当进行海图范围查询时,此参数为必选。
1818
* @param {boolean} [options.returnContent=true] - 获取或设置是返回查询结果记录集 recordsets,还是返回查询结果的资源 resourceInfo。
1919
* @param {number} [options.startRecord=0] - 查询起始记录位置。
2020
* @param {number} [options.expectCount] - 期望查询结果返回的记录数,该值大于0。
@@ -31,7 +31,7 @@ export class ChartQueryParameters {
3131
this.queryMode = null;
3232

3333
/**
34-
* @member {(Bounds|L.Bounds|ol.extent)} ChartQueryParameters.prototype.bounds
34+
* @member {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} ChartQueryParameters.prototype.bounds
3535
* @description 海图查询范围。
3636
*/
3737
this.bounds = null;

src/common/iServer/ClipParameter.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {ServerGeometry} from './ServerGeometry';
1212
* @param {Object} options - 可选参数。
1313
* @param {string} [options.clipDatasetName] - 裁剪的数据集名。
1414
* @param {string} [options.clipDatasourceName] - 裁剪的数据集所在数据源的名字。
15-
* @param {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON} [options.clipRegion] - 用户指定的裁剪区域。
15+
* @param {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON|GeoJSONObject}} [options.clipRegion] - 用户指定的裁剪区域。
1616
* @param {boolean} [options.isClipInRegion=true] - 是否对裁剪区内的数据集进行裁剪。
1717
* @param {boolean} [options.isExactClip=true] - 是否使用精确裁剪。
1818
* @usage
@@ -34,7 +34,7 @@ export class ClipParameter {
3434
this.clipDatasourceName = null;
3535

3636
/**
37-
* @member {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON} ClipParameter.prototype.clipRegion
37+
* @member {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON|GeoJSONObject} ClipParameter.prototype.clipRegion
3838
* @description 用户指定的裁剪区域,优先使用,clipDatasetName 与 clipRegion 必须设置一个。
3939
*/
4040
this.clipRegion = null;

src/common/iServer/ComputeWeightMatrixParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {TransportationAnalystParameter} from './TransportationAnalystParameter';
1111
* @classdesc 耗费矩阵分析参数类。根据交通网络分析参数中的耗费字段返回一个耗费矩阵。该矩阵是一个二维数组,用来存储任意两点间的资源消耗。
1212
* @param {Object} options - 参数。
1313
* @param {boolean} [options.isAnalyzeById=false] - 是否通过节点 ID 指定路径分析的结点。
14-
* @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|number>} options.nodes - 要计算耗费矩阵的点数组。
14+
* @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} options.nodes - 要计算耗费矩阵的点数组。
1515
* @param {TransportationAnalystParameter} [options.parameter] - 交通网络分析通用参数。
1616
* @usage
1717
*/
@@ -26,7 +26,7 @@ export class ComputeWeightMatrixParameters {
2626
this.isAnalyzeById = false;
2727

2828
/**
29-
* @member {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|number>} ComputeWeightMatrixParameters.prototype.nodes
29+
* @member {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} ComputeWeightMatrixParameters.prototype.nodes
3030
* @description 要计算耗费矩阵的点数组。
3131
* 当 {@link ComputeWeightMatrixParameters.isAnalyzeById} = false 时,nodes 应为点的坐标数组;
3232
* 当 {@link ComputeWeightMatrixParameters.isAnalyzeById} = true 时,nodes 应为点的 ID 数组。

src/common/iServer/DatasetOverlayAnalystParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import {ServerGeometry} from './ServerGeometry';
1717
* @param {string} options.sourceDataset - 源数据集名称。
1818
* @param {Array.<string>} [options.operateDatasetFields] - 叠加分析中操作数据集保留在结果数据集中的字段名列表。
1919
* @param {FilterParameter} [options.operateDatasetFilter] - 设置操作数据集中空间对象过滤条件。
20-
* @param {Array.<GeometryPolygon|L.Polygon|ol.geom.Polygon>} [options.operateRegions] - 操作面对象集合,表示与这些面对象进行叠加分析。与 operateDataset 参数互斥,冲突时以 operateDataset 为准。
20+
* @param {Array.<GeometryPolygon|L.Polygon|ol.geom.Polygon|GeoJSONObject>} [options.operateRegions] - 操作面对象集合,表示与这些面对象进行叠加分析。与 operateDataset 参数互斥,冲突时以 operateDataset 为准。
2121
* @param {Array.<string>} [options.sourceDatasetFields] - 叠加分析中源数据集保留在结果数据集中的字段名列表。
2222
* @param {FilterParameter} [options.sourceDatasetFilter] - 设置源数据集中空间对象过滤条件。
2323
* @param {number} [options.tolerance=0] - 容限。
@@ -50,7 +50,7 @@ export class DatasetOverlayAnalystParameters extends OverlayAnalystParameters {
5050
this.operateDatasetFilter = new FilterParameter();
5151

5252
/**
53-
* @member {Array.<GeometryPolygon|L.Polygon|ol.geom.Polygon>} [DatasetOverlayAnalystParameters.prototype.operateRegions]
53+
* @member {Array.<GeometryPolygon|L.Polygon|ol.geom.Polygon|GeoJSONObject>} [DatasetOverlayAnalystParameters.prototype.operateRegions]
5454
* @description 操作面对象集合,表示与这些面对象进行叠加分析。与 operateDataset 参数互斥,冲突时以 operateDataset 为准。
5555
*/
5656
this.operateRegions = [];

src/common/iServer/DensityKernelAnalystParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {Util} from '../commontypes/Util';
1212
* @param {string} options.dataset - 要用来做核密度分析数据源中数据集的名称。该名称用形如 "数据集名称@数据源别名" 形式来表示,例如:BaseMap_P@Jingjin。
1313
* @param {string} options.fieldName - 用于进行核密度分析的测量值的字段名称,核密度分析不支持文本类型的字段。
1414
* @param {string} options.resultGridName - 指定结果数据集名称。
15-
* @param {(Bounds|L.Bounds|ol.extent)} [options.bounds] - 核密度分析的范围,用于确定结果栅格数据集的范围。如果缺省,则默认为原数据集的范围。
15+
* @param {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} [options.bounds] - 核密度分析的范围,用于确定结果栅格数据集的范围。如果缺省,则默认为原数据集的范围。
1616
* @param {number} [options.searchRadius] - 栅格邻域内用于计算密度的查找半径,单位与当前数据集相同。默认值为当前数据集的长宽中的最大值除30。
1717
* @param {number} [options.resultGridDatasetResolution] - 密度分析结果栅格数据的分辨率,单位与当前数据集相同。默认值为当前数据集的长宽中的最小值除500。
1818
* @param {string} [options.targetDatasource] - 指定的存储结果数据集的数据源,默认为当前分析的数据集所在的数据源。
@@ -32,7 +32,7 @@ export class DensityKernelAnalystParameters {
3232
this.dataset = null;
3333

3434
/**
35-
* @member {(Bounds|L.Bounds|ol.extent)} [DensityKernelAnalystParameters.prototype.bounds]
35+
* @member {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} [DensityKernelAnalystParameters.prototype.bounds]
3636
* @description 核密度分析的范围,用于确定结果栅格数据集的范围。
3737
* 如果缺省,则默认为原数据集的范围。
3838
*/

0 commit comments

Comments
 (0)