ImageIdentifyParameters

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

imageService 的输入参数。

另请参阅

构造函数

new ImageIdentifyParameters(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
Point|Polygon

定义要标识的位置的输入几何。

更多详情
ImageIdentifyParameters
Number

控制返回的目录项的最大数量,设置为 1 将仅返回最上面的栅格。

更多详情
ImageIdentifyParameters
MosaicRule

指定定义图像排序顺序的镶嵌规则。

更多详情
ImageIdentifyParameters
PixelSize

指定在 x 和 y 轴上标识的像素级别。

更多详情
ImageIdentifyParameters
Boolean

当为 true 时,将处理所有变量和维度的请求。

更多详情
ImageIdentifyParameters
RasterFunction

指定应如何渲染请求影像的渲染规则。

更多详情
ImageIdentifyParameters
RasterFunction

渲染规则数组,用于检索多个已处理的像素值。

更多详情
ImageIdentifyParameters
Boolean

如果为 true,则返回目录项的几何和属性。

更多详情
ImageIdentifyParameters
Boolean

true 时,目录项中的每个要素都包含几何。

更多详情
ImageIdentifyParameters
Boolean

如果为 true,则返回请求几何下所有栅格目录项目的像素值。

更多详情
ImageIdentifyParameters
TimeExtent

时态数据相对于时间感知型影像图层的时间范围。

更多详情
ImageIdentifyParameters

属性详细信息

declaredClass Stringreadonly inherited

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

geometry Point|Polygon

定义要标识的位置的输入几何。该位置可以是点或多边形。

maxItemCount Number

控制返回的目录项的最大数量,设置为 1 将仅返回最上面的栅格。

指定定义图像排序顺序的镶嵌规则。未指定镶嵌规则时,使用 center

指定在 x 和 y 轴上标识的像素级别。未指定时,默认为数据集的基本分辨率。

processAsMultidimensional Boolean
起始版本:GeoScene Maps SDK for JavaScript 4.23

当为 true 时,将处理所有变量和维度的请求。将返回所有切片的像素值以及描述切片的额外属性。如果为 false,则仅针对第一个或选定的切片处理请求。它仅适用于多维服务。此功能仅适用于使用 GeoScene Server 3.0 或更高版本发布的影像服务。

默认值:false

指定应如何渲染请求影像的渲染规则。

renderingRules RasterFunction

渲染规则数组,用于检索多个已处理的像素值。

returnCatalogItems Boolean

如果为 true,则返回目录项的几何和属性。当不需要目录项目以显著提高识别操作的性能时,请将其设置为 false

returnGeometry Boolean

true 时,目录项中的每个要素都包含几何。当为 false 时,地图上不会显示要素。

默认值:false
returnPixelValues Boolean

如果为 true,则返回请求几何下所有栅格目录项目的像素值。当不需要目录项目值以显著提高识别操作的性能时,请将其设置为 false

时态数据相对于时间感知型影像图层的时间范围。例如,它可用于发现土地在十年间的覆被变化。

方法概述

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

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

更多详情
Accessor
*

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

更多详情
ImageIdentifyParameters
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
ImageIdentifyParameters

方法详细说明

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 表示。

类型定义

PixelSize Object

指定像素大小 (或分辨率)。镶嵌数据集中指定像素大小的栅格将用于 ImageryLayer 上的标识直方图统计数据计算。

属性

沿 x 轴的一个像素的大小,以地图单位表示。

沿 y 轴的一个像素的大小,以地图单位表示。

spatialReference Object
optional

要用于请求的空间参考。如果未指定,将使用影像服务的空间参考。

规范
wkid Number
optional

空间参考的 wkid。

wkt Number
optional

空间参考的熟知文本或 wkt。

另请参阅
示例
// set the pixel size parameter to match the current
// resolution of the view and spatial reference
let pixelSize = {
  x:view.resolution,
  y:view.resolution,
  spatialReference: {
    wkid: view.spatialReference.wkid
  }
}
// set the histogram parameters to request
// data for the current view extent and resolution
let params = new ImageHistogramParameters({
  geometry:  view.extent,
  pixelSize: pixelSize
});

// request for histograms for the specified parameters
layer.computeHistograms(params).then(function(results){
  // results are returned and process it as needed.
  console.log("histograms", results);
})
.catch(function(err){
  console.log("err", err)
});

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