Class: ChartQueryParameters

ChartQueryParameters

海图查询参数类,该类用于设置海图查询时的相关参数,海图查询分为海图属性查询和海图范围查询两类,通过属性queryMode指定查询模式。 必设属性有:queryMode、chartLayerNames、chartQueryFilterParameters。当进行海图范围查询时,必设属性还包括bounds。

new SuperMap.ChartQueryParameters(options)

common/iServer/ChartQueryParameters.js, line 4
Name Type Description
options Object

可选参数。如:
queryMode - {string} 海图查询模式类型,支持两种查询方式:海图属性查询("ChartAttributeQuery")和海图空间查询("ChartBoundsQuery") 。
bounds - {Object} 海图查询范围。Bounds类型可以是SuperMap.Bounds|L.Bounds|ol.extent。
chartLayerNames - {Array} 查询的海图图层的名称。
chartQueryFilterParameters - {Array <SuperMap.ChartQueryFilterParameter>} 海图查询过滤参数。包括:物标代码、物标可应用对象的选择(是否查询点、线或面)、属性字段过滤条件。
returnContent - {boolean} 获取或设置是返回查询结果记录集 recordsets,还是返回查询结果的资源 resourceInfo。默认为 true,表示返回 recordsets。
startRecord - {number} 查询起始记录位置,默认为0。
expectCount - {number} 期望查询结果返回的记录数,该值大于0。

Members

boundsObject

海图查询范围。Bounds类型可以是SuperMap.Bounds|L.Bounds|ol.extent。

chartLayerNamesArray.<string>

查询的海图图层的名称。

chartQueryFilterParametersArray.<SuperMap.ChartQueryFilterParameter>

海图查询过滤参数。包括:物标代码、物标可应用对象的选择(是否查询点、线或面)、属性字段过滤条件。

expectCountnumber

期望查询结果返回的记录数,该值大于0。

queryModestring

海图查询模式类型,支持两种查询方式:海图属性查询("ChartAttributeQuery")和海图空间查询("ChartBoundsQuery") 。

returnContentboolean

获取或设置是返回查询结果记录集 recordsets,还是返回查询结果的资源 resourceInfo。默认为 true,表示返回 recordsets。

startRecordnumber

查询起始记录位置,默认为0。

Methods

destroy()

common/iServer/ChartQueryParameters.js, line 68

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

getVariablesJson(){string}

common/iServer/ChartQueryParameters.js, line 83

将属性信息转换成能够被服务识别的JSON格式字符串。

Returns:
Type Description
string JSON字符串。