ImageSampleParameters

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

geometry Point|Multipoint|Polyline|Extent|Polygonautocast

自动转换自 Object

定义要采样的位置的输入几何。几何可以是点、多点、折线、范围或多边形。

如果几何是 multipoint，则 locations 属性可用于设置 points 数组以便使用。如果您设置了 locations 属性，则点数组将在运行时转换为 multipoint 几何。

interpolation String

定义如何插值像素值。

可能值："nearest"|"bilinear"|"cubic"|"majority"

默认值：nearest

locations Point[]

在对多个位置进行采样时，您可以使用点数组，而不是为几何属性提供多点。点数组将转换为 multipoint，并在运行时用作几何。第一个点的空间参考用于 getSamples 操作。

mosaicRule MosaicRuleautocast

自动转换自 Object

指定定义图像排序顺序和选择内容的镶嵌规则。当未指定镶嵌规则时，将使用 ImageryLayer 上的当前设置。

outFields String[]

与要包含在响应中的栅格相关联的字段列表。

默认值：null

pixelSize PixelSizeautocast

自动转换自 Object

指定将用于采样的像素大小 (或分辨率)。如果未指定像素大小，则 pixelSize 将默认为影像图层的基本分辨率。镶嵌数据集中指定像素大小的栅格将用于此操作。

returnFirstValueOnly Boolean

为 true 时，返回每个采样点位置处满足指定条件的第一个有效像素值。当为 false 时，返回所有像素值。

默认值：true

sampleCount Number

当输入几何为折线、面或范围时，指定要从提供的几何中采样的大致位置数。需要 sampleDistance 或 sampleCount 对输入折线执行增密操作以采样点。几何空间参考的单位将用于增密操作。

sampleDistance Number

当输入几何为折线时，指定从提供的几何采样点的距离间隔。需要 sampleDistance 或 sampleCount 对输入折线执行增密操作以采样点。几何空间参考的单位将用于增密操作。

sliceId Number

指定多维栅格的切片 ID。GeoScene Server 3.0 及更高版本支持此参数。

timeExtent TimeExtentautocast

自动转换自 Object

执行采样的时间范围。GeoScene Server 3.0 及更高版本支持此参数。

方法概述

方法详细说明

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

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

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}

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

返回

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