Association

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

公共设施网络关联可对资产之间的连通性、包含和结构关系进行建模。Association 连接两个网络元素,即 "From" 和 "To",以及关联事项的顺序。此类可定义关联及其基本属性。

另请参阅
示例
// Utility network service url
const networkServiceUrl = "https://myserver.geosceneonline.cn/server/rest/services/NapervilleElectric/UtilityNetworkServer";

// Define the QueryAssociationsParameters
const queryAssociationsParameters = new QueryAssociationsParameters({
  associationTypes: ["containment", "attachment", "junction-edge-from-connectivity"],
  elements: [
    {
      networkSourceId: 2,
      globalId: "{46B3FA19-2237-4D38-A7CF-AA34C3T40420}",
      objectId: 44,
      terminalId: 1,
      assetGroupCode: 1,
      assetTypeCode: 1
    },
    {
      networkSourceId: 9,
      globalId: "{321C0089-1165-42D9-K45B-ED91B1A40500}",
      objectId: 45,
      terminalId: 1,
      assetGroupCode: 13,
      assetTypeCode: 441
    }
 ]
});

// Query associations, and assign the query result to a variable of type QueryAssociationsResult
const queryAssociationsResult = await queryAssociations(networkServiceUrl, queryAssociationsParameters);

// Print out the first association
console.log(queryAssociationsResult.associations[0]);

构造函数

new Association(properties)
参数
properties Object
optional

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

属性概述

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

关联的类型。

更多详情
Association
String

类的名称。

更多详情
Accessor
Number

服务器为失败的关联查询返回的错误代码。

更多详情
Association
String

服务器为失败的关联查询返回的消息。

更多详情
Association
NetworkElement

关联的自端网络元素。

更多详情
Association
String

关联记录的 globalId (UUID),唯一标识此关联行。

更多详情
Association
Boolean

指定地图上的内容可见性。

更多详情
Association
Polyline

在两个网络元素之间创建的合成 polyline 几何。

更多详情
Association
Number

此为值为 0-1 的双参数,表示沿追踪位置所在线的百分比。

更多详情
Association
Number

指示要素或对象参与的关联类型、网络要素在关联关系中扮演的角色以及设置的任何属性。

更多详情
Association
NetworkElement

关联的至端网络元素。

更多详情
Association

属性详细信息

associationType String

关联的类型。可以合成的关联是 attachmentconnectivitycontainment。方案版本 4 中还引入了非空间关联。这些将在 4.20 之后添加

可能值"attachment"|"connectivity"|"containment"

declaredClass Stringreadonly inherited

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

errorCode Number

服务器为失败的关联查询返回的错误代码。

errorMessage String

服务器为失败的关联查询返回的消息。

fromNetworkElement NetworkElement

关联的自端网络元素。包含 globalid、网络源和终端。

globalId String

关联记录的 globalId (UUID),唯一标识此关联行。

isContentVisible Boolean

指定地图上的内容可见性。

在两个网络元素之间创建的合成 polyline 几何。

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
status Number

指示要素或对象参与的关联类型、网络要素在关联关系中扮演的角色以及设置的任何属性。

toNetworkElement NetworkElement

关联的至端网络元素。包含 globalid、网络源和终端。

方法概述

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

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

更多详情
Accessor
*

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

更多详情
Association
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
Association

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

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

// 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

如果存在指定的句柄组,则返回 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

移除对象拥有的句柄组。

参数
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 表示。

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