new GetFeaturesByIDsParameters(options)
Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/openlayers/iclient-ol.js"></script>
<script>
new ol.supermap.GetFeaturesByIDsParameters(options);
// 弃用的写法
new SuperMap.GetFeaturesByIDsParameters(options);
</script>
// ES6 Import
import { GetFeaturesByIDsParameters } from '@supermapgis/iclient-ol';
new GetFeaturesByIDsParameters(options);
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
参数。
|
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 paramsGetFeaturesByIDsParameters ID 查询参数对象。
Returns:
Type Description string 转化后的 JSON 字符串。 -
inherited destroy()
common/iServer/GetFeaturesByIDsParameters.js, line 56 -
释放资源，将引用资源的属性置空。