Class: GetFeaturesByGeometryParameters

GetFeaturesByGeometryParameters

数据集几何查询参数类。此类用于指定进行几何查询的数据集列表，设置查询的几何对象、属性过滤条件、空间查询模式以及一些通用的查询参数。

Notice

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

new GetFeaturesByGeometryParameters(options)

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

</script>

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

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

参数。

Name Type Default Description
geometry GeoJSONObject

查询的几何对象。
datasetNames Array.<string>

数据集集合中的数据集名称列表。
attributeFilter string 可选

几何查询属性过滤条件。
fields Array.<string> 可选

查询结果返回字段。默认返回所有字段。
orderBy string 可选

查询排序的字段，orderBy 的字段须为数值型的。
spatialQueryMode SpatialQueryMode SpatialQueryMode.CONTAIN 可选

空间查询模式。
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 数据服务。

attributeFilterstring

几何查询属性过滤条件。

datasetNameArray.<string>

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

fieldsArray.<string>

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

fromIndexnumber

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

geometryGeoJSONObject

用于查询的几何对象。
点类型可以是：GeometryPoint|L.Marker|L.CircleMarker|L.Circle|L.GeoJSON|ol.geom.Point|ol.format.GeoJSON|mapboxgl.LngLat|mapboxgl.Point|GeoJSONObject。
线类型可以是：GeometryLineString|GeometryLinearRing|L.Polyline|L.GeoJSON|ol.geom.LineString|ol.format.GeoJSON|GeoJSONObject。
面类型可以是：GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON|mapboxgl.LngLatBounds|GeoJSONObject。

getFeatureModestring

数据集查询模式。几何查询有 "SPATIAL"，"SPATIAL_ATTRIBUTEFILTER" 两种，当用户设置 attributeFilter 时会自动切换到 SPATIAL_ATTRIBUTEFILTER 访问服务。

hasGeometrynumber

返回结果是否包含 Geometry。

Default Value:
true

maxFeaturesnumber

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

Default Value:
1000

orderBystring

查询排序的字段，orderBy 的字段须为数值型的。 相当于 SQL 语句中的 ORDER BY 子句，其格式为：ORDER BY <列名>或ORDER BY <列名 排序规则>。 列名即属性表中每一列的名称，列又可称为属性，在 SuperMap 中又称为字段。 排序规则即按字段的升序或降序排序，asc 表示升序，desc 表示降序，不指定排序规则按升序排序。 对单个字段排序时，该字段的用法为 orderBy = "字段名"，升序为orderBy = "字段名 asc"；降序为 orderBy = "字段名 desc"； 对多个字段排序时，字段之间以英文逗号进行分割，用法为 orderBy = "字段名1, 字段名2 asc, 字段名2 desc"。 例如，在一个国家数据集中，有两个字段，字段名分别为“SmArea”和“pop_1994”，分别表示国家的面积和1994年的各国的人口数量， 如果要按照各国人口数量对记录进行排序，可以设置 orderBy = "pop_1994"； 如果要以面积降序和人口升序进行排序， 设置 orderBy = "SmArea desc, pop_1994 asc"。

returnContentboolean

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

Default Value:
true

returnFeaturesOnlyboolean

仅返回要素信息。

spatialQueryModeSpatialQueryMode

空间查询模式。

Default Value:
SpatialQueryMode.CONTAIN

targetEpsgCodestring

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

targetPrjObject

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

toIndexnumber

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

Default Value:
19

Methods

static toJsonParameters(params){string}

common/iServer/GetFeaturesByGeometryParameters.js, line 113

将 GetFeaturesByGeometryParameters 对象参数转换为 JSON 字符串。

Name Type Description
params GetFeaturesByGeometryParameters

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

destroy()

common/iServer/GetFeaturesByGeometryParameters.js, line 90

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