Class: ImageSearchParameter

import { ImageSearchParameter } from '@supermapgis/iclient-leaflet';

new ImageSearchParameter(options);

<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.ImageSearchParameter({paramsNames});
  // 弃用的写法
  new SuperMap.ImageSearchParameter(options);
</script>

API Relations

Members

bboxArray.<number>

指定查询范围。只有具有几何对象（geometry）属性的 Features，并且该几何对象与该参数指定的范围相交的 Features 才会被选择出来该参数可以包含 4 个数值或者 6 个数值，这取决于使用的坐标参考系统是否包含高程值： * 左下角坐标轴 1 的值 * 左下角坐标轴 2 的值 * 坐标轴 3 的最小值（可选） * 右上角坐标轴 1 的值 * 右上角坐标轴 2 的值 * 坐标轴 3 的最大值（可选） 坐标参考系统为 WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84). 对于 WGS84 坐标参考系统，该参数值的格式通常为：最小经度,最小纬度,最大经度,最大纬度。如果包含了高程值，该参数的格式为：最小经度,最小纬度,最小高程值,最大经度,最大纬度,最大高程值。如果一个 Feature 具有多个空间几何对象（geometry）属性，由服务器决定是否使用单一的空间几何对象属性，还是使用所有相关的几何对象作为最终的查询空间范围。

collectionsArray.<string>

影像集合的 ID 数组，将在该指定的 Collection 中搜索 Items。

fieldsFieldsFilter

通过 ‘include’ 和 ‘exclude’ 属性分别指定哪些字段包含在查询结果的 Feature 描述中，哪些需要排除。返回结果中的 stac_version，id，bbox，assets，links，geometry，type，properties 这些字段为必须字段，若要返回结果中不含这种字段信息，需要显式地进行排除设置，如：排除 geometry 和 bbox 字段；在 POST 请求中，将这些字段添加到 “exclude” 字段中，即："fields": { "exclude": ["geometry","bbox"] } }。而对于返回的 “properties” 对象中的扩展字段内容，可以将字段前添加到 ‘include’ 字段中，如："fields": { "include": ["properties.SmFileName","properties.SmHighPS"] } } ，表示 properties.SmFileName 和 properties.SmHighPS 属性都包含在查询结果中。

idsArray.<string>

只返回指定 Item 的 ID 数组中的 Item。设置了该参数，所有其他过滤器参数（除了 next 和 limit ）将被忽略。

limitnumber

单页返回的最大结果数，即响应文档包含的 Item 的数目。最小值为 1，最大值为 10000。

queryObject

定义查询哪些属性，查询运算符将应用于这些属性。

sortbyArray.<Sortby>

由包含属性名称和排序规则的对象构成的数组。

Methods

constructFromObject(data, obj){ImageSearchParameter}

common/iServer/ImageSearchParameter.js, line 81

目标对象新增该类的可选参数。

Name	Type	Description
data	Object	要转换的数据。
obj	ImageSearchParameter	返回的模型。

Returns:

Type	Description
ImageSearchParameter	返回结果。

destroy()

common/iServer/ImageSearchParameter.js, line 66

释放资源，将引用资源的属性置空。