优化API

Author: songyumeng

build/jsdocs/template/config.json

@@ -338,11 +338,18 @@
         "name": "互联网地图",
         "name_en": "ThirdPartyMap"
     },
-
     "BaseTypes": {
         "name": "基础类",
         "name_en": "BaseTypes",
         "content": {
+            "Namespace": {
+                "name": "命名空间",
+                "name_en": "Namespace"
+            },
+            "Util": {
+                "name": "工具",
+                "name_en": "Util"
+            },
             "Geometry": {
                 "name": "几何要素",
                 "name_en": "Geometry"

build/jsdocs/template/tmpl/navigation.tmpl

@@ -72,9 +72,6 @@ function buildLi(obj){
      <li class="item" data-name="<?js= obj.longname ?>">
             <span class="title">
                 <?js= self.linkto(obj.longname, obj.longname) ?>
-                <?js if (obj.type === 'namespace') { ?>
-                <span class="static">s</span>
-                <?js } ?>
             </span>
             <ul class="members itemMembers">
             <?js

examples/js/common.js

@@ -12,7 +12,17 @@
             onLoadCallBack(); //设置标题栏当前语言
             callback && callback();
         });
-        bindEvents();
+        $('.icl-header').on('click', '.lang-option', function () {
+            var value = $(this).data('lang');
+            utils.setLanguage(value);
+            $('#lang').html($(this).html());
+            i18next.changeLanguage(value);
+            if (window.isSite) {
+                localize();
+                return;
+            }
+            window.location.reload();
+        });
     }
 
     function onLoadCallBack() {
@@ -60,21 +70,6 @@
         });
     }
 
-
-    function bindEvents() {
-        $('.icl-header').on('click', '.lang-option', function () {
-            var value = $(this).data('lang');
-            utils.setLanguage(value);
-            $('#lang').html($(this).html());
-            i18next.changeLanguage(value);
-            if (window.isSite) {
-                localize();
-                return;
-            }
-            window.location.reload();
-        });
-    }
-
     function localize() {
         var lang = utils.getLanguage();
         var pathname = window.location.pathname.replace("/en/", "/");

src/common/commontypes/BaseTypes.js

@@ -1,6 +1,7 @@
 import {SuperMap} from '../SuperMap';
 /**
  *@namespace SuperMap
+ *@category BaseTypes Namespace
  */
 
 /**
@@ -73,8 +74,9 @@ SuperMap.mixin = function (...mixins) {
 
 /**
  * @name String
- * @memberOf SuperMap
  * @namespace
+ * @memberOf SuperMap
+ * @category BaseTypes Util
  * @description 字符串操作的一系列常用扩展函数。
  */
 export var StringExt = SuperMap.String = {
@@ -255,6 +257,7 @@ export var StringExt = SuperMap.String = {
  * @name Number
  * @memberOf SuperMap
  * @namespace
+ * @category BaseTypes Util
  * @description 数值操作的一系列常用扩展函数。
  */
 export var NumberExt = SuperMap.Number = {
@@ -353,6 +356,7 @@ if (!Number.prototype.limitSigDigs) {
  * @name Function
  * @memberOf SuperMap
  * @namespace
+ * @category BaseTypes Util
  * @description 函数操作的一系列常用扩展函数。
  */
 export var FunctionExt = SuperMap.Function = {
@@ -425,6 +429,7 @@ export var FunctionExt = SuperMap.Function = {
  * @name Array
  * @memberOf SuperMap
  * @namespace
+ * @category BaseTypes Util
  * @description 数组操作的一系列常用扩展函数。
  */
 export var ArrayExt = SuperMap.Array = {

src/common/commontypes/Bounds.js

@@ -6,6 +6,7 @@ import {Util} from './Util';
 
 /**
  * @class SuperMap.Bounds
+ * @category BaseTypes Geometry
  * @classdesc 表示边界类实例。使用 bounds 之前需要设置 left，bottom，right，top 四个属性，这些属性的初始值为 null。
  * @param {number} [left] - 左边界，注意考虑宽度，理论上小于 right 值。
  * @param {number} [bottom] - 下边界。考虑高度，理论上小于 top 值。

src/common/commontypes/Credential.js

@@ -2,6 +2,7 @@
 
 /**
  * @class SuperMap.Credential
+ * @category Security
  * @classdesc SuperMap 的安全证书类，其中包括 token 等安全验证信息。</br>
  * 需要使用用户名和密码在："http://localhost:8090/iserver/services/security/tokens" 下申请 value。</br>
  * 获得形如："2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ.." 的 value。</br>

src/common/commontypes/Date.js

@@ -4,6 +4,7 @@
  * @name Date
  * @memberOf SuperMap
  * @namespace
+ * @category BaseTypes Util
  * @description 包含 parse、toISOString 方法的实现，两个方法用来解析 RFC 3339 日期，遵循 ECMAScript 5 规范。
  */
 export var DateExt = SuperMap.Date = {

src/common/commontypes/Feature.js

@@ -3,6 +3,7 @@ import {Util} from './Util';
 
 /**
  * @class SuperMap.Feature
+ * @category BaseTypes Geometry
  * @classdesc 要素类组合了地理和属性，Feature 类同时具有 marker 和 lonlat 属性。
  * @param {SuperMap.Layer} layer - 图层。
  * @param {SuperMap.LonLat} lonlat - 经纬度。

src/common/commontypes/Geometry.js

@@ -5,6 +5,7 @@ import {Util} from './Util';
 
 /**
  * @class SuperMap.Geometry
+ * @category BaseTypes Geometry
  * @classdesc 几何对象类，描述地理对象的几何图形。
  */
 export class Geometry {

src/common/commontypes/LonLat.js

@@ -2,6 +2,7 @@
 
 /**
  * @class SuperMap.LonLat
+ * @category BaseTypes Geometry
  * @classdesc  这个类用来表示经度和纬度对。
  * @param {number} [lon=0.0] - 地图单位上的 X 轴坐标，如果地图是地理投影，则此值是经度，否则，此值是地图地理位置的 x 坐标。
  * @param {number} [lat=0.0] - 地图单位上的 Y 轴坐标，如果地图是地理投影，则此值是纬度，否则，此值是地图地理位置的 y 坐标。