Class: TraceAnalystParameters

TraceAnalystParameters

上游/下游追踪分析参数类。

new TraceAnalystParameters(options)

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

</script>

// ES6 Import
import { TraceAnalystParameters } from '@supermap/iclient-leaflet';

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

参数。

Name Type Default Description
traceType number

分析类型，只能是 0 (上游追踪分析) 或者是 1 (下游追踪分析)。
edgeID number 可选

【与nodeID必填一项】需查找上游设施的弧段 ID 。
nodeID number 可选

【与edgeID必填一项】需查找上游设施的结点 ID 。
weightName string 可选

权重字段。
returnFeatures boolean true 可选

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

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

当使用 FlatGeobuf 表述时该参数可选。表示返回的表述为 FlatGeobuf 的结果是否包含空间索引，默认为true。
Version:
  • 11.1.1

Members

edgeIDnumber

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

isUncertainDirectionValidboolean

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

nodeIDnumber

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

returnFeaturesboolean

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

Default Value:
true

traceTypenumber

分析类型，只能是 0 (上游追踪分析) 或者是 1（下游追踪分析）。

weightNamestring

权重字段。

withIndexboolean

当使用 FlatGeobuf 表述时该参数可选。表示返回的表述为 FlatGeobuf 的结果是否包含空间索引，默认为true。

Methods

destroy()

common/iServer/TraceAnalystParameters.js, line 73

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