Circle

AMD: require(["geoscene/geometry/Circle"], (Circle) => { /* 代码 */ });
ESM: import Circle from "@geoscene/core/geometry/Circle";
类: geoscene/geometry/Circle
继承于: Circle Polygon Geometry Accessor
起始版本: GeoScene API for JavaScript 4.22

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

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

另参阅:
示例代码:
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

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

center Pointautocast
自动转换自 Object|Number[]

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

centroid Point inherited

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

declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

extent Extentreadonly inherited

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

geodesic Boolean

当中心点的空间参考设置为 Web Mercator (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]
示例代码:
//具有 m 值的 3D 多边形环(请注意,第二个环没有为其定义 m 值)
const rings = [
 [  // 第一个环
  [-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]  // 与第一个顶点相同
 ], [  // 第二个环
  [-97.06326,32.759,35.4],
  [-97.06298,32.755,35.5],
  [-97.06153,32.749,35.6],
  [-97.06326,32.759,35.4]  // 与第一个顶点相同
 ]
];

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

几何的空间参考。

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

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

对于 Polygon 类型始终为 "polygon"

方法列表

展示继承方法 隐藏继承方法
名称 返回值类型 描述
Polygon更多信息

向 Polygon 添加一个环。

更多信息Polygon
Circle更多信息

创建 Circle 的深度克隆。

更多信息Circle
Boolean更多信息

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

更多信息Polygon
*更多信息

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

更多信息Geometry
Point更多信息

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

更多信息Polygon
Polygon更多信息

在多边形中插入一个新点。

更多信息Polygon
Boolean更多信息

检查 Polygon 环是否顺时针。

更多信息Polygon
Point[]更多信息

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

更多信息Polygon
Point[]更多信息

从 Polygon 中移除一个环。

更多信息Polygon
Polygon更多信息

更新多边形中的一个点。

更多信息Polygon
Object更多信息

将此类的实例转换为其 GeoScene portal JSON 格式。

更多信息Geometry

方法详细说明

addRing(points){Polygon}inherited

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

参数:

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

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

创建 Circle 的深度克隆。

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

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

参数:
point Point

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

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

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

参数:
json Object

实例的 json 表达式,以 Geoscene 格式显示。

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

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

参数:
ringIndex Number

包含所需点的环的索引。

pointIndex Number

环内所需点的索引。

返回值:
类型 描述
Point 返回指定环索引和点索引处的点。
insertPoint(ringIndex, pointIndex, point){Polygon}inherited

在多边形中插入一个新点。

参数:
ringIndex Number

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

pointIndex Number

要插入环内的点的索引。

point Point|Number[]

要插入的点。

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

检查 Polygon 环是否顺时针。

参数:

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

返回值:
类型 描述
Boolean 如果环是顺时针方向,则返回 true,逆时针方向返回 false
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

环内要更新的点的索引。

point Point|Number[]

新的点几何。

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

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息,请参阅使用 fromJSON() 指南主题。

返回值:
类型 描述
Object 此类实例的 GeoSceneportal JSON 格式。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.