【API】优化微件API

songyumeng · songyumeng · commit 717dd6121bfb · 2018-09-25T00:20:52.000+08:00
diff --git a/build/jsdocs/classic/docs.json b/build/jsdocs/classic/docs.json
@@ -21,7 +21,7 @@
             "src/common/iServer/GeoCodingParameter.js","src/common/iServer/GeoDecodingParameter.js"
         ],
         "exclude": [
-            "src/classic/libs","src/classic/theme","src/classic/resource","src/common/overlay/levelRenderer"
+            "src/classic/libs","src/classic/theme","src/classic/resource","src/common/overlay/levelRenderer","src/common/widgets"
         ]
     },
     "plugins": ["plugins/markdown"],
diff --git a/build/jsdocs/mapboxgl/docs.json b/build/jsdocs/mapboxgl/docs.json
@@ -22,7 +22,7 @@
             "src/common","src/mapboxgl"
         ],
         "exclude": [
-            "src/common/overlay/levelRenderer"
+            "src/common/overlay/levelRenderer","src/common/widgets"
         ]
     },
     "plugins": ["plugins/markdown"],
diff --git a/build/jsdocs/openlayers/docs.json b/build/jsdocs/openlayers/docs.json
@@ -22,7 +22,7 @@
             "src/common","src/openlayers"
         ],
         "exclude": [
-            "src/common/overlay/levelRenderer"
+            "src/common/overlay/levelRenderer","src/common/widgets"
         ]
     },
     "plugins": ["plugins/markdown"],
