SuperMap.REST.QueryByDistanceParameters

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

Inherits from

Summary
SuperMap.REST.QueryByDistanceParameters Distance 查询参数类。 该类用于设置 Distance 查询的相关参数。
Properties
distance {Number} 查询距离,默认为0,单位与所查询图层对应的数据集单位相同。 当查找最近地物时,该属性无效。
geometry {SuperMap.Geometry} 用于查询的地理对象,必设属性。
isNearest {Boolean} 是否为最近距离查询。 建议该属性与 expectCount (继承自 QueryParameters)属性联合使用。 当该属性为 true 时,即表示查找最近地物,如果查询结果数大于期望返回的结果记录数(expectCount), 则查找结果为查询总记录中距离中心最近的expectCount个地物。 当该属性为不为 true 时,如果查询结果数大于期望返回的结果记录数(expectCount), 则查找结果为从查询总记录中随机抽取的expectCount个地物。 目前查询结果不支持按远近距离排序。
returnContent {Boolean} 是否立即返回新创建资源的表述还是返回新资源的 URI。 如果为 true,则直接返回新创建资源,即查询结果的表述。 为 false,则返回的是查询结果资源的 URI。默认为 true。
Constructor
SuperMap.REST.QueryByDistanceParameters Distance 查询参数类构造函数。
Functions
destroy 释放资源,将引用资源的属性置空。

Properties

distance

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

geometry

{SuperMap.Geometry} 用于查询的地理对象,必设属性。

isNearest

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

returnContent

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

Constructor

SuperMap.REST.QueryByDistanceParameters

Distance 查询参数类构造函数。

Parameters

options {Object} 参数。

Allowed options properties

customParams {String} 自定义参数,供扩展使用。
distance {Number} 查询距离。
expectCount {Integer} 期望返回结果记录个数。
geometry {SuperMap.Geometry} 用于查询的几何对象。
holdTime {Integer} 资源在服务端保存的时间。
isNearest {Boolean} 是否为最近距离查询。
networkType {SuperMap.REST.GeometryType} 网络数据集对应的查询类型。
queryOption {SuperMap.REST.QueryOption} 查询结果类型枚举类。
queryParams {Array(SuperMap.REST.FilterParameter)} 查询过滤条件参数数组。
startRecord {Integer} 查询起始记录号。
returnContent {Boolean} 是否立即返回新创建资源的表述还是返回新资源的 URI。

Functions

destroy

destroy: function()

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

几何对象类,描述地理对象的几何图形。
destroy: function()
释放资源,将引用资源的属性置空。
查询参数基类。 距离查询、SQL 查询、几何地物查询等各自的参数均继承此类。
{Object} 几何对象枚举类。 该类定义了一系列几何对象类型。
{Object} 查询结果类型枚举类。 该类描述查询结果返回类型,包括只返回属性、只返回几何实体以及返回属性和几何实体。
查询过滤条件参数类。 该类用于设置查询数据集的查询过滤参数。
Close