Skip to content

Commit 7e8ba1e

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】common/iServer下F-K开头的文件，规范API写法
1 parent 0e582e3 commit 7e8ba1e

File tree

70 files changed

+1036
-1045
lines changed

Some content is hidden

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

70 files changed

+1036
-1045
lines changed

‎build/jsdocs/template/typeLinkExt.js

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
var olapi = "https://openlayers.org/en/latest/apidoc/";
2+
var lfapi = "http://leafletjs.com/reference-1.3.0.html";
23
var typeLinks = {
34
"ol.Map": olapi + "ol.Map.html",
4-
"ol.View": olapi + "ol.View.html"
5+
"ol.View": olapi + "ol.View.html",
6+
"ol.extent": olapi + "ol.extent.html",
7+
"ol.feature": olapi + "ol.feature.html",
8+
"ol.geom.Polygon": olapi + "ol.geom.Polygon.html",
9+
"ol.geom.Point": olapi + "ol.geom.Point.html",
10+
"ol.format.GeoJSON": olapi + "ol.format.GeoJSON.html",
11+
"L.bounds": lfapi + "#bounds",
12+
"L.Polygon": lfapi + "#polygon",
13+
"L.Point": lfapi + "#point",
14+
"L.LatLng": lfapi + "#latlng",
15+
"L.GeoJSON": lfapi + "#geojson"
516
}
617
exports.typeLinks = typeLinks;

‎src/common/iServer/EditFeaturesService.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {EditFeaturesParameters} from './EditFeaturesParameters';
1212
* @param {string} url - 服务端的数据服务资源地址。请求数据服务中数据集编辑服务，URL 应为：</br>
1313
* http://{服务器地址}:{服务端口号}/iserver/services/{数据服务名}/rest/data/datasources/name/{数据源名}/datasets/name/{数据集名} 。</br>
1414
* 例如：http://localhost:8090/iserver/services/data-jingjin/rest/data/datasources/name/Jingjin/datasets/name/Landuse_R
15-
* @param {Object} options - 参数。如:</br>
15+
* @param {Object} options - 参数。</br>
1616
* @param {Object} options.eventListeners - 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。<br>
1717
* @param {SuperMap.ServerType} serverType - 服务器类型，iServer|iPortal|Online。<br>
1818
* @param {SuperMap.DataFormat} format -查询结果返回格式，目前支持iServerJSON 和GeoJSON两种格式。参数格式为"ISERVER","GEOJSON"。

