Polyline

属性概述

属性详细信息

cache Objectreadonly inherited

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

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 值 用米表示。然而，在使用投影坐标系的局部场景中，垂直单位假定为与服务指定的水平单位相同。

paths Number[][][]

构成折线的路径数组或线段。每个路径都是一个二维数字数组，表示视图空间参考中路径每个折点的坐标。每个折点表示为由两个、三个或四个数字组成的数组。下表显示了折点数组的各种结构。

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

示例

// 2D polyline with to paths with m-values (note that the 2nd path does not have m-values defined)
let paths = [
 [  // first path
  [-97.06138,32.837,5],
  [-97.06133,32.836,6],
  [-97.06124,32.834,7]
 ], [  // second path
  [-97.06326,32.759],
  [-97.06298,32.755]
 ]
];

let line = new Polyline({
  hasZ: false,
  hasM: true,
  paths: paths,
  spatialReference: { wkid: 4326 }
});

spatialReference SpatialReferenceautocast inherited

几何的空间参考。

默认值：WGS84 (wkid: 4326)

type Stringreadonly

对于 Polyline，类型总是 "polyline"。

方法概述

方法详细说明

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

addPath(points){Polyline}

将路径或线段添加到折线。添加时，路径的索引将递增 1。

参数

points Point[]|Number[][] 折线路径。这可定义为点几何数组或 XY 坐标数组。

返回

类型	描述
Polyline	返回包含新路径的折线。

clone(){Polyline}

创建 Polyline 对象的深度克隆。

返回

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

fromJSON(json){*}static

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

参数

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

返回

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

getPoint(pathIndex, pointIndex){Point}

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

参数

pathIndex Number 折线中路径的索引。

pointIndex Number 路径中点的索引。

返回

类型	描述
Point	返回位于给定路径和点索引处的沿 Polyline 的点。

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(pathIndex, pointIndex, point){Polyline}

将新点插入到折线中。

参数

pathIndex Number 要在其中插入点的路径的索引。

pointIndex Number 路径中插入点的索引。

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

返回

类型	描述
Polyline	返回更新的折线。

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

removePath(index){Point[]}

从折线中移除路径。索引指定要移除的路径。

参数

index Number 要从折线中移除的路径的索引。

返回

类型	描述
Point[]	返回一个表示已移除路径的点数组。

removePoint(pathIndex, pointIndex){Point}

在给定 pathIndex 标识的路径内，在给定 pointIndex 处从折线上移除一个点。

参数

pathIndex Number 包含要移除的点的路径的索引。

pointIndex Number 路径中要移除的点的索引。

返回

类型	描述
Point	返回已移除的点。

setPoint(pathIndex, pointIndex, point){Polyline}

更新折线中的点。

参数

pathIndex Number 包含要更新的点的路径的索引。

pointIndex Number 路径中要更新的点的索引。

point Point|Number[] 路径中要更新的点几何。

返回

类型	描述
Polyline	返回更新的折线。

toJSON(){Object}inherited

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

返回

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