Class: GeoRelationAnalystParameters

SuperMap.GeoRelationAnalystParameters

The GeoRelationAnalystParameters class. This class is used to parameters of spatial relation analysis service.

new SuperMap.GeoRelationAnalystParameters(options)

GeoRelationAnalystParameters.js, line 6
Name Type Description
options Object

The parameters.

Name Type Default Description
sourceFilter SuperMap.FilterParameter

The reference dataset query parameter of spatial relation analysis. Only name, ids, attriubteFilter and fields are valid.

referenceFilter SuperMap.FilterParameter

The reference dataset query parameter of spatial relation analysis. Only name, ids, attriubteFilter and fields are valid.

spatialRelationType SuperMap.SpatialRelationType

The specified spatial relation type.

isBorderInside boolean optional

whether to contain the points on the border. This parameter is only used in containing or contained relations of spatial analysis.

returnFeature boolean optional

Whether to return Feature information.

returnGeoRelatedOnly boolean true optional

Whether to return the spatial objects meet with the spatial relations.

startRecord number 0 optional

The start recording location of the analysis results.

expectCount number 500 optional

The number of the expected result records in the spatial analysis. If the number of the records is less than 500, then it will return all the analysis results.

Members

datasetstring

Source dataset name.

expectCountnumber

The number of the expected result records in the spatial analysis. If the number of the records is less than 500, then it will return all the analysis results.

Default Value:
500

isBorderInsideboolean

Whether to contain the points on the border. This parameter is only used in containing or contained relations of spatial analysis.

referenceFilterSuperMap.FilterParameter

The reference dataset query parameter of spatial relation analysis. Only name, ids, attriubteFilter and fields are valid.

returnFeatureboolean

The reference dataset query parameter of spatial relation analysis.

returnGeoRelatedOnlynumber

The start recording location of the analysis results.

returnGeoRelatedOnlyboolean

Whether to return the spatial objects which meet the specified the spatial relationship.

Default Value:
true

The source dataset query parameter of spatial relation analysis. Only ids, attriubteFilter and fields are valid.

spatialRelationTypeSuperMap.SpatialRelationType

The specified spatial relation type.

Methods

destroy()

GeoRelationAnalystParameters.js, line 84

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