TraceParameters

AMD: require(["geoscene/rest/networks/support/TraceParameters"], (TraceParameters) => { /* code goes here */ });
ESM: import TraceParameters from "@geoscene/core/rest/networks/support/TraceParameters";
类: geoscene/rest/networks/support/TraceParameters
继承于:TraceParameters Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.20

确定如何执行追踪分析所需的参数列表。这包括追踪位置、类型、追踪配置、结果类型、输出和许多其他参数。

另请参阅

构造函数

new TraceParameters(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

要执行函数的地理数据库版本。

更多详情
TraceParameters
Date

在给定时间执行函数的日期/时间戳 (以 UTC 为单位)。

更多详情
TraceParameters
String

命名追踪配置的 globalId (UUID) 在网络中保持不变。

更多详情
TraceParameters
SpatialReference

应该用于投影追踪返回的聚合几何的空间参考 (如果适用)。

更多详情
TraceParameters
Object[]更多详情TraceParameters
TraceConfiguration

定义追踪的属性

更多详情
TraceParameters
TraceLocation[]

定义追踪开始和停止位置的起点和障碍列表。

更多详情
TraceParameters
String

在此追踪配置中定义的追踪类型。

更多详情
TraceParameters

属性详细信息

declaredClass Stringreadonly inherited

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

gdbVersion String

要执行函数的地理数据库版本。如果未提供版本,则默认为 SDE.DEFAULT

moment Date

在给定时间执行函数的日期/时间戳 (以 UTC 为单位)。这可用于在过去的某个时刻或在长事务模式 (撤消/重做) 下运行该函数。仅适用于分支版本化数据集。

namedTraceConfigurationGlobalId String

命名追踪配置的 globalId (UUID) 在网络中保持不变。

outSpatialReference SpatialReference

应该用于投影追踪返回的聚合几何的空间参考 (如果适用)。

resultTypes Object[]
traceConfiguration TraceConfiguration

定义追踪的属性

traceLocations TraceLocation[]

定义追踪开始和停止位置的起点和障碍列表。如果 NamedTraceConfiguration 中的 minStartingPoints 设置为 none,则此参数可以是可选的 (默认为空数组)。

traceType String

在此追踪配置中定义的追踪类型。

可能值"connected"|"upstream"|"downstream"|"shortest-path"|"subnetwork"|"subnetwork-controllers"|"loops"|"isolation"

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
*

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

更多详情
TraceParameters
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为 GeoScene Portal JSON 表示。

更多详情
TraceParameters

方法详细说明

addHandles(handleOrHandles, groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

fromJSON(json){*}static

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

参数
json Object

GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档

返回
类型 描述
* 返回该类的新实例。
hasHandles(groupKey){Boolean}inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组,则返回 true。

参数
groupKey *
optional

组键。

返回
类型 描述
Boolean 如果存在指定的句柄组,则返回 true
示例
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数
groupKey *
optional

要移除的组键或组键的数组或集合。

示例
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息