IdentifyParameters

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

identify 的输入参数。

另请参阅

构造函数

new IdentifyParameters(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
Number

当前地图视图的分辨率,以每英寸点数为单位。

更多详情
IdentifyParameters
String

指定待搜索的地理数据库版本。

更多详情
IdentifyParameters
Geometry

用于在标识操作期间选择要素的几何。

更多详情
IdentifyParameters
Number

指定任务返回的几何中的小数位数。

更多详情
IdentifyParameters
Number

View 的高度,以像素为单位。

更多详情
IdentifyParameters
Number[]

要在其中执行标识操作的图层。

更多详情
IdentifyParameters
String

指定使用识别时要使用的图层。

更多详情
IdentifyParameters
Extent

当前地图视图的范围或边界框。

更多详情
IdentifyParameters
Number

用于概化标识操作返回的几何的最大允许偏移量。

更多详情
IdentifyParameters
Boolean

如果为 true,将返回字段名而不是字段别名。

更多详情
IdentifyParameters
Boolean

如果为 true,则结果集包括与每个结果相关联的几何。

更多详情
IdentifyParameters
Boolean

当为 true 时,表示将返回 M 值。

更多详情
IdentifyParameters
Boolean

如果为 true,则不会格式化结果中的值。

更多详情
IdentifyParameters
Boolean

当为 true 时,则表示将返回 z 值。

更多详情
IdentifyParameters
SpatialReference

输入和输出几何的空间参考以及 mapExtent

更多详情
IdentifyParameters
Sublayer[]

Sublayer 对象的集合,用于更改图层排序和/或渲染,或重新定义地图。

更多详情
IdentifyParameters
TimeExtent

指定标识使用的时间范围。

更多详情
IdentifyParameters
Number

应在其中执行识别的指定几何之间的距离 (以屏幕像素为单位)。

更多详情
IdentifyParameters
Number

当前地图视图的宽度,以像素为单位。

更多详情
IdentifyParameters

属性详细信息

declaredClass Stringreadonly inherited

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

dpi Number

当前地图视图的分辨率,以每英寸点数为单位。

默认值:96
gdbVersion String

指定待搜索的地理数据库版本。

用于在标识操作期间选择要素的几何。由 Geometry.type 指定的几何类型。与“标识”一起使用的最常见几何是

geometryPrecision Number

指定任务返回的几何中的小数位数。

height Number

View 的高度,以像素为单位。

默认值:400
layerIds Number[]

要在其中执行标识操作的图层。这些图层被指定为一个以逗号分隔的图层 ID 列表。

layerOption String

指定使用识别时要使用的图层。

可能值 描述
top 仅识别服务上最顶层可见的图层。
visible 将识别服务上的所有可见图层。
all 将识别服务上的所有图层,即使它们不可见。如果您的服务具有多个图层,则使用此选项的请求将无法正常运行。可见图层意味着您可以在当前范围的地图中看到它。如果图层根据其比例依赖性设置关闭或不在范围内,则无法识别该图层。
popup 具有 popupTemplate 的所有可见图层。此选项需要 sublayers

可能值"top"|"visible"|"all"|"popup"

默认值:top
mapExtent Extent

当前地图视图的范围或边界框。除非指定了 spatialReference,否则假定 mapExtent 属性位于地图的空间参考中。

mapExtentheightwidthdpi 值用于确定当前地图比例。知道比例后,地图服务即可根据图层的比例依赖性设置排除图层。地图服务不会根据提供的范围执行空间交叉。这些属性还用于根据屏幕像素的容差计算地图上的搜索距离。

maxAllowableOffset Number

用于概化标识操作返回的几何的最大允许偏移量。偏移量以 spatialReference 的单位表示。如果未定义 spatialReference,则使用视图的空间参考。

returnFieldName Boolean

如果为 true,将返回字段名而不是字段别名。

默认值:true
returnGeometry Boolean

如果为 true,则结果集包括与每个结果相关联的几何。

默认值:false
returnM Boolean

当为 true 时,表示将返回 M 值。

默认值:false
returnUnformattedValues Boolean

如果为 true,则结果中的值将不会被格式化,即数字将原样返回,日期将返回为历元值。

默认值:true
returnZ Boolean

当为 true 时,则表示将返回 z 值。

默认值:false
spatialReference SpatialReference

输入和输出几何的空间参考以及 mapExtent。如果未指定空间参考,则假定几何和范围位于视图的空间参考中,并且输出几何也将位于视图的空间参考中。

sublayers Sublayer[]
起始版本:GeoScene Maps SDK for JavaScript 4.22

Sublayer 对象的集合,用于更改图层排序和/或渲染,或重新定义地图。也可使用动态创建为动态图层的子图层。设置后,将对 MapImageLayer 执行识别操作。

timeExtent TimeExtent
起始版本:GeoScene Maps SDK for JavaScript 4.22

指定标识使用的时间范围。

tolerance Number

应在其中执行识别的指定几何之间的距离 (以屏幕像素为单位)。

width Number

当前地图视图的宽度,以像素为单位。

默认值:400

方法概述

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

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

更多详情
Accessor
*

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

更多详情
IdentifyParameters
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
IdentifyParameters

方法详细说明

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

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