Skip to content

Commit 831334e

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】规范common/iServer下T开头的API Doc
1 parent 8b15434 commit 831334e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+613
-625
lines changed

‎src/common/iServer/TerrainCurvatureCalculationParameters.js

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ import {Util} from '../commontypes/Util';
55
* @class SuperMap.TerrainCurvatureCalculationParameters
66
* @category iServer SpatialAnalyst TerrainCalculation
77
* @classdesc 地形曲率计算参数类。
8-
* @param options - {Object} 可选参数。如</br>
9-
* dataset - {string} 要用来做地形曲率计算数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。必设字段。</br>
10-
* zFactor - {number}指定的高程缩放系数。默认值为 1.0，表示不缩放。</br>
11-
* averageCurvatureName - {string} 结果数据集：平均曲率数据集的名称，必设字段。</br>
12-
* profileCurvatureName - {string} 结果数据集：剖面曲率数据集的名称。</br>
13-
* planCurvatureName - {string} 结果数据集：平面曲率数据集的名称。</br>
14-
* deleteExistResultDataset - {boolean} 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。默认为 false，即不删除。</br>
8+
* @param {Object} options - 参数。如/br>
9+
* @param {string} options.dataset - 要用来做地形曲率计算数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。必设字段。</br>
10+
* @param {number} [options.zFactor=1.0] - 指定的高程缩放系数。1.0表示不缩放。</br>
11+
* @param {string} options.averageCurvatureName - 结果数据集：平均曲率数据集的名称，必设字段。</br>
12+
* @param {string} options.profileCurvatureName - 结果数据集：剖面曲率数据集的名称。</br>
13+
* @param {string} options.planCurvatureName - 结果数据集：平面曲率数据集的名称。</br>
14+
* @param {boolean} [options.deleteExistResultDataset=false] - 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。</br>
1515
*/
1616
export class TerrainCurvatureCalculationParameters {
1717

@@ -20,43 +20,43 @@ export class TerrainCurvatureCalculationParameters {
2020
return;
2121
}
2222
/**
23-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.dataset -{string}
23+
* @member {string} SuperMap.TerrainCurvatureCalculationParameters.prototype.dataset
2424
* @description 要用来做地形曲率计算数据源中数据集的名称。
2525
* 该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。必设字段。
2626
* 注：地形曲率计算必须为栅格数据集。
2727
*/
2828
this.dataset = null;
2929

3030
/**
31-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.zFactor -{number}
32-
* @description 指定的高程缩放系数。默认值为 1.0，表示不缩放。
31+
* @member {number} [SuperMap.TerrainCurvatureCalculationParameters.prototype.zFactor=1.0]
32+
* @description 指定的高程缩放系数。1.0表示不缩放。
3333
* 该值是指在 DEM 栅格数据中，栅格值（Z 坐标，即高程值）相对于 X 和 Y 坐标的单位变换系数。
3434
* 通常有 X，Y，Z 都参加的计算中，需要将高程值乘以一个高程缩放系数，使得三者单位一致。
3535
* 例如，X、Y 方向上的单位是米，而 Z 方向的单位是英尺，由于 1 英尺等于 0.3048 米，则需要指定缩放系数为 0.3048。
3636
*/
3737
this.zFactor = 1.0;
3838

3939
/**
40-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.averageCurvatureName -{string}
40+
* @member {string} SuperMap.TerrainCurvatureCalculationParameters.prototype.averageCurvatureName
4141
* @description 结果数据集：平均曲率数据集的名称，必设字段。
4242
*/
4343
this.averageCurvatureName = null;
4444

4545
/**
46-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.profileCurvatureName -{string}
46+
* @member {string} SuperMap.TerrainCurvatureCalculationParameters.prototype.profileCurvatureName
4747
* @description 结果数据集：剖面曲率数据集的名称。
4848
*/
4949
this.profileCurvatureName = "";
5050

5151
/**
52-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.planCurvatureName -{string}
52+
* @member {string} SuperMap.TerrainCurvatureCalculationParameters.prototype.planCurvatureName
5353
* @description 结果数据集：平面曲率数据集的名称。
5454
*/
5555
this.planCurvatureName = "";
5656

5757
/**
58-
* @member SuperMap.TerrainCurvatureCalculationParameters.prototype.deleteExistResultDataset -{boolean}
59-
* @description 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。默认为 false，即不删除。
58+
* @member {boolean} [SuperMap.TerrainCurvatureCalculationParameters.prototype.deleteExistResultDataset=false]
59+
* @description 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。
6060
*/
6161
this.deleteExistResultDataset = false;
6262

@@ -82,8 +82,8 @@ export class TerrainCurvatureCalculationParameters {
8282

8383
/**
8484
* @function SuperMap.TerrainCurvatureCalculationParameters.toObject
85-
* @param derrainCurvatureCalculationParameters - {Object} 地形曲率计算参数
86-
* @param tempObj - {Object} 目标对象。
85+
* @param {Object} derrainCurvatureCalculationParameters - 地形曲率计算参数
86+
* @param {Object} tempObj - 目标对象。
8787
* @description 生成地形曲率计算对象
8888
*/
8989
static toObject(derrainCurvatureCalculationParameters, tempObj) {

‎src/common/iServer/TerrainCurvatureCalculationService.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ import {TerrainCurvatureCalculationParameters} from './TerrainCurvatureCalculati
66
* @class SuperMap.TerrainCurvatureCalculationService
77
* @category iServer SpatialAnalyst TerrainCalculation
88
* @classdesc 地形曲率计算服务类。
9-
* @extends SuperMap.SpatialAnalystBase
10-
* @param options - {Object} 可选参数。如</br>
11-
* eventListeners - {Object} 需要被注册的监听器对象。
12-
* @param url - {string} 服务的访问地址。如 http://localhost:8090/iserver/services/spatialanalyst-changchun/restjsr/spatialanalyst 。
9+
* @extends {SuperMap.SpatialAnalystBase}
10+
* @param {Object} options - 参数。</br>
11+
* @param {Object} options.eventListeners - 需要被注册的监听器对象。
12+
* @param {string} options.url - 服务的访问地址。如 http://localhost:8090/iserver/services/spatialanalyst-changchun/restjsr/spatialanalyst 。
1313
* @example 例如：
1414
* (start code)
1515
* var myTerrainCurvatureCalculationService = new SuperMap.TerrainCurvatureCalculationService(url);
@@ -38,7 +38,7 @@ export class TerrainCurvatureCalculationService extends SpatialAnalystBase {
3838
/**
3939
* @function SuperMap.TerrainCurvatureCalculationService.prototype.processAsync
4040
* @description 负责将客户端的查询参数传递到服务端。
41-
* @param parameter - {SuperMap.TerrainCurvatureCalculationParameters}
41+
* @param {SuperMap.TerrainCurvatureCalculationParameters} parameter - 地形曲率计算参数类。
4242
*/
4343
processAsync(parameter) {
4444
var me = this;

‎src/common/iServer/Theme.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import './ThemeMemoryData';
66
* @class SuperMap.Theme
77
* @category iServer Map Theme
88
* @classdesc 专题图基类。
9-
* @param type - {string} 专题图类型。
10-
* @param options - {Object} 可选参数。如：<br>
11-
* memoryData - {{@link SuperMap.ThemeMemoryData}} 专题图内存数据。
9+
* @param {string} type - 专题图类型。
10+
* @param {Object} options - 参数。<br>
11+
* @param {SuperMap.ThemeMemoryData} options.memoryData - 专题图内存数据。
1212
*/
1313
export class Theme {
1414

@@ -17,15 +17,15 @@ export class Theme {
1717
return this;
1818
}
1919
/**
20-
* @member SuperMap.Theme.prototype.memoryData -{SuperMap.ThemeMemoryData}
20+
* @member {SuperMap.ThemeMemoryData} SuperMap.Theme.prototype.memoryData
2121
* @description 专题图内存数据。<br>
2222
* 用内存数据制作专题图的方式与表达式制作专题图的方式互斥，前者优先级较高。
2323
* 第一个参数代表专题值，即数据集中用来做专题图的字段或表达式的值；第二个参数代表外部值。在制作专题图时，会用外部值代替专题值来制作相应的专题图。
2424
*/
2525
this.memoryData = null;
2626

2727
/**
28-
* @member SuperMap.Theme.prototype.type -{string}
28+
* @member {string} SuperMap.Theme.prototype.type
2929
* @description 专题图类型。
3030
*/
3131
this.type = type;
@@ -53,7 +53,7 @@ export class Theme {
5353
/**
5454
* @function SuperMap.Theme.prototype.toServerJSONObject
5555
* @description 转换成对应的 JSON 格式对象。
56-
* @return {Object} 对应的 JSON 格式对象
56+
* @returns {Object} 对应的 JSON 格式对象
5757
*/
5858
toServerJSONObject() {
5959
//return 子类实现

‎src/common/iServer/ThemeDotDensity.js

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,37 @@ import {ServerStyle} from './ServerStyle';
77
* @class SuperMap.ThemeDotDensity
88
* @category iServer Map Theme
99
* @classdesc 点密度专题图。<br>
10-
* @description
11-
* 点密度专题图用一定大小、形状相同的点表示现象分布范围、数量特征和分布密度。点的多少和所代表的意义由地图的内容确定。<br>
10+
* @description 点密度专题图用一定大小、形状相同的点表示现象分布范围、数量特征和分布密度。点的多少和所代表的意义由地图的内容确定。<br>
1211
* 点密度专题图利用图层的某一数值属性信息（专题值）映射为不同等级，每一级别使用不同数量或表现为密度的点符号来表示。<br>
1312
* 该专题值在各个分区内的分布情况，体现不同区域的相对数量差异。多用于具有数量特征的地图上，<br>
1413
* 比如表示不同地区的粮食产量、GDP、人口等的分级，主要针对区域或面状的要素，因而，点密度专题图适用于面数据集。<br>
1514
* 注意：点密度专题图中点的分布是随机的，并不代表实际的分布位置。即使在相关设置完全相同的情况下，<br>
1615
* 每次制作出的专题图，点的数量相同，但点的位置都有差异。
17-
* @extends SuperMap.Theme
18-
* @param options - {Object} 可选参数。如：<br>
19-
* dotExpression - {string} 创建点密度专题图的字段或字段表达式。<br>
20-
* style - {{@link SuperMap.ServerStyle}} 点密度专题图中点的风格。<br>
21-
* value - {number} 专题图中每一个点所代表的数值。<br>
22-
* memoryData - {{@link SuperMap.ThemeMemoryData}} 专题图内存数据。
16+
* @extends {SuperMap.Theme}
17+
* @param {Object} options - 参数。<br>
18+
* @param {string} options.dotExpression - 创建点密度专题图的字段或字段表达式。<br>
19+
* @param {SuperMap.ServerStyle} options.style - 点密度专题图中点的风格。<br>
20+
* @param {number} options.value - 专题图中每一个点所代表的数值。<br>
21+
* @param {SuperMap.ThemeMemoryData} options.memoryData - 专题图内存数据。
2322
*/
2423
export class ThemeDotDensity extends Theme {
2524

2625
constructor(options) {
2726
super("DOTDENSITY", options);
2827
/**
29-
* @member SuperMap.ThemeDotDensity.prototype.dotExpression -{string}
28+
* @member {string} SuperMap.ThemeDotDensity.prototype.dotExpression
3029
* @description 创建点密度专题图的字段或字段表达式。点的数目或密集程度的来源。
3130
*/
3231
this.dotExpression = null;
3332

3433
/**
35-
* @member SuperMap.ThemeDotDensity.prototype.style -{SuperMap.ServerStyle}
34+
* @member {SuperMap.ServerStyle} SuperMap.ThemeDotDensity.prototype.style
3635
* @description 点密度专题图中点的风格。
3736
*/
3837
this.style = new ServerStyle();
3938

4039
/**
41-
* @member SuperMap.ThemeDotDensity.prototype.value -{number}
40+
* @member {number} SuperMap.ThemeDotDensity.prototype.value
4241
* @description 专题图中每一个点所代表的数值。<br>
4342
* 点值的确定与地图比例尺以及点的大小有关。地图比例尺越大，相应的图面范围也越大，<br>
4443
* 点相应就可以越多，此时点值就可以设置相对小一些。点形状越大，<br>
@@ -71,7 +70,7 @@ export class ThemeDotDensity extends Theme {
7170
/**
7271
* @function SuperMap.ThemeDotDensity.prototype.toServerJSONObject
7372
* @description 转换成对应的 JSON 格式对象。
74-
* @return{Object} 对应的 JSON 格式对象
73+
* @returns {Object} 对应的 JSON 格式对象
7574
*/
7675
toServerJSONObject() {
7776
var obj = {};
@@ -87,8 +86,8 @@ export class ThemeDotDensity extends Theme {
8786
/**
8887
* @function SuperMap.ThemeDotDensity.fromObj
8988
* @description 从传入对象获取点密度专题图中点的风格。
90-
* @param obj - {Object} 传入对象
91-
* @return {SuperMap.ThemeDotDensity} ThemeDotDensity对象
89+
* @param {Object} obj - 传入对象
90+
* @returns {SuperMap.ThemeDotDensity} ThemeDotDensity对象
9291
*/
9392
static fromObj(obj) {
9493
if (!obj) {

‎src/common/iServer/ThemeFlow.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ import {ServerStyle} from './ServerStyle';
66
* @class SuperMap.ThemeFlow
77
* @category iServer Map Theme
88
* @classdesc 标签或符号流动显示和牵引线风格设置类。
9-
* 通过该类可以设置专题图中符号是否流动显示、是否使用牵引线以及牵引线风格。
10-
* @param options - {Object} 可选参数。如：<br>
11-
* flowEnabled - {boolean} 是否流动显示标签或符号。<br>
12-
* leaderLineDisplayed - {boolean} 是否显示标签或符号和它标注的对象之间的牵引线。<br>
13-
* leaderLineStyle - {{@link SuperMap.ServerStyle}} 标签或符号与其标注对象之间牵引线的风格。
9+
* 通过该类可以设置专题图中符号是否流动显示、是否使用牵引线以及牵引线风格。
10+
* @param {Object} options - 参数。<br>
11+
* @param {boolean} options.flowEnabled - 是否流动显示标签或符号。<br>
12+
* @param {boolean} options.leaderLineDisplayed - 是否显示标签或符号和它标注的对象之间的牵引线。<br>
13+
* @param SuperMap.ServerStyle} options.leaderLineStyle - 标签或符号与其标注对象之间牵引线的风格。
1414
*/
1515
export class ThemeFlow {
1616

1717
constructor(options) {
1818
/**
19-
* @member SuperMap.ThemeFlow.prototype.flowEnabled -{boolean}
19+
* @member {boolean} SuperMap.ThemeFlow.prototype.flowEnabled
2020
* @description 是否流动显示标签或符号。<br>
2121
* 对于标签专题图而言，对于跨越比较大的区域和线条状的几何对象，在一个地图窗口中不能完全显示的情况下，如果其标签位置比较固定，<br>
2222
* 在当前地图窗口中该对象的标签不可见，则需要通过平移地图来查看对象的标签信息。如果采用了流动显示的效果，在当前地图窗口中，对象即使是部分显示，<br>
@@ -25,15 +25,15 @@ export class ThemeFlow {
2525
this.flowEnabled = false;
2626

2727
/**
28-
* @member SuperMap.ThemeFlow.prototype.leaderLineDisplayed -{boolean}
29-
* @description 是否显示标签或符号和它标注的对象之间的牵引线。默认值为 false，即不显示标签或符号和它标注的对象之间的牵引线。<br>
28+
* @member {boolean} [SuperMap.ThemeFlow.prototype.leaderLineDisplayed=false]
29+
* @description 是否显示标签或符号和它标注的对象之间的牵引线。false表示不显示标签或符号和它标注的对象之间的牵引线。<br>
3030
* 只有当 flowEnabled 为 true 时，牵引线才起作用。在当标签流动显示时，其位置不固定，由于牵引线始终指向要素的内点，<br>
3131
* 因而通过牵引线显示功能可以找到流动的标签或符号实际对应的要素。或者渲染符号偏移它所指向的对象时，图与对象之间可以采用牵引线进行连接。
3232
*/
3333
this.leaderLineDisplayed = false;
3434

3535
/**
36-
* @member SuperMap.ThemeFlow.prototype.leaderLineStyle -{SuperMap.ServerStyle}
36+
* @member {SuperMap.ServerStyle} SuperMap.ThemeFlow.prototype.leaderLineStyle
3737
* @description 标签或符号与其标注对象之间牵引线的风格。
3838
*/
3939
this.leaderLineStyle = new ServerStyle();
@@ -62,8 +62,8 @@ export class ThemeFlow {
6262
/**
6363
* @function SuperMap.ThemeFlow.fromObj
6464
* @description 从传入对象获取标签或符号流动显示和牵引线风格设置类。
65-
* @param obj - {Object} 传入对象
66-
* @return {SuperMap.ThemeFlow} ThemeFlow对象
65+
* @param {Object} obj - 传入对象
66+
* @returns {SuperMap.ThemeFlow} ThemeFlow 对象
6767
*/
6868
static fromObj(obj) {
6969
if (!obj) {

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