【API】API增加version标识 review by zhurch

songyumeng · songyumeng · commit a0d557593c5c · 2018-12-06T19:03:52.000+08:00
diff --git a/src/common/widgets/chart/ChartView.js b/src/common/widgets/chart/ChartView.js
@@ -6,8 +6,9 @@ import echarts from "echarts";
 import { ChartViewModel } from "./ChartViewModel";
 
 /**
- * @class SuperMap.Widgets.ChartView
+ * @class SuperMap.Widgets.Chart
  * @classdesc 图表微件
+ * @version 9.1.1
  * @param {string} domID - 图表dom元素ID。
  * @param {Object} options - 可选参数。
  * @param {string} options.type - 图表类型。
@@ -32,7 +33,7 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.onAdd
+     * @function SuperMap.Widgets.Chart.prototype.onAdd
      * @description 创建图表之后成功回调
      * @param {function} addChart - 回调函数
      */
@@ -41,7 +42,7 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype._fillDataToView
+     * @function SuperMap.Widgets.Chart.prototype._fillDataToView
      * @description 填充数据到 view。
      * @private
      */
@@ -51,23 +52,23 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.getStyle
+     * @function SuperMap.Widgets.Chart.prototype.getStyle
      * @description 获取图表样式。
      */
     getStyle() {
         return this.viewModel.getStyle()
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.getFeatures
+     * @function SuperMap.Widgets.Chart.prototype.getFeatures
      * @description 获取地图服务，数据服务请求返回的数据。
      */
     getFeatures() {
         return this.viewModel.getFeatures();
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.setStyle
+     * @function SuperMap.Widgets.Chart.prototype.setStyle
      * @description 设置图表样式。
      * @param {Object} style - 图表样式 参考Echarts-options样式设置
      */
@@ -77,7 +78,7 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.changeType
+     * @function SuperMap.Widgets.Chart.prototype.changeType
      * @description 改变图表类型
      * @param {string} type - 图表类型
      */
@@ -88,7 +89,7 @@ export class ChartView {
     }
     
     /**
-     * @function SuperMap.Widgets.ChartView.prototype.updateData
+     * @function SuperMap.Widgets.Chart.prototype.updateData
      * @description 更新图表数据
      * @param {string} url - 数据源地址
      * @param {Object} queryInfo - 查询条件
@@ -105,7 +106,7 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype._createChart
+     * @function SuperMap.Widgets.Chart.prototype._createChart
      * @description 创建图表
      * @private
      * @param {Object} data - 图表数据
@@ -124,7 +125,7 @@ export class ChartView {
     }
 
     /**
-     * @function SuperMap.Widgets.ChartView.prototype._updateChart
+     * @function SuperMap.Widgets.Chart.prototype._updateChart
      * @description 更新图表
      * @private
      * @param {Object} options - 图表参数
diff --git a/src/common/widgets/chart/ChartViewModel.js b/src/common/widgets/chart/ChartViewModel.js
@@ -7,6 +7,7 @@ import { ChartModel } from "./ChartModel";
 /**
  * @class SuperMap.Widgets.ChartViewModel
  * @classdesc 图表微件功能类
+ * @version 9.1.1
  * @param {Object} options - 可选参数。
  * @param {string} options.type - 图表类型。
  * @param {Object} options.datasets - 数据来源。
diff --git a/src/leaflet/widgets/WidgetsViewBase.js b/src/leaflet/widgets/WidgetsViewBase.js
@@ -7,6 +7,7 @@ import '../core/Base';
 /**
  * @class WidgetsViewBase
  * @classdesc lealfet 微件基类
+ * @version 9.1.1
  * @param {Object} options - 参数。
  * @param {string} [options.position='topright'] - 微件在底图中显示的位置，包括: 'topleft', 'topright', 'bottomleft' 和 'bottomright'，默认为'topright'。
  * @param {function} options.style - 设置图层点线面默认样式，点 样式返回 maker 或者 circleMaker;线和面返回 L.path 样式。
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationLayer.js b/src/leaflet/widgets/clientcomputation/ClientComputationLayer.js
@@ -8,6 +8,7 @@ import '../../core/Base';
 /**
  * @class L.supermap.widgets.clientComputationLayer
  * @classdesc 客户端计算图层对象。
+ * @version 9.1.1
  * @param {Object} layerObject -  图层对象。
  * @param {string} layerObject.layerName -  图层名。
  * @param {L.GeoJSON} layerObject.layer -  图层。
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationView.js b/src/leaflet/widgets/clientcomputation/ClientComputationView.js
@@ -9,6 +9,7 @@ import {CommonContainer, DropDownBox, Select, MessageBox, Lang} from '@supermap/
 /**
  * @class L.supermap.widgets.clientComputation
  * @classdesc 客户端计算微件，用于进行叠加图层的客户端计算。
+ * @version 9.1.1
  * @param {string} workerUrl - worker 地址，原始位置为 dist/leaflet/workers/TurfWorker.js。
  * @param {Object} options - 可选参数。
  * @param {function} options.style - 设置图层点线面默认样式，点 样式返回 maker 或者 circleMaker;线和面返回 L.path 样式。
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js b/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js
@@ -11,6 +11,7 @@ import {AttributesPopContainer} from '@supermap/iclient-common';
 /**
  * @class L.supermap.widgets.clientComputationViewModel
  * @classdesc 客户端计算微件功能类。
+ * @version 9.1.1
  * @category Widgets ClientComputation
  * @param {string} workerUrl - worker 地址，原始位置为 dist/leaflet/workers/TurfWorker.js。
  * @fires L.supermap.widgets.clientComputationViewModel#analysisfailed
diff --git a/src/leaflet/widgets/dataflow/DataFlowView.js b/src/leaflet/widgets/dataflow/DataFlowView.js
@@ -9,6 +9,7 @@ import {DataFlowViewModel} from './DataFlowViewModel';
 /**
  * @class L.supermap.widgets.dataFlow
  * @classdesc 数据流微件。
+ * @version 9.1.1
  * @category Widgets DataFlow
  * @param {Object} options - 可选参数
  * @param {string} [options.position="topright"] - 控件所在位置，包括 'topleft', 'topright', 'bottomleft' or 'bottomright'
diff --git a/src/leaflet/widgets/dataflow/DataFlowViewModel.js b/src/leaflet/widgets/dataflow/DataFlowViewModel.js
@@ -9,6 +9,7 @@ import {CommontypesConversion} from '../../core/CommontypesConversion';
 /**
  * @class L.supermap.widgets.dataFlowViewModel
  * @classdesc 数据流微件功能类。
+ * @version 9.1.1
  * @category Widgets DataFlow
  * @param {L.Map} map - 当前微件所在的底图
  * @param {Object} [dataFlowLayerOptions] - 数据流服务返回数据数据展示样式，默认采用 ViewModel 默认样式。
diff --git a/src/leaflet/widgets/dataservicequery/DataServiceQueryView.js b/src/leaflet/widgets/dataservicequery/DataServiceQueryView.js
@@ -19,6 +19,7 @@ import {
 /**
  * @class L.supermap.widgets.dataServiceQuery
  * @classdesc 数据服务查询微件。
+ * @version 9.1.1
  * @param {string} dataServiceUrl - 数据服务地址。
  * @param {(Array.<string>|string)} dataSetNames - 配置查询方式和查询的数据集数组。格式：" 数据源名：数据集名 "，例："World: Countries"。
  * @param {Object.<Array>} options - 可选参数。
diff --git a/src/leaflet/widgets/dataservicequery/DataServiceQueryViewModel.js b/src/leaflet/widgets/dataservicequery/DataServiceQueryViewModel.js
@@ -9,6 +9,7 @@ import { GetFeaturesByIDsParameters, GetFeaturesBySQLParameters, GetFeaturesByBo
 /**
  * @class L.supermap.widgets.dataServiceQueryViewModel
  * @classdesc 数据服务查询微件功能类。
+ * @version 9.1.1
  * @category Widgets DataServiceQuery
  * @param {string} dataserviceUrl - 数据服务地址。
  * @fires L.supermap.widgets.dataServiceQueryViewModel#getfeaturesfaild
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js
@@ -9,6 +9,7 @@ import { CommonContainer, DropDownBox, Select, MessageBox, Lang, KernelDensityJo
 /**
  * @class L.supermap.widgets.distributedAnalysis
  * @classdesc 分布式分析微件。
+ * @version 9.1.1
  * @param {string} processingUrl - 分布式分析服务地址。
  * @param {Object} options - 可选参数。
  * @param {function} options.style - 设置图层点线面默认样式，点 样式返回 maker 或者 circleMaker;线和面返回 L.path 样式。
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js
@@ -9,6 +9,7 @@ import { ProcessingService } from '../../services/ProcessingService'
 /**
  * @class L.supermap.widgets.distributedAnalysisViewModel
  * @classdesc 分布式分析微件功能类。
+ * @version 9.1.1
  * @category Widgets DistributedAnalysis
  * @param {string} processingUrl - 分布式分析地址。
  * @fires L.supermap.widgets.distributedAnalysisViewModel#datasetsloaded
diff --git a/src/leaflet/widgets/openfile/OpenFileView.js b/src/leaflet/widgets/openfile/OpenFileView.js
@@ -9,6 +9,7 @@ import {MessageBox, Lang} from '@supermap/iclient-common';
 /**
  * @class L.supermap.widgets.openFile
  * @classdesc 打开文件微件，用于打开本地数据文件并加载到底图
+ * @version 9.1.1
  * @category Widgets OpenFile
  * @fires L.supermap.widgets.openFile#openfilesuccess
  */
diff --git a/src/leaflet/widgets/openfile/OpenFileViewModel.js b/src/leaflet/widgets/openfile/OpenFileViewModel.js
@@ -13,6 +13,7 @@ import {
 /**
  * @class L.supermap.widgets.openFileViewModel
  * @classdesc 打开本地文件微件功能类。
+ * @version 9.1.1
  * @category Widgets OpenFile
  * @param {L.Map} map - leaflet map 对象。
  * @fires L.supermap.widgets.openFileViewModel#filesizeexceed
diff --git a/src/leaflet/widgets/search/SearchView.js b/src/leaflet/widgets/search/SearchView.js
@@ -25,6 +25,7 @@ import {
  * @class L.supermap.widgets.search
  * @classdesc 图层查询微件。
  * @category Widgets Search
+ * @version 9.1.1
  * @param {Object} options - 可选参数。
  * @param {string} [options.position='topright'] - 控件位置，继承自 leaflet control。
  * @param {string} [options.addressUrl] - 配置地址匹配服务。
diff --git a/src/leaflet/widgets/search/SearchViewModel.js b/src/leaflet/widgets/search/SearchViewModel.js
@@ -16,6 +16,7 @@ import {
 /**
  * @class L.supermap.widgets.searchViewModel
  * @classdesc 图层查询微件功能类。
+ * @version 9.1.1
  * @category Widgets Search
  * @param {Object} options - 可选参
  * @param {Object} [options.cityGeoCodingConfig] - 城市地址匹配服务配置，包括：{addressUrl:"",key:""} 默认为 online 地址匹配服务，与 options.cityConfig 对应。
diff --git a/src/openlayers/overlay/vectortile/MapboxStyles.js b/src/openlayers/overlay/vectortile/MapboxStyles.js
@@ -174,6 +174,7 @@ export class MapboxStyles extends ol.Observable {
     }
     /**
      * @function ol.supermap.MapboxStyles.prototype.setStyle
+     * @version 9.1.1
      * @description 设置 Mapbox style 对象。
      * @param {Object} style - Mapbox style 对象。
      */
