[fix]修改api review by xiongjj

luoxiao-supermap · luoxiao-supermap · commit a66b9ac08739 · 2022-03-09T14:44:46.000+08:00
diff --git a/build/jsdocs/classic/docs.json b/build/jsdocs/classic/docs.json
@@ -40,8 +40,13 @@
       "src/common/iServer/DatasourceConnectionInfo.js",
       "src/common/iServer/SetDatasourceParameters.js",
       "src/common/commontypes/Bounds.js",
+      "src/common/commontypes/Size.js",
+      "src/common/commontypes/geometry/Point.js",
+      "src/common/commontypes/Geometry.js",
       "src/common/commontypes/LonLat.js",
       "src/common/commontypes/Pixel.js",
+      "src/common/commontypes/Events.js",
+      "src/common/commontypes/Event.js",
       "src/common/REST.js"
     ],
     "exclude": [
diff --git a/build/jsdocs/leaflet/docs.json b/build/jsdocs/leaflet/docs.json
@@ -24,7 +24,54 @@
         ],
         "exclude": [
             "src/common/overlay/levelRenderer",
-            "src/common/lang/locales"
+            "src/common/lang/locales",
+            "src/common/iPortal/iPortalQueryResult",
+            "src/common/iManager/iManagerServiceBase",
+            "src/common/online/OnlineServiceBase",
+            "src/common/online/OnlineData",
+            "src/common/iServer/GetFeaturesServiceBase",
+            "src/common/iServer/NetworkAnalystServiceBase",
+            "src/common/iServer/SpatialAnalystBase",
+            "src/common/iServer/ProcessingServiceBase",
+            "src/common/iServer/PointWithMeasure",
+            "src/common/iServer/ServerTheme",
+            "src/common/overlay/RankSymbol",
+            "src/common/overlay/ThemeVector",
+            "src/common/overlay/Graph",
+            "src/common/overlay/feature/ShapeFactory",
+            "src/common/overlay/feature/ShapeParameters",
+            "src/common/overlay/feature/Rectangle",
+            "src/common/overlay/feature/Circle",
+            "src/common/overlay/feature/Image",
+            "src/common/overlay/feature/Label",
+            "src/common/overlay/feature/Line",
+            "src/common/overlay/feature/Point",
+            "src/common/overlay/feature/Polygon",
+            "src/common/overlay/feature/Sector",
+            "src/common/commontypes/Credential",
+            "src/common/components/chart/ChartViewModel",
+            "src/common/components/util/Util",
+            "src/common/components/templates/AttributesPopContainer",
+            "src/common/components/templates/CityTabsPage",
+            "src/common/components/templates/CommonContainer",
+            "src/common/components/templates/DropDownBox",
+            "src/common/components/templates/NavTabsPage",
+            "src/common/components/templates/IndexTabsPageContainer",
+            "src/common/components/templates/PaginationContainer",
+            "src/common/components/templates/PopContainer",
+            "src/common/components/templates/Select",
+            "src/common/security/KeyServiceParameter",
+
+            "src/leaflet/components/clientcomputation/ClientComputationViewModel",
+            "src/leaflet/components/dataflow/DataFlowViewModel",
+            "src/leaflet/overlay/dataflow/MapvRenderer",
+            "src/leaflet/overlay/dataflow/NormalRenderer",
+            "src/leaflet/components/search/SearchViewModel",
+            "src/leaflet/components/dataservicequery/DataServiceQueryViewModel",
+            "src/leaflet/components/distributedanalysis/DistributedAnalysisViewModel",
+            "src/leaflet/components/openfile/OpenFileViewModel",
+            "src/leaflet/components/commonmodels/GeoJsonLayersModel" ,
+            "src/leaflet/core/CommontypesConversion"
         ]
 
     },
