Polygon

属性概述

属性详细信息

cache Objectreadonly inherited

缓存用于存储从几何中计算的值，这些值需要在发生突变时清除或重新计算。例如，面的范围。

centroid Point

多边形的质心。对于具有多个环的多边形，它表示最大环的质心。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

extent Extentreadonly inherited

几何的范围。对于点，范围为空。

hasM Boolean inherited

指示几何是否具有 M 值。

hasZ Boolean inherited

指示几何是否具有 z 值 (高程)。

在地理或公制坐标系中定义的 Z 值 用米表示。然而，在使用投影坐标系的局部场景中，垂直单位假定为与服务指定的水平单位相同。

isSelfIntersecting Boolean

检查多边形环是否相互交叉，并指示多边形是否自相交，这意味着多边形的环自行交叉。

rings Number[][][]

环的数组。每个环都是一个二维数字数组，表示视图空间参考中环的每个折点的坐标。每个环的第一个折点应始终与最后一个折点相同。每个折点都是由两个、三个或四个数字组成的数组。下表显示了折点数组的各种结构。

实例	折点数组
无 z 值且无 m 值	[x, y]
无 z 值但具有 m 值	[x, y, m]
具有 z 值但无 m 值	[x, y, z]
具有 z 值且具有 m 值	[x, y, z, m]

示例

//3D polygon rings with m-values (note that the second ring does not have m-values defined for it)
const rings = [
 [  // first ring
  [-97.06138,32.837,35.1,4.8],
  [-97.06133,32.836,35.2,4.1],
  [-97.06124,32.834,35.3,4.2],
  [-97.06138,32.837,35.1,4.8]  // same as first vertex
 ], [  // second ring
  [-97.06326,32.759,35.4],
  [-97.06298,32.755,35.5],
  [-97.06153,32.749,35.6],
  [-97.06326,32.759,35.4]  // same as first vertex
 ]
];

const polygon = new Polygon({
  hasZ: true,
  hasM: true,
  rings: rings,
  spatialReference: { wkid: 4326 }
});

spatialReference SpatialReferenceautocast inherited

几何的空间参考。

默认值：WGS84 (wkid: 4326)

type Stringreadonly

表示几何类型的字符串值。

对于 Polygon，类型总是 "polygon"。

方法概述

方法详细说明

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

addRing(points){Polygon}

向 Polygon 添加一个环。环可以是以下值之一：数字数组或点数组。添加时，环的索引递增 1。

参数

points Point[]|Number[][] 多边形环。环中的第一个和最后一个坐标/点必须相同。这可定义为点几何数组或 XY 坐标数组。

返回

类型	描述
Polygon	返回包含新环的多边形。

clone(){Polygon}

创建 Polygon 对象的深度克隆。

返回

类型	描述
Polygon	Polygon 对象的新实例，其等于用于调用 .clone() 的对象。

contains(point){Boolean}

在客户端检查输入点是否在多边形内。多边形线上的点被视为内部点。

参数

point Point 用于测试它是否包含在测试面中的点。

返回

类型	描述
Boolean	如果点位于面内，则返回 true。

fromExtent(extent){Polygon}static

将给定范围转换为 Polygon 实例。这对于要将感兴趣区域 (通常由范围或边界框定义) 显示为视图中带有填充符号的面的场景非常有用。某些地理处理工具要求输入几何为 Polygon 类型而不是 Extent。

参数

extent Extent 要转换为面的范围对象。

返回

类型	描述
Polygon	表示给定范围的面实例。

示例

view.on("click", function(evt) {
  const area = Polygon.fromExtent(view.extent);
  const graphic = new Graphic({
    geometry: area,
    symbol: { type: "simple-fill" }
  });
  view.graphics.add(graphic);
});

fromJSON(json){*}static

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

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

getPoint(ringIndex, pointIndex){Point}

返回由环指定的点和路径中的点。

参数

ringIndex Number 包含所需点的环的索引。

pointIndex Number 环内所需点的索引。

返回

类型	描述
Point	返回指定环索引和点索引处的点。

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

insertPoint(ringIndex, pointIndex, point){Polygon}

将新点插入到多边形中。

参数

ringIndex Number 要在其中插入点的环的索引。

pointIndex Number 在环内插入的点的索引。

point Point|Number[] 要插入的点。

返回

类型	描述
Polygon	返回更新的多边形。

isClockwise(ring){Boolean}

检查 Polygon 环是否为顺时针。

参数

ring Point[]|Number[][] 多边形环。环中的第一个和最后一个坐标/点必须相同。这可定义为点几何数组或 XY 坐标数组。

返回

类型	描述
Boolean	如果环是顺时针方向，则返回 true，如果是逆时针方向，则返回 false。

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

removePoint(ringIndex, pointIndex){Point[]}

在由 ringIndex 标识的环内，在给定 pointIndex 处从多边形上移除一个点。

参数

ringIndex Number 包含要移除点的环的索引。

pointIndex Number 环内要移除的点的索引。

返回

类型	描述
Point[]	返回已移除点的几何。

removeRing(index){Point[]}

从 Polygon 移除一个环。索引指定要移除的环。

参数

index Number 要移除的环的索引。

返回

类型	描述
Point[]	返回表示已移除环的点数组。

setPoint(ringIndex, pointIndex, point){Polygon}

更新多边形中的一个点。

参数

ringIndex Number 包含要更新点的环的索引。

pointIndex Number 环内要更新的点的索引。

point Point|Number[] 新点几何。

返回

类型	描述
Polygon	返回更新的多边形。

toJSON(){Object}inherited

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。