Class: FindClosestFacilitiesParameters

FindClosestFacilitiesParameters

最近设施分析参数类。此类用于设置最近设施分析中的事件点、设施点、期望查找的设施点数量、权值的最大限值以及交通网络分析中的通用参数等。
最近设施分析指在网络上给定一个事件点和一组设施点,查找从事件点到设施点(或从设施点到事件点)以最小耗费能到达的最佳路径。

new FindClosestFacilitiesParameters(options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/openlayers/iclient-ol.js"></script>
<script>
  new ol.supermap.FindClosestFacilitiesParameters(options);
  
  // 弃用的写法
  new SuperMap.FindClosestFacilitiesParameters(options);

</script>

// ES6 Import
import { FindClosestFacilitiesParameters } from '@supermapgis/iclient-ol';

new FindClosestFacilitiesParameters(options);

common/iServer/FindClosestFacilitiesParameters.js, line 7
Name Type Description
options Object

参数。

Name Type Default Description
event GeometryPoint | L.LatLng | L.Point | ol.geom.Point | mapboxgl.LngLat | mapboxgl.Point | Array.<number>

事件点,一般为需要获得服务设施服务的事件位置。

facilities Array.<(GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|mapboxgl.Point|Array.<number>)>

设施点集合,一般为提供服务的服务设施位置。

expectFacilityCount number 1 可选

要查找的设施点数量。

fromEvent boolean false 可选

是否从事件点到设施点进行查找。

isAnalyzeById boolean false 可选

事件点和设施点是否通过节点 ID 号来指定。

maxWeight number 0 可选

权值的最大限值。单位与该类中 parameter 字段(交通网络分析通用参数)中设置的耗费字段一致。

parameter TransportationAnalystParameter 可选

交通网络分析通用参数。

Members

事件点,一般为需要获得服务设施服务的事件位置。 可以通过两种方式赋予事件点:当该类中字段 isAnalyzeById = true 时,应输入事件点 ID 号;当 isAnalyzeById = false 时,应输入事件点坐标。

expectFacilityCountnumber

要查找的设施点数量。

Default Value:
1

设施点集合,一般为提供服务的服务设施位置。 可以通过两种方式赋予设施点:当该类中字段 isAnalyzeById = true 时,应输入设施点 ID 号;当 isAnalyzeById = false 时,应输入设施点坐标。

fromEventboolean

是否从事件点到设施点进行查找。最近设施分析主要是通过设施点和事件点之间最优的路线来分析在一定范围内哪个或哪些设施与事件点有最优路线的关系。 这个行走线路是通过网络图层进行网络分析算法计算出来的两点间的最优路线。由于存在从 A 点到 B 点与从 B 点到 A 点的耗费不一样的情况,因此起止点不同可能会得到不同的最优路线。因此在进行最近设施分析之前,需要设置获取的最优路线的方向,即是以事件点作为起点到最近设施点的方向分析,还是以最近设施点为起点到事件点的方向分析。如果需要以事件点作为起点到设施点方向进行查找,设置该字段值为 true;设置为 false,表示从设施点到事件点进行查找。

isAnalyzeByIdboolean

事件点和设施点是否通过节点 ID 号来指定,设置为 false,表示通过坐标点指定事件点和设施点。

maxWeightnumber

权值的最大限值。单位与该类中 parameter 字段(交通网络分析通用参数)中设置的耗费字段一致。 例如事件发生点是一起交通事故,要求查找在 10 分钟内能到达的最近医院,超过 10 分钟能到达的都不予考虑。 那么需要将网络分析参数中 parameter.weightFieldName 设置为表示时间的字段,然后设置查找范围的半径值为 10。

交通网络分析通用参数。通过本类可以设置障碍边、障碍点、权值字段信息的名称标识、转向权值字段等信息。 它虽然为可选参数,但是如果不设置其中的 resultSetting 字段,则返回结果空间信息等都为空。

Methods

destroy()

common/iServer/FindClosestFacilitiesParameters.js, line 79

释放资源,将引用资源的属性置空。