Skip to content

Commit 1fce77d

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】common/iServer下L-N开头的文件，规范API
1 parent 7e8ba1e commit 1fce77d

14 files changed

+155
-159
lines changed

‎src/common/iServer/InterpolationKrigingAnalystParameters.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ import {InterpolationAnalystParameters} from './InterpolationAnalystParameters';
6969
* @param {string} options.outputDatasourceName - 插值分析结果数据源的名称。必设参数<br>
7070
* @param {string} options.pixelFormat - 指定结果栅格数据集存储的像素格式。<br>
7171
* @param {string} options.dataset - 要用来做插值分析的数据源中数据集的名称。该名称用形如”数据集名称@数据源别名”形式来表示。当插值分析类型(SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。<br>
72-
* @param {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point} options.inputPoints - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystType）为 geometry 时，必设参数。
72+
* @param {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point>} options.inputPoints - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystType）为 geometry 时，必设参数。
7373
* @extends {SuperMap.InterpolationAnalystParameters}
7474
* @example 例如：
7575
* var myInterpolationKrigingAnalystParameters = new SuperMap.InterpolationKrigingAnalystParameters({

‎src/common/iServer/LabelImageCell.js‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,58 @@ import {LabelMatrixCell} from './LabelMatrixCell';
44

55
/**
66
* @class SuperMap.LabelImageCell
7-
* @category iServer Map Theme
7+
* @category iServer Map Theme
88
* @classdesc 图片类型的矩阵标签元素类。
99
* @description 该类继承自 {@link SuperMap.LabelMatrixCell}类，主要对矩阵标签中的专题图类型的矩阵标签元素进行设置。
1010
* 矩阵标签专题图是标签专题图（ThemeLabel）的一种，其中矩阵标签中的填充元素又可分为图片类型（{@link SuperMap.LabelImageCell}）、
1111
* 符号类型（{@link SuperMap.LabelSymbolCell}）、专题图类型（{@link SuperMap.LabelThemeCell}）三种，该类是这三种类型的矩阵标签元素其中的一种，
1212
* 用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
1313
* 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link SuperMap.ThemeLabel.matrixCells} 属性即可。matrixCells 属是一个二维数组，
1414
* 每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
15-
* @extends SuperMap.LabelMatrixCell
16-
* @param options - {Object} 可选参数。如：<br>
17-
* height - {number}设置图片的高度，单位为毫米。<br>
18-
* pathField - {string} 设置矩阵标签元素所使用图片的路径。<br>
19-
* rotation - {number}图片的旋转角度。逆时针方向为正方向，单位为度，精确到0.1度。默认值为0.0。<br>
20-
* width - {number}设置图片的宽度，单位为毫米。<br>
21-
* sizeFixed - {boolean} 是否固定图片的大小。默认值为 false，即图片将随地图缩放。
15+
* @extends {SuperMap.LabelMatrixCell}
16+
* @param {Object} options - 参数。<br>
17+
* @param {number} options.height - 设置图片的高度，单位为毫米。<br>
18+
* @param {string} options.pathField - 设置矩阵标签元素所使用图片的路径。<br>
19+
* @param {number} [options.rotation=0.0] - 图片的旋转角度。逆时针方向为正方向，单位为度，精确到0.1度。<br>
20+
* @param {number} options.width - 设置图片的宽度，单位为毫米。<br>
21+
* @param {boolean} [options.sizeFixed=false] - 是否固定图片的大小。
2222
*/
2323
export class LabelImageCell extends LabelMatrixCell {
2424

2525
constructor(options) {
2626
super(options);
2727
/**
28-
* @member SuperMap.LabelImageCell.prototype.height -{number}
28+
* @member {number} SuperMap.LabelImageCell.prototype.height
2929
* @description 设置图片的高度，单位为毫米。
3030
*/
3131
this.height = 0;
3232

3333
/**
34-
* @member SuperMap.LabelImageCell.prototype.pathField -{string}
34+
* @member {string} SuperMap.LabelImageCell.prototype.pathField
3535
* @description 设置矩阵标签元素所使用的图片路径对应的字段名。
3636
*/
3737
this.pathField = null;
3838

3939
/**
40-
* @member SuperMap.LabelImageCell.prototype.rotation -{number}
41-
* @description 图片的旋转角度。逆时针方向为正方向，单位为度，精确到0.1度。默认值为0.0。
40+
* @member {number} [SuperMap.LabelImageCell.prototype.rotation=0.0]
41+
* @description 图片的旋转角度。逆时针方向为正方向，单位为度，精确到0.1度。
4242
*/
4343
this.rotation = 0.0;
4444

4545
/**
46-
* @member SuperMap.LabelImageCell.prototype.width -{number}
46+
* @member {number} SuperMap.LabelImageCell.prototype.width
4747
* @description 设置图片的宽度，单位为毫米。
4848
*/
4949
this.width = 0;
5050

5151
/**
52-
* @member SuperMap.LabelImageCell.prototype.sizeFixed -{boolean}
53-
* @description 是否固定图片的大小。默认值为 false，即图片将随地图缩放。
52+
* @member {boolean} [SuperMap.LabelImageCell.prototype.sizeFixed=false]
53+
* @description 是否固定图片的大小。
5454
*/
5555
this.sizeFixed = false;
5656

5757
/**
58-
* @member SuperMap.LabelImageCell.prototype.type -{boolean}
58+
* @member {string} SuperMap.LabelImageCell.prototype.type
5959
* @description 制作矩阵专题图时是必须的。
6060
*/
6161
this.type = "IMAGE";

‎src/common/iServer/LabelMatrixCell.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
/**
44
* @class SuperMap.LabelMatrixCell
5-
* @category iServer Map Theme
5+
* @category iServer Map Theme
66
* @classdesc 矩阵标签元素抽象类。
77
* @description 该类可以包含 n*n 个矩阵标签元素，矩阵标签元素的类型可以是图片，符号，标签专题图等。
88
* 符号类型的矩阵标签元素类、图片类型的矩阵标签元素类和专题图类型的矩阵标签元素类均继承自该类。

‎src/common/iServer/LabelMixedTextStyle.js‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {ServerTextStyle} from './ServerTextStyle';
44

55
/**
66
* @class SuperMap.LabelMixedTextStyle
7-
* @category iServer Map Theme
7+
* @category iServer Map Theme
88
* @classdesc 标签文本复合风格类。
99
* @description 该类主要用于对标签专题图中标签的文本内容进行风格设置。通过该类用户可以使标签的文字显示不同的风格，
1010
* 比如文本 “喜马拉雅山”，通过本类可以将前三个字用红色显示，后两个字用蓝色显示。
@@ -16,39 +16,39 @@ import {ServerTextStyle} from './ServerTextStyle';
1616
* 第一个字符（“珠”）的索引值为0，第二个字符（“穆”）的索引值为1，以此类推；当设置分段索引值为1，3，4，9时，
1717
* 字符分段范围相应的就是(-∞，1)，[1，3)，[3，4)，[4，9)，[9，+∞)，可以看出索引号为0的字符（即“珠” ）在第一个分段内，
1818
* 索引号为1，2的字符（即“穆”、“朗”）位于第二个分段内，索引号为3的字符（“玛”）在第三个分段内，索引号为4的字符（“峰”）在第四个分段内，其余分段中没有字符。
19-
* @param options - {Object} 可选参数。如：<br>
20-
* defaultStyle - {{@link SuperMap.ServerTextStyle}} 默认的文本复合风格。<br>
21-
* separator - {string} 文本的分隔符。<br>
22-
* separatorEnabled - Boolean} 文本的分隔符是否有效。<br>
23-
* splitIndexes - {Array<number>} 分段索引值，分段索引值用来对文本中的字符进行分段。<br>
24-
* styles - {Array<{@link SuperMap.ServerTextStyle}>} 文本样式集合。
19+
* @param {Object} options - 参数。<br>
20+
* @param {SuperMap.ServerTextStyle} options.defaultStyle - 默认的文本复合风格。<br>
21+
* @param {string} options.separator - 文本的分隔符。<br>
22+
* @param {boolean} options.separatorEnabled - 文本的分隔符是否有效。<br>
23+
* @param {Array.<number>} options.splitIndexes - 分段索引值，分段索引值用来对文本中的字符进行分段。<br>
24+
* @param {Array.<SuperMap.ServerTextStyle>} options.styles - 文本样式集合。
2525
*/
2626
export class LabelMixedTextStyle {
2727

2828
constructor(options) {
2929
/**
30-
* @member SuperMap.LabelMixedTextStyle.prototype.defaultStyle -{SuperMap.ServerTextStyle}
30+
* @member {SuperMap.ServerTextStyle} SuperMap.LabelMixedTextStyle.prototype.defaultStyle
3131
* @description 默认的文本复合风格，即 SuperMap.ServerTextStyle 各字段的默认值。
3232
*/
3333
this.defaultStyle = null;
3434

3535
/**
36-
* @member SuperMap.LabelMixedTextStyle.prototype.separator -{string}
36+
* @member {string} SuperMap.LabelMixedTextStyle.prototype.separator
3737
* @description 文本的分隔符，分隔符的风格与前一个字符的风格一样。文本的分隔符是一个将文本分割开的符号，
3838
* 比如文本 “5_109” 被 “_” 隔符为 “5” 和 “109” 两部分，假设有风格数组：style1、style2。
3939
* 在显示时，“5” 和分隔符 “_” 使用 Style1 风格渲染，字符串 “109” 使用 Style2 的风格。
4040
*/
4141
this.separator = null;
4242

4343
/**
44-
* @member SuperMap.LabelMixedTextStyle.prototype.separatorEnabled -{boolean}
44+
* @member {boolean} [SuperMap.LabelMixedTextStyle.prototype.separatorEnabled=false]
4545
* @description 文本的分隔符是否有效。分隔符有效时利用分隔符对文本进行分段；无效时根据文本中字符的位置进行分段。
46-
* 分段后，同一分段内的字符具有相同的显示风格。默认为 false。
46+
* 分段后，同一分段内的字符具有相同的显示风格。
4747
*/
4848
this.separatorEnabled = false;
4949

5050
/**
51-
* @member SuperMap.LabelMixedTextStyle.prototype.splitIndexes -{Array<number>}
51+
* @member {Array.<number>} SuperMap.LabelMixedTextStyle.prototype.splitIndexes
5252
* @description 分段索引值，分段索引值用来对文本中的字符进行分段。
5353
* 文本中字符的索引值是以0开始的整数，比如文本“珠穆朗玛峰”，第一个字符（“珠”）的索引值为0，第二个字符（“穆”）的索引值为1，
5454
* 以此类推；当设置分段索引值数组为[1，3，4，9]时，字符分段范围相应的就是(-∞，1)，[1，3)，[3，4)，[4，9)，[9，+∞)，
@@ -58,7 +58,7 @@ export class LabelMixedTextStyle {
5858
this.splitIndexes = null;
5959

6060
/**
61-
* @member SuperMap.LabelMixedTextStyle.prototype.styles -{Array<SuperMap.ServerTextStyle>}
61+
* @member {Array.<SuperMap.ServerTextStyle>} SuperMap.LabelMixedTextStyle.prototype.styles
6262
* @description 文本样式集合。文本样式集合中的样式根据索引与不同分段一一对应，
6363
* 如果有分段没有风格对应则使用 defaultStyle。
6464
*/
@@ -96,8 +96,8 @@ export class LabelMixedTextStyle {
9696
/**
9797
* @function SuperMap.LabelMixedTextStyle.fromObj
9898
* @description 从传入对象获取标签文本复合风格类。
99-
* @param obj - {Object} 传入对象
100-
* @return {SuperMap.LabelMixedTextStyle} 返回新的LabelMixedTextStyle对象
99+
* @param {Object} obj - 传入对象
100+
* @returns {SuperMap.LabelMixedTextStyle} 返回新的LabelMixedTextStyle对象
101101
*/
102102
static fromObj(obj) {
103103
if (!obj) {

‎src/common/iServer/LabelSymbolCell.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,30 @@ import {LabelMatrixCell} from './LabelMatrixCell';
1313
* 用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
1414
* 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link SuperMap.ThemeLabel.matrixCells} 属性即可。matrixCells 属是一个二维数组，
1515
* 每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
16-
* @extends SuperMap.LabelMatrixCell
17-
* @param options - {Object} 可选参数。如：<br>
18-
* style - {{@link SuperMap.ServerStyle}} 获取或设置符号样式—— {@link SuperMap.ServerStyle} 对象。<br>
19-
* symbolIDField - {string} 符号 ID 或符号 ID 所对应的字段名称。
16+
* @extends {SuperMap.LabelMatrixCell}
17+
* @param {Object} options - 参数。<br>
18+
* @param {SuperMap.ServerStyle} options.style - 获取或设置符号样式 —— {@link SuperMap.ServerStyle} 对象。<br>
19+
* @param {string} options.symbolIDField - 符号 ID 或符号 ID 所对应的字段名称。
2020
*/
2121
export class LabelSymbolCell extends LabelMatrixCell {
2222

2323
constructor(options) {
2424
super(options);
2525
/**
26-
* @member SuperMap.LabelSymbolCell.prototype.style -{SuperMap.ServerStyle}
26+
* @member {SuperMap.ServerStyle} SuperMap.LabelSymbolCell.prototype.style
2727
* @description 获取或设置符号样式—— {@link SuperMap.ServerStyle} 对象，包括符号大小（{@link SuperMap.ServerStyle.markerSize}）
2828
* 和符号旋转（{@link SuperMap.ServerStyle.markerAngle}）角度，其中用于设置符号 ID 的属性（{@link SuperMap.ServerStyle.markerSymbolID}）在此处不起作用。
2929
*/
3030
this.style = new ServerStyle();
3131

3232
/**
33-
* @member SuperMap.LabelSymbolCell.prototype.symbolIDField -{string}
33+
* @member {string} SuperMap.LabelSymbolCell.prototype.symbolIDField
3434
* @description 获取或设置符号 ID 或符号 ID 所对应的字段名称，必设属性。
3535
*/
3636
this.symbolIDField = null;
3737

3838
/**
39-
* @member SuperMap.LabelSymbolCell.prototype.type -{string}
39+
* @member {string} SuperMap.LabelSymbolCell.prototype.type
4040
* @description 制作矩阵专题图时是必须的。
4141
*/
4242
this.type = "SYMBOL";

‎src/common/iServer/LabelThemeCell.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,31 @@ import {LabelMatrixCell} from './LabelMatrixCell';
55

66
/**
77
* @class SuperMap.LabelThemeCell
8-
* @category iServer Map Theme
8+
* @category iServer Map Theme
99
* @classdesc 专题图类型的矩阵标签元素类。
1010
* @description 该类继承自 {@link SuperMap.LabelMatrixCell}类，主要对矩阵标签中的专题图类型的矩阵标签元素进行设置。
1111
* 矩阵标签专题图是标签专题图（{@link SuperMap.ThemeLabel}）的一种，其中矩阵标签中的填充元素又可分为图片类型（{@link SuperMap.LabelImageCell}）、
1212
* 符号类型（{@link SuperMap.LabelSymbolCell}）、专题图类型（{@link SuperMap.LabelThemeCell}）三种，该类是这三种类型的矩阵标签元素其中的一种，
1313
* 用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
1414
* 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link SuperMap.ThemeLabel.matrixCells} 属性即可。matrixCells 属是一个二维数组，
1515
* 每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
16-
* @extends SuperMap.LabelMatrixCell
17-
* @param options - {Object} 可选参数。如：<br>
18-
* themeLabel - {{@link SuperMap.ThemeLabel}} 使用专题图对象作为矩阵标签的一个元素。
16+
* @extends {SuperMap.LabelMatrixCell}
17+
* @param options - {Object} 参数。<br>
18+
* @param {SuperMap.ThemeLabel} options.themeLabel - 使用专题图对象作为矩阵标签的一个元素。
1919
*/
2020
export class LabelThemeCell extends LabelMatrixCell {
2121

2222

2323
constructor(options) {
2424
super(options);
2525
/**
26-
* @member SuperMap.LabelThemeCell.prototype.themeLabel -{SuperMap.ThemeLabel}
26+
* @member {SuperMap.ThemeLabel} SuperMap.LabelThemeCell.prototype.themeLabel
2727
* @description 使用专题图对象作为矩阵标签的一个元素。
2828
*/
2929
this.themeLabel = new ThemeLabel();
3030

3131
/**
32-
* @member SuperMap.LabelThemeCell.prototype.type -{string}
32+
* @member {string} SuperMap.LabelThemeCell.prototype.type
3333
* @description 制作矩阵专题图时是必须的。
3434
*/
3535
this.type = "THEME";

‎src/common/iServer/LayerStatus.js‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,39 @@ import {Util} from '../commontypes/Util';
33

44
/**
55
* @class SuperMap.LayerStatus
6-
* @category iServer Map Theme
6+
* @category iServer Map Theme
77
* @classdesc 子图层显示参数类。
88
* @description 该类存储了各个子图层的名字和是否可见的状态。
9-
* @param options - {Object} 可选参数。如：<br>
10-
* layerName - {string} 获取或设置图层名称。<br>
11-
* isVisible - {boolean} 获取或设置图层是否可见，true 表示可见。<br>
12-
* displayFilter - {string} 图层显示 SQL 过滤条件。
9+
* @param {Object} options - 参数。<br>
10+
* @param {string} options.layerName - 获取或设置图层名称。<br>
11+
* @param {boolean} options.isVisible - 获取或设置图层是否可见，true 表示可见。<br>
12+
* @param {string} options.displayFilter - 图层显示 SQL 过滤条件。
1313
*/
1414
export class LayerStatus {
1515

1616
constructor(options) {
1717
/**
18-
* @member SuperMap.LayerStatus.prototype.layerName -{string}
18+
* @member {string} SuperMap.LayerStatus.prototype.layerName
1919
* @description 获取或设置图层名称。必设属性。
2020
*/
2121
this.layerName = null;
2222

2323
/**
24-
* @member SuperMap.LayerStatus.prototype.isVisible -{boolean}
24+
* @member {boolean} SuperMap.LayerStatus.prototype.isVisible
2525
* @description 获取或设置图层是否可见，true 表示可见。必设属性。
2626
*/
2727
this.isVisible = null;
2828

2929
/**
30-
* @member SuperMap.LayerStatus.prototype.displayFilter -{string}
30+
* @member {boolean} SuperMap.LayerStatus.prototype.displayFilter
3131
* @description 图层显示 SQL 过滤条件，如 layerStatus.displayFilter = "smid < 10"，表示仅显示 smid 值小于 10 的对象。
3232
*/
3333
this.displayFilter = null;
3434

3535
/**
36-
* @member SuperMap.LayerStatus.prototype.fieldValuesDisplayFilter -{Object}
37-
* @description 图层要素的显示和隐藏的过滤属性，其带有三个属性，分别是:values、fieldName、fieldValuesDisplayMode,他们的作用如下：<br>
38-
* values：{Array<number>} - 就是要过滤的值；<br>
36+
* @member {Object} SuperMap.LayerStatus.prototype.fieldValuesDisplayFilter
37+
* @description 图层要素的显示和隐藏的过滤属性，其带有三个属性，分别是：values、fieldName、fieldValuesDisplayMode。他们的作用如下：<br>
38+
* values：{Array.<number>} - 就是要过滤的值；<br>
3939
* fieldName：{string} - 要过滤的字段名称 只支持数字类型的字段；<br>
4040
* fieldValuesDisplayMode：{string} 目前有两个DISPLAY/DISABLE。当为DISPLAY时，表示只显示以上设置的相应属性值的要素，否则表示不显示以上设置的相应属性值的要素
4141
*/
@@ -62,7 +62,7 @@ export class LayerStatus {
6262
/**
6363
* @function SuperMap.LayerStatus.prototype.toJSON
6464
* @description 生成对应的json。
65-
* @return {Object} 对应的json
65+
* @returns {Object} 对应的json
6666
*/
6767
toJSON() {
6868
var json = '{';

0 commit comments

Comments
 (0)