RelationParameters

属性概述

属性详细信息

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

geometries1 Geometry[]

用于计算关联的第一个几何数组。数组中每个几何的结构与 GeoScene REST API 返回的 json 几何对象的结构相同。

geometries2 Geometry[]

用于计算关联的第二个几何数组。数组中每个几何的结构与 GeoScene REST API 返回的 json 几何对象的结构相同。

relation String

两个输入几何数组之间要进行测试的空间关系。有关可能值列表，请参见下表。如果将关系指定为 relation，则 relationParameter 参数可描述空间关系，并且必须指定。

值	描述
cross	如果两条折线仅共享多个公共点 (其中至少有一个不是端点)，则它们相交。如果一条折线与一个多边形在多边形内部共享一段公共折线 (不等于整条折线)，则它们相交。Cross 是 Clementini 运算符。如果任一几何为空，则几何不会交叉。
disjoint	如果两个几何的交点为空，则它们是不相交的。如果 disjoint 为 "false"，则两个几何相交。
in	如果基础几何是几何的交集并且它们内部的交集不为空，则基础几何在比较几何内。空几何位于另一个几何中，除非另一个几何也是空的。
interior-intersection	几何相交，不包括边界接触。
intersection	几何内部相交或边界相接，与 'not disjoint' 相同。
line-coincidence	几何边界必须共享一个交集，但不考虑形状内部之间的关系 (它们可能重叠，一个可能包含在另一个中，或者它们的内部可能不相交)。此关系适用于折线和多边形。
line-touch	当几何的交集不为空，但它们的内部交集为空时，则称这两个几何相接触。这会评估接触是否沿边界（而不是点）发生。对多边形有效。
overlap	两条折线共享一个公共子线，或者两个多边形共享一个公共子区域。如果任一几何为空，则两个几何不重叠。
point-touch	当几何的交集不为空，但它们的内部交集为空时，则称这两个几何相接触。这会评估接触是否发生在某个点 (而不是边界)。
relation	允许使用形状比较语言定义的任何关系的规范。如果使用此值，则必须指定 relationParameter 的值。
touch	点接触与线接触的并集。当几何的交集不为空，但它们的内部交集为空时，则称这两个几何相接触。例如，仅当点与折线端点之一重合时，该点才与折线接触。如果两个几何中的任何一个为空，则这些几何不会被接触。
within	与 in 相同，但允许在多边形中考虑严格位于多边形边界上的折线。

可能值："cross"|"disjoint"|"in"|"interior-intersection"|"intersection"|"line-coincidence"|"line-touch"|"overlap"|"point-touch"|"relation"|"touch"|"within"

relationParameter String

该字符串描述了当 RelationParameters.relation = 'relation' 时要测试的空间关系。有关更多详细信息，请参阅 ST_Geometry 的关系函数主题。有效字符串示例为：FFFTTT**。另请参阅 geometryEngine.relate() 的描述以获取有效字符串的其他示例。

方法概述

方法详细说明

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

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

起始版本：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 表示。