new QueryByDistanceParameters(options)

Usage

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

new QueryByDistanceParameters(options);

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

common/iServer/QueryByDistanceParameters.js, line 7

Name Type Description

options

Object

参数。

Name	Type	Default	Description
`geometry`	Object		用于查询的几何对象。
`queryParams`	Array.<FilterParameter>		查询过滤条件参数数组。
`distance`	number		查询距离，单位与所查询图层对应的数据集单位相同。距离查询时，表示距离地物的距离。最近地物查询时，表示搜索的范围。此为必设参数。
`customParams`	string		可选自定义参数，供扩展使用。
`prjCoordSys`	Object		可选自定义参数，供 SuperMap Online 提供的动态投影查询扩展使用。如 {"epsgCode":3857}。
`expectCount`	number	100000	可选查询结果中期望返回的结果记录数，该值需大于 0。
`networkType`	GeometryType	GeometryType.LINE	可选网络数据集对应的查询类型。分为 POINT 点和 LINE 线两种类型。
`queryOption`	QueryOption	QueryOption.ATTRIBUTEANDGEOMETRY	可选查询结果选项对象，用于指定查询结果中包含的内容。
`startRecord`	number	0	可选查询起始记录位置。
`holdTime`	number	10	可选资源在服务端保存的时间，单位为分钟。
`returnCustomResult`	boolean	false	可选仅供三维使用。是否返回查询结果的 Bounds 信息，当 returnContent=false 时有效。如果为 true，返回查询结果的 Bounds 信息。如果为 false，则不返回 Bounds 信息。
`isNearest`	boolean	false	可选是否为最近距离查询。
`returnContent`	boolean	true	可选是否立即返回新创建资源的表述还是返回新资源的 URI。如果为 true，则直接返回新创建资源，即查询结果的表述。如果为 false，则返回的是查询结果资源的 URI。
`returnFeatureWithFieldCaption`	boolean	false	可选返回的查询结果要素字段标识是否为字段别名。为 false 时，返回的是字段名；为 true 时，返回的是字段别名。

API Relations

As method parameter: QueryService.queryByDistance.

Extends

QueryByDistanceParameters -> QueryParameters

Members

customParamsstring

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

distancenumber

查询距离，单位与所查询图层对应的数据集单位相同。距离查询时，表示距离地物的距离。最近地物查询时，表示搜索的范围。

expectCountnumber

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

Default Value:

geometryObject

holdTimenumber

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

Default Value:

isNearestboolean

是否为最近距离查询。
建议该属性与 expectCount（继承自 QueryParameters）属性联合使用。当该属性为 true 时，即表示查找最近地物，如果查询结果数大于期望返回的结果记录数（expectCount），则查找结果为查询总记录中距离中心最近的 expectCount 个地物。当该属性为不为 true 时，如果查询结果数大于期望返回的结果记录数（expectCount），则查找结果为从查询总记录中随机抽取的 expectCount 个地物。目前查询结果不支持按远近距离排序。

networkTypeGeometryType

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

Default Value:

prjCoordSysObject

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

queryOptionQueryOption

查询结果选项对象，用于指定查询结果中包含的内容。该类描述查询结果返回类型，包括只返回属性、只返回几何实体以及返回属性和几何实体。

Default Value:

queryParamsArray.<FilterParameter>

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

returnContentboolean

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

Default Value:

returnCustomResultboolean

仅供三维使用。

returnFeatureWithFieldCaptionboolean

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

startRecordnumber

查询起始记录位置。

Methods

destroy() common/iServer/QueryByDistanceParameters.js, line 77

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

Class: QueryByDistanceParameters