Class: FacilityAnalystStreamParameters

FacilityAnalystStreamParameters

上游/下游关键设施查找资源参数类。上游/下游关键设施查找是指查找给定弧段或节点的上游/下游中的关键设施结点。 此类用于设置上游/下游关键设施查找中的设施点、分析类型、弧段或结点等参数，还可以对不确定流向是否有效进行设置。

new FacilityAnalystStreamParameters(options)

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

</script>

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

new FacilityAnalystStreamParameters(options);
common/iServer/FacilityAnalystStreamParameters.js, line 6
Name Type Description
options Object

参数。

Name Type Default Description
sourceNodeIDs Array.<number>

指定的设施点 ID 数组。
queryType number

分析类型，只能是 0 (上游关键设施查询) 或者是 1（下游关键设施查询）。
returnFeatures boolean true 可选

是否返回结果要素的详细描述信息。若为 false，只返回结果要素的 ID 集合。
edgeID number 可选

指定的弧段 ID，edgeID 与 nodeID 必须指定一个。
nodeID number 可选

指定的结点 ID，edgeID 与 nodeID 必须指定一个。
isUncertainDirectionValid boolean false 可选

指定不确定流向是否有效。

Members

edgeIDnumber

指定的弧段 ID，edgeID 与 nodeID 必须指定一个。

isUncertainDirectionValidboolean

指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行； 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。

nodeIDnumber

指定的结点 ID，edgeID 与 nodeID 必须指定一个。

queryTypenumber

分析类型，只能是 0 (上游关键设施查询) 或者是 1（下游关键设施查询）。

sourceNodeIDsArray.<number>

指定的设施点 ID 数组。

Methods

destroy()

common/iServer/FacilityAnalystStreamParameters.js, line 66

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