new SuperMap.DatasetOverlayAnalystParameters(options)

DatasetOverlayAnalystParameters.js, line 8

Name Type Description

options

Object

The parameters.

Name	Type	Default	Description
`operateDataset`	string		Dataset name to operate in overlay analysis.
`sourceDataset`	string		The name of the source dataset in overlay analysis.
`operateDatasetFields`	Array.<string>		optional The list of field names remain in the result dataset of the operate dataset in overlay analysis.
`operateDatasetFilter`	SuperMap.FilterParameter		optional Sets the filter of the spatial object in the operation dataset.
`operateRegions`	Array.<(SuperMap.Geometry.Polygon\|L.Polygon\|ol.geom.Polygon)>		optional The operating regions. If it excluses wth operateDataset, the operateDataset shall prevail.
`sourceDatasetFields`	Array.<string>		optional The list of field names remain in the result dataset of the source dataset in overlay analysis.
`sourceDatasetFilter`	SuperMap.FilterParameter		optional Sets the filter of the spatial object in the source dataset.
`tolerance`	number	0	optional The tolerance.
`operation`	SuperMap.OverlayOperationType		The enumeration value of the overlay operation.
`resultSetting`	SuperMap.DataReturnOption		optional The DataReturnOption class.

Extends

SuperMap.GetFeaturesParametersBase

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.

filterQueryParameterSuperMap.FilterParameter

Sets the filter of the spatial object in the source dataset.

fromIndexnumber

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

maxFeaturesnumber

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

Default Value:

operateDatasetstring

Dataset name to operate in overlay analysis.

operateDatasetFieldsArray.<string>

The list of field names remain in the result dataset of the operate dataset in overlay analysis.

operateDatasetFilterSuperMap.FilterParameter

Sets the filter of the spatial object in the operation dataset.

operateRegionsArray.<(SuperMap.Geometry.Polygon|L.Polygon|ol.geom.Polygon)>

The operating regions. If it excluses wth operateDataset, the operateDataset shall prevail.

resultSettingSuperMap.DataReturnOption

The DataReturnOption class.

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:

returnCountOnlyboolean

Only return the total amount of the query result.

sourceDatasetstring

The name of the source dataset in overlay analysis.

sourceDatasetFieldsArray.<string>

The list of field names remain in the result dataset of the source dataset in overlay analysis.

toIndexnumber

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

Default Value:

tolerancenumber

The tolerance.

Methods

SuperMap.DatasetOverlayAnalystParameters.toObject(datasetOverlayAnalystParameters, tempObj){Object} DatasetOverlayAnalystParameters.js, line 126

Transform The DatasetOverlayAnalystParameters class to the JSON.

Name	Type	Description
`datasetOverlayAnalystParameters`	SuperMap.DatasetOverlayAnalystParameters	The DatasetOverlayAnalystParameters class
`tempObj`	SuperMap.DatasetOverlayAnalystParameters	The DatasetOverlayAnalystParameters.

Returns:

Type	Description
Object	The JSON object.

inherited destroy() GetFeaturesParametersBase.js, line 67

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