Class: GetFeaturesByGeometryParameters

SuperMap.GetFeaturesByGeometryParameters

The GetFeaturesByGeometryParameters class.

new SuperMap.GetFeaturesByGeometryParameters(options)

GetFeaturesByGeometryParameters.js, line 8
Name Type Description
options Object

The parameters.

Name Type Default Description
geometry Object

The geometry object used for the query.
datasetNames Array.<string>

A list of data set names in the dataset collection.
attributeFilter string optional

The condition of the attribute 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.
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 geometry query.

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.

geometryObject

The geometry object used for the query.

The point type could be: SuperMap.Geometry.Point|L.Point|L.GeoJSON|ol.geom.Point|ol.format.GeoJSON.
The line type could be: SuperMap.Geometry.LineString|SuperMap.Geometry.LinearRing|L.Polyline|L.GeoJSON|ol.geom.LineString|ol.format.GeoJSON.
The Polygon type could be: SuperMap.Geometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON.

getFeatureModestring

Query modes of data set. There are two query modes for the geometry query: "SPATIAL" and "SPATIAL_ATTRIBUTEFILTER". When you set the attributeFilter, it automatically switches to the "SPATIAL_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

Spatial query modes. 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.GetFeaturesByGeometryParameters.toJsonParameters(params){string}

GetFeaturesByGeometryParameters.js, line 88

Transform the SuperMap.GetFeaturesByGeometryParameters to JSON

Name Type Description
params SuperMap.GetFeaturesByGeometryParameters

The GetFeaturesByGeometryParameters
Returns:
Type Description
string The converted JSON string.

destroy()

GetFeaturesByGeometryParameters.js, line 66

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