Class: GetFeaturesByIDsParameters

GetFeaturesByIDsParameters

数据集 ID 查询参数类。此类用于指定进行 ID 查询的数据集列表，设置查询元素 ID 以及一些通用的查询参数。

Notice

推荐设置 returnFeaturesOnly 配置为 true 来提升性能，如果需要获取总数量与数据集信息，FeatureService 提供了 getFeaturesCount 和 getFeaturesDatasetInfo 方法

new GetFeaturesByIDsParameters(options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.GetFeaturesByIDsParameters(options);
  
  // 弃用的写法
  new SuperMap.GetFeaturesByIDsParameters(options);

</script>

// ES6 Import
import { GetFeaturesByIDsParameters } from '@supermapgis/iclient-leaflet';

new GetFeaturesByIDsParameters(options);
common/iServer/GetFeaturesByIDsParameters.js, line 8
Name Type Description
options Object

参数。

Name Type Default Description
IDs Array.<number>

指定查询的元素 ID 信息。
fields Array.<string> 可选

查询结果返回字段。默认返回所有字段。
dataSetNames Array.<string>

数据集集合中的数据集名称列表。
returnContent boolean true 可选

是否直接返回查询结果。
returnFeaturesOnly boolean false 可选

是否仅返回要素信息。当 returnContent 为 true 时设置有效。
fromIndex number 0 可选

查询结果的最小索引号。
toIndex number 19 可选

查询结果的最大索引号。
targetEpsgCode string | number 可选

动态投影的目标坐标系对应的 EPSG Code，使用此参数时，returnContent 参数需为 true。
targetPrj Object 可选

动态投影的目标坐标系。使用此参数时，returnContent 参数需为 true。如：prjCoordSys={"epsgCode":3857}。当同时设置 targetEpsgCode 参数时，此参数不生效。
aggregations MetricsAggParameter | GeoHashGridAggParameter 可选

聚合查询参数。该参数仅支持数据来源为 Elasticsearch 服务的 SuperMap iServer 的 REST 数据服务。

Extends

Members

aggregationsMetricsAggParameter GeoHashGridAggParameter

聚合查询参数，该参数仅支持数据来源为 Elasticsearch 服务的 SuperMap iServer 的 REST 数据服务。

datasetNameArray.<string>

数据集集合中的数据集名称列表。

fieldsArray.<string>

查询结果返回字段。当指定了返回结果字段后，则 GetFeaturesResult 中的 features 的属性字段只包含所指定的字段。不设置即返回全部字段。

fromIndexnumber

查询结果的最小索引号。如果该值大于查询结果的最大索引号，则查询结果为空。

getFeatureModestring

数据集查询模式。

hasGeometrynumber

返回结果是否包含 Geometry。

Default Value:
true

IDsArray.<number>

所要查询指定的元素 ID 信息。

maxFeaturesnumber

进行 SQL 查询时，用于设置服务端返回查询结果条目数量。

Default Value:
1000

returnContentboolean

是否立即返回新创建资源的表述还是返回新资源的 URI。 如果为 true，则直接返回新创建资源，即查询结果的表述。 如果为 false，则返回的是查询结果资源的 URI。

Default Value:
true

returnFeaturesOnlyboolean

仅返回要素信息。

targetEpsgCodestring

动态投影的目标坐标系对应的 EPSG Code，使用时需设置 returnContent 参数为 true。

targetPrjObject

动态投影的目标坐标系。使用时需设置 returnContent 参数为 true。如：prjCoordSys={"epsgCode":3857}。当同时设置 targetEpsgCode 参数时，此参数不生效。

toIndexnumber

查询结果的最大索引号。如果该值大于查询结果的最大索引号，则以查询结果的最大索引号为终止索引号。

Default Value:
19

Methods

static toJsonParameters(params){string}

common/iServer/GetFeaturesByIDsParameters.js, line 73

将 GetFeaturesByIDsParameters 对象转换为 JSON 字符串。

Name Type Description
params GetFeaturesByIDsParameters

ID 查询参数对象。
Returns:
Type Description
string 转化后的 JSON 字符串。

inherited destroy()

common/iServer/GetFeaturesByIDsParameters.js, line 56

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