Extent

属性概述

属性详细信息

cache Objectreadonly inherited

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

center Pointreadonly

范围的中心点，以地图单位表示。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

extent Extentreadonly inherited

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

hasM Booleanreadonly

指示几何是否具有 M 值。

hasZ Booleanreadonly

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

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

height Numberreadonly

以地图单位表示的范围高度 (ymin 和 ymax 之间的距离)。

mmax Number

范围包络中可能的最大 m 值。

默认值：undefined

mmin Number

范围包络中可能的最小 m 值。

默认值：undefined

spatialReference SpatialReferenceautocast inherited

几何的空间参考。

默认值：WGS84 (wkid: 4326)

type Stringreadonly

对于 Extent，类型总是 "extent"。

width Numberreadonly

以地图单位表示的范围宽度 (xmin 和 xmax 之间的距离)。

xmax Number

范围包络的最大 X 坐标。

默认值：0

xmin Number

范围包络的最小 X 坐标。

默认值：0

ymax Number

范围包络的最大 Y 坐标。

默认值：0

ymin Number

范围包络的最小 Y 坐标。

默认值：0

zmax Number

范围包络中可能的最大 z 值或高程值。

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

默认值：undefined

zmin Number

范围包络中可能的最小 z 值或高程值。

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

默认值：undefined

方法概述

方法详细说明

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

centerAt(point){Extent}

将范围居中到指定的点。此方法将就地修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。

参数

point Point 要使范围居中显示的点。

返回

类型	描述
Extent	以 point 为中心的新范围。

clone(){Extent}

创建 Extent 对象的深度克隆。

返回

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

contains(geometry){Boolean}

检查输入几何是否包含在范围内。

参数

geometry Point|Extent 输入几何以测试它是否包含在范围内。

返回

类型	描述
Boolean	如果输入几何包含在范围内，则返回 true。

equals(extent){Boolean}

指示输入范围是否等于测试范围。

参数

extent Extent 输入范围。

返回

类型	描述
Boolean	如果输入范围等于调用 equals() 的范围，则返回 true。

expand(factor){Extent}

按给定因子扩展范围。例如，值 1.5 将扩展范围，使其比原始范围大 50%。此方法将就地修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。

参数

factor Number 乘数值。

返回

类型	描述
Extent	返回扩展范围。

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

intersection(extent){Extent}

将原始范围缩小到与输入范围的交集。

此方法将就地修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。如果原始范围和输入范围没有交集，则不会修改范围并返回 null。

参数

extent Extent 要相交的输入范围。

返回

类型	描述
Extent	输入范围与原始范围或 null 的交集。

intersects(geometry){Boolean}

测试以验证输入几何是否与范围相交并返回布尔值。

参数

geometry Geometry 用于测试相交的几何。几何可以是 Point、Polyline、Polygon、Extent 或 Multipoint。

返回

类型	描述
Boolean	如果输入几何与范围相交，则返回 true。

normalize(){Extent[]}

返回一个数组，其中包含一个已移动到 +/- 180 范围内的范围，或者如果原始范围与国际日期变更线相交，则返回两个范围。

此方法将就地修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。

返回

类型	描述
Extent[]	标准化 Extent。

offset(dx, dy, dz){Extent}

使用 X 和 Y 偏移 (以地图单位为单位) 适当修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。

参数

dx Number X 坐标的偏移距离，以地图单位表示。

dy Number Y 坐标的偏移距离，以地图单位表示。

dz Number Z 坐标的偏移距离，以地图单位表示。

返回

类型	描述
Extent	偏移 Extent。

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

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

返回

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

union(extent){Extent}

扩展原始范围以包括输入范围的范围。此方法将就地修改范围几何。在适当情况下调用此方法之前，应克隆范围对象。

参数

extent Extent 并集的输入范围。

返回

类型	描述
Extent	输入 Extent 与原始 Extent 的并集。