Class: GetFeaturesBySQLParameters

SuperMap.GetFeaturesBySQLParameters

The GetFeaturesBySQLParameters class.

new SuperMap.GetFeaturesBySQLParameters(options)

GetFeaturesBySQLParameters.js, line 6
Name Type Description
options Object

The parameters.

Name Type Default Description
queryParameter SuperMap.FilterParameter

Query filter parameters.

datasetNames Array.<string>

A list of data set names in the dataset collection.

returnContent boolean true optional

Whether to return query result directly.

fromIndex number 0 optional

The minimum index.

toIndex number 19 optional

The maximum index.

Extends

Members

aggregationsObject

Aggregate query parameters, which only support data services from the Elasticsearch service.

datasetNameArray.<string>

A list of data set names in the dataset collection.

fromIndexnumber

The minimum index. If this value is greater than the max index, the result is null.

getFeatureModestring

The mode of get feature.

Default Value:
'SQL'

maxFeaturesnumber

When processing the SQL query, it is used to set the number of query result returned by the server.

Default Value:
1000

queryParameterSuperMap.FilterParameter

The FilterParameter array.

returnContentboolean

Whether to return the new created resource representation or return the URL of the new resource. If the result is true, then the new created resource, i.e., the the query result representation. If the result is false, the URI of the querying result is returned.

Default Value:
true

returnCountOnlyboolean

Only return the total amount of the query result.

toIndexnumber

The maximum index. If this value is greater than the max index, treat this value as the end index.

Default Value:
19

Methods

inherited destroy()

GetFeaturesParametersBase.js, line 67

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

inherited destroy()

GetFeaturesParametersBase.js, line 67

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

toJsonParameters(params){string}

GetFeaturesBySQLParameters.js, line 54

Transform the SuperMap.GetFeaturesBySQLParameters to JSON string

Name Type Description
params SuperMap.GetFeaturesBySQLParameters

The GetFeaturesBySQLParameters

Returns:
Type Description
string The converted JSON string.