RelationshipContent

RelationshipContent 弹窗元素表示与要素相关联的关系元素。只有将相关图层或表添加到地图时，才能配置此元素。

RelationshipContent 提供了一种在弹出窗口中浏览当前选定要素的相关记录的方法，如下图所示。Origin Feature 图像显示了一个配置有 RelationshipContent 的弹出窗口模板。在列表中选择一个相关要素时，将显示所选相关目标要素的弹出窗口模板。Related Destination Feature 图像显示配置有 FieldsContent 和 RelationshipContent 的目标弹出模板 content。当浏览相关要素的 RelationshipContent 时，可以导航到该要素的相关记录，或使用箭头按钮退出原始要素的相关记录浏览。

原始要素	相关目标要素

注

• 还必须将相关图层或表添加到地图中，才能配置 RelationshipContent。
• 不支持编辑相关记录。
• 相关记录列表中最多只能显示 10 个相关要素。

另请参阅

• PopupTemplate
• Content

示例

// Create the RelationshipContent popup element
const relationshipContent = new RelationshipContent({
  relationshipId: 3,
  title: "Cities in {COUNTY_NAME}",
  description: "All the cities that reside in {COUNTY_NAME}.",
  displayCount: 3,
  // Autocasts as new array of RelatedRecordsInfoFieldOrder objects
  orderByFields: [{
    field: "CITY",
    order: "asc"
  }]
});

// Create the RelationshipContent popup element
// and add it to the popup template content for the layer.
layer.popupTemplate.content = [{
  // Autocasts as new RelationshipContent object
  type: "relationship",
  relationshipId: 1,
  title: "Hydrant Maintenance Inspections",
  description: "Hydrant maintenance inspections for {expression/asset}",
  displayCount: 5,
  // Autocasts as new array of RelatedRecordsInfoFieldOrder objects
  orderByFields: [{
    field: "INSTALLDATE",
    order: "desc"
  }]
}];

构造函数

new RelationshipContent(properties)

参数

properties Object optional 有关可能传递给构造函数的所有属性的列表，请参见属性。

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

description String

详细描述关系的内容。

displayCount Number

一个数字值，指示要在相关记录列表中显示的相关要素的最大数量。在相关记录列表中显示的最大相关记录数为 10。如果未指定值，则 Show all 按钮将可用于显示所有相关记录。

displayType String

一个字符串值，指示如何显示关系内容中的相关记录。

值	描述
list	显示指定关系的相关记录列表。

对于 RelationshipContent，displayType 总是 "list"。

默认值："list"

orderByFields RelatedRecordsInfoFieldOrder[]

RelatedRecordsInfoFieldOrder 的数组，指示相关记录的显示顺序以及这些记录应按升序 asc 还是降序 desc 排序。

relationshipId Number

已定义关系的数字 id 值。如果 supportsRelationshipResource 为 true，则可在服务本身或服务的关系资源上找到该值。

title String

指示关系内容所表示的内容的标题。

type Stringreadonly

显示的弹出元素的类型。

对于 RelationshipContent，类型总是 "relationship"。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){this}

创建此对象的深度克隆。任何通过引用存储值的属性都将被分配克隆实例上引用值的副本。

返回

类型	描述
this	调用此方法的类实例的深度克隆。

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