TraceLocation

AMD: require(["geoscene/rest/networks/support/TraceLocation"], (TraceLocation) => { /* 代码 */ });
ESM: import TraceLocation from "@geoscene/core/rest/networks/support/TraceLocation";
类: geoscene/rest/networks/support/TraceLocation
继承于: TraceLocation Accessor
起始版本: GeoScene API for JavaScript 4.22

要执行追踪分析,用户可以选择以 globalIds (UUID) 和终端的形式提供位置列表。这些位置指示追踪应该从哪里开始(也称为起点)和应该在哪里结束(障碍) 。起始位置可以应用于所有网络道路源。

示例:

构造函数

new TraceLocation(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
String更多信息

类名。

更多信息Accessor
String更多信息

要启动或停止追踪的要素的 globalId (UUID)。

更多信息TraceLocation
Boolean更多信息

这指示当追踪尝试查找上游控制器时是否应跳过(过滤)此屏障起始位置。

更多信息TraceLocation
Number更多信息

这个值为 0-1 的双参数表示沿起始位置所在线的百分比。

更多信息TraceLocation
Number更多信息

放置起始位置的终端 ID。

更多信息TraceLocation
String更多信息

追踪位置的类型;starting-point定义追踪应该从哪里开始,barrier定义追踪应该在哪里停止。

更多信息TraceLocation

属性详细说明

declaredClass Stringreadonly inherited

类名。类的名称声明格式为 geoscene.folder.className

globalId String

要启动或停止追踪的要素的 globalId (UUID)。

isFilterBarrier Boolean

这指示当追踪尝试查找上游控制器时是否应跳过(过滤)此屏障起始位置。如果遇到此障碍,将其设置为false将停止追踪。当设置为true时,追踪将暂时跳过障碍以查找任何上游控制器并相应地过滤掉输出。仅适用于基于子网的追踪类型。


默认值:false
percentAlong Number

这个值为 0-1 的双参数表示沿起始位置所在线的百分比。仅适用于线要素。

示例代码:
Line feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elements
F-j1, j1-j2 and j2-T.

                                       OID=100
                               F------j1------j2------T

F-j1  (objectId=100, positionFrom=0, positionTo=0.33)
j1-j2 (objectId=100, positionFrom=0.33, positionTo=0.66)
j2-T  (objectId=100, positionFrom=0.66, positionTo=1)

When percentAlong is 0.5 (50%) the starting location will be placed on the middle edge (j1-j2)

                                       OID=100
                               F------j1---x--j2------T

When percentAlong is 0.1 (10%) the starting location will be placed on the first edge (F-j1)

                                       OID=100
                               F-x----j1------j2------T
terminalId Number

放置起始位置的终端 ID。仅适用于节点/设备源。用户可以UtilityNetwork中使用 getTerminalConfiguration()来获取终端。

示例:
type String

追踪位置的类型;starting-point定义追踪应该从哪里开始,barrier定义追踪应该在哪里停止。

可选值:"starting-point"|"barrier"

方法列表

属性 返回值类型 描述
*更多信息

创建此类的新实例并使用从 GeoScene产品生成的 JSON 对象的值对其进行初始化。

更多信息TraceLocation
Object更多信息

将此类的实例转换为其 GeoScene portal JSON 格式。

更多信息TraceLocation

方法详细说明

fromJSON(json){*}static

创建此类的新实例,并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入 json 参数的对象通常来自对 REST API 中的查询操作的响应,或者来自另一个 GeoScene产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例,请参阅指南中的 使用 fromJSON() 主题。

参数:
json Object

实例的 json 表达式,以geoscene 格式显示。

返回值:
类型 描述
* 返回一个该类的新实例。
toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息,请参阅 使用 fromJSON() 指南。

返回值:
类型 描述
Object 此类实例的 GeoScene portal JSON 格式。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.