diff --git a/build/jsdocs/template/typeLinkExt.js b/build/jsdocs/template/typeLinkExt.js
@@ -26,6 +26,7 @@ var typeLinks = {
     "ol.style.Fill": olapi + "module-ol_style_Fill-Fill.html",
     "ol.style.Stroke": olapi + "module-ol_style_Stroke-Stroke.html",
     "ol.style.RegularShape": olapi + "module-ol_style_RegularShape.html",
+    "ol.style.Style": olapi + "module-ol_style_Style-Style.html",
     "ol.Object": olapi + "module-ol_Object-BaseObject.html",
     "ol.source.ImageCanvas": olapi + "module-ol_source_ImageCanvas-ImageCanvasSource.html",
     "ol.source.TileImage": olapi + "module-ol_source_TileImage-TileImage.html",
@@ -101,8 +102,10 @@ var typeLinks = {
     "JSONObject": webApi + 'JavaScript/Reference/Global_Objects/JSON',
     "CanvasRenderingContext2D": webApi + 'API/CanvasRenderingContext2D',
     "HTMLElement": webApi + 'API/HTMLElement',
+    "HTMLVideoElement": webApi + 'API/HTMLVideoElement',
     "HTMLCanvasElement": webApi + 'API/HTMLCanvasElement',
     "HTMLImageElement": webApi + 'API/HTMLImageElement',
+    "ImageData": webApi + 'API/ImageData',
     "CanvasGradient": webApi + 'API/CanvasGradient',
 
     // THREE
@@ -113,6 +116,9 @@ var typeLinks = {
     "THREE.WebGLRenderer": threeApi + '#api/renderers/WebGLRenderer',
     "THREE.Material": threeApi + '#api/en/materials/Material',
     "THREE.Mesh": threeApi + '#api/objects/Mesh',
-    "THREE.Shape": threeApi + '#api/extras/core/Shape'
+    "THREE.Shape": threeApi + '#api/extras/core/Shape',
+
+    // TF
+    'tf.GraphModel': 'https://js.tensorflow.org/api/latest/#class:GraphModel'
 }
 exports.typeLinks = typeLinks;
diff --git a/src/classic/overlay/MapVLayer.js b/src/classic/overlay/MapVLayer.js
@@ -37,7 +37,7 @@ export class MapVLayer extends SuperMap.Layer {
         this.supported = false;
 
         /**
-         * @member {Canvas} SuperMap.Layer.MapVLayer.prototype.canvas
+         * @member {HTMLCanvasElement} SuperMap.Layer.MapVLayer.prototype.canvas
          * @description MapV 图主绘制面板。
          */
         this.canvas = null;
diff --git a/src/common/format/GeoJSON.js b/src/common/format/GeoJSON.js
@@ -345,7 +345,7 @@ export class GeoJSON extends JSONFormat {
             /**
              * @function GeoJSONFormat.extract.multilinestring
              * @description 从一个多线对象中返回一个线数组。
-             * @param {MultiLinestring} multilinestring - 多线对象。
+             * @param {GeometryMultiLineString} multilinestring - 多线对象。
              *
              * @returns {Array} 一个表示多线的线数组。
              */
diff --git a/src/common/iServer/ChartQueryParameters.js b/src/common/iServer/ChartQueryParameters.js
@@ -13,7 +13,7 @@ import {ChartQueryFilterParameter} from './ChartQueryFilterParameter';
  * @param {Object} options - 参数。
  * @param {string} options.queryMode - 海图查询模式类型，支持两种查询方式：海图属性查询（"ChartAttributeQuery"）和海图空间查询（"ChartBoundsQuery"）。
  * @param {Array.<string>} options.chartLayerNames - 查询的海图图层的名称。
- * @param {Array.<{ChartQueryFilterParameter}>} options.chartQueryFilterParameters - 海图查询过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。
+ * @param {Array.<ChartQueryFilterParameter>} options.chartQueryFilterParameters - 海图查询过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。
  * @param {(Bounds|L.Bounds|ol.extent)} [options.bounds] - 海图查询范围。当进行海图范围查询时，此参数为必选。
  * @param {boolean} [options.returnContent=true] - 获取或设置是返回查询结果记录集 recordsets，还是返回查询结果的资源 resourceInfo。
  * @param {number} [options.startRecord=0] - 查询起始记录位置。
diff --git a/src/common/iServer/DataFlowService.js b/src/common/iServer/DataFlowService.js
@@ -100,7 +100,7 @@ export class DataFlowService extends CommonServiceBase {
     /**
      * @function DataFlowService.prototype.initSubscribe
      * @description 初始化订阅数据
-     * @returns {this} this
+     * @returns {DataFlowService} DataFlowService的实例对象。
      */
     initSubscribe() {
         var me = this;
@@ -125,7 +125,7 @@ export class DataFlowService extends CommonServiceBase {
      * @function DataFlowService.prototype.setExcludeField
      * @description 设置排除字段
      * @param {Object} excludeField - 排除字段
-     * @returns {this} this
+     * @returns {DataFlowService} DataFlowService的实例对象。
      */
     setExcludeField(excludeField) {
         this.excludeField = excludeField;
@@ -137,7 +137,7 @@ export class DataFlowService extends CommonServiceBase {
      * @function DataFlowService.prototype.setGeometry
      * @description 设置添加的几何要素数据
      * @param {GeoJSONObject} geometry - 指定几何范围，该范围内的要素才能被订阅。
-     * @returns {this} this
+     * @returns {DataFlowService} DataFlowService的实例对象。
      */
     setGeometry(geometry) {
         this.geometry = geometry;
diff --git a/src/common/iServer/GeoprocessingService.js b/src/common/iServer/GeoprocessingService.js
@@ -79,7 +79,7 @@ export class GeoprocessingService extends CommonServiceBase {
      * @param {string} identifier - 处理自动化工具ID。
      * @param {Object} options - 状态信息参数。
      * @param {number} options.interval - 定时器时间间隔。
-     * @param {Callback} options.statusCallback - 任务状态的回调函数。
+     * @param {function} options.statusCallback - 任务状态的回调函数。
      */
     waitForJobCompletion(jobId, identifier, options) {
         const me = this;
diff --git a/src/common/iServer/InterpolationAnalystParameters.js b/src/common/iServer/InterpolationAnalystParameters.js
@@ -4,7 +4,6 @@
 import {
     Util
 } from '../commontypes/Util';
-import './ClipParameter';
 
 /**
  * @class InterpolationAnalystParameters
@@ -118,7 +117,7 @@ export class InterpolationAnalystParameters {
         this.InterpolationAnalystType = "dataset";
 
         /**
-         * @member {Object} InterpolationAnalystParameters.prototype.clipParam
+         * @member {ClipParameter} InterpolationAnalystParameters.prototype.clipParam
          * @description 对插值分析结果进行裁剪的参数。
          */
         this.clipParam = null;
diff --git a/src/common/iServer/InterpolationAnalystService.js b/src/common/iServer/InterpolationAnalystService.js
@@ -63,7 +63,7 @@ export class InterpolationAnalystService extends SpatialAnalystBase {
     /**
      * @function InterpolationAnalystService.prototype.processAsync
      * @description 负责将客户端的查询参数传递到服务端。
-     * @param {InterpolationAnalystParameters} parameter - 插值分析参数类。
+     * @param {InterpolationDensityAnalystParameters|InterpolationIDWAnalystParameters|InterpolationRBFAnalystParameters|InterpolationKrigingAnalystParameters} parameter - 插值分析参数类。
      */
     processAsync(parameter) {
         var parameterObject = {};
diff --git a/src/common/iServer/ThiessenAnalystService.js b/src/common/iServer/ThiessenAnalystService.js
@@ -14,8 +14,8 @@ import {GeometryThiessenAnalystParameters} from './GeometryThiessenAnalystParame
  * 泰森多边形分析服务类
  * 该类负责将客户设置的泰森多边形分析参数传递给服务端，并接收服务端返回的分析结果数据。
  * 泰森多边形分析结果通过该类支持的事件的监听函数参数获取
- * 泰森多边形分析的参数支持两种，当参数为 {DatasetThiessenAnalystParameters} 类型
- * 时，执行数据集泰森多边形分析，当参数为 {GeometryThiessenAnalystParameters} 类型时，
+ * 泰森多边形分析的参数支持两种，当参数为 {@link DatasetThiessenAnalystParameters} 类型
+ * 时，执行数据集泰森多边形分析，当参数为 {@link GeometryThiessenAnalystParameters} 类型时，
  * 执行几何对象泰森多边形分析。
  * @param {string} url - 服务地址。如 http://localhost:8090/iserver/services/spatialanalyst-changchun/restjsr/spatialanalyst。
  * @param {Object} options - 参数。
@@ -61,7 +61,7 @@ export class ThiessenAnalystService extends SpatialAnalystBase {
     /**
      * @function ThiessenAnalystService.prototype.processAsync
      * @description 负责将客户端的查询参数传递到服务端。
-     * @param {(DatasetThiessenAnalystParameters|GeometryThiessenAnalystParameters)} parameter - 泰森多边形分析参数基类。
+     * @param {DatasetThiessenAnalystParameters|GeometryThiessenAnalystParameters} parameter - 泰森多边形分析参数基类。
      */
     processAsync(parameter) {
         var parameterObject = {};
diff --git a/src/common/online/OnlineData.js b/src/common/online/OnlineData.js
@@ -14,6 +14,7 @@ import {OnlineServiceBase} from './OnlineServiceBase';
  * @param {boolean} [options.crossOrigin] - 是否允许跨域请求。
  * @param {Object} [options.headers] - 请求头。
  * @usage
+ * @extends OnlineServiceBase
  */
 export class OnlineData extends OnlineServiceBase {
 
diff --git a/src/common/thirdparty/ai/MachineLearningBase.js b/src/common/thirdparty/ai/MachineLearningBase.js
@@ -41,7 +41,7 @@ export default class MachineLearningModelBase {
      * @function  MachineLearningBase.prototype._loadModel
      * @description 加载模型
      * @param {string} modelUrl - 模型地址。
-     * @returns {Promise<tf.GraphModel>}
+     * @returns {Promise.<tf.GraphModel>}
      */
 
     async _loadModel(modelUrl) {
diff --git a/src/leaflet/control/ChangeTileVersion.js b/src/leaflet/control/ChangeTileVersion.js
@@ -86,7 +86,7 @@ export var ChangeTileVersion = L.Control.extend({
      * @function ChangeTileVersion.prototype.setVersionName
      * @description  设置版本号。
      * @param {string} content - 版本信息。
-     * @returns {this} this
+     * @returns {ChangeTileVersion} ChangeTileVersion的实例对象。
      */
     setVersionName: function (content) {
         var value = content;
@@ -101,7 +101,7 @@ export var ChangeTileVersion = L.Control.extend({
      * @function ChangeTileVersion.prototype.setToolTip
      * @description 设置提示信息。
      * @param {(HTMLElement|string)} tooltip - 提示信息。
-     * @returns {this} this
+     * @returns {ChangeTileVersion} ChangeTileVersion的实例对象。
      */
     setToolTip: function (tooltip) {
         this.tooltip.innerHTML = tooltip;
@@ -177,7 +177,7 @@ export var ChangeTileVersion = L.Control.extend({
     /**
      * @function ChangeTileVersion.prototype.nextTilesVersion
      * @description 下一个版本，首次调用该函数默认为无版本。
-     * @returns {this} this
+     * @returns {ChangeTileVersion} ChangeTileVersion的实例对象。
      */
     nextTilesVersion: function () {
         if (this.firstLoad) {
diff --git a/src/leaflet/mapping/WebMap.js b/src/leaflet/mapping/WebMap.js
@@ -151,7 +151,7 @@ export var WebMap = L.LayerGroup.extend({
      * @param {L.Layer} layer - Leaflet Layer 对象。
      * @param {boolean} [isBaseLayer] - 是否为底图层。
      * @param {Object} options - 参数。
-     * @returns {this} this
+     * @returns {WebMap} WebMap的实例对象。
      */
     addLayerWrapper: function (layer, isBaseLayer, options) {
         if (isBaseLayer) {
diff --git a/src/leaflet/overlay/TiledVectorLayer.js b/src/leaflet/overlay/TiledVectorLayer.js
@@ -35,7 +35,7 @@
  * @param {boolean} [options.cacheEnabled=true] - 是否启用缓存。
  * @param {Object} [options.tileTemplate] - 瓦片模板，如果设置了此参数，则按此模板出图。默认出图方式为 URL 对接的第三方瓦片。
  * @param {string} [options.subdomains] - 子域名。
- * @param {num} [options.timeout=10000] - 延时。
+ * @param {number} [options.timeout=10000] - 延时。
  * @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>`] - 版权信息。
  * @usage
  */
diff --git a/src/leaflet/overlay/vectortile/VectorGrid.js b/src/leaflet/overlay/vectortile/VectorGrid.js
@@ -115,7 +115,7 @@ export var VectorGrid = L.GridLayer.extend({
      * @param {number} id - 要素 ID。
      * @param {string} layerName - 图层名称。
      * @param {(Array|function)} layerStyle - 图层样式。
-     * @returns {this} this
+     * @returns {VectorGrid} VectorGrid的实例对象。
      */
     setFeatureStyle: function (id, layerName, layerStyle) {
         var featureKey = this._getFeatureKey(id, layerName);
@@ -138,7 +138,7 @@ export var VectorGrid = L.GridLayer.extend({
      * @description 指定要素 ID 和图层名称重绘要素风格。
      * @param {number} id - 要素 ID。
      * @param {string} layerName - 图层名称。
-     * @returns {this} this
+     * @returns {VectorGrid} VectorGrid的实例对象。
      */
     resetFeatureStyle: function (id, layerName) {
         var featureKey = this._getFeatureKey(id, layerName);
diff --git a/src/leaflet/services/GeoprocessingService.js b/src/leaflet/services/GeoprocessingService.js
@@ -138,7 +138,7 @@ export const GeoprocessingService = ServiceBase.extend({
      * @param {Object} options - 参数。
      * @param {number} options.interval - 定时器时间间隔。
      * @param {RequestCallback} options.statusCallback - 任务状态的回调函数。
-     * @param {Callback} callback 回调函数。
+     * @param {function} callback 回调函数。
      */
     waitForJobCompletion: function (jobId, identifier, options, callback) {
         const geoprocessingJobsService = new CommonGeoprocessingService(this.url, {
diff --git a/src/leaflet/services/NetworkAnalyst3DService.js b/src/leaflet/services/NetworkAnalyst3DService.js
@@ -62,7 +62,7 @@ export var NetworkAnalyst3DService = ServiceBase.extend({
      * @description 源查找服务。
      * @param {FacilityAnalystSources3DParameters} params - 最近设施分析参数类（源查找资源）。
      * @param {RequestCallback} callback - 回调函数。
-     * @returns {this} this
+     * @returns {NetworkAnalyst3DService} NetworkAnalyst3DService的实例对象。
      */
     sourcesFacilityAnalyst: function (params, callback) {
         var me = this;
@@ -85,7 +85,7 @@ export var NetworkAnalyst3DService = ServiceBase.extend({
      * @description 上游追踪资源服务。
      * @param {FacilityAnalystTraceup3DParameters} params - 上游追踪资源参数类。
      * @param {RequestCallback} callback - 回调函数。
-     * @returns {this} this
+     * @returns {NetworkAnalyst3DService} NetworkAnalyst3DService的实例对象。
      */
     traceUpFacilityAnalyst: function (params, callback) {
         var me = this;
diff --git a/src/leaflet/services/SpatialAnalystService.js b/src/leaflet/services/SpatialAnalystService.js
@@ -173,7 +173,7 @@ export var SpatialAnalystService = ServiceBase.extend({
     /**
      * @function SpatialAnalystService.prototype.interpolationAnalysis
      * @description 插值分析。
-     * @param {InterpolationRBFAnalystParameters} params - 样条插值（径向基函数插值法）分析参数类。
+     * @param {InterpolationDensityAnalystParameters|InterpolationIDWAnalystParameters|InterpolationRBFAnalystParameters|InterpolationKrigingAnalystParameters} params - 样条插值（径向基函数插值法）分析参数类。
      * @param {RequestCallback} callback - 回调函数。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
      */
@@ -348,7 +348,7 @@ export var SpatialAnalystService = ServiceBase.extend({
     /**
      * @function SpatialAnalystService.prototype.thiessenAnalysis
      * @description 泰森多边形分析。
-     * @param {DatasetThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
+     * @param {DatasetThiessenAnalystParameters|GeometryThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
      * @param {RequestCallback} callback - 回调函数。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
      */
diff --git a/src/mapboxgl/overlay/ThreeLayer.js b/src/mapboxgl/overlay/ThreeLayer.js
diff --git a/src/mapboxgl/overlay/theme/Theme3DLayer.js b/src/mapboxgl/overlay/theme/Theme3DLayer.js
diff --git a/src/mapboxgl/services/GeoprocessingService.js b/src/mapboxgl/services/GeoprocessingService.js
diff --git a/src/mapboxgl/services/SpatialAnalystService.js b/src/mapboxgl/services/SpatialAnalystService.js
diff --git a/src/openlayers/control/ChangeTileVersion.js b/src/openlayers/control/ChangeTileVersion.js
diff --git a/src/openlayers/control/ScaleLine.js b/src/openlayers/control/ScaleLine.js
diff --git a/src/openlayers/overlay/Graphic.js b/src/openlayers/overlay/Graphic.js
diff --git a/src/openlayers/services/GeoprocessingService.js b/src/openlayers/services/GeoprocessingService.js

Original file line number	Diff line number	Diff line change
`@@ -345,7 +345,7 @@ export class GeoJSON extends JSONFormat {`
`345`	`345`	`/**`
`346`	`346`	`* @function GeoJSONFormat.extract.multilinestring`
`347`	`347`	`* @description 从一个多线对象中返回一个线数组。`
`348`		`- * @param {MultiLinestring} multilinestring - 多线对象。`
	`348`	`+ * @param {GeometryMultiLineString} multilinestring - 多线对象。`
`349`	`349`	`*`
`350`	`350`	`* @returns {Array} 一个表示多线的线数组。`
`351`	`351`	`*/`