diff --git a/build/jsdocs/template/config.json b/build/jsdocs/template/config.json
@@ -329,7 +329,33 @@
     },
     "Widgets": {
         "name": "微件",
-        "name_en": "Widgets"
+        "name_en": "Widgets",
+        "content": {
+            "Common": {
+                "name": "通用",
+                "name_en": "Common"
+            },
+            "OpenFile": {
+                "name": "打开文件微件",
+                "name_en": "OpenFile"
+            },
+            "DataFlow": {
+                "name": "数据流微件",
+                "name_en": "DataFlow"
+            },
+            "ClientComputation": {
+                "name": "客户端计算微件",
+                "name_en": "ClientComputation"
+            },
+            "DistributedAnalysis": {
+                "name": "分布式分析微件",
+                "name_en": "DistributedAnalysis"
+            },
+            "POISearch": {
+                "name": "地址匹配或图层要素查询微件",
+                "name_en": "POISearch"
+            }
+        }
     },
     "Security": {
         "name": "安全",
diff --git a/src/common/widgets/messagebox/MessageBox.js b/src/common/widgets/messagebox/MessageBox.js
@@ -6,7 +6,7 @@ import {SuperMap} from '../../SuperMap';
 /**
  * @class SuperMap.Widgets.MessageBox
  * @classdesc MessageBox 微件，信息框提示
- * @category Widgets
+ * @category Widgets Common
  */
 export class MessageBox {
 
diff --git a/src/common/widgets/openfile/FileModel.js b/src/common/widgets/openfile/FileModel.js
@@ -6,6 +6,8 @@ import {FileTypes, FileConfig} from '../CommonTypes'
 /**
  * @class SuperMap.FileModel
  * @description 文件数据微件数据模型，用于存储一些文件数据或状态，todo 结构待完善
+ * @category Widgets OpenFile
+ * @private
  */
 export class FileModel {
     constructor(options) {
diff --git a/src/common/widgets/templates/CityTabsPage.js b/src/common/widgets/templates/CityTabsPage.js
@@ -8,6 +8,7 @@ import {Util} from '../../commontypes/Util';
 /**
  * @class SuperMap.Widgets.CityTabsPage
  * @classdesc 城市地址匹配组件模板
+ * @category Widgets Common
  * @param {Object|Array.<string>} config - 城市名称配置列表，支持两种格式：{key1:{A:[],B:[]}, key2:{C:[],D:[]}} 或
  *                               ["成都市","北京市"]，用户可根据自己的项目需求进行配置
  */
diff --git a/src/common/widgets/templates/NavTabsPage.js b/src/common/widgets/templates/NavTabsPage.js
@@ -1,9 +1,11 @@
 /* Copyright© 2000 - 2018 SuperMap Software Co.Ltd. All rights reserved.
  * This program are made available under the terms of the Apache License, Version 2.0
  * which accompanies this distribution and is available at http://www.apache.org/licenses/LICENSE-2.0.html.*/
-/**
- * @class NavTabsPage
+ import {SuperMap} from '../../SuperMap';
+ /**
+ * @class SuperMap.Widgets.NavTabsPage
  * @classdesc 标签页面组件
+ * @category Widgets Common
  * @param {Array.<Object>} [tabs=[]] - 标签对象数组 [{title: "",content: HTMLElement}],初始时，传入则创建页面。
  * todo 思考拆分的控件应该以哪种方式使用
  */
@@ -135,4 +137,5 @@ export class NavTabsPage {
         }
     }
 
-}
+}
+SuperMap.Widgets.NavTabsPage = NavTabsPage;
diff --git a/src/common/widgets/templates/PaginationContainer.js b/src/common/widgets/templates/PaginationContainer.js
@@ -7,6 +7,7 @@ import {SuperMap} from '../../SuperMap';
 /**
  * @class SuperMap.Widgets.PaginationContainer
  * @classdesc 分页组件模板
+ * @category Widgets Common
  */
 export class PaginationContainer {
     constructor(contents = null, pageCounts = 0) {
diff --git a/src/common/widgets/templates/WidgetContainer.js b/src/common/widgets/templates/WidgetContainer.js
@@ -9,7 +9,7 @@ import {SuperMap} from '../../SuperMap';
  * @classdesc 微件统一外框。
  * @param {string} title - 标题。
  * @param {Object} position - 设置外框绝对位置，包括上下左右：{"top":"5px","bottom":"5px","left":"5px","right":"5px"}
- * @category Widgets
+ * @category Widgets Common
  */
 export class WidgetContainer {
     constructor(title, position = null) {
diff --git a/src/common/widgets/templates/WidgetDropDownBox.js b/src/common/widgets/templates/WidgetDropDownBox.js
@@ -13,7 +13,7 @@ import { SuperMap } from '../../SuperMap';
  * @param {string} [optionsArr.dataValue] - 下拉框 attribute 名为 data-value 的值 。
  * @param {string} [optionsArr.icon.className] - 下拉框图标类名。
  * @param {string} [optionsArr.icon.background] - 下拉框图标背景 url。
- * @category Widgets
+ * @category Widgets Common
  */
 export class WidgetDropDownBox {
     constructor(optionsArr) {
diff --git a/src/common/widgets/templates/WidgetSelect.js b/src/common/widgets/templates/WidgetSelect.js
@@ -10,7 +10,7 @@ import { SuperMap } from '../../SuperMap';
  * @param {string} [options.labelName] - label 名称。
  * @param {Array.<string>} options.optionsArr - 需要创建的 option 数据数组。
  * @param {Function} [options.optionsClickCb] - option 点击事件回调函数。
- * @category Widgets
+ * @category Widgets Common
  */
 export class WidgetSelect {
     constructor(options) {
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationLayer.js b/src/leaflet/widgets/clientcomputation/ClientComputationLayer.js
@@ -12,7 +12,7 @@ import '../../core/Base';
  * @param {string} layerObject.layerName -  图层名。
  * @param {L.GeoJSON} layerObject.layer -  图层。
  * @param {Array.<string>} [layerObject.fields] - 字段数组。
- * @category Widgets
+ * @category Widgets ClientComputationLayer
  */
 export class ClientComputationLayer{
     constructor(layerObject){
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationView.js b/src/leaflet/widgets/clientcomputation/ClientComputationView.js
@@ -10,7 +10,7 @@ import { WidgetContainer, WidgetDropDownBox, WidgetSelect, MessageBox, Lang } fr
  * @class L.supermap.widgets.clientComputation
  * @classdesc 客户端计算微件，用于进行叠加图层的客户端计算。
  * @param {string} workerUrl - worker 地址，原始位置为 dist/leaflet/workers/TurfWorker.js。
- * @category Widgets
+ * @category Widgets ClientComputationLayer
  */
 export var ClientComputationView = L.Control.extend({
 
@@ -29,6 +29,7 @@ export var ClientComputationView = L.Control.extend({
     /**
      * @function L.supermap.widgets.clientComputation.prototype.onAdd
      * @description 添加控件。
+     * @private
      */
     onAdd: function (map) {
         this.map = map;
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js b/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js
@@ -10,7 +10,8 @@ import { AttributesPopContainer } from '@supermap/iclient-common';
 /**
  * @class L.supermap.widgets.ClientComputationViewModel
  * @classdesc 客户端计算 ViewModel。
- * @category Widgets
+ * @private
+ * @category Widgets ClientComputationLayer
  * @param {string} workerUrl - worker 地址，原始位置为 dist/leaflet/workers/TurfWorker.js。
  * @fires L.supermap.widgets.ClientComputationViewModel#analysisfailed
  * @fires L.supermap.widgets.ClientComputationViewModel#layerloaded
diff --git a/src/leaflet/widgets/commonmodels/GeoJsonLayersModel.js b/src/leaflet/widgets/commonmodels/GeoJsonLayersModel.js
@@ -10,7 +10,7 @@ import '../../core/Base';
 /**
  * @class L.supermap.widgets.GeoJsonLayersDataModel
  * @description 多图层数据模型
- * @category Widgets
+ * @category Widgets Common
  * @param {Array.<Object>} layers - 图层数组。
  * @param {L.supermap.widgets.GeoJSONLayersWithName} layers.layerObject - 含有 layerName 与 GeoJSON 图层的对象。 
  */
diff --git a/src/leaflet/widgets/commonmodels/GeoJsonLayersWithName.js b/src/leaflet/widgets/commonmodels/GeoJsonLayersWithName.js
@@ -11,7 +11,7 @@ import '../../core/Base';
  * @param {Object} layerObject - 图层对象。
  * @param {string} layerObject.layerName -  图层名。
  * @param {L.GeoJSON} layerObject.layer -  图层。
- * @category Widgets
+ * @category Widgets Common
  */
 export class GeoJSONLayersWithName {
     constructor(layerObject) {
diff --git a/src/leaflet/widgets/dataflow/DataFlowView.js b/src/leaflet/widgets/dataflow/DataFlowView.js
@@ -7,9 +7,10 @@ import { MessageBox, WidgetContainer, Lang } from '@supermap/iclient-common';
 import { DataFlowViewModel } from './DataFlowViewModel';
 
 /**
- * @class L.supermap.widgets.DataFlowView
- * @classdesc dataFlow 微件，用于打开本地数据文件并加载到底图
- * @category Widgets
+ * @class L.supermap.widgets.dataFlow
+ * @classdesc 数据流微件。
+ * @category Widgets DataFlow
+ * @param {Object} options - 可选参数
  * @param {string} [options.position="topright"] - 控件所在位置，包括 'topleft', 'topright', 'bottomleft' or 'bottomright'
  * @param {Function} [options.pointToLayer] - 定义点要素如何绘制在地图上。
  `function(geoJsonPoint, latlng) {
@@ -62,6 +63,7 @@ export var DataFlowView = L.Control.extend({
     /**
      * @function L.supermap.widgets.DataFlowView.prototype.onAdd
      * @description 向底图添加微件
+     * @private
      */
     onAdd(map) {
         this.map = map;
diff --git a/src/leaflet/widgets/dataflow/DataFlowViewModel.js b/src/leaflet/widgets/dataflow/DataFlowViewModel.js
@@ -9,7 +9,8 @@ import {CommontypesConversion} from '../../core/CommontypesConversion';
 /**
  * @class L.supermap.widgets.dataFlowViewModel
  * @classdesc 打开本地文件微件 ViewModel，用于管理一些业务逻辑
- * @category Widgets
+ * @category Widgets DataFlow
+ * @private
  * @param {L.Map} map - 当前微件所在的底图
  * @param {Object} [dataFlowLayerOptions] - 数据流服务返回数据数据展示样式，默认采用 ViewModel 默认样式。
  * @param {Function} [options.pointToLayer] - 定义点要素如何绘制在地图上。
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisModel.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisModel.js
@@ -8,7 +8,8 @@ import { FetchRequest } from '@supermap/iclient-common';
 /**
  * @class L.supermap.widgets.DistributedAnalysisModel
  * @classdesc 分布式分析微件数据模型。
- * @category Widgets
+ * @private
+ * @category Widgets DistributedAnalysis
  * @param {string} processingUrl - 分布式分析地址。
  * @fires L.supermap.widgets.DistributedAnalysisModel#datasetsloaded
  * @fires L.supermap.widgets.DistributedAnalysisModel#datasetinfoloaded
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js
@@ -10,7 +10,7 @@ import { WidgetContainer, WidgetDropDownBox, WidgetSelect, MessageBox, Lang } fr
  * @class L.supermap.widgets.distributedAnalysis
  * @classdesc 分布式分析微件。
  * @param {string} processingUrl - 分布式分析服务地址。
- * @category Widgets
+ * @category Widgets DistributedAnalysis
  */
 export var DistributedAnalysisView = L.Control.extend({
 
@@ -26,6 +26,7 @@ export var DistributedAnalysisView = L.Control.extend({
     /**
      * @function L.supermap.widgets.distributedAnalysis.prototype.onAdd
      * @description 添加控件。
+     * @private
      */
     onAdd: function (map) {
         this.map = map;
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js
@@ -9,7 +9,8 @@ import { ProcessingService } from '../../services/ProcessingService'
 /**
  * @class L.supermap.widgets.DistributedAnalysisViewModel
  * @classdesc 分布式分析 ViewModel。
- * @category Widgets
+ * @category Widgets DistributedAnalysis
+ * @private
  * @param {string} processingUrl - 分布式分析地址。
  * @fires L.supermap.widgets.DistributedAnalysisViewModel#datasetsloaded
  * @fires L.supermap.widgets.DistributedAnalysisViewModel#datasetinfoloaded
diff --git a/src/leaflet/widgets/openfile/OpenFileView.js b/src/leaflet/widgets/openfile/OpenFileView.js
@@ -8,8 +8,8 @@ import {MessageBox, Lang} from '@supermap/iclient-common';
 
 /**
  * @class L.supermap.widgets.openFile
- * @classdesc openfile 微件，用于打开本地数据文件并加载到底图
- * @category Widgets
+ * @classdesc 打开文件微件，用于打开本地数据文件并加载到底图
+ * @category Widgets OpenFile
  */
 export var OpenFileView = L.Control.extend({
     options: {
@@ -19,8 +19,9 @@ export var OpenFileView = L.Control.extend({
         position: 'topright'
     },
     /**
-     * @function L.supermap.widgets.openfile.prototype.onAdd
+     * @function L.supermap.widgets.openFile.prototype.onAdd
      * @description 向底图添加微件
+     * @private
      */
     onAdd: function (map) {
         this.map = map;
@@ -32,7 +33,7 @@ export var OpenFileView = L.Control.extend({
     },
 
     /**
-     * @function L.supermap.widgets.openfile.prototype.onAdd
+     * @function L.supermap.widgets.openFile.prototype.setViewStyle
      * @description 改变微件样式
      * @param {string} styleName - css样式名
      * @param {string} value - css样式值
@@ -42,7 +43,7 @@ export var OpenFileView = L.Control.extend({
     },
 
     /**
-     * @function L.supermap.widgets.openfile.prototype._initOpenFileView
+     * @function L.supermap.widgets.openFile.prototype._initOpenFileView
      * @description 创建打开本地文件数据微件
      * @returns {HTMLElement}
      * @private
diff --git a/src/leaflet/widgets/openfile/OpenFileViewModel.js b/src/leaflet/widgets/openfile/OpenFileViewModel.js
@@ -12,7 +12,8 @@ import {
 /**
  * @class L.supermap.widgets.OpenFileViewModel
  * @classdesc 打开本地文件微件 ViewModel，用于管理一些业务逻辑
- * @category Widgets
+ * @category Widgets OpenFile
+ * @private
  */
 export var OpenFileViewModel = L.Evented.extend({
     initialize(map) {
diff --git a/src/leaflet/widgets/poisearch/POISearchView.js b/src/leaflet/widgets/poisearch/POISearchView.js
diff --git a/src/leaflet/widgets/poisearch/POISearchViewModel.js b/src/leaflet/widgets/poisearch/POISearchViewModel.js

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`"src/common/iServer/GeoCodingParameter.js","src/common/iServer/GeoDecodingParameter.js"`
`22`	`22`	`],`
`23`	`23`	`"exclude": [`
`24`		`- "src/classic/libs","src/classic/theme","src/classic/resource","src/common/overlay/levelRenderer"`
	`24`	`+ "src/classic/libs","src/classic/theme","src/classic/resource","src/common/overlay/levelRenderer","src/common/widgets"`
`25`	`25`	`]`
`26`	`26`	`},`
`27`	`27`	`"plugins": ["plugins/markdown"],`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`"src/common","src/mapboxgl"`
`23`	`23`	`],`
`24`	`24`	`"exclude": [`
`25`		`- "src/common/overlay/levelRenderer"`
	`25`	`+ "src/common/overlay/levelRenderer","src/common/widgets"`
`26`	`26`	`]`
`27`	`27`	`},`
`28`	`28`	`"plugins": ["plugins/markdown"],`