Skip to content

Commit 8c57a22

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】规范、改正common/iServer下Q-S开头的API。
1 parent 69703f8 commit 8c57a22

Some content is hidden

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

50 files changed

+3248
-3611
lines changed

‎dist/iclient-classic.js

Lines changed: 109 additions & 109 deletions
Large diffs are not rendered by default.

‎dist/iclient-classic.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/iclient9-leaflet.js

Lines changed: 805 additions & 892 deletions
Large diffs are not rendered by default.

‎dist/iclient9-leaflet.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/iclient9-mapboxgl.js

Lines changed: 804 additions & 891 deletions
Large diffs are not rendered by default.

‎dist/iclient9-mapboxgl.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/iclient9-openlayers.js

Lines changed: 805 additions & 892 deletions
Large diffs are not rendered by default.

‎dist/iclient9-openlayers.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/common/iServer/QueryByBoundsParameters.js

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ import {QueryParameters} from './QueryParameters';
66
* @class SuperMap.QueryByBoundsParameters
77
* @category iServer Map QueryResults
88
* @classdesc Bounds 查询参数类。该类用于设置 Bounds 查询的相关参数。
9-
* @extends SuperMap.QueryParameters
10-
* @param options - {Object} 可选参数。如：<br>
11-
* customParams - {string} 自定义参数，供扩展使用。<br>
12-
* prjCoordSys -{Object} 自定义参数，供SuperMap Online提供的动态投影查询扩展使用。如 {"epsgCode":3857}。<br>
13-
* expectCount - {number}期望返回结果记录个数。<br>
14-
* networkType - {{@link SuperMap.GeometryType}} 网络数据集对应的查询类型。<br>
15-
* queryOption - {{@link SuperMap.QueryOption}} 查询结果类型枚举类。<br>
16-
* queryParams - {Array<{@link SuperMap.FilterParameter}>} 查询过滤条件参数数组。<br>
17-
* startRecord - {number}查询起始记录号。<br>
18-
* holdTime - {number}资源在服务端保存的时间。<br>
19-
* returnCustomResult -{boolean} 仅供三维使用。<br>
20-
* returnContent - {boolean} 是否立即返回新创建资源的表述还是返回新资源的 URI。<br>
21-
* bounds - {{@link SuperMap.Bounds}} 指定的查询范围。<br>
22-
* Bounds类型可以是SuperMap.Bounds|L.Bounds|ol.extent。
9+
* @extends {SuperMap.QueryParameters}
10+
* @param {Object} options - 参数。<br>
11+
* @param {string} options.customParams - 自定义参数，供扩展使用。<br>
12+
* @param {Object} options.prjCoordSys -自定义参数，供SuperMap Online提供的动态投影查询扩展使用。如 {"epsgCode":3857}。<br>
13+
* @param {number} options.expectCount - 期望返回结果记录个数。<br>
14+
* @param {SuperMap.GeometryType} options.networkType - 网络数据集对应的查询类型。<br>
15+
* @param {SuperMap.QueryOption} options.queryOption - 查询结果类型枚举类。<br>
16+
* @param {Array.<SuperMap.FilterParameter>} options.queryParams - 查询过滤条件参数数组。<br>
17+
* @param {number} options.startRecord - 查询起始记录号。<br>
18+
* @param {number} options.holdTime - 资源在服务端保存的时间。<br>
19+
* @param {boolean} options.returnCustomResult - 仅供三维使用。<br>
20+
* @param {boolean} options.returnContent - 是否立即返回新创建资源的表述还是返回新资源的 URI。<br>
21+
* @param {(SuperMap.Bounds|L.Bounds|ol.extent)} options.bounds - 指定的查询范围。<br>
2322
*/
2423
export class QueryByBoundsParameters extends QueryParameters {
2524

@@ -29,17 +28,16 @@ export class QueryByBoundsParameters extends QueryParameters {
2928
}
3029
super(options);
3130
/**
32-
* @member SuperMap.QueryByBoundsParameters.prototype.returnContent -{boolean}
31+
* @member {boolean} [SuperMap.QueryByBoundsParameters.prototype.returnContent=true]
3332
* @description 是否立即返回新创建资源的表述还是返回新资源的 URI。<br>
34-
* 如果为 true，则直接返回新创建资源，即查询结果的表述。<br>
35-
* 为 false，则返回的是查询结果资源的 URI。默认为 true。
33+
* 如果为 true，则直接返回新创建资源，即查询结果的表述。<br>
34+
* 为 false，则返回的是查询结果资源的 URI。
3635
*/
3736
this.returnContent = true;
3837

3938
/**
40-
* @member SuperMap.QueryByBoundsParameters.prototype.bounds
39+
* @member {(SuperMap.Bounds|L.Bounds|ol.extent)} SuperMap.QueryByBoundsParameters.prototype.bounds
4140
* @description 指定的查询范围。<br>
42-
* Bounds类型可以是SuperMap.Bounds|L.Bounds|ol.extent。
4341
*/
4442
this.bounds = null;
4543

‎src/common/iServer/QueryByBoundsService.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {QueryByBoundsParameters} from './QueryByBoundsParameters';
77
* @class SuperMap.QueryByBoundsService
88
* @category iServer Map QueryResults
99
* @classdesc Bounds 查询服务类。
10-
* @augments SuperMap.QueryService
10+
* @augments {SuperMap.QueryService}
1111
* @example
1212
* (start end)
1313
* var myQueryByBoundsService = new SuperMap.QueryByBoundsService(url, {
@@ -19,11 +19,11 @@ import {QueryByBoundsParameters} from './QueryByBoundsParameters';
1919
* function queryCompleted(object){//todo};
2020
* function queryError(object){//todo};
2121
* (end)
22-
* @param url - {string} 服务的访问地址。如访问World Map服务，只需将url设为: http://localhost:8090/iserver/services/map-world/rest/maps/World+Map 即可。
23-
* @param options - {Object} 互服务时所需可选参数。如：<br>
24-
* eventListeners - {Object} 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。<br>
25-
* serverType - {SuperMap.ServerType} 服务器类型，iServer|iPortal|Online。<br>
26-
* format -{SuperMap.DataFormat} 查询结果返回格式，目前支持iServerJSON 和GeoJSON两种格式。参数格式为"ISERVER","GEOJSON"。
22+
* @param {string} url - 服务的访问地址。如访问World Map服务，只需将url设为: http://localhost:8090/iserver/services/map-world/rest/maps/World+Map 即可。
23+
* @param {Object} options - 参数。<br>
24+
* @param {Object} options.eventListeners - 事件监听器对象。有processCompleted属性可传入处理完成后的回调函数。processFailed属性传入处理失败后的回调函数。<br>
25+
* @param {SuperMap.ServerType} options.serverType - 服务器类型，iServer|iPortal|Online。<br>
26+
* @param {SuperMap.DataFormat} options.format - 查询结果返回格式，目前支持iServerJSON 和GeoJSON两种格式。参数格式为"ISERVER"，"GEOJSON"。
2727
*/
2828
export class QueryByBoundsService extends QueryService {
2929

@@ -43,8 +43,8 @@ export class QueryByBoundsService extends QueryService {
4343
* @function SuperMap.QueryByBoundsService.prototype.getJsonParameters
4444
* @description 将查询参数转化为 JSON 字符串。
4545
* 在本类中重写此方法，可以实现不同种类的查询（sql, geometry, distance, bounds 等）。
46-
* @param params - {SuperMap.QueryByBoundsParameters} Bounds 查询参数。
47-
* @return {Object} 转化后的 JSON 字符串。
46+
* @param {SuperMap.QueryByBoundsParameters} params - Bounds 查询参数。
47+
* @returns {Object} 转化后的 JSON 字符串。
4848
*/
4949
getJsonParameters(params) {
5050
if (!(params instanceof QueryByBoundsParameters)) {

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