Class: QueryByDistanceParameters

SuperMap.QueryByDistanceParameters

Distance 查询参数类。 该类用于设置 Distance 查询的相关参数。

new SuperMap.QueryByDistanceParameters(options)

common/iServer/QueryByDistanceParameters.js, line 8
Name Type Description
options Object

参数。

Name Type Default Description
geometry Object

用于查询的几何对象。

queryParams Array.<SuperMap.FilterParameter>

查询过滤条件参数数组。

customParams string 可选

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

prjCoordSys Object 可选

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

expectCount number 100000 可选

期望返回结果记录个数。

networkType SuperMap.GeometryType SuperMap.GeometryType.LINE 可选

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

queryOption SuperMap.QueryOption SuperMap.QueryOption.ATTRIBUTEANDGEOMETRY 可选

查询结果类型枚举类。

startRecord number 0 可选

查询起始记录号。

holdTime number 10 可选

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

returnCustomResult boolean false 可选

仅供三维使用。

distance number 0 可选

查询距离。

isNearest boolean false 可选

是否为最近距离查询。

returnContent boolean true 可选

是否立即返回新创建资源的表述还是返回新资源的 URI。

returnFeatureWithFieldCaption boolean false 可选

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

Extends

Members

customParamsstring

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

distancenumber

查询距离,单位与所查询图层对应的数据集单位相同。 当查找最近地物时,该属性无效。

expectCountnumber

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

Default Value:
100000

geometry

用于查询的地理对象。
点类型可以是:SuperMap.Geometry.Point|L.Marker|L.CircleMarker|L.Circle|L.GeoJSON|ol.geom.Point|ol.format.GeoJSON
线类型可以是:SuperMap.Geometry.LineString|SuperMap.Geometry.LinearRing|L.Polyline|L.GeoJSON|ol.geom.LineString|ol.format.GeoJSON
面类型可以是:SuperMap.Geometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON

holdTimenumber

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

Default Value:
10

isNearestboolean

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

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

Default Value:
SuperMap.GeometryType.LINE

prjCoordSysObject

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

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

Default Value:
SuperMap.QueryOption.ATTRIBUTEANDGEOMETRY

queryParamsArray.<SuperMap.FilterParameter>

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

returnContentboolean

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

Default Value:
true

returnCustomResultboolean

仅供三维使用。

returnFeatureWithFieldCaptionboolean

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

startRecordnumber

查询起始记录号。

Methods

destroy()

common/iServer/QueryByDistanceParameters.js, line 80

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