Class: QueryParameters

QueryParameters

查询参数基类。此类为地图查询提供了查询过滤条件参数、查询结果类型、查询起始记录号、资源在服务端的保存时间等参数, 还可以对返回的查询结果进行一系列设置,并且支持自定义参数。

new QueryParameters(options)

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

</script>

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

new QueryParameters(options);

common/iServer/QueryParameters.js, line 12
Name Type Description
options Object

参数。

Name Type Default Description
queryParams Array.<FilterParameter>

查询过滤条件参数数组。

customParams string 可选

自定义参数,供扩展使用。

prjCoordSys Object 可选

自定义参数,供 SuperMap Online 提供的动态投影查询扩展使用。如 {"epsgCode":3857}。

expectCount number 100000 可选

期望返回结果记录个数。

networkType GeometryType GeometryType.LINE 可选

网络数据集对应的查询类型。

queryOption QueryOption QueryOption.ATTRIBUTEANDGEOMETRY 可选

查询结果类型。

startRecord number 0 可选

查询起始记录号。

holdTime number 10 可选

资源在服务端保存的时间,单位为分钟。

returnCustomResult boolean false 可选

仅供三维使用。

returnFeatureWithFieldCaption boolean false 可选

返回的查询结果要素字段标识是否为字段别名。为 false 时,返回的是字段名;为 true 时,返回的是字段别名。

Members

customParamsstring

自定义参数,供扩展使用。

expectCountnumber

期望返回结果记录个数,默认返回 100000 条查询记录, 如果实际不足 100000 条则返回实际记录条数。

Default Value:
100000

holdTimenumber

资源在服务端保存的时间,单位为分钟。

Default Value:
10

networkTypeGeometryType

网络数据集对应的查询类型,分为点和线两种类型。

Default Value:
GeometryType.LINE

prjCoordSysObject

自定义参数,供 SuperMap Online 提供的动态投影查询扩展使用。如 {"epsgCode":3857}。

queryOptionQueryOption

查询结果类型。 该类描述查询结果返回类型,包括只返回属性、 只返回几何实体以及返回属性和几何实体。

Default Value:
QueryOption.ATTRIBUTEANDGEOMETRY

queryParamsArray.<FilterParameter>

查询过滤条件参数数组。 该类用于设置查询数据集的查询过滤参数。

returnCustomResultboolean

仅供三维使用。

returnFeatureWithFieldCaptionboolean

返回的查询结果要素字段标识是否为字段别名。为 false 时,返回的是字段名;为 true 时,返回的是字段别名。

startRecordnumber

查询起始记录号。

Methods

destroy()

common/iServer/QueryParameters.js, line 105

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