优化API

songyumeng · songyumeng · commit 484b2857fb94 · 2018-08-01T14:56:49.000+08:00
diff --git a/build/jsdocs/template/config.json b/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"
diff --git a/build/jsdocs/template/tmpl/navigation.tmpl b/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
diff --git a/examples/js/common.js b/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/", "/");
diff --git a/src/common/commontypes/BaseTypes.js b/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 = {
diff --git a/src/common/commontypes/Bounds.js b/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 值。
diff --git a/src/common/commontypes/Credential.js b/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>
diff --git a/src/common/commontypes/Date.js b/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 = {
diff --git a/src/common/commontypes/Feature.js b/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 - 经纬度。
diff --git a/src/common/commontypes/Geometry.js b/src/common/commontypes/Geometry.js
@@ -5,6 +5,7 @@ import {Util} from './Util';
 
 /**
  * @class SuperMap.Geometry
+ * @category BaseTypes Geometry
  * @classdesc 几何对象类，描述地理对象的几何图形。
  */
 export class Geometry {
diff --git a/src/common/commontypes/LonLat.js b/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 坐标。
diff --git a/src/common/commontypes/Pixel.js b/src/common/commontypes/Pixel.js
@@ -2,6 +2,7 @@
 
 /**
  * @class SuperMap.Pixel
+ * @category BaseTypes Geometry
  * @classdesc 此类用 x,y 坐标描绘屏幕坐标（像素点）。
  * @param {number} [x=0.0] - x 坐标。
  * @param {number} [y=0.0] - y 坐标。
diff --git a/src/common/commontypes/Size.js b/src/common/commontypes/Size.js
@@ -2,6 +2,7 @@
 
 /**
  * @class  SuperMap.Size
+ * @category BaseTypes Style
  * @classdesc 此类描绘一对高宽值的实例。
  * @param {number} [w=0.0] - 宽度。
  * @param {number} [h=0.0] - 高度。
diff --git a/src/common/commontypes/Util.js b/src/common/commontypes/Util.js
@@ -6,6 +6,7 @@ export var Util = SuperMap.Util = SuperMap.Util || {};
  * @name Util
  * @memberOf SuperMap
  * @namespace
+ * @category BaseTypes Util
  * @description common 工具类。
  */
 
diff --git a/src/common/commontypes/Vector.js b/src/common/commontypes/Vector.js
@@ -6,6 +6,7 @@ import {Util} from './Util';
 
 /**
  * @class SuperMap.Feature.Vector
+ * @category BaseTypes Geometry
  * @classdesc 矢量要素类。该类具有 Geometry 属性存放几何信息，
  * attributes 属性存放非几何信息，另外还包含了 style 属性，用来定义矢量要素的样式，
  * 其中，默认的样式在 {@link SuperMap.Feature.Vector.style} 类中定义，如果没有特别的指定将使用默认的样式。
diff --git a/src/leaflet/core/Base.js b/src/leaflet/core/Base.js
@@ -1,8 +1,10 @@
 /**
  * @namespace L
+ * @category BaseTypes Namespace
  */
 /**
  * @namespace L.supermap
+ * @category BaseTypes Namespace
  */
 /**
  * SuperMap Leaflet基类
diff --git a/src/leaflet/core/CommontypesConversion.js b/src/leaflet/core/CommontypesConversion.js
@@ -4,6 +4,8 @@ import {Bounds} from '@supermap/iclient-common';
 
 /**
  * @class L.supermap.CommontypesConversion
+ * @category BaseTypes Util
+ * @namespace
  * @classdesc Leaflet 对象和 SuperMap 对象转换工具。
  */
 export class CommontypesConversion {
diff --git a/src/leaflet/core/Detector.js b/src/leaflet/core/Detector.js
@@ -1,6 +1,4 @@
-/**
- * 检测类，用于检测浏览器是否支持相关特性
- */
+
 export class Detector {
     static supportWebGL() {
         return getContext('webgl');
diff --git a/src/leaflet/core/Util.js b/src/leaflet/core/Util.js
@@ -1,6 +1,9 @@
 import L from "leaflet";
 import {GeoJSON as GeoJSONFormat, Unit} from '@supermap/iclient-common';
-
+/**
+ * @namespace L.Util
+ * @category BaseTypes Util
+ */
 export var supermap_callbacks = {};
 L.Util.supermap_callbacks = supermap_callbacks;
 export var toGeoJSON = function (feature) {
diff --git a/src/leaflet/overlay/HeatMapLayer.js b/src/leaflet/overlay/HeatMapLayer.js
@@ -564,6 +564,7 @@ L.supermap.heatMapLayer = heatMapLayer;
 
 /**
  * @class L.supermap.heatMapFeature
+ * @category Visualization HeatMap
  * @classdesc 客户端专题图要素类。
  *            支持的 geometry 参数类型为 {@link L.Point}、{@link L.LatLng}、{@link L.CircleMarker}。
  * @extends {L.Class}
diff --git a/src/mapboxgl/core/Base.js b/src/mapboxgl/core/Base.js
@@ -4,9 +4,11 @@
  */
 /**
  * @namespace mapboxgl
+ * @category BaseTypes Namespace
  */
 /**
  * @namespace mapboxgl.supermap
+ * @category BaseTypes Namespace
  */
 import mapboxgl from 'mapbox-gl';
 import './MapExtend';
diff --git a/src/mapboxgl/core/Util.js b/src/mapboxgl/core/Util.js
@@ -4,6 +4,7 @@ import {Bounds, GeometryPoint, GeoJSON as GeoJSONFormat} from '@supermap/iclient
 
 /**
  * @class mapboxgl.supermap.Util
+ * @category BaseTypes Util
  * @classdesc 工具类。
  */
 export class Util {
diff --git a/src/mapboxgl/overlay/mapv/MapExtend.js b/src/mapboxgl/overlay/mapv/MapExtend.js
@@ -3,10 +3,6 @@ import mapboxgl from 'mapbox-gl';
 mapboxgl.supermap = mapboxgl.supermap || {};
 mapboxgl.supermap.map = mapboxgl.supermap.map || {};
 
-/**
- * @class mapboxgl.supermap.map.getDefaultVectorTileStyle
- * @description 配置默认底图样式。
- */
 export var getDefaultVectorTileStyle = function (urlTemplate, options) {
     options = options || {};
     var defaultOptions = {};
@@ -38,11 +34,6 @@ export var getDefaultVectorTileStyle = function (urlTemplate, options) {
     }
     return style;
 };
-
-/**
- * @class mapboxgl.supermap.map.setBackground
- * @description 设置地图背景。
- */
 export var setBackground = function (map, color) {
     if (color && map) {
         map.addLayer({
@@ -55,16 +46,6 @@ export var setBackground = function (map, color) {
     }
 };
 
-/**
- * @class mapboxgl.supermap.map.setPaintProperty
- * @description 设置图层风格。
- * @param {mapboxgl.Map} map - 当前 Mapbox GL map 对象。
- * @param {string} [layerIds] - 图层 Id。
- * @param {String} [type] - 图层类型。
- * @param {Object} [paint] - 图层的样式。
- * @param {Object} [source=vector-tiles] - 源。
- * @param {Object} [sourceLayers]- 源图层，默认与 id 对应。
- */
 export var setPaintProperty = function (map, layerIds, type, paint, source, sourceLayers) {
     if (layerIds && map) {
         if (Object.prototype.toString.call(layerIds) !== '[object Array]') {
diff --git a/src/mapboxgl/overlay/theme/GeoFeatureThemeLayer.js b/src/mapboxgl/overlay/theme/GeoFeatureThemeLayer.js
@@ -5,6 +5,7 @@ import {Theme} from './ThemeLayer';
 
 /**
  * @class mapboxgl.supermap.GeoFeatureThemeLayer
+ * @category Visualization Theme
  * @classdesc 地理几何专题要素型专题图层。
  * @param {string} name - 图层名。
  * @param {Object} opt_options - 参数。
diff --git a/src/mapboxgl/overlay/theme/ThemeLayer.js b/src/mapboxgl/overlay/theme/ThemeLayer.js
@@ -14,6 +14,7 @@ import {
 
 /**
  * @class mapboxgl.supermap.ThemeLayer
+ * @category Visualization Theme
  * @classdesc 专题图基类。
  * @param {string} name - 专题图图层名。
  * @param {Object} options -可选参数。
diff --git a/src/openlayers/core/Util.js b/src/openlayers/core/Util.js
@@ -5,6 +5,7 @@ ol.supermap = ol.supermap || {};
 
 /**
  * @class ol.supermap.Util
+ * @category BaseTypes Util
  * @classdesc 工具类。
  */
 export class Util {
diff --git a/src/openlayers/overlay/theme/GeoFeature.js b/src/openlayers/overlay/theme/GeoFeature.js
@@ -4,6 +4,7 @@ import {Theme} from './Theme';
 
 /**
  * @class ol.source.GeoFeature
+ * @category Visualization Theme
  * @classdesc 地理几何专题要素型专题图层基类。
  * @param {string} name - 图层名称。
  * @param {Object} opt_options - 参数。
diff --git a/src/openlayers/overlay/theme/Theme.js b/src/openlayers/overlay/theme/Theme.js
@@ -14,6 +14,7 @@ import {ThemeFeature} from './ThemeFeature';
 
 /**
  * @class ol.source.Theme
+ * @category Visualization Theme
  * @classdesc 专题图基类。
  * @param {string} name - 专题图图层名称。
  * @param {Object} opt_option - 参数。
diff --git a/src/openlayers/overlay/theme/ThemeFeature.js b/src/openlayers/overlay/theme/ThemeFeature.js
@@ -9,6 +9,7 @@ ol.supermap = ol.supermap || {};
 
 /**
  * @class ol.supermap.ThemeFeature
+ * @category Visualization Theme
  * @classdesc 专题图要素类。
  * @param {Object} geometry - 要量算的几何对象，支持 {@link ol.geom.Geometry} 和 GeoText 标签数组类型 geometry = [x,y,text]。
  * @param {Object} [attributes] - 属性。
diff --git a/src/openlayers/services/ServiceBase.js b/src/openlayers/services/ServiceBase.js
@@ -1,12 +1,15 @@
 ﻿import ol from 'openlayers';
 /**
  * @namespace ol
+ * @category BaseTypes Namespace
  */
 /**
  * @namespace ol.supermap
+ * @category BaseTypes Namespace
  */
 /**
  * @namespace ol.source
+ * @category BaseTypes Namespace
  */
 ol.supermap = ol.supermap || {};
 
