Skip to content

Commit d4a29f0

Browse files
committed
【fix】 修复ColorsPickerUtil、ArrayStatistic的api 文档; review by luoxiao
1 parent b7c6e60 commit d4a29f0

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

src/common/util/ArrayStatistic.js

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
/**
2-
* @class ArrayStatistic
2+
* @name ArrayStatistic
3+
* @namespace
34
* @category BaseTypes Util
45
* @classdesc 处理数组。
56
* @usage
67
* ```
78
* // 浏览器
89
* <script type="text/javascript" src="{cdn}"></script>
910
* <script>
10-
* const arrayStatistic = {namespace}.ArrayStatistic();
11+
* const result = {namespace}.ArrayStatistic.newInstance();
12+
*
13+
* // 弃用的写法
14+
* const result = SuperMap.ArrayStatistic.newInstance();
1115
*
1216
* </script>
17+
*
1318
* // ES6 Import
1419
* import { ArrayStatistic } from '{npm}';
15-
*
16-
* new ArrayStatistic();
20+
*
21+
* const result = ArrayStatistic.newInstance();
1722
* ```
1823
*/
19-
export class ArrayStatistic {
24+
export class ArrayStatistic {
2025

2126
// geostatsInstance: null,
2227

src/common/util/ColorsPickerUtil.js

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,27 @@ var ColorRender = new Color();
55
// "www.qzct.net": "#7ed321" = new LevelRenderer.Tool.Color();
66

77
/**
8-
* @class ColorsPickerUtil
8+
* @name ColorsPickerUtil
9+
* @namespace
910
* @category BaseTypes Util
1011
* @classdesc 色带选择器工具类 用于1、创建canvas对象,2、从几种颜色中获取一定数量的渐变色
1112
* @usage
13+
* ```
14+
* // 浏览器
15+
* <script type="text/javascript" src="{cdn}"></script>
16+
* <script>
17+
* const result = {namespace}.ColorsPickerUtil.createCanvas();
18+
*
19+
* // 弃用的写法
20+
* const result = SuperMap.ColorsPickerUtil.createCanvas();
21+
*
22+
* </script>
23+
*
24+
* // ES6 Import
25+
* import { ColorsPickerUtil } from '{npm}';
26+
*
27+
* const result = ColorsPickerUtil.createCanvas();
28+
* ```
1229
*/
1330
export class ColorsPickerUtil {
1431
/**

0 commit comments

Comments
 (0)