UtilityNetworkTraceViewModel

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

defaultGraphicColor GraphicColor

起始版本：GeoScene API for JavaScript 4.23

用于指定追踪结果的聚合几何的默认颜色。

默认值：{ color: [255, 255, 0, 0.6], haloOpacity: 0.9, fillOpacity: 0.2, hex: "#FFFF00" }

flags FlagProperty[]

要加载到微件中以查找标志的映射点数组。

默认值：[]

示例：

const unt = new UtilityNetworkTrace({
 view: view,
 showSelectionAttributes: true,
 selectOnComplete: true,
 showGraphicsOnComplete: true,
 selectedTraces: ["{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}"],
 flags: [
   {
     type: "starting-point",
     mapPoint: {
       spatialReference: { latestWkid: 3857, wkid: 102100 },
       x: -9814829.166046409,
       y: 5127094.1017433
     }
   },
   {
     type: "barrier",
     mapPoint: {
     spatialReference: { latestWkid: 3857, wkid: 102100 },
       x: -9814828.449441982,
       y: 5127089.085566963
     }
   }
 ]
});

gdbVersion String

要传递到追踪中的地理数据库版本。

默认值：PictureMarkerSymbol

goToOverride GoToOverride

此函数提供了重写 MapView goTo() 或 SceneView goTo() 方法的功能。

另请参阅：

• MapView
• SceneView

示例：

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

selectedTraces String[]

要在初始加载时选择的追踪的全局 ID 数组。

默认值：[]

selectOnComplete Boolean

如果为 true，则在追踪完成后在视图中选择公共设施网络元素。

默认值：true

showGraphicsOnComplete Boolean

如果为 true，则将图形图层添加到视图中，以便在追踪完成时高亮显示公共设施网络元素。

默认值：true

showSelectionAttributes Boolean

确定是否显示已完成追踪中所选要素的列表。

默认值：true

state Stringreadonly

视图模型的状态。

可能的值："loading"|"ready"

默认值：ready

view MapView

微件将从中操作的视图。

方法概述

方法详细信息

addFlagByHit(type){Promise<boolean>}

如果要查询要素，则为视图上的单击事件添加标志点图形。

参数：

type String 标志的类型可以是 "starting point" 或 "barrier"。

返回：

类型	说明
Promise<boolean>	解析后，响应是 true 视图中是否存在要查询的要素。

addResultGraphicToView(trace, color){Promise}

在视图的图形上为追踪返回的所有要素的聚合结果创建图形。

参数：

trace TraceResultExtend 追踪配置设置的聚合以及该追踪的结果。

color GraphicColor 追踪图形的颜色会在视图的图形中生成。

返回：

类型	说明
Promise	在将图形添加到视图时解析。

addTerminal(selectedTerminal, feature)

将选定的终端添加到标志点。

参数：

selectedTerminal String 所选终端的终端 id。

feature FlagProperty 用于分配终端的标志。

callTrace(){Promise<boolean>}

获取在执行追踪之前选择要运行的追踪类型的所有参数。

返回：

类型	说明
Promise<boolean>	解析后，响应是 true 当追踪类型中的参数已加载时。

changeResultGraphicColor(color, trace)

更改追踪的聚合结果的图形颜色。

参数：

color GraphicColor 追踪图形的颜色会在视图的图形中生成。

trace TraceResultExtend 追踪配置设置的聚合以及该追踪的结果。

checkCanTrace(){ValidSetup}

可用于验证是否满足执行追踪的所有要求（至少选择了 1 个起点和至少 1 个追踪类型）。

返回：

类型	说明
ValidSetup	表示追踪设置是否正确。

checkSelectionExist(){Boolean}

指示视图上是否存在任何选择。

返回：

类型	说明
Boolean	如果视图上存在选定内容，则返回 true。

clearResult(trace)

从结果中删除特定跟踪。这还将清除该追踪的视图中的任何图形或选定内容。

参数：

trace TraceItem 将清除的追踪。

executeTrace(traceItem, url, params){Promise<TraceResultExtend>}

执行追踪并将所有追踪结果作为图形和/或要素选择和函数返回。

参数：

traceItem TraceItem 追踪的追踪项输入。

url String 要追踪的服务的 URL。

params TraceParameters 追踪输入参数。

返回：

类型	说明
Promise<TraceResultExtend>	表示追踪结果及其属性。

getValidSources(){Array<(EdgeSourceJSON|JunctionSourceJSON)>}

获取视图中属于公共设施网络的有效边图层和交汇点图层，这些图层可用于在视图中放置标志。

返回：

类型	说明
Array<(EdgeSourceJSON|JunctionSourceJSON)>	边或交汇点图层信息。

loadUtilityNetwork(){Promise<UtilityNetwork>}

读取 web 地图并加载 UtilityNetwork（如果存在）。

返回：

类型	说明
Promise<UtilityNetwork>	在加载 UtilityNetwork 时解析。

manageFilterBarrier(status, feature)

启用或禁用屏障标志上的过滤器屏障设置。

参数：

status Boolean 过滤器屏障是启用还是禁用。

feature FlagProperty 为其启用或禁用筛选器屏障的屏障标志。

mergeSelection(status, trace)

用于在运行多个追踪时合并图层视图中的要素选择。

参数：

status Boolean 如果为 true，则追踪选择结果是合并选择集的一部分。

trace TraceItem 为其定义状态的追踪。

queryFeaturesById(dataItems){Promise<FeatureSetInfo[]>}

按 ObjectID 查询图层，以获取追踪结果元素上不存在的更多属性。

参数：

dataItems NetworkElement[] NetworkElement 的数组。

返回：

类型	说明
Promise<FeatureSetInfo[]>	解析后，将返回一个 FeatureSetInfo 数组。

queryFlagByHitTest(e, flagType){Promise<boolean>}

获取命中测试的结果以查找资产，以便为追踪创建标志。

参数：

e ClickEvent 单击事件。

flagType String 标志的类型。它必须是 "starting point" 或 "barrier"。

返回：

类型	说明
Promise<boolean>	解析后，对于成功的 hitTest，返回 true。

removeFlag(flag)

从视图中删除选定的标志。

参数：

flag FlagProperty 标识要删除的标志的 FlagProperty 。

removeResultGraphicFromView(trace)

从视图的图形中删除特定的追踪结果图形。

参数：

trace TraceResultExtend 将删除图形的追踪。

removeSelection()

从图层视图中移除所选内容。

removeTerminal(selectedTerminal, feature)

从标志中删除选定的终端。

参数：

selectedTerminal String 所选终端的终端 id。

feature FlagProperty 用于删除终端的标志。

reset()

清除视图中的所有输入（标志、追踪类型）和所有结果（选择、图形）。

selectFeaturesById(resultSet)

基于 ObjectID 列表对图层视图执行选择。

参数：

resultSet NetworkElement[] NetworkElement 的数组。

selectResults(resultSet)

遍历追踪结果元素以按网络源 id 对其进行分组，并在图层视图中选择它们。

参数：

resultSet NetworkElement[] NetworkElement 的数组。

selectTraces(state, traceId)

设置要从 WebMap 中的可用追踪配置中运行的追踪类型。

参数：

state Boolean 如果选择了跟踪，则为 true。

traceId String 追踪配置的 globalid 。

selectTracesOnLoad()

预设要在加载微件时从 WebMap 中的可用追踪配置中运行的追踪类型。

zoomToAsset(geometry)

缩放至视图中标志的要素或结果要素。

参数：

geometry GoToTarget2D|GoToTarget3D 要缩放到的几何。

类型定义

AssetGroupJSON Object

AssetGroupJSON 表示资产群组。资产群组是子类型字段，表示公共设施网络类的主要分类。

属性：

assetGroupCode Number 资产群组代码。

assetGroupName String 资产群组名称。

assetTypes AssetTypeJSON[] 资产类型。

AssetTypeJSON Object

AssetTypeJSON 表示资产类型。属性域在每个网络类的子类型级别的资产类型字段上分配。它表示公共设施网络类的次要分类。

属性：

assetTypeCode Number 资产类型代码。

assetTypeName String 资产类型名称。

terminalConfigurationId Number 终点站配置的 id 。

DisplayField Object

显示字段表示用作标志和所选要素的显示标注的属性字段。

属性：

field String 要素的显示字段。

value String 字段的值。

EdgeSourceJSON Object

EdgeSourceJSON 表示参与公共设施网络服务的线图层。

属性：

layerId Number 线图层的图层 id。

assetGroups AssetGroupJSON[] 线图层的资产群组属性值。

sourceId Number 线图层的网络源 id。

FeatureSetInfo Object

FeatureSetInfo 表示要素集中结果的信息。

属性：

layer FeatureLayer 数据集的 FeatureLayer。

featureSet FeatureSet FeatureSet。

FlagProperty Object

FlagProperty 表示用于定义每个标志点（起点和障碍）的属性。

属性：

allTerminals TerminalConfiguration 可用的终端，用于根据终端配置定义允许的路径。始终设置默认终端。

details any hitTest 返回的所有信息。

displayField DisplayField 标志的显示字段。

id Number 标志的 id。

mapGraphic Graphic 标志图形。

mapPoint Point 标志的几何点。

selectedTerminals Number[] 为标志选择的终端（可以是最终用户选择的一个或多个默认终端）。

type String 正在设置的标志类型。它必须是 "starting point" 或 "barrier"。 可能值 值 说明 starting-point 标志集将是追踪的起始位置。 barrier 标志集将标记停止追踪的位置。

GraphicColor Object

图形颜色表示图形图层中追踪结果图形的颜色。

属性：

color Number[] 视图中追踪结果图形的颜色。

haloOpacity Number 图形符号的光晕的不透明度。

hex String 颜色选取器中追踪结果图形的颜色。

JunctionSourceJSON Object

JunctionSourceJSON 表示参与公共设施网络服务的点图层。

属性：

layerId Number 点图层的图层 id。

assetGroups AssetGroupJSON[] 点图层的资产群组属性值。

sourceId Number 点图层的网络源 id。

TraceItem Object

TraceItem 扩展了命名的追踪配置，并添加了一个属性来管理视图上的选择。

属性：

selected Boolean 如果视图上有用于追踪的选定内容，则返回 true 。

TraceResultExtend Object

TraceResultExtend 根据追踪配置和追踪结果来组织结果。

属性：

TraceItem TraceItem TraceItem 扩展了命名的追踪配置，并添加了一个属性来管理视图上的选择。

TraceResult TraceResult 从追踪返回的结果的集合。

selectionEnabled Boolean 如果启用了选择，则返回 true。

graphicEnabled Boolean 如果启用了图形，则返回 true。

graphicColor GraphicColor 追踪图形的颜色将在图形图层中显示。

status String 要从服务器返回错误的追踪的当前状态。

ValidSetup Object

ValidSetup 在追踪可以执行之前验证追踪是否满足所有要求。

属性：

status Boolean 如果满足要求是 true。

issues String[] 缺少要求的错误消息数组。