QueryAssociationsParameters

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

QueryAssociationsParameters 可描述执行 queryAssociations() 函数所需的参数,该函数返回由参数集过滤的关联列表。

另请参阅
示例
// Utility network service url
const networkServiceUrl = "https://myserver.geoscene.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 QueryAssociationsParameters(properties)
参数
properties Object
optional

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

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
NetworkElement[]

查询关联的 NetworkElements

更多详情
QueryAssociationsParameters
String

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

更多详情
QueryAssociationsParameters
Date

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

更多详情
QueryAssociationsParameters
Boolean

指定是否返回逻辑删除的关联。

更多详情
QueryAssociationsParameters
String[]

指定要查询的关联类型数组。

更多详情
QueryAssociationsParameters

属性详细信息

declaredClass Stringreadonly inherited

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

查询关联的 NetworkElements

gdbVersion String

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

moment Date

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

另请参阅
returnDeletes Boolean

指定是否返回逻辑删除的关联。

默认值:false
types String[]

指定要查询的关联类型数组。它以字符串数组的形式提供。

交汇点-边连通性关联用于在点要素或交汇点对象与边对象之间的建立关系。

  • Junction-edge from connectivity
  • Junction-edge midspan connectivity
  • Junction-edge to connectivity

这些关联类型允许在非空间交汇点和边对象之间建立连通性,并提供了一种使用边对象对非交汇点要素之间的连通性进行建模的附加方法。

可能值

描述
connectivity 允许对两个不重合的要素之间或空间要素与非空间连接和边对象之间的连通性进行建模。
attachment 允许对网络中的支撑结构和附件进行建模。
containment 允许由单个要素表示的密集要素集合。
junction-edge-from-connectivity 交汇点-边自连通性。
junction-midspan-connectivity 交汇点-边中跨连通性。
junction-edge-to-connectivity 交汇点-边至连通性。
另请参阅

方法概述

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

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

更多详情
Accessor
*

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

更多详情
QueryAssociationsParameters
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
QueryAssociationsParameters

方法详细说明

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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

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

groupKey *
optional

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
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 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。