mbgl service模块 api参数优化 review by songym

Author: liqian7

src/mapboxgl/services/AddressMatchService.js

@@ -6,14 +6,17 @@ import {AddressMatchService as CommonAddressMatchService} from '@supermap/iclien
 /**
  * @class mapboxgl.supermap.AddressMatchService
  * @category  iServer AddressMatch
- * @classdesc 地址匹配服务
+ * @classdesc 地址匹配服务。
  * @example
  * new mapboxgl.supermap.AddressMatchService(url,options)
  * .code(function(result){
  *     //doSomething
  * })
- * @param {string} url - 与客户端交互的服务地址。</br>
+ * @param {string} url - 与客户端交互的服务地址。
  * @param {Object} options - 交互时所需可选参数。
+ * @param {string} [options.proxy] - 服务代理地址。
+ * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  * @extends {mapboxgl.supermap.ServiceBase}
  */
 export class AddressMatchService extends ServiceBase {
@@ -24,7 +27,7 @@ export class AddressMatchService extends ServiceBase {
     /**
      * @function mapboxgl.supermap.AddressMatchService.prototype.code
      * @description 获取正向地址匹配结果。
-     * @param {Object} params - 正向匹配参数。</br>
+     * @param {Object} params - 正向匹配参数。
      * @param {RequestCallback} callback - 请求结果的回调函数。
      */
     code(params, callback) {
@@ -45,7 +48,7 @@ export class AddressMatchService extends ServiceBase {
     /**
      * @function mapboxgl.supermap.AddressMatchService.prototype.decode
      * @description 获取反向地址匹配结果。
-     * @param {Object} params -反向匹配参数。 </br>
+     * @param {Object} params -反向匹配参数。
      * @param {RequestCallback} callback - 请求结果的回调函数。
      */
     decode(params, callback) {

src/mapboxgl/services/ChartService.js

@@ -11,12 +11,14 @@ import {Bounds, DataFormat, ChartQueryService, ChartFeatureInfoSpecsService} fro
  * @extends {mapboxgl.supermap.ServiceBase}
  * @example
  * new mapboxgl.supermap.ChartService(url)
- * .queryChart(param,function(result){
+ *  .queryChart(param,function(result){
  *     //doSomething
  * })
- * @param {string} url - 与客户端交互的海图服务地址。</br>
+ * @param {string} url - 与客户端交互的海图服务地址。
  * @param {Object} options - 交互时所需可选参数。
- *
+ * @param {string} [options.proxy] - 服务代理地址。
+ * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  */
 export class ChartService extends ServiceBase {
     constructor(url, options) {
@@ -26,9 +28,9 @@ export class ChartService extends ServiceBase {
     /**
      * @function mapboxgl.supermap.ChartService.prototype.queryChart
      * @description 查询海图服务。
-     * @param {SuperMap.ChartQueryParameters} params - 海图查询所需参数类。</br>
-     * @param {RequestCallback} callback 回调函数。</br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的结果格式类型。
+     * @param {SuperMap.ChartQueryParameters} params - 海图查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=SuperMap.DataFormat.GEOJSON] - 返回的结果格式类型。
      */
     queryChart(params, callback, resultFormat) {
         var me = this,
@@ -52,7 +54,7 @@ export class ChartService extends ServiceBase {
     /**
      * @function mapboxgl.supermap.ChartService.prototype.getChartFeatureInfo
      * @description 获取海图物标信息服务。
-     * @param {RequestCallback} callback 回调函数
+     * @param {RequestCallback} callback 回调函数。
      */
     getChartFeatureInfo(callback) {
         var me = this, url = me.url.concat();

src/mapboxgl/services/DataFlowService.js

@@ -6,19 +6,17 @@ import {DataFlowService as DataFlow} from '@supermap/iclient-common';
 /**
  * @class mapboxgl.supermap.DataFlowService
  * @category  iServer DataFlow
- * @classdesc 实时数据服务
+ * @classdesc 实时数据服务。
  * @extends {mapboxgl.supermap.ServiceBase}
  * @example
  * new mapboxgl.supermap.DataFlowService(url)
- * .queryChart(param,function(result){
+ *  .queryChart(param,function(result){
  *     //doSomething
  * })
  * @param {string} url - 与客户端交互的实时数据服务地址。
- * @param {Object} options - 加载实时数据可选参数。</br>
- * @param {function} options.style - 设置数据加载样式。</br>
- * @param {function} options.onEachFeature - 设置每个数据加载popup等。</br>
- * @param {Array.<Object>} options.geometry - 设置增添的几何要素对象数组。</br>
- * @param {Object} options.excludeField - 排除字段。
+ * @param {Object} options - 加载实时数据可选参数。
+ * @param {Array.<Object>} [options.geometry] - 设置增添的几何要素对象数组。
+ * @param {Object} [options.excludeField] - 排除字段。
  */
 export class DataFlowService extends ServiceBase {
 
@@ -51,7 +49,7 @@ export class DataFlowService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.initBroadcast
-     * @description 初始化广播
+     * @description 初始化广播。
      * @returns {mapboxgl.supermap.DataFlowService}
      */
     initBroadcast() {
@@ -61,16 +59,16 @@ export class DataFlowService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.broadcast
-     * @description 加载广播数据
-     * @param {JSON} obj - json格式的要素数据
+     * @description 加载广播数据。
+     * @param {JSON} obj - JSON 格式的要素数据。
      */
     broadcast(obj) {
         this.dataFlow.broadcast(obj);
     }
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.initSubscribe
-     * @description 初始化订阅数据
+     * @description 初始化订阅数据。
      */
     initSubscribe() {
         this.dataFlow.initSubscribe();
@@ -80,8 +78,8 @@ export class DataFlowService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.setExcludeField
-     * @description 设置排除字段
-     * @param {Object} excludeField - 排除字段
+     * @description 设置排除字段。
+     * @param {Object} excludeField - 排除字段。
      */
     setExcludeField(excludeField) {
         this.dataFlow.setExcludeField(excludeField);
@@ -91,7 +89,7 @@ export class DataFlowService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.setGeometry
-     * @description 设置添加的几何要素数据
+     * @description 设置添加的几何要素数据。
      * @param {Array.<Object>} geometry - 设置增添的几何要素对象数组。
      */
     setGeometry(geometry) {
@@ -102,15 +100,15 @@ export class DataFlowService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.unSubscribe
-     * @description 结束订阅数据
+     * @description 结束订阅数据。
      */
     unSubscribe() {
         this.dataFlow.unSubscribe();
     }
 
     /**
      * @function mapboxgl.supermap.DataFlowService.prototype.unBroadcast
-     * @description 结束加载广播
+     * @description 结束加载广播。
      */
     unBroadcast() {
         this.dataFlow.unBroadcast();

src/mapboxgl/services/FeatureService.js

@@ -15,16 +15,18 @@ import {
 /**
  * @class mapboxgl.supermap.FeatureService
  * @category  iServer Data Feature
- * @classdesc 要素数据集类。提供：ID查询，范围查询，SQL查询，几何查询，bounds查询，缓冲区查询，地物编辑
+ * @classdesc 要素数据集类。提供：ID 查询，范围查询，SQL 查询，几何查询，bounds 查询，缓冲区查询，地物编辑。
  * @example
  * new mapboxgl.supermap.FeatureService(url)
- * .getFeaturesByIDs(param,function(result){
+ *  .getFeaturesByIDs(param,function(result){
  *     //doSomething
  * })
  * @extends {mapboxgl.supermap.ServiceBase}
- * @param {string} url - 要素数据集服务地址 </br>
- * @param {Object} options - 创建要素数据集服务类可选参数。</br>
- * @param {SuperMap.ServerType} options.serverType - 服务来源 iServer|iPortal|online
+ * @param {string} url - 要素数据集服务地址。
+ * @param {Object} options - 创建要素数据集服务类可选参数。
+ * @param {string} [options.proxy] - 服务代理地址。
+ * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  */
 export class FeatureService extends ServiceBase {
     constructor(url, options) {
@@ -33,10 +35,10 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.getFeaturesByIDs
-     * @description 数据集ID查询服务
-     * @param {SuperMap.GetFeaturesByIDsParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback - 回调函数</br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的数据格式
+     * @description 数据集 ID 查询服务。
+     * @param {SuperMap.GetFeaturesByIDsParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback - 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的数据格式。
      */
     getFeaturesByIDs(params, callback, resultFormat) {
         var me = this;
@@ -55,10 +57,10 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.getFeaturesByBounds
-     * @description 数据集Bounds查询服务
-     * @param {SuperMap.GetFeaturesByBoundsParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback - 回调函数 </br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的数据格式
+     * @description 数据集 Bounds 查询服务。
+     * @param {SuperMap.GetFeaturesByBoundsParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback - 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的数据格式。
      */
     getFeaturesByBounds(params, callback, resultFormat) {
         var me = this;
@@ -77,10 +79,10 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.getFeaturesByBuffer
-     * @description 数据集Buffer查询服务
-     * @param {SuperMap.GetFeaturesByBufferParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback 回调函数 </br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的数据格式
+     * @description 数据集 Buffer 查询服务。
+     * @param {SuperMap.GetFeaturesByBufferParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的数据格式。
      */
     getFeaturesByBuffer(params, callback, resultFormat) {
         var me = this;
@@ -99,10 +101,10 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.getFeaturesBySQL
-     * @description 数据集SQL查询服务
-     * @param {SuperMap.GetFeaturesBySQLParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback 回调函数 </br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的数据格式
+     * @description 数据集 SQL 查询服务。
+     * @param {SuperMap.GetFeaturesBySQLParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=SuperMap.DataFormat.GEOJSON] - 返回的数据格式。
      */
     getFeaturesBySQL(params, callback, resultFormat) {
         var me = this;
@@ -122,10 +124,10 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.getFeaturesByGeometry
-     * @description 数据集几何查询服务类
-     * @param {SuperMap.GetFeaturesByGeometryParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback - 回调函数 </br>
-     * @param {SuperMap.DataFormat} resultFormat - 返回的数据格式
+     * @description 数据集几何查询服务类。
+     * @param {SuperMap.GetFeaturesByGeometryParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback - 回调函数。
+     * @param {SuperMap.DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的数据格式。
      */
     getFeaturesByGeometry(params, callback, resultFormat) {
         var me = this;
@@ -144,9 +146,9 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FeatureService.prototype.editFeatures
-     * @description 地物编辑服务
-     * @param {SuperMap.EditFeaturesParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback 回调函数
+     * @description 地物编辑服务。
+     * @param {SuperMap.EditFeaturesParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
      */
     editFeatures(params, callback) {
         if (!params || !params.dataSourceName || !params.dataSetName) {
@@ -172,9 +174,9 @@ export class FeatureService extends ServiceBase {
 
     /**
      * @private
-     * @description 参数类型转换
-     * @param {object} params - 由端传进的服务参数 
-     * @returns {object} params - 转换后的对接SuperMap 服务的参数
+     * @description 参数类型转换。
+     * @param {object} params - 服务参数 。
+     * @returns {object} params - 转换后的对接 SuperMap 服务的参数。
      */
     _processParams(params) {
         if (!params) {

src/mapboxgl/services/FieldService.js

@@ -7,13 +7,16 @@ import {GetFieldsService, FieldStatisticService} from '@supermap/iclient-common'
 /**
  * @class mapboxgl.supermap.FieldService
  * @category  iServer Data Field
- * @classdesc 字段服务类
+ * @classdesc 字段服务类。
  * @example
  * new mapboxgl.supermap.FieldService(url).getFields(function(result){
  *     //doSomething
  * });
- * @param {string} url - 与客户端交互的服务地址。</br>
+ * @param {string} url - 与客户端交互的服务地址。
  * @param {Object} options - 参数。
+ * @param {string} [options.proxy] - 服务代理地址。
+ * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  * @extends {mapboxgl.supermap.ServiceBase}
  */
 export class FieldService extends ServiceBase {
@@ -23,9 +26,9 @@ export class FieldService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FieldService.prototype.getFields
-     * @description 字段查询服务
-     * @param {SuperMap.FieldParameters} params - 字段信息查询参数类 </br>
-     * @param {RequestCallback} callback 回调函数 
+     * @description 字段查询服务。
+     * @param {SuperMap.FieldParameters} params - 字段信息查询参数类。
+     * @param {RequestCallback} callback 回调函数。
      */
     getFields(params, callback) {
         var me = this;
@@ -46,9 +49,9 @@ export class FieldService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.FieldService.prototype.getFieldStatisticsInfo
-     * @description 字段统计服务
-     * @param {SuperMap.FieldStatisticsParameters} params - 查询所需参数类。</br>
-     * @param {RequestCallback} callback 回调函数
+     * @description 字段统计服务。
+     * @param {SuperMap.FieldStatisticsParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
      */
     getFieldStatisticsInfo(params, callback) {
         var me = this,

src/mapboxgl/services/GridCellInfosService.js

@@ -6,19 +6,19 @@ import {GetGridCellInfosService} from '@supermap/iclient-common';
 /**
  * @class mapboxgl.supermap.GridCellInfosService
  * @category  iServer Data Grid
- * @classdesc 数据栅格查询服务
+ * @classdesc 数据栅格查询服务。
  * @extends {mapboxgl.supermap.ServiceBase}
  * @example
  * new mapboxgl.supermap.GridCellInfosService(url)
- * .getGridCellInfos(param,function(result){
+ *  .getGridCellInfos(param,function(result){
  *     //doSomething
  * })
- * @param {string} url - 与客户端交互的地图服务地址。请求地图服务,URL 应为：</br>
- *                       http://{服务器地址}:{服务端口号}/iserver/services/{地图服务名}/rest/maps/{地图名}/tempLayersSet/{tempLayerID}/Rivers@World@@World"；
- * @param {Object} options - 服务所需可选参数。</br>
- * @param {Object} options.eventListeners - 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。</br>
- * @param {SuperMap.ServerType} options.serverType - 服务器类型，iServer|iPortal|Online。</br>
- * @param {SuperMap.DataFormat} options.format - 查询结果返回格式，目前支持iServerJSON和GeoJSON两种格式。参数格式为"ISERVER","GEOJSON"。
+ * @param {string} url - 与客户端交互的地图服务地址。请求地图服务，URL 应为：</br>
+ *                       http://{服务器地址}:{服务端口号}/iserver/services/{地图服务名}/rest/maps/{地图名}/tempLayersSet/{tempLayerID}/Rivers@World@@World"。
+ * @param {Object} options - 服务所需可选参数。
+ * @param {string} [options.proxy] - 服务代理地址。
+ * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  */
 export class GridCellInfosService extends ServiceBase {
 
@@ -28,8 +28,8 @@ export class GridCellInfosService extends ServiceBase {
 
     /**
      * @function mapboxgl.supermap.GridCellInfosService.prototype.getGridCellInfos
-     * @param {SuperMap.GetGridCellInfosParameters} params - 查询所需参数类 </br>
-     * @param {RequestCallback} callback 回调函数
+     * @param {SuperMap.GetGridCellInfosParameters} params - 查询所需参数类。
+     * @param {RequestCallback} callback 回调函数。
      */
     getGridCellInfos(params, callback) {
         if (!params) {