【API】 优化 API, 增加部分 version 标识 review by zhurc

Author: liqian7

examples/leaflet/widgets_clientComputation.html

@@ -80,7 +80,7 @@
         // 打开文件
         var openFile = L.supermap.widgets.openFile().addTo(map).setPosition('bottomleft');
 
-        openFile.viewModel.on('openfilesucceed', function (e) {
+        openFile.viewModel.on('openfilesucceeded', function (e) {
             var layer = L.geoJSON(e.result, {
                 style: { fillColor: '#ff7373', color: '#ff7373', opacity: 1, fillOpacity: 0.8 }
             }).addTo(map);
@@ -94,7 +94,7 @@
             clientComputation.addLayer(clientComputationLayer);
         })
 
-        clientComputation.on("analysissucceed", function (e) {
+        clientComputation.on("analysissucceeded", function (e) {
             control.addOverlay(e.layer, e.name);
         })
         clientComputation.on("layersremoved", function (e) {

examples/leaflet/widgets_distributedAnalysis.html

@@ -36,7 +36,7 @@
         distributedAnalysis.addTo(map);
 
 
-        distributedAnalysis.on("analysissucceed", function (e) {
+        distributedAnalysis.on("analysissucceeded", function (e) {
             control.addOverlay(e.layer, e.name);
         })
         distributedAnalysis.on("layersremoved", function (e) {

examples/leaflet/widgets_openFileWidget.html

@@ -26,7 +26,7 @@
     var layersControl = L.control.layers({"baseLayers": baseLayers}, {}, {"position": 'topleft'}).addTo(map);
     var openFileWidgets = L.supermap.widgets.openFile().addTo(map);
     //将成功返回的数据加载到地图
-    openFileWidgets.on("openfilesucceed", function (e) {
+    openFileWidgets.on("openfilesucceeded", function (e) {
         var layer = L.geoJSON(e.result).addTo(map);
         map.flyToBounds(layer.getBounds());
         layersControl.addOverlay(layer, e.layerName);

examples/leaflet/widgets_openFileWidget_react.html

@@ -70,7 +70,7 @@
             this.openFileViewModel.on("errorfileformat", this._messageListener.bind(this));
             this.openFileViewModel.on("openfilefailed", this._messageListener.bind(this));
             this.openFileViewModel.on("readdatafail", this._messageListener.bind(this));
-            this.openFileViewModel.on("openfilesucceed", function (e) {
+            this.openFileViewModel.on("openfilesucceeded", function (e) {
                 var layer = L.geoJSON(e.result).addTo(map);
                 map.flyToBounds(layer.getBounds());
                 layersControl.addOverlay(layer, e.layerName);

examples/leaflet/widgets_openFileWidget_vue.html

@@ -86,7 +86,7 @@
                 self.openFileViewModel.on("errorfileformat", _messageListener.bind(self));
                 self.openFileViewModel.on("openfilefailed", _messageListener.bind(self));
                 self.openFileViewModel.on("readdatafail", _messageListener.bind(self));
-                self.openFileViewModel.on("openfilesucceed", function (e) {
+                self.openFileViewModel.on("openfilesucceeded", function (e) {
                     var layer = L.geoJSON(e.result).addTo(map);
                     map.flyToBounds(layer.getBounds());
                     layersControl.addOverlay(layer, e.layerName);

examples/mapboxgl/dataFlowService.html

@@ -72,7 +72,7 @@
                 prjCoordSys: options.prjCoordSys,
                 excludeField: options.excludeField
             }).initSubscribe();
-            dataFlowSubscribe.on('messageSuccessed', function (msg) {
+            dataFlowSubscribe.on('messageSucceeded', function (msg) {
                 popup.remove();
                 addLayer(msg);
             });

src/common/format/GeoJSON.js

@@ -546,7 +546,7 @@ export class GeoJSON extends JSONFormat {
      *  @function SuperMap.Format.GeoJSON.prototype.isValidType
      *  @description 检查一个 GeoJSON 对象是否和给定的类型相符的合法的对象。
      *  @returns {boolean} GeoJSON 是否是给定类型的合法对象。
-     * @private
+     *  @private
      */
     isValidType(obj, type) {
         var valid = false;

src/common/iServer/DataFlowService.js

@@ -28,7 +28,7 @@ export class DataFlowService extends CommonServiceBase {
          * {Array.<string>}
          * 此类支持的事件类型
          */
-        options.EVENT_TYPES = ["broadcastSocketConnected", "broadcastSocketError", "broadcastFailed", "broadcastSuccessed", "subscribeSocketConnected", "subscribeSocketError", "messageSuccessed", "setFilterParamSuccessed"]
+        options.EVENT_TYPES = ["broadcastSocketConnected", "broadcastSocketError", "broadcastFailed", "broadcastSucceeded", "subscribeSocketConnected", "subscribeSocketError", "messageSucceeded", "setFilterParamSucceeded"]
         super(url, options);
 
         /**
@@ -95,7 +95,7 @@ export class DataFlowService extends CommonServiceBase {
             return;
         }
         this.broadcastWebSocket.send(JSON.stringify(geoJSONFeature));
-        this.events.triggerEvent('broadcastSuccessed');
+        this.events.triggerEvent('broadcastSucceeded');
 
     }
 
@@ -203,14 +203,14 @@ export class DataFlowService extends CommonServiceBase {
         if (e.data && e.data.indexOf("filterParam") >= 0) {
             var filterParam = JSON.parse(e.data);
             e.filterParam = filterParam;
-            e.eventType = 'setFilterParamSuccessed';
-            this.events.triggerEvent('setFilterParamSuccessed', e);
+            e.eventType = 'setFilterParamSucceeded';
+            this.events.triggerEvent('setFilterParamSucceeded', e);
             return;
         }
         var feature = JSON.parse(e.data);
         e.featureResult = feature;
-        e.eventType = 'messageSuccessed';
-        this.events.triggerEvent('messageSuccessed', e);
+        e.eventType = 'messageSucceeded';
+        this.events.triggerEvent('messageSucceeded', e);
     }
 
 

src/common/widgets/messagebox/MessageBox.js

@@ -5,7 +5,8 @@ import {SuperMap} from '../../SuperMap';
 
 /**
  * @class SuperMap.Widgets.MessageBox
- * @classdesc 微件信息提示框
+ * @version 9.1.1
+ * @classdesc 微件信息提示框。
  * @category Widgets Common
  */
 export class MessageBox {
@@ -51,17 +52,17 @@ export class MessageBox {
 
     /**
      * @function SuperMap.Widgets.MessageBox.prototype.closeView
-     * @description 关闭提示框
+     * @description 关闭提示框。
      */
     closeView() {
         this.messageBoxContainer.hidden = true;
     }
 
     /**
      * @function SuperMap.Widgets.MessageBox.prototype.showView
-     * @description 显示提示框
-     * @param {string} message - 提示框显示内容
-     * @param {string}[type="warring"] 提示框类型，如 "warring", "failure", "success", 默认为"warring"
+     * @description 显示提示框。
+     * @param {string} message - 提示框显示内容。
+     * @param {string}[type="warring"] 提示框类型，如 "warring", "failure", "success"。
      */
     showView(message, type = 'warring') {
         //设置提示框的样式：

src/common/widgets/templates/AttributesPopContainer.js

@@ -7,6 +7,7 @@ import {PopContainer} from './PopContainer';
 /**
  * @class SuperMap.Widgets.AttributesPopContainer
  * @classdesc 属性弹框组件
+ * @version 9.1.1
  * @param {Object} options - 组件配置参数。
  * @param {string} options.id - 组件 dom 元素 id。
  * @param {Object} options.title - 属性弹框组件名称。