Skip to content

Commit e5d71e8

Browse files
Wenxinyu1998Wenxinyu1998
committed
[fix]文档注释修改 remain review by jinny
1 parent fad9ecf commit e5d71e8

26 files changed

+29
-56
lines changed

‎src/common/commontypes/Bounds.js

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -452,20 +452,16 @@ export class Bounds {
452452

453453
/**
454454
* @function Bounds.prototype.intersectsBounds
455-
* @description 判断目标边界范围是否与当前边界范围相交。如果两个边界范围中的任意
456-
* 边缘相交或者一个边界包含了另外一个就认为这两个边界相交。
455+
* @description 判断目标边界范围是否与当前边界范围相交。如果两个边界范围中的任意边缘相交或者一个边界包含了另外一个就认为这两个边界相交。
457456
* @example
458457
* var bounds = new Bounds(-180,-90,100,80);
459458
* var isIntersects = bounds.intersectsBounds(
460459
* new Bounds(-170,-90,120,80)
461460
* );
462461
* @param {Bounds} bounds - 目标边界。
463462
* @param {Object} options - 参数。
464-
* @param {boolean} [options.inclusive=true] - 边缘重合也看成相交。如果是false，
465-
* 两个边界范围没有重叠部分仅仅是在边缘相接（重合），
466-
* 这种情况被认为没有相交。
467-
* @param {Bounds} [options.worldBounds] - 提供了 worldBounds 参数, 如果他们相交时
468-
* 是在全球范围内, 两个边界将被视为相交。这仅适用于交叉或完全不在世界范围的边界。
463+
* @param {boolean} [options.inclusive=true] - 边缘重合也看成相交。如果是false，两个边界范围没有重叠部分仅仅是在边缘相接（重合），这种情况被认为没有相交。
464+
* @param {Bounds} [options.worldBounds] - 提供了 worldBounds 参数，如果他们相交时是在全球范围内，两个边界将被视为相交。这仅适用于交叉或完全不在世界范围的边界。
469465
* @returns {boolean} 传入的 bounds 对象与当前 bounds 相交。
470466
*/
471467
intersectsBounds(bounds, options) {

‎src/common/commontypes/Event.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,7 @@
269269
},
270270

271271
/**
272-
* @description 移除事件监听和注册的事件处理方法。注意：事件的移除和监听相对应，移除时的各属性信息必须监听时
273-
* 保持一致才能确保事件移除成功。
272+
* @description 移除事件监听和注册的事件处理方法。注意：事件的移除和监听相对应，移除时的各属性信息必须监听时保持一致才能确保事件移除成功。
274273
* @param {(HTMLElement|string)} elementParam - 被监听的 DOM 元素或者其 ID。
275274
* @param {string} name - 需要移除的被监听事件名称。
276275
* @param {function} observer - 需要移除的事件处理方法。

‎src/common/commontypes/Events.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,7 @@ export class Events {
8282

8383
/**
8484
* @member {boolean} [Events.prototype.includeXY=false]
85-
* @description 判断是否让 xy 属性自动创建到浏览器上的鼠标事件，一般设置为 false，如果设置为 true，鼠标事件将会在事件传递过程中自动产生 xy 属性。
86-
* 可根据事件对象的 'evt.object' 属性在相关的事件句柄上调用 getMousePosition 函数。这个选项习惯默认为 false 的原因在于，当创建一个
87-
* 事件对象，其主要目的是管理。在一个 div 的相对定位的鼠标事件，将其设为 true 也是有意义的。这个选项也可以用来控制是否抵消缓存。如果
88-
* 设为 false 不抵消，如果设为 true，用 this.clearMouseCache() 清除缓存偏移（边界元素偏移，元素在页面的位置偏移）。
85+
* @description 判断是否让 xy 属性自动创建到浏览器上的鼠标事件，一般设置为 false，如果设置为 true，鼠标事件将会在事件传递过程中自动产生 xy 属性。可根据事件对象的 'evt.object' 属性在相关的事件句柄上调用 getMousePosition 函数。这个选项习惯默认为 false 的原因在于，当创建一个事件对象，其主要目的是管理。在一个 div 的相对定位的鼠标事件，将其设为 true 也是有意义的。这个选项也可以用来控制是否抵消缓存。如果设为 false 不抵消，如果设为 true，用 this.clearMouseCache() 清除缓存偏移（边界元素偏移，元素在页面的位置偏移）。
8986
* @example
9087
* function named(evt) {
9188
* this.xy = this.object.events.getMousePosition(evt);

‎src/common/iServer/DatasourceConnectionInfo.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {EngineType} from '../REST'; // eslint-disable-line no-unused-vars
1010
* @category iServer Data Datasource
1111
* @classdesc 数据源连接信息类。该类包括了进行数据源连接的所有信息，如所要连接的服务器名称、数据库名称、用户名以及密码等。
1212
* 当保存为工作空间时，工作空间中的数据源的连接信息都将存储到工作空间文件中。对于不同类型的数据源，其连接信息有所区别。
13-
* 所以在使 用该类所包含的成员时，请注意该成员所适用的数据源类型。对于从数据源对象中返回的数据连接信息对象，只有 connect 方法可以被修改，
13+
* 所以在使用该类所包含的成员时，请注意该成员所适用的数据源类型。对于从数据源对象中返回的数据连接信息对象，只有 connect 方法可以被修改，
1414
* 其他内容是不可以被修改的。对于用户创建的数据源连接信息对象，其内容都可以修改。
1515
* @param {Object} options - 参数。
1616
* @param {string} options.alias - 数据源别名。

‎src/common/iServer/FacilityAnalyst3DParameters.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ import {Util} from '../commontypes/Util';
99
* @category iServer FacilityAnalyst3D
1010
* @classdesc 最近设施分析参数基类。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点（或从设施点到事件点）以最小耗费能到达的最佳路径。
1111
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在 10 分钟内能到达的最近医院，
12-
* 超过 10 分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起
13-
* 作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
12+
* 超过 10 分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
1413
* @param {Object} options - 参数。
1514
* @param {string} options.weightName - 指定的权值字段信息对象的名称。
1615
* @param {number} [options.edgeID] - 指定的弧段 ID，edgeID 与 nodeID 必须指定一个。

‎src/common/iServer/FacilityAnalystSinks3DParameters.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
88
* @deprecatedclass SuperMap.FacilityAnalystSinks3DParameters
99
* @category iServer FacilityAnalyst3D Sinks
1010
* @classdesc 最近设施分析参数类(汇查找资源)。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11-
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分钟
12-
* 能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、
13-
* 转向表、耗费等属性在最近设施分析时同样可设置。
11+
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
1412
* @extends {FacilityAnalyst3DParameters}
1513
* @param {Object} options - 参数。
1614
* @param {string} options.weightName - 指定的权值字段信息对象的名称。

‎src/common/iServer/FacilityAnalystSources3DParameters.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
88
* @deprecatedclass SuperMap.FacilityAnalystSources3DParameters
99
* @category iServer FacilityAnalyst3D Sources
1010
* @classdesc 最近设施分析参数类(源查找资源)。最近设施分析是指在网络上给定一个事件点和一组设施点，查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。
11-
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分
12-
* 钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍
13-
* 点、转向表、耗费等属性在最近设施分析时同样可设置。
11+
* 设施点一般为学校、超市、加油站等服务设施；事件点为需要服务设施的事件位置。例如事件发生点是一起交通事故，要求查找在10分钟内能到达的最近医院，超过10分钟能到达的都不予考虑。此例中，事故发生地即是一个事件点，周边的医院则是设施点。最近设施查找实际上也是一种路径分析，因此对路径分析起作用的障碍边、障碍点、转向表、耗费等属性在最近设施分析时同样可设置。
1412
* @extends {FacilityAnalyst3DParameters}
1513
* @param {Object} options - 参数。
1614
* @param {string} options.weightName - 指定的权值字段信息对象的名称。

‎src/common/iServer/FacilityAnalystStreamService.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { FacilityAnalystStreamParameters } from './FacilityAnalystStreamParamete
99
* @class FacilityAnalystStreamService
1010
* @deprecatedclass SuperMap.FacilityAnalystStreamService
1111
* @category iServer NetworkAnalyst UpstreamCirticalFaclilities
12-
* @classdesc 上游/下游 关键设施查找资源服务类；即查找给定弧段或节点的上游/下游中的关键设施结点，返回关键结点 ID 数组及其下游弧段 ID 数组。
12+
* @classdesc 上游/下游 关键设施查找资源服务类：即查找给定弧段或节点的上游/下游中的关键设施结点，返回关键结点 ID 数组及其下游弧段 ID 数组。
1313
* @extends NetworkAnalystServiceBase
1414
* @param {string} url - 服务地址。请求网络分析服务，URL应为：
1515
* http://{服务器地址}:{服务端口号}/iserver/services/{网络分析服务名}/rest/networkanalyst/{网络数据集@数据源}；

‎src/common/iServer/FindClosestFacilitiesParameters.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@ export class FindClosestFacilitiesParameters {
4646
/**
4747
* @member {boolean} [FindClosestFacilitiesParameters.prototype.fromEvent=false]
4848
* @description 是否从事件点到设施点进行查找。最近设施分析主要是通过设施点和事件点之间最优的路线来分析在一定范围内哪个或哪些设施与事件点有最优路线的关系。
49-
* 这个行走线路是通过网络图层进行网络分析算法计算出来的两点间的最优路线。由于存在从 A 点到 B 点与从 B 点到 A 点的耗费不一样的情况，因此起止点
50-
* 不同可能会得到不同的最优路线。因此在进行最近设施分析之前，需要设置获取的最优路线的方向，即是以事件点作为起点到最近设施点的方向分析，还是以最
51-
* 近设施点为起点到事件点的方向分析。如果需要以事件点作为起点到设施点方向进行查找，设置该字段值为 true；设置为 false，表示从设施点到事件点进行查找。
49+
* 这个行走线路是通过网络图层进行网络分析算法计算出来的两点间的最优路线。由于存在从 A 点到 B 点与从 B 点到 A 点的耗费不一样的情况，因此起止点不同可能会得到不同的最优路线。因此在进行最近设施分析之前，需要设置获取的最优路线的方向，即是以事件点作为起点到最近设施点的方向分析，还是以最近设施点为起点到事件点的方向分析。如果需要以事件点作为起点到设施点方向进行查找，设置该字段值为 true；设置为 false，表示从设施点到事件点进行查找。
5250
*/
5351
this.fromEvent = false;
5452

‎src/common/iServer/FindTSPPathsParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {TransportationAnalystParameter} from './TransportationAnalystParameter';
1111
* @classdesc 旅行商分析参数类。
1212
* 旅行商分析是路径分析的一种，它从起点开始（默认为用户指定的第一点）查找能够遍历所有途经点且花费最小的路径。
1313
* 旅行商分析也可以指定到达的终点，这时查找从起点能够遍历所有途经点最后到达终点，且花费最小的路径。
14-
* 旅行商分析和最佳路径分析都是在网络中寻找遍历所有站点的最经济的路径，区别是在遍历网络所有站点的过程中对结点访问顺序不同
14+
* 旅行商分析和最佳路径分析都是在网络中寻找遍历所有站点的最经济的路径，区别是在遍历网络所有站点的过程中对结点访问顺序不同。
1515
* 最佳路径分析必须按照指定顺序对站点进行访问，而旅行商分析是无序的路径分析。
1616
* @param {Object} options - 参数。
1717
* @param {boolean} [options.endNodeAssigned=false] - 是否指定终止点，将指定的途经点的最后一个点作为终止点。true 表示指定终止点，则旅行商必须最后一个访问终止点。

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