Class: GetFeaturesByBoundsParameters

SuperMap.GetFeaturesByBoundsParameters

The GetFeaturesByBoundsParameters class, used to set related parameters.

new SuperMap.GetFeaturesByBoundsParameters(options)

GetFeaturesByBoundsParameters.js, line 7
Name Type Description
options Object

The parameters.

Name Type Default Description
bounds SuperMap.Bounds | L.Bounds | ol.extent

The specified bounds object.
attributeFilter string optional

Attribute filter for bounds query.
fields Array.<string> optional

Set the query result return field. All fields are returned by default.
spatialQueryMode SuperMap.SpatialQueryMode SuperMap.SpatialQueryMode.CONTAIN optional

Spatial query modes.
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.

attributeFilterstring

Attribute filter for bounds query.

boundsSuperMap.Bounds L.Bounds ol.extent

The specified bounds object.

datasetNameArray.<string>

A list of data set names in the dataset collection.

fieldsArray.<string>

Sets the result query field. If specified, features of GetFeaturesResult only contains the specified field. If not, return all fields.

fromIndexnumber

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

getFeatureModestring

Query modes of data set. There are two query modes for the bounds query: "BOUNDS" and "BOUNDS_ATTRIBUTEFILTER". When you set the attributeFilter, it automatically switches to the BOUNDS_ATTRIBUTEFILTER mode to access the service.

maxFeaturesnumber

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

Default Value:
1000

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.

spatialQueryModeSuperMap.SpatialQueryMode

The constant of the spatialQueryMode, required.

Default Value:
SuperMap.SpatialQueryMode.CONTAIN

toIndexnumber

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

Default Value:
19

Methods

SuperMap.GetFeaturesByBoundsParameters.toJsonParameters(params){string}

GetFeaturesByBoundsParameters.js, line 83

Transform the SuperMap.GetFeaturesByBoundsParameters to JSON.

Name Type Description
params SuperMap.GetFeaturesByBoundsParameters

The GetFeaturesByBoundsParameters class.
Returns:
Type Description
string The JSON object.

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.