Class: ChartQueryParameters

SuperMap.ChartQueryParameters

The ChartQueryParameters class that is used to set the related parameters of chart query which includes chart attribute query and chart range query. The query mode is specified by queryMode. The required properties are queryMode, chartLayerNames and chartQueryFilterParameters. The required property is bounds for the chart range query.

new SuperMap.ChartQueryParameters(options)

ChartQueryParameters.js, line 5
Name Type Description
options Object

The parameters.

Name Type Default Description
queryMode string

The chart query mode type. SuperMap iClient for JavaScript supports two query patterns: "ChartAttributeQuery" and "ChartBoundsQuery".
chartLayerNames Array.<string>

The name of the chart layer to be looked up.
chartQueryFilterParameters Array.<{SuperMap.ChartQueryFilterParameter}>

ChartQueryFilterParameter includes the feature ID, the applicable object's selection of the feature (whether looks up point, line or area), and the attribute field filter condition.
bounds SuperMap.Bounds | L.Bounds | ol.extent optional

Chart query range. This parameter is required when performing a chart range query.
returnContent boolean true optional

Gets or sets whether it is the recordset (Recordsets) of the query results, or the resource (ResourceInfo) of the query results.
startRecord number 0 optional

The start recording location of the query.
expectCount number optional

The expected number of the record returned from the query results, and this value is greater than 0.

Members

boundsSuperMap.Bounds L.Bounds ol.extent

Chart query range. This parameter is required when performing a chart range query.

chartLayerNamesArray.<string>

The name of the chart layer to be looked up.

chartQueryFilterParametersArray.<SuperMap.ChartQueryFilterParameter>

ChartQueryFilterParameter includes the feature ID, the applicable object's selection of the feature (whether looks up point, line or area), and the attribute field filter condition.

expectCountnumber

The expected number of the record returned from the query results, and this value is greater than 0.

queryModestring

The chart query mode type. SuperMap iClient for JavaScript supports two query patterns: "ChartAttributeQuery" and "ChartBoundsQuery".

returnContentboolean

Gets or sets whether it is the recordset (Recordsets) of the query results, or the resource (ResourceInfo) of the query results.

Default Value:
true

startRecordnumber

The start recording location of the query.

Methods

destroy()

ChartQueryParameters.js, line 69

Disposes the resource. The property that references resource is set to null.

getVariablesJson(){string}

ChartQueryParameters.js, line 84

Transform attributes information to JSON format string that can be identified by server.

Returns:
Type Description
string The JSON string.