‎src/common/iServer/FacilityAnalyst3DParameters.js

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,42 @@ import {Util} from '../commontypes/Util';
55
* @class SuperMap.FacilityAnalyst3DParameters
66
* @category iServer FacilityAnalyst3D
77
* @classdesc 最近设施分析参数基类。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
8-
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，
9-
* 超过10分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起
10-
* 作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
11-
* @param options - {Object} 可选参数。如：<br>
12-
* edgeID - {number} 指定的弧段ID。<br>
13-
* nodeID - {integer} 指定的结点ID。<br>
14-
* weightName -{string} 指定的权值字段信息对象的名称。<br>
15-
* isUncertainDirectionValid - {boolean} 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
16-
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
8+
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，
9+
* 超过10分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起
10+
* 作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
11+
* @param {Object} options - 参数。<br>
12+
* @param {number} options.edgeID - 指定的弧段ID。<br>
13+
* @param {number} options.nodeID - 指定的结点ID。<br>
14+
* @param {string} options.weightName - 指定的权值字段信息对象的名称。<br>
15+
* @param {boolean} options.isUncertainDirectionValid - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
16+
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
1717
*/
1818
export class FacilityAnalyst3DParameters {
1919

2020

2121
constructor(options) {
2222
/**
23-
* @member SuperMap.FacilityAnalyst3DParameters.prototype.edgeID - {number}
23+
* @member {number} SuperMap.FacilityAnalyst3DParameters.prototype.edgeID
2424
* @description 指定的弧段ID。
2525
*/
2626
this.edgeID = null;
2727

2828
/**
29-
* @member SuperMap.FacilityAnalyst3DParameters.prototype.nodeID - {number}
29+
* @member {number} SuperMap.FacilityAnalyst3DParameters.prototype.nodeID
3030
* @description 指定的结点ID。
3131
*/
3232
this.nodeID = null;
3333

3434
/**
35-
* @member SuperMap.FacilityAnalyst3DParameters.prototype.weightName - string}
35+
* @member {string} SuperMap.FacilityAnalyst3DParameters.prototype.weightName
3636
* @description 指定的权值字段信息对象的名称。
3737
*/
3838
this.weightName = null;
3939

4040
/**
41-
* @member SuperMap.FacilityAnalyst3DParameters.prototype.isUncertainDirectionValid - {boolean}
41+
* @member {boolean} SuperMap.FacilityAnalyst3DParameters.prototype.isUncertainDirectionValid
4242
* @description 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
43-
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找
43+
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找
4444
*/
4545
this.isUncertainDirectionValid = false;
4646
Util.extend(this, options);

‎src/common/iServer/FacilityAnalystSinks3DParameters.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
55
* @class SuperMap.FacilityAnalystSinks3DParameters
66
* @category iServer FacilityAnalyst3D Sinks
77
* @classdesc 最近设施分析参数类(汇查找资源)。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
8-
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分钟
9-
* 能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、
10-
* 转向表、耗费等属性在最近设施分析时同样可设置。
11-
* @extends SuperMap.FacilityAnalyst3DParameters
12-
* @param options - {Object} 可选参数。如:<br>
13-
* edgeID - {number} 指定的弧段ID。<br>
14-
* nodeID - {integer} 指定的结点ID。<br>
15-
* weightName - {string} 指定的权值字段信息对象的名称。<br>
16-
* isUncertainDirectionValid - {boolean} 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
17-
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
8+
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分钟
9+
* 能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、
10+
* 转向表、耗费等属性在最近设施分析时同样可设置。
11+
* @extends {SuperMap.FacilityAnalyst3DParameters}
12+
* @param {Object} options - 参数。<br>
13+
* @param {number} options.edgeID - 指定的弧段ID。<br>
14+
* @param {number} options.nodeID - 指定的结点ID。<br>
15+
* @param {string} options.weightName - 指定的权值字段信息对象的名称。<br>
16+
* @param {boolean} options.isUncertainDirectionValid - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
17+
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
1818
*/
1919
export class FacilityAnalystSinks3DParameters extends FacilityAnalyst3DParameters {
2020

‎src/common/iServer/FacilityAnalystSinks3DService.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ import {FacilityAnalystSinks3DParameters} from './FacilityAnalystSinks3DParamete
44

55
/**
66
* @class SuperMap.FacilityAnalystSinks3DService
7-
* @category iServer FacilityAnalyst3D Sinks
7+
* @category iServer FacilityAnalyst3D Sinks
88
* @classdesc 最近设施分析服务类(汇查找资源)<br>
9-
* 最近设施分析是指在网络上给定一个事件点和一组设施点，
10-
* 查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11-
* 该类负责将客户端指定的最近设施分析参数传递给服务端，并接收服务端返回的结果数据。
12-
* 最近设施分析结果通过该类支持的事件的监听函数参数获取
13-
* @extends SuperMap.CommonServiceBase
9+
* 最近设施分析是指在网络上给定一个事件点和一组设施点，
10+
* 查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11+
* 该类负责将客户端指定的最近设施分析参数传递给服务端，并接收服务端返回的结果数据。
12+
* 最近设施分析结果通过该类支持的事件的监听函数参数获取
13+
* @extends {SuperMap.CommonServiceBase}
1414
* @example
1515
* var myFacilityAnalystSinks3DService = new SuperMap.FacilityAnalystSinks3DService(url, {
1616
* eventListeners: {
1717
* "processCompleted": facilityAnalystSinks3DCompleted,
1818
* "processFailed": facilityAnalystSinks3DError
1919
* }
2020
* });
21-
* @param url - {string} 网络分析服务地址。请求网络分析服务，URL应为：<br>
22-
* http://{服务器地址}:{服务端口号}/iserver/services/{网络分析服务名}/rest/networkanalyst/{网络数据集@数据源}；<br>
23-
* 例如:"http://localhost:8090/iserver/services/components-rest/rest/networkanalyst/RoadNet@Changchun"。<br>
24-
* @param options - {Object} 互服务时所需可选参数。如：<br>
25-
* eventListeners - {Object} 需要被注册的监听器对象。
21+
* @param {string} url - 网络分析服务地址。请求网络分析服务，URL应为：<br>
22+
* http://{服务器地址}:{服务端口号}/iserver/services/{网络分析服务名}/rest/networkanalyst/{网络数据集@数据源}；<br>
23+
* 例如:"http://localhost:8090/iserver/services/components-rest/rest/networkanalyst/RoadNet@Changchun"。<br>
24+
* @param {Object} options - 参数。<br>
25+
* @param {Object} options.eventListeners - 需要被注册的监听器对象。
2626
*/
2727
export class FacilityAnalystSinks3DService extends CommonServiceBase {
2828

@@ -44,7 +44,7 @@ export class FacilityAnalystSinks3DService extends CommonServiceBase {
4444
/**
4545
* @function SuperMap.FacilityAnalystSinks3DService.prototype.processAsync
4646
* @description 负责将客户端的查询参数传递到服务端。
47-
* @param params - {SuperMap.FacilityAnalystSinks3DParameters} 最近设施分析参数类(汇查找资源)
47+
* @param {SuperMap.FacilityAnalystSinks3DParameters} params - 最近设施分析参数类(汇查找资源)
4848
*/
4949
processAsync(params) {
5050
if (!(params instanceof FacilityAnalystSinks3DParameters)) {

‎src/common/iServer/FacilityAnalystSources3DParameters.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
55
* @class SuperMap.FacilityAnalystSources3DParameters
66
* @category iServer FacilityAnalyst3D Sources
77
* @classdesc 最近设施分析参数类(源查找资源)。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
8-
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分
9-
* 钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍
10-
* 点、转向表、耗费等属性在最近设施分析时同样可设置。
11-
* @extends SuperMap.FacilityAnalyst3DParameters
12-
* @param options - {Object} 可选参数。如:<br>
13-
* edgeID - {number} 指定的弧段ID。<br>
14-
* nodeID - {integer} 指定的结点ID。<br>
15-
* weightName - {string} 指定的权值字段信息对象的名称。<br>
16-
* isUncertainDirectionValid - {boolean} 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
17-
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
8+
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分
9+
* 钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍
10+
* 点、转向表、耗费等属性在最近设施分析时同样可设置。
11+
* @extends {SuperMap.FacilityAnalyst3DParameters}
12+
* @param {Object} options - 参数。<br>
13+
* @param {number} options.edgeID - 指定的弧段ID。<br>
14+
* @param {number} options.nodeID - 指定的结点ID。<br>
15+
* @param {string} options.weightName - 指定的权值字段信息对象的名称。<br>
16+
* @param {boolean} options.isUncertainDirectionValid - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
17+
* 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
1818
*/
1919
export class FacilityAnalystSources3DParameters extends FacilityAnalyst3DParameters {
2020

‎src/common/iServer/FacilityAnalystSources3DService.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ import {FacilityAnalystSources3DParameters} from './FacilityAnalystSources3DPara
66
* @class SuperMap.FacilityAnalystSources3DService
77
* @category iServer FacilityAnalyst3D Sources
88
* @classdesc 最近设施分析服务类(源查找资源) <br>
9-
* 最近设施分析是指在网络上给定一个事件点和一组设施点，
10-
* 查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11-
* 该类负责将客户端指定的最近设施分析参数传递给服务端，并接收服务端返回的结果数据。
12-
* 最近设施分析结果通过该类支持的事件的监听函数参数获取
13-
* @extends SuperMap.CommonServiceBase
14-
* @param url - {string} 网络分析服务地址。请求网络分析服务，URL应为：<br>
15-
* http://{服务器地址}:{服务端口号}/iserver/services/{网络分析服务名}/rest/networkanalyst/{网络数据集@数据源}；<br>
16-
* 例如:"http://localhost:8090/iserver/services/components-rest/rest/networkanalyst/RoadNet@Changchun"。
17-
* @param options - {Object} 互服务时所需可选参数。如：<br>
18-
* eventListeners - {Object} 需要被注册的监听器对象。
9+
* 最近设施分析是指在网络上给定一个事件点和一组设施点，
10+
* 查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11+
* 该类负责将客户端指定的最近设施分析参数传递给服务端，并接收服务端返回的结果数据。
12+
* 最近设施分析结果通过该类支持的事件的监听函数参数获取。
13+
* @extends {SuperMap.CommonServiceBase}
14+
* @param {string} url - 网络分析服务地址。请求网络分析服务，URL应为：<br>
15+
* http://{服务器地址}:{服务端口号}/iserver/services/{网络分析服务名}/rest/networkanalyst/{网络数据集@数据源}；<br>
16+
* 例如:"http://localhost:8090/iserver/services/components-rest/rest/networkanalyst/RoadNet@Changchun"。
17+
* @param {Object} options - 参数。<br>
18+
* @param {Object} options.eventListeners - 需要被注册的监听器对象。
1919
*/
2020
export class FacilityAnalystSources3DService extends CommonServiceBase {
2121

@@ -38,7 +38,7 @@ export class FacilityAnalystSources3DService extends CommonServiceBase {
3838
/**
3939
* @function SuperMap.FacilityAnalystSources3DService.prototype.processAsync
4040
* @description 负责将客户端的查询参数传递到服务端。
41-
* @param params - {SuperMap.FacilityAnalystSources3DParameters} 最近设施分析参数类(源查找资源)
41+
* @param {SuperMap.FacilityAnalystSources3DParameters} params - 最近设施分析参数类（源查找资源）
4242
*/
4343
processAsync(params) {
4444
if (!(params instanceof FacilityAnalystSources3DParameters)) {

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