Circle

AMD: require(["geoscene/geometry/Circle"], (Circle) => { /* code goes here */ });
ESM: import Circle from "@geoscene/core/geometry/Circle";
类: geoscene/geometry/Circle
继承于:Circle Polygon Geometry Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.0

圆是通过指定中心点半径创建的多边形。该点可提供为 Point 对象或纬度/经度值数组。

中心点的 SpatialReference 将确定圆的空间参考。如果提供经度/纬度坐标数组作为中心点,则空间参考将默认为 WGS84 (wkid 4326)。不能设置圆本身的 spatialReference 属性。它必须始终在中心点中进行设置。

另请参阅
示例
const circleGeometry = new Circle({
  center: [ -113, 36 ],
  geodesic: true,
  numberOfPoints: 100,
  radius: 100,
  radiusUnit: "kilometers"
});

view.graphics.add(new Graphic({
  geometry: circleGeometry,
  symbol: {
    type: "simple-fill",
    style: "none",
    outline: {
      width: 3,
      color: "red"
    }
  }
}));

构造函数

new Circle(properties)
参数
properties Object
optional

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

属性概述

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

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

更多详情
Geometry
Point

圆的中心点。

更多详情
Circle
Point

多边形的质心。

更多详情
Polygon
String

类的名称。

更多详情
Accessor
Extent

几何的范围。

更多详情
Geometry
Boolean

当中心点的空间参考设置为以下值时适用:Web 墨卡托 (wkid: 3857) 或地理/测地线 (wkid: 4326)。

更多详情
Circle
Boolean

指示几何是否具有 M 值。

更多详情
Geometry
Boolean

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

更多详情
Geometry
Boolean

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

更多详情
Polygon
Number

此值用于定义沿圆曲线的点数。

更多详情
Circle
Number

圆的半径。

更多详情
Circle
String

半径的单位。

更多详情
Circle
Number[][][]

环的数组。

更多详情
Polygon
SpatialReference

几何的空间参考。

更多详情
Geometry
String

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

更多详情
Polygon

属性详细信息

cache Objectreadonly inherited

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

Autocasts from Object|Number[]

圆的中心点。中心点必须指定为或经度/纬度坐标数组。中心点的空间参考将决定圆的空间参考。如果提供经度/纬度坐标数组,则空间参考将默认为 WGS84 (wkid 4326)。

centroid Point inherited

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

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

extent Extentreadonly inherited

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

geodesic Boolean

当中心点的空间参考设置为以下值时适用:Web 墨卡托 (wkid: 3857) 或地理/测地线 (wkid: 4326)。当使用这些空间参考中的任何一个时,可将测地线设置为 true 以最大限度地减少失真。其他坐标系不会创建测地圆。

默认值:false

指示几何是否具有 M 值。

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

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

isSelfIntersecting Boolean inherited

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

numberOfPoints Number

此值用于定义沿圆曲线的点数。

默认值:60
radius Number

圆的半径。

默认值:1000
radiusUnit String

半径的单位。

可能值"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"

默认值:meters

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

实例 折点数组
无 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 }
});

几何的空间参考。

默认值:WGS84 (wkid: 4326)
type Stringreadonly inherited

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

对于 Polygon,类型总是 "polygon"

方法概述

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

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

更多详情
Accessor
Polygon

向 Polygon 添加一个环。

更多详情
Polygon
Circle

创建 Circle 的深度克隆。

更多详情
Circle
Boolean

在客户端检查输入点是否在多边形内。

更多详情
Polygon
*

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

更多详情
Geometry
Point

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

更多详情
Polygon
Boolean

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

更多详情
Accessor
Polygon

将新点插入到多边形中。

更多详情
Polygon
Boolean

检查 Polygon 环是否为顺时针。

更多详情
Polygon

移除对象拥有的句柄组。

更多详情
Accessor
Point[]

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

更多详情
Polygon
Point[]

从 Polygon 移除一个环。

更多详情
Polygon
Polygon

更新多边形中的一个点。

更多详情
Polygon
Object

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

更多详情
Geometry

方法详细说明

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}inherited

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

参数

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

返回
类型 描述
Polygon 返回包含新环的多边形。
clone(){Circle}

创建 Circle 的深度克隆。

返回
类型 描述
Circle Circle 对象的新实例,其等于用于调用 .clone() 的对象。
contains(point){Boolean}inherited

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

参数
point Point

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

返回
类型 描述
Boolean 如果点位于面内,则返回 true
fromJSON(json){*}static

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

参数
json Object

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

返回
类型 描述
* 返回该类的新实例。
getPoint(ringIndex, pointIndex){Point}inherited

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

参数
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}inherited

将新点插入到多边形中。

参数
ringIndex Number

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

pointIndex Number

在环内插入的点的索引。

要插入的点。

返回
类型 描述
Polygon 返回更新的多边形。
isClockwise(ring){Boolean}inherited

检查 Polygon 环是否为顺时针。

参数

多边形环。环中的第一个和最后一个坐标/点必须相同。这可定义为点几何数组或 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[]}inherited

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

参数
ringIndex Number

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

pointIndex Number

环内要移除的点的索引。

返回
类型 描述
Point[] 返回已移除点的几何。
removeRing(index){Point[]}inherited

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

参数
index Number

要移除的环的索引。

返回
类型 描述
Point[] 返回表示已移除环的点数组。
setPoint(ringIndex, pointIndex, point){Polygon}inherited

更新多边形中的一个点。

参数
ringIndex Number

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

pointIndex Number

环内要更新的点的索引。

新点几何。

返回
类型 描述
Polygon 返回更新的多边形。
toJSON(){Object}inherited

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

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

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