Class: DataReturnOption

ol.supermap.DataReturnOption

The data return set class.

new ol.supermap.DataReturnOption(options)

DataReturnOption.js, line 5
Name Type Description
options Object

The parameters.

Name Type Default Description
expectCount number 1000 optional

Sets the maximum number of records returned. It returns all the record number when it is less than or equal to 0.
dataset string optional

The result dataset identifier. Valid when dataReturnMode is ol.supermap.DataReturnMode.DATASET_ONLY or ol.supermap.DataReturnMode.DATASET_AND_RECORDSET, As the name of the returned data set. The name is represented by the form "data set name @data source alias".
dataReturnMode ol.supermap.DataReturnMode ol.supermap.DataReturnMode.RECORDSET_ONLY optional

The data return mode.
deleteExistResultDataset boolean true optional

Whether to delete the existing dataset if the specified result dataset name is identical to the name of an existing dataset.

Members

dataReturnModeol.supermap.DataReturnMode

The data return mode.

Default Value:
ol.supermap.DataReturnMode.RECORDSET_ONLY

datasetstring

The result dataset identifier. Valid when dataReturnMode is ol.supermap.DataReturnMode.DATASET_ONLY or ol.supermap.DataReturnMode.DATASET_AND_RECORDSET, As the name of the returned data set. The name is represented by the form "data set name @data source alias".

deleteExistResultDatasetboolean

Whether to delete the existing dataset if the specified result dataset name is identical to the name of an existing dataset.

Default Value:
true

expectCountnumber

Sets the maximum number of records returned. It returns all the record number when it is less than or equal to 0.

Default Value:
1000

Methods

destroy()

DataReturnOption.js, line 50

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