Skip to content

Commit 7faae9c

Browse files
Wenxinyu1998Wenxinyu1998
committed
[fix]文档注释修改 src：component control iportal review by jinny
1 parent 95db34a commit 7faae9c

15 files changed

+89
-89
lines changed

‎src/common/components/chart/ChartViewModel.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Events } from '../../commontypes/Events';
88
* @class ChartViewModel
99
* @aliasclass Components.ChartViewModel
1010
* @deprecatedclass SuperMap.Components.ChartViewModel
11-
* @classdesc 图表组件功能类
11+
* @classdesc 图表组件功能类。
1212
* @category Components Chart
1313
* @version 10.0.0
1414
* @param {Object} options - 可选参数。

‎src/common/components/util/FileReaderUtil.js

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ export let FileReaderUtil = {
3636
rAT: typeof FileReader !== 'undefined' && FileReader.prototype && FileReader.prototype.readAsText,
3737
/**
3838
* @function FileReaderUtil.prototype.readFile
39-
* @description 读取文件
40-
* @param {string} fileType - 当前读取的文件类型
39+
* @description 读取文件。
40+
* @param {string} fileType - 当前读取的文件类型。
4141
*
42-
* @param {Object} file - 读取回来的文件内容对象
43-
* @param {function} success - 读取文件成功回调函数
44-
* @param {function} failed - 读取文件失败回调函数
45-
* @param {Object} context - 回调重定向对象
42+
* @param {Object} file - 读取回来的文件内容对象。
43+
* @param {function} success - 读取文件成功回调函数。
44+
* @param {function} failed - 读取文件失败回调函数。
45+
* @param {Object} context - 回调重定向对象。
4646
*/
4747
readFile(fileType, file, success, failed, context) {
4848
if (FileTypes.JSON === fileType || FileTypes.GEOJSON === fileType) {
@@ -53,11 +53,11 @@ export let FileReaderUtil = {
5353
},
5454

5555
/**
56-
* @description 读取文本文件
57-
* @param {Object} file 文件内容对象
58-
* @param {function} success 读取文件成功回调函数
59-
* @param {function} failed 读取文件失败回调函数
60-
* @param {Object} context - 回调重定向对象
56+
* @description 读取文本文件。
57+
* @param {Object} file 文件内容对象。
58+
* @param {function} success 读取文件成功回调函数。
59+
* @param {function} failed 读取文件失败回调函数。
60+
* @param {Object} context - 回调重定向对象。
6161
*/
6262
readTextFile(file, success, failed, context) {
6363
let reader = new FileReader();
@@ -71,11 +71,11 @@ export let FileReaderUtil = {
7171
},
7272

7373
/**
74-
* @description 读取excel或csv文件
75-
* @param {Object} file 文件内容对象
76-
* @param {function} success 读取文件成功回调函数
77-
* @param {function} failed 读取文件失败回调函数
78-
* @param {Object} context - 回调重定向对象
74+
* @description 读取excel或csv文件。
75+
* @param {Object} file 文件内容对象。
76+
* @param {function} success 读取文件成功回调函数。
77+
* @param {function} failed 读取文件失败回调函数。
78+
* @param {Object} context - 回调重定向对象。
7979
*/
8080
readXLSXFile(file, success, failed, context) {
8181
let reader = new FileReader();
@@ -101,13 +101,13 @@ export let FileReaderUtil = {
101101

102102
/**
103103
* @function FileReaderUtil.prototype.processDataToGeoJson
104-
* @description 将读取回来得数据统一处理为 GeoJSON 格式
105-
* @param {string} type - 文件类型
106-
* @param {Object} data - 读取返回的数据对象
107-
* @param {function} success - 数据处理成功的回调
108-
* @param {function} failed - 数据处理失败的回调
109-
* @param {Object} context - 回调重定向对象
110-
* @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据
104+
* @description 将读取回来得数据统一处理为 GeoJSON 格式。
105+
* @param {string} type - 文件类型。
106+
* @param {Object} data - 读取返回的数据对象。
107+
* @param {function} success - 数据处理成功的回调。
108+
* @param {function} failed - 数据处理失败的回调。
109+
* @param {Object} context - 回调重定向对象。
110+
* @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据。
111111
* @private
112112
*/
113113
processDataToGeoJson(type, data, success, failed, context) {
@@ -137,9 +137,9 @@ export let FileReaderUtil = {
137137
},
138138
/**
139139
* @function FileReaderUtil.prototype.processExcelDataToGeoJson
140-
* @description 表格文件数据处理
141-
* @param {Object} data - 读取的表格文件数据
142-
* @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据
140+
* @description 表格文件数据处理。
141+
* @param {Object} data - 读取的表格文件数据。
142+
* @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据。
143143
* @private
144144
*/
145145
processExcelDataToGeoJson(data) {
@@ -187,8 +187,8 @@ export let FileReaderUtil = {
187187
return features;
188188
},
189189
/**
190-
* @description 判断是否地理X坐标
191-
* @param {string} data 字段名
190+
* @description 判断是否地理X坐标。
191+
* @param {string} data 字段名。
192192
*/
193193
isXField(data) {
194194
var lowerdata = data.toLowerCase();
@@ -198,8 +198,8 @@ export let FileReaderUtil = {
198198
},
199199

200200
/**
201-
* @description 判断是否地理Y坐标
202-
* @param {string} data 字段名
201+
* @description 判断是否地理Y坐标。
202+
* @param {string} data 字段名。
203203
*/
204204
isYField(data) {
205205
var lowerdata = data.toLowerCase();
@@ -208,9 +208,9 @@ export let FileReaderUtil = {
208208
lowerdata === "latitude" || lowerdata === "lat" || lowerdata === "y坐标");
209209
},
210210
/**
211-
* @description 字符串转为dataEditor 支持的csv格式数据
212-
* @param {string} string 待转化的字符串
213-
* @param {boolean} withoutTitle 是否需要列标题
211+
* @description 字符串转为dataEditor 支持的csv格式数据。
212+
* @param {string} string 待转化的字符串。
213+
* @param {boolean} withoutTitle 是否需要列标题。
214214
*/
215215
string2Csv(string, withoutTitle) {
216216
// let rows = string.split('\r\n');

‎src/common/control/TimeControlBase.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {Events} from '../commontypes/Events';
66
/**
77
* @class TimeControlBase
88
* @deprecatedclass SuperMap.TimeControlBase
9-
* @classdesc 时间控制基类类。
9+
* @classdesc 时间控制基类。
1010
* @category Control
1111
* @param {Object} options - 可选参数。
1212
* @param {number} [options.speed=1] - 速度。不能小于 0，（每帧渲染的数据之间的间隔为1），设置越大速度越快。
@@ -28,7 +28,7 @@ export class TimeControlBase {
2828

2929
/**
3030
* @member {number} [TimeControlBase.prototype.speed=1]
31-
* @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）
31+
* @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）。
3232
*/
3333
this.speed = (options.speed && options.speed >= 0) ? options.speed : 1;
3434

@@ -41,14 +41,14 @@ export class TimeControlBase {
4141
/**
4242
* @member {number} [TimeControlBase.prototype.startTime=0]
4343
* @description 记录的起始时间，必须为数字，
44-
* 如果不设置，初始化时为0，建议设置
44+
* 如果不设置，初始化时为0，建议设置。
4545
*/
4646
this.startTime = (options.startTime && options.startTime != null) ? options.startTime : 0;
4747

4848
/**
4949
* @member {number} TimeControlBase.prototype.endTime
5050
* @description 记录的结束时间，必须为数字，
51-
* 如果不设置，初始化时以当前时间进行设置，建议设置
51+
* 如果不设置，初始化时以当前时间进行设置，建议设置。
5252
*/
5353
this.endTime = (options.endTime && options.endTime != null && options.endTime >= me.startTime) ? options.endTime : +new Date();
5454

@@ -116,7 +116,7 @@ export class TimeControlBase {
116116
/**
117117
* @function TimeControlBase.prototype.updateOptions
118118
* @description 更新参数。
119-
* @param {Object} options - 设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
119+
* @param {Object} options - 设置参数的可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
120120
*/
121121
updateOptions(options) {
122122
//设置步长，刷新频率、开始结束时间、是否循环、是否反向
@@ -228,7 +228,7 @@ export class TimeControlBase {
228228
/**
229229
* @function TimeControlBase.prototype.getSpeed
230230
* @description 获取步长。
231-
* @returns {number} 返回当前的步长
231+
* @returns {number} 返回当前的步长。
232232
*/
233233
getSpeed() {
234234
return this.speed;

‎src/common/control/TimeFlowControl.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {TimeControlBase} from './TimeControlBase';
99
* @category Control
1010
* @classdesc 时间管理类。此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。
1111
* 如设置起始时间为 1000，结束时间是 2000，步长设置为 1，
12-
* 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会 1 次（通过 setFrequency 修改）
12+
* 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会变化 1 次（通过 setFrequency 修改）
1313
* @extends {TimeControlBase}
1414
* @param {function} callback - 每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
1515
* @param {Object} options - 可选参数。

‎src/common/format/WKT.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ export class WKT extends Format {
280280

281281
/**
282282
* @function WKTFormat.prototype.read
283-
* @description 反序列化 WKT 字符串并返回向量特征或向量特征数组。 支持 POINT、MULTIPOINT、LINESTRING、MULTILINESTRING、POLYGON、MULTIPOLYGON 和 GEOMETRYCOLLECTION 的 WKT。
283+
* @description 反序列化 WKT 字符串并返回向量特征或向量特征数组。支持 POINT、MULTIPOINT、LINESTRING、MULTILINESTRING、POLYGON、MULTIPOLYGON 和 GEOMETRYCOLLECTION 的 WKT。
284284
* @param {string} wkt - WKT 字符串。
285285
* @returns {FeatureVector|Array} GEOMETRYCOLLECTION WKT 的矢量要素或者矢量要素数组。
286286
*/

‎src/common/iPortal/iPortalAddDataParam.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
* @version 10.0.1
1212
* @category iPortal/Online Resources Data
1313
* @param {Object} params - 参数。
14-
* @param {string} params.fileName - 文件名称
14+
* @param {string} params.fileName - 文件名称。
1515
* @param {DataItemType} params.type - 数据类型。
16-
* @param {Array} [params.tags] - 数据的标签
17-
* @param {IPortalDataMetaInfoParam} [params.dataMetaInfo] - 数据元信息
16+
* @param {Array} [params.tags] - 数据的标签。
17+
* @param {IPortalDataMetaInfoParam} [params.dataMetaInfo] - 数据元信息。
1818
* @usage
1919
*/
2020
export class IPortalAddDataParam {

‎src/common/iPortal/iPortalAddResourceParam.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* @param {Object} params - 可选参数。
1414
* @param {string} [params.rootUrl] - 服务地址。
1515
* @param {Array} [params.tags] - 标签。
16-
* @param {IPortalShareEntity} [params.entities] - 资源的实体共享参数
16+
* @param {IPortalShareEntity} [params.entities] - 资源的实体共享参数。
1717
* @usage
1818
*/
1919
export class IPortalAddResourceParam {

‎src/common/iPortal/iPortalDataMetaInfoParam.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
* @version 10.0.1
1212
* @category iPortal/Online Resources Data
1313
* @param {Object} params - 参数。
14-
* @param {string} params.xField - X 坐标字段
15-
* @param {string} params.yField - Y 坐标字段
16-
* @param {number} params.xIndex - x所在列（关系型存储下CSV或EXCEL数据时必填）
17-
* @param {number} params.yIndex - y所在列（关系型存储下CSV或EXCEL数据时必填）
14+
* @param {string} params.xField - X 坐标字段。
15+
* @param {string} params.yField - Y 坐标字段。
16+
* @param {number} params.xIndex - x所在列（关系型存储下CSV或EXCEL数据时必填）。
17+
* @param {number} params.yIndex - y所在列（关系型存储下CSV或EXCEL数据时必填）。
1818
* @param {Array.<string>} [params.fieldTypes] - 设置字段类型（关系型存储下CSV或EXCEL数据时可选填）。默认类型为：WTEXT。该参数按照CSV文件字段顺序从左到右依次设置，其中默认字段类型可省略不设置。例如，CSV文件中有10个字段，如果只需设定第1，2，4个字段，可设置为['a','b',,'c']。
19-
* @param {string} params.separator - 分隔符（关系型存储下CSV数据时必填）
20-
* @param {boolean} params.firstRowIsHead - 是否带表头（关系型存储下CSV数据时必填）
21-
* @param {boolean} params.url - HDFS注册目录地址
22-
* @param {IPortalDataStoreInfoParam} params.dataStoreInfo - 注册数据时的数据存储信息
19+
* @param {string} params.separator - 分隔符（关系型存储下CSV数据时必填）。
20+
* @param {boolean} params.firstRowIsHead - 是否带表头（关系型存储下CSV数据时必填）。
21+
* @param {boolean} params.url - HDFS注册目录地址。
22+
* @param {IPortalDataStoreInfoParam} params.dataStoreInfo - 注册数据时的数据存储信息。
2323
* @usage
2424
*/
2525
export class IPortalDataMetaInfoParam {

‎src/common/iPortal/iPortalDataStoreInfoParam.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
* @version 10.0.1
1212
* @category iPortal/Online Resources Data
1313
* @param {Object} params - 参数。
14-
* @param {string} params.type - 大数据文件共享类型和空间数据库类型，包括大数据文件共享HDFS 目录(HDFS)和空间数据库HBASE
15-
* @param {string} params.url - HDFS数据存储目录地址
16-
* @param {IPortalDataConnectionInfoParam} [params.connectionInfo] - HBASE空间数据库服务的连接信息
14+
* @param {string} params.type - 大数据文件共享类型和空间数据库类型，包括大数据文件共享HDFS 目录(HDFS)和空间数据库HBASE。
15+
* @param {string} params.url - HDFS数据存储目录地址。
16+
* @param {IPortalDataConnectionInfoParam} [params.connectionInfo] - HBASE空间数据库服务的连接信息。
1717
* @usage
1818
*/
1919
export class IPortalDataStoreInfoParam {

‎src/common/iPortal/iPortalQueryParam.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ import {Util} from '../commontypes/Util';
1111
* @version 10.0.1
1212
* @category iPortal/Online Resources ResourcesQuery
1313
* @param {Object} params - 可选参数。
14-
* @param {ResourceType} [params.resourceType] - 资源类型
14+
* @param {ResourceType} [params.resourceType] - 资源类型。
1515
* @param {number} [params.pageSize] - 分页中每页大小。
1616
* @param {number} [params.currentPage] - 分页页码。
1717
* @param {OrderBy} [params.orderBy] - 排序字段。
1818
* @param {OrderType} [params.orderType] - 根据升序还是降序过滤。
1919
* @param {SearchType} [params.searchType] - 根据查询的范围进行过滤。
2020
* @param {Array} [params.tags] - 标签。
21-
* @param {Array} [params.dirIds] - 目录 id
21+
* @param {Array} [params.dirIds] - 目录 ID。
2222
* @param {Array} [params.resourceSubTypes] - 根据资源的子类型进行过滤。
2323
* @param {AggregationTypes} [params.aggregationTypes] - 聚合查询的类型。
2424
* @param {string} [params.text] - 搜索的关键词。

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy