【API】 fire事件 & 微件 API 优化 review by songym

Author: liqian7

build/jsdocs/template/config.json

@@ -336,7 +336,7 @@
                 "name_en": "Common"
             },
             "OpenFile": {
-                "name": "打开文件微件",
+                "name": "打开本地文件微件",
                 "name_en": "OpenFile"
             },
             "DataFlow": {

dist/leaflet/iclient9-leaflet-es6.js

@@ -7,8 +7,8 @@
  * @classdesc 标签页面组件
  * @category Widgets Common
  * @param {Array.<Object>} [tabs=[]] - 标签对象数组 [{title: "",content: HTMLElement}],初始时，传入则创建页面。
- * todo 思考拆分的控件应该以哪种方式使用
- */
+ */ 
+//  todo 思考拆分的控件应该以哪种方式使用
 export class NavTabsPage {
     constructor(tabs = [], id = null) {
         this.navTabsPage = null;

dist/leaflet/iclient9-leaflet-es6.min.js

@@ -32,6 +32,8 @@ import Attributions from '../core/Attributions'
  * @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权信息。
  *
  * @extends {L.Layer}
+ * @fires L.supermap.heatMapLayer#featuresremoved
+ * @fires L.supermap.heatMapLayer#changelayer
  */
 export var HeatMapLayer = L.Layer.extend({
     options: {
@@ -428,6 +430,12 @@ export var HeatMapLayer = L.Layer.extend({
         }
         var succeed = heatPointsFailedRemoved.length == 0 ? true : false;
         //派发删除features成功的事件
+        /**
+         * @event L.supermap.heatMapLayer#featuresremoved
+         * @description 删除features成功后触发。
+         * @property {Array.<SuperMap.Feature.Vector>} features  - 事件对象。
+         * @property {boolean} succeed  - 删除是否成功，false 为失败，true 为成功。
+         */
         this._map.fire("featuresremoved", {features: heatPointsFailedRemoved, succeed: succeed});
         this.refresh();
     },
@@ -469,6 +477,12 @@ export var HeatMapLayer = L.Layer.extend({
         var me = this;
         CommonUtil.modifyDOMElement(me.rootCanvas, null, null, null, null, null, null, me.options.opacity);
         if (me._map !== null) {
+            /**
+             * @event L.supermap.heatMapLayer#changelayer
+             * @description 图层透明度更新成功之后触发。
+             * @property {L.supermap.heatMapLayer} layer - 图层。
+             * @property {string} property - 改变的图层属性。
+             */
             me._map.fire("changelayer", {layer: me, property: "opacity"});
         }
     },

dist/leaflet/iclient9-leaflet.js

@@ -16,6 +16,7 @@ import Attributions from '../core/Attributions'
  * @param {Object} options - 参数。
  * @param {string} [options.attributionPrefix] - 版权信息前缀。
  * @param {string} [options.attribution='© 2017 百度 MapV'] - 版权信息。
+ * @fires L.supermap.mapVLayer#loaded
  */
 export var MapVLayer = L.Layer.extend({
 
@@ -54,6 +55,10 @@ export var MapVLayer = L.Layer.extend({
         container.style.height = size.y + "px";
         this.renderer = new MapVRenderer(map, this, this.dataSet, this.mapVOptions);
         this.draw();
+        /**
+         * @event L.supermap.mapVLayer#loaded
+         * @description 图层添加完成之后触发。
+         */
         this.fire("loaded");
     },
 

dist/leaflet/iclient9-leaflet.min.js

@@ -20,6 +20,7 @@ import '../core/Base';
  * @param {string} [options.fontFamily='sans-serif'] - 符号的字体。
  * @param {string} [options.textAlign='center'] - 符号内容的对齐方式。
  * @param {string} [options.textBaseline='middle'] - 绘制符号时使用的基线。
+ * @fires L.supermap.unicodeMarker#move
  */
 export var UnicodeMarker = L.Path.extend({
     // @section
@@ -42,16 +43,27 @@ export var UnicodeMarker = L.Path.extend({
         this._latlng = latlng;
     },
 
-    // @method setLatLng(latLng: LatLng): this
-    // Sets the position of a circle marker to a new location.
+    /**
+     * @function L.supermap.unicodeMarker.prototype.setLatLng
+     * @description 设置 marker 新坐标。
+     * @param {L.LatLng} setLatLng - 需要设置的新坐标。
+     */
     setLatLng: function (latlng) {
         this._latlng = latlng;
         this.redraw();
+        /**
+         * @event L.supermap.unicodeMarker#move
+         * @description circle marker 重设坐标之后触发。
+         * @property {L.LatLng} latlng - 当前 marker 坐标。
+         */
         return this.fire('move', {latlng: this._latlng});
     },
 
-    // @method getLatLng(): LatLng
-    // Returns the current geographical position of the circle marker
+    /**
+     * @function L.supermap.unicodeMarker.prototype.getLatLng
+     * @description 获取 marker 坐标。
+     * @returns {L.LatLng} 返回当前 marker 坐标。
+     */
     getLatLng: function () {
         return this._latlng;
     },

src/common/widgets/templates/NavTabsPage.js

@@ -31,6 +31,7 @@ import {CommontypesConversion} from '../../core/CommontypesConversion';
  *                                        禁止对专题要素使用数据（feature）的 style。
  *                                        此属性可强制将数据 feature 的 style 中有效属性应用到专题要素上，且拥有比图层 style 和 styleGroups 更高的优先级，使专题要素
  *                                        的样式脱离专题图层的控制。可以通过此方式实现对特殊数据（feature） 对应专题要素赋予独立 style。
+ * @fires L.supermap.GeoFeatureThemeLayer#beforefeaturesadded
  */
 export var GeoFeatureThemeLayer = ThemeLayer.extend({
 
@@ -71,6 +72,12 @@ export var GeoFeatureThemeLayer = ThemeLayer.extend({
      */
     addFeatures: function (features) {
         var me = this;
+
+        /**
+         * @event L.supermap.GeoFeatureThemeLayer#beforefeaturesadded
+         * @description 向专题图图层中添加数据之前触发。
+         * @property {(SuperMap.ServerFeature|L.supermap.themeFeature|GeoJSONObject)} features - 事件对象。
+         */
         me.fire("beforefeaturesadded", {features: features});
 
         //转换 features 形式