Skip to content

Commit 7d27b2d

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】jsdoc优化
1 parent 77b2f9b commit 7d27b2d

File tree

6 files changed

+43
-43
lines changed

6 files changed

+43
-43
lines changed

‎src/common/iServer/CommonServiceBase.js‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ import {
3030
* @class SuperMap.CommonServiceBase
3131
* @category iServer
3232
* @classdesc 对接iServer各种服务的Service的基类。
33-
* @param url - {string} 服务地址。
34-
* @param options - {Object} 可选参数。如：<br>
35-
* eventListeners - {Object} 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。<br>
36-
* proxy - {string} 服务代理地址<br>
37-
* serverType - {SuperMap.ServerType} 服务器类型，iServer|iPortal|Online。<br>
38-
* withCredentials - {boolean} 请求是否携带cookie,默认为false。<br>
39-
* format -{SuperMap.DataFormat} 查询结果返回格式，目前支持iServerJSON 和GeoJSON两种格式。参数格式为"ISERVER","GEOJSON"。
33+
* @param {string} url - 服务地址。
34+
* @param {Object} options - 参数。<br>
35+
* @param {Object} options.eventListeners - 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。
36+
* @param {string} options.proxy - 服务代理地址。
37+
* @param {SuperMap.ServerType} options.serverType - 服务器类型，iServer|iPortal|Online。
38+
* @param {boolean} options.withCredentials - 请求是否携带cookie,默认为false。
39+
* @param {SuperMap.DataFormat} options.format - 查询结果返回格式，目前支持iServerJSON 和GeoJSON两种格式。参数格式为"ISERVER","GEOJSON"。
4040
*/
4141
export class CommonServiceBase {
4242

@@ -144,16 +144,16 @@ export class CommonServiceBase {
144144
/**
145145
* @function SuperMap.CommonServiceBase.prototype.request
146146
* @description: 该方法用于向服务发送请求。
147-
* @param options - {Object} 参数。
148-
* method - {string} 请求方式，包括"GET"，"POST"，"PUT"，"DELETE"。<br>
149-
* url - {string} 发送请求的地址。<br>
150-
* params - {Object} 作为查询字符串添加到url中的一组键值对，此参数只适用于GET方式发送的请求。<br>
151-
* data - {String } 发送到服务器的数据。<br>
152-
* success - {function} 请求成功后的回调函数。<br>
153-
* failure - {function} 请求失败后的回调函数。<br>
154-
* scope - {Object} 如果回调函数是对象的一个公共方法，设定该对象的范围。<br>
155-
* isInTheSameDomain - {boolean} 请求是否在当前域中。<br>
156-
* withCredentials - {boolean} 请求是否携带cookie。<br>
147+
* @param {Object} options - 参数。
148+
* @param {string} options.method - 请求方式，包括"GET"，"POST"，"PUT"，"DELETE"。<br>
149+
* @param {string} options.url - 发送请求的地址。<br>
150+
* @param {Object} options.params - 作为查询字符串添加到url中的一组键值对，此参数只适用于GET方式发送的请求。<br>
151+
* @param {String} options.data - 发送到服务器的数据。<br>
152+
* @param {function} options.success - 请求成功后的回调函数。<br>
153+
* @param {function} options.failure - 请求失败后的回调函数。<br>
154+
* @param {Object} options.scope - 如果回调函数是对象的一个公共方法，设定该对象的范围。<br>
155+
* @param {boolean} options.isInTheSameDomain - 请求是否在当前域中。<br>
156+
* @param {boolean} options.withCredentials - 请求是否携带cookie。<br>
157157
*/
158158
request(options) {
159159
let me = this;
@@ -190,7 +190,7 @@ export class CommonServiceBase {
190190
/**
191191
* @function SuperMap.CommonServiceBase.prototype.getCredential
192192
* @description 获取凭据信息
193-
* @param url - {string} 服务地址。
193+
* @param {string} url - 服务地址。
194194
* @return {SuperMap.Credential} 凭据信息对象。
195195
*/
196196
getCredential(url) {
@@ -221,7 +221,7 @@ export class CommonServiceBase {
221221
/**
222222
* @function SuperMap.CommonServiceBase.prototype.getUrlCompleted
223223
* @description 请求成功后执行此方法。
224-
* @param result - {Object} 服务器返回的结果对象。
224+
* @param {Object} result - 服务器返回的结果对象。
225225
*/
226226
getUrlCompleted(result) {
227227
let me = this;
@@ -232,7 +232,7 @@ export class CommonServiceBase {
232232
/**
233233
* @function SuperMap.CommonServiceBase.prototype.getUrlFailed
234234
* @description 请求失败后执行此方法。
235-
* @param result - {Object} 服务器返回的结果对象。
235+
* @param {Object} result - 服务器返回的结果对象。
236236
*/
237237
getUrlFailed(result) {
238238
let me = this;
@@ -305,7 +305,7 @@ export class CommonServiceBase {
305305
/**
306306
* @function SuperMap.CommonServiceBase.prototype.serviceProcessCompleted
307307
* @description 状态完成，执行此方法。
308-
* @param result - {Object} 服务器返回的结果对象。
308+
* @param {Object} result - 服务器返回的结果对象。
309309
*/
310310
serviceProcessCompleted(result) {
311311
result = Util.transformResult(result);
@@ -317,7 +317,7 @@ export class CommonServiceBase {
317317
/**
318318
* @function SuperMap.CommonServiceBase.prototype.serviceProcessFailed
319319
* @description 状态失败，执行此方法。
320-
* @param result - {Object} 服务器返回的结果对象。
320+
* @param{Object} result - 服务器返回的结果对象。
321321
*/
322322
serviceProcessFailed(result) {
323323
result = Util.transformResult(result);

‎src/common/iServer/FindTSPPathsParameters.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import {TransportationAnalystParameter} from './TransportationAnalystParameter';
1111
* 旅行商分析和最佳路径分析都是在网络中寻找遍历所有站点的最经济的路径，区别是在遍历网络所有站点的过程中对结点访问顺序不同
1212
* 最佳路径分析必须按照指定顺序对站点进行访问，而旅行商分析是无序的路径分析。
1313
* @param {Object} options - 参数。<br>
14-
* {boolean} [options.endNodeAssigned=false] - 是否指定终止点，将指定的途经点的最后一个点作为终止点。true 表示指定终止点，则旅行商必须最后一个访问终止点。<br>
15-
* {boolean} [options.isAnalyzeById=false] - 是否通过节点 ID 号来指定配送中心点和配送目的点。<br>
16-
* {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number>} options.nodes - 配送目标集合，必设字段。<br>
17-
* {SuperMap.TransportationAnalystParameter} options.parameter - 交通网络分析通用参数。<br>
14+
* @param {boolean} [options.endNodeAssigned=false] - 是否指定终止点，将指定的途经点的最后一个点作为终止点。true 表示指定终止点，则旅行商必须最后一个访问终止点。<br>
15+
* @param {boolean} [options.isAnalyzeById=false] - 是否通过节点 ID 号来指定配送中心点和配送目的点。<br>
16+
* @param {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number>} options.nodes - 配送目标集合，必设字段。<br>
17+
* @param {SuperMap.TransportationAnalystParameter} options.parameter - 交通网络分析通用参数。<br>
1818
*/
1919
export class FindTSPPathsParameters {
2020

‎src/common/iServer/Image.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ import '../REST';
1010
* @classdesc UGC 影像图层类。
1111
* @extends {SuperMap.UGCSubLayer}
1212
* @param {Object} options - 参数。<br>
13-
* @param {SuperMap.ColorSpaceType} colorSpaceType - 返回影像图层的色彩显示模式。<br>
14-
* @param {number} brightness - 影像图层的亮度。<br>
15-
* @param {Array.<number>} displayBandIndexes - 返回当前影像图层显示的波段索引。<br>
16-
* @param {number} contrast - 影像图层的对比度。<br>
17-
* @param {boolean} transparent - 是否背景透明。<br>
18-
* @param {SuperMap.ServerColor} transparentColor - 返回背景透明色。<br>
19-
* @param {number} transparentColorTolerance - 背景透明色容限。
13+
* @param {SuperMap.ColorSpaceType} options.colorSpaceType - 返回影像图层的色彩显示模式。
14+
* @param {number} options.brightness - 影像图层的亮度。
15+
* @param {Array.<number>} options.displayBandIndexes - 返回当前影像图层显示的波段索引。
16+
* @param {number} options.contrast - 影像图层的对比度。
17+
* @param {boolean} options.transparent - 是否背景透明。
18+
* @param {SuperMap.ServerColor} options.transparentColor - 返回背景透明色。
19+
* @param {number} options.transparentColorTolerance - 背景透明色容限。
2020
*/
2121
export class UGCImage extends UGCSubLayer {
2222

‎src/common/iServer/ThemeFlow.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import {ServerStyle} from './ServerStyle';
77
* @category iServer Map Theme
88
* @classdesc 标签或符号流动显示和牵引线风格设置类。
99
* 通过该类可以设置专题图中符号是否流动显示、是否使用牵引线以及牵引线风格。
10-
* @param {Object} options - 参数。<br>
11-
* @param {boolean} options.flowEnabled - 是否流动显示标签或符号。<br>
12-
* @param {boolean} options.leaderLineDisplayed - 是否显示标签或符号和它标注的对象之间的牵引线。<br>
13-
* @param SuperMap.ServerStyle} options.leaderLineStyle - 标签或符号与其标注对象之间牵引线的风格。
10+
* @param {Object} options - 参数。
11+
* @param {boolean} options.flowEnabled - 是否流动显示标签或符号。
12+
* @param {boolean} options.leaderLineDisplayed - 是否显示标签或符号和它标注的对象之间的牵引线。
13+
* @param {SuperMap.ServerStyle} options.leaderLineStyle - 标签或符号与其标注对象之间牵引线的风格。
1414
*/
1515
export class ThemeFlow {
1616

‎src/leaflet/overlay/DataFlowLayer.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ import {
1717
* @extends {L.LayerGroup}
1818
* @param {string} url - 实时数据图层服务地址
1919
* @param {Object} options - 设置图层参数。
20-
* @param {Object} [options.render='normal'] - 绘制方式。可选值为`'normal'`，`'mapv'`。</br>
21-
`'normal'` 表示以 { {@link L.LatLng}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Marker} } 方式绘制实时数据。`'mapv'` 表示以 {@link L.supermap.mapVLayer} 方式绘制实时数据。</br>
20+
* @param {Object} [options.render='normal'] - 绘制方式。可选值为'normal'，'mapv'。</br>
21+
'normal'表示以 {( {@link L.LatLng}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Marker} )} 方式绘制实时数据。'mapv'表示以 {@link L.supermap.mapVLayer} 方式绘制实时数据。</br>
2222
* @param {Object} [options.geometry] - GeoJSON几何对象。
2323
* @param {Object} [options.prjCoordSys] - 投影坐标对象。
2424
* @param {string} [options.excludeField] - 排除字段。
2525
* @param {string} [options.idField='id'] - 要素属性中表示唯一标识的字段。
26-
* @param {Function} [options.pointToLayer] - 定义点要素如何绘制在地图上。</br>
26+
* @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上。</br>
2727
`function(geoJsonPoint, latlng) {
2828
return L.marker(latlng);
2929
}`
30-
* @param {Function} [options.style] - 定义点、线、面要素样式。参数为{@link L.Path-option}。</br>
30+
* @param {function} [options.style] - 定义点、线、面要素样式。参数为{@link L.Path-option}。</br>
3131
`function (feature) {
3232
return {
3333
fillColor: "red",

‎src/leaflet/overlay/HeatMapLayer.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ import {
2020
* @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
2121
* @param {string} options.featureWeight - 对应 feature 属性中的热点权重字段名称，权重值类型为float。
2222
* @param {number} [options.radius=50] - 热点渲染的最大半径（热点像素半径），单位为 px,当 useGeoUnit参数 为 true 时，单位使用当前图层地理坐标单位。热点显示的时候以精确点为中心点开始往四周辐射衰减，其衰减半径和权重值成比列。
23-
* @param {boolean} [loadWhileAnimating=true] - 是否实时重绘。(当绘制大数据量要素的情况下会出现卡顿，建议把该参数设为false)。
2423
* @param {number} options.opacity - 图层透明度。
25-
* @param {Array.<string>} colors - 颜色线性渐变数组,颜色值必须为canvas所支持的。默认为['blue','cyan','lime','yellow','red']。
2624
* @param {boolean} [options.useGeoUnit=false] - 使用地理单位，即默认热点半径默认使用像素单位。 当设置为true时，热点半径和图层地理坐标保持一致。
25+
* @param {boolean} [loadWhileAnimating=true] - 是否实时重绘。(当绘制大数据量要素的情况下会出现卡顿，建议把该参数设为false)。
26+
* @param {Array.<string>} colors - 颜色线性渐变数组,颜色值必须为canvas所支持的。默认为['blue','cyan','lime','yellow','red']。
2727
* @extends {L.Layer}
2828
*/
2929
export var HeatMapLayer = L.Layer.extend({

0 commit comments

Comments
 (0)