Network

类: geoscene/networks/Network
继承于: Network Accessor
子类: UtilityNetwork
起始版本: GeoScene API for JavaScript 4.22

定义描述公用事业网络和跟踪网络的高级属性的类。

示例:

属性列表

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

完整的网络定义,只有在加载网络后才能访问。

更多信息Network
String更多信息

后端数据库中定义的网络物理数据集名称。

更多信息Network
String更多信息

类名。

更多信息Accessor
String更多信息

返回此网络所属的根要素服务 url。

更多信息Network
Extent更多信息

网络的完整范围,从用于创建网络的服务区域定义。

更多信息Network
String更多信息

用于标识 webmap 规范中定义的网络的随机唯一 ID (UUID)。

更多信息Network
Number更多信息

网络的层 ID。

更多信息Network
String更多信息

网络地图规范中定义的网络层 ID 的完整 url。

更多信息Network
Boolean更多信息

网络实例是否已加载。

更多信息Network
Error更多信息

如果加载时发生错误,则返回 Error 对象。

更多信息Network
String更多信息

表示加载操作的状态。

更多信息Network
Object[]更多信息

加载时发生的警告列表。

更多信息Network
String更多信息

返回网络服务器的 url。

更多信息Network
String更多信息

网络的门户用户所有者。

更多信息Network
String更多信息

将 url 转换为 url 对象

更多信息Network
Number更多信息

网络的架构版本。

更多信息Network
Object更多信息更多信息Network
SpatialReference更多信息

网络的空间参考,在创建网络时定义,通常来自服务区域类。

更多信息Network
String更多信息

网络地图规范中定义的网络名称。

更多信息Network
String更多信息

数据集的类型。

更多信息Network

属性详细说明

dataElement Object

完整的网络定义,只有在加载网络后才能访问。

datasetName Stringreadonly

后端数据库中定义的网络物理数据集名称。 仅在加载网络时才可访问。

declaredClass Stringreadonly inherited

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

featureServiceUrl Stringreadonly

返回此网络所属的根要素服务 url。

示例代码:
`https://utilitynetwork.geosceneonline.cn/server/rest/services/NapervilleElectric/FeatureServer/`
fullExtent Extent

网络的完整范围,从用于创建网络的服务区域定义。

id String

用于标识 webmap 规范中定义的网络的随机唯一 ID (UUID)。 在共享网络地图期间生成。

layerId Numberreadonly

网络的层 ID。

layerUrl String

网络地图规范中定义的网络层 ID 的完整 url。 例如 https://utilitynetwork.geoscene.cn/server/rest/services/NapervilleElectric/FeatureServer/17 (其中 17 是网络的层 ID)

loaded Booleanreadonly

指示网络实例是否已加载。 如果为  true,则可以访问对象的所有属性。

默认值:false
loadError Errorreadonly

如果加载时发生错误,则返回 Error 对象。

默认值:null
loadStatus Stringreadonly

表示加载操作的状态。

描述
not-loaded

对象的资源尚未加载。

loading

对象的资源当前正在加载。

loaded

对象的资源已加载且没有错误。

failed 无法加载对象的资源。 有关详细信息,请参阅 loadError

可选值:"not-loaded"|"loading"|"failed"|"loaded"

默认值:not-loaded
loadWarnings Object[]readonly

加载时发生的警告列表。

networkServiceUrl Stringreadonly

返回网络服务器的 url。

示例代码:
`https://utilitynetwork.geoscene.cn/server/rest/services/NapervilleElectric/UtilityNetworkServer/`
owner Stringreadonly

网络的门户用户所有者。 此门户用户可以对网络执行管理操作。

parsedUrl Stringreadonly

将 url 转换为 url 对象

schemaGeneration Numberreadonly

网络的架构版本。 网络的每个版本都引入了新的特性和功能。 

sourceJSON Object
spatialReference SpatialReference

网络的空间参考,在创建网络时定义,通常来自服务区域类。

title String

网络地图规范中定义的网络名称。 表示在共享 web 地图时定义的网络图层的图层名称。

type Stringreadonly

数据集的类型。 如果对象表示公共设施网络,则返回“utility”;如果网络是跟踪网络,则返回“trace”。

可选值:"utility"|"trace"

默认值:utility

方法列表

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

如果load()操作已经在进行中,则取消它。

更多信息Network
*更多信息

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

更多信息Network
Number更多信息

网络由源(类)组成,每个源都有一个唯一的 ID。

更多信息Network
Boolean更多信息

isFulfilled()可用于验证创建类的实例是否已完成(已解决或已拒绝)。

更多信息Network
Boolean更多信息

isRejected() 可用于验证创建类的实例是否被拒绝。

更多信息Network
Boolean更多信息

isResolved() 可用于验证创建类的实例是否已解决。

更多信息Network
Promise更多信息

触发网络实例的加载。

更多信息Network
Promise更多信息

加载此类引用的资源。

更多信息Network
Object更多信息

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

更多信息Network
Promise更多信息

一旦创建了类的实例,就可以利用 when() 。

更多信息Network

方法详细说明

cancelLoad()

如果 load() 操作已经在进行中,则取消它。

fromJSON(json){*}static

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

参数:
json Object

GeoScene 格式的实例的 JSON 表示。

返回值:
类型 描述
*

返回此类的新实例。

getLayerIdBySourceId(id){Number}

网络由源(类)组成,每个源都有一个唯一的 ID。 这些源 ID 用于在网络拓扑中执行遍历。 跟踪端点不知道层,只返回结果源。 此方法返回给定源 ID 的 layerId。 用作处理跟踪结果的辅助方法。

参数:
id Number

源的 ID。

返回值:
类型 描述
Number

图层 ID。

isFulfilled(){Boolean}

isFulfilled() 可用于验证创建类的实例是否已完成(已解决或已拒绝)。 如果满足,则返回  true 

返回值:
类型 描述
Boolean 指示创建类的实例是否已完成(无论成功或失败)。
isRejected(){Boolean}

isRejected() 可用于验证创建类的实例是否被拒绝。 如果被拒绝,则返回  true 

返回值:
类型 描述
Boolean

创建类的实例是否已被拒绝。

isResolved(){Boolean}

isResolved() 可用于验证创建类的实例是否已解决。 如果已解决,将返回 true

返回值:
类型 描述
Boolean 创建类的实例是否已解决。
load(){Promise}

触发网络实例的加载。

完全加载网络定义和所有相关对象(例如跟踪配置)

返回值:
类型 描述
Promise 网络加载解析。
load(signal){Promise}

加载此类引用的资源。 如果视图是使用地图实例构造的,则此方法会自动为 视图 及其在 Map 中引用的所有资源执行。

开发人员在访问不会在 视图 中加载的资源时必须调用此方法。

load() 方法仅在第一次调用时触发资源的加载。 随后的调用返回相同的promise。

可以提供一个signal 来停止对  Loadable 实例的加载状态感兴趣。 当信号中止时,实例不会停止其加载过程,只有 cancelLoad 可以中止它。

参数:
signal AbortSignal
可选

可用于中止异步任务的信号对象。 当发出中止信号时,返回的 Promise 将被一个名为  AbortError错误拒绝。 另请参阅 AbortController以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回值:
类型 描述
Promise 资源已加载时解析。
toJSON(){Object}

将此类的实例转换为其 GeoScene 门户 JSON 表示。 有关更多信息,请参阅使用 fromJSON() 指南主题。

返回值:
类型 描述
Object

此类实例的 JSON 表示。

when(callback, errback){Promise}

一旦创建了类的实例,就可以利用when() 。 这个方法有两个输入参数:一个callback 函数和一个 errback函数。 callback 在类的实例加载时执行。 如果类的实例无法加载,则执行  errback 

参数:
callback Function
可选

当 promise 解决时调用的函数。

errback Function
可选

当 promise 失败时执行的函数。

返回值:
类型 描述
Promise 返回 callback 结果的新 promise,可用于链接其他函数。 
示例代码:
// 尽管此示例使用 MapView,但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let view = new MapView(); view.when(function(){ // 一旦 promise 被解决,这个函数就会执行
}, function(error){ // 如果 promise 由于错误而被拒绝,此函数将执行
});

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