Class: DataReturnOption

DataReturnOption

数据返回设置类。该类主要用于设置空间分析完成后返回数据的一些选项,包括数据返回模式、返回的最大记录数、结果数据集名称,数据集重名处理方式等。

new DataReturnOption(options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/openlayers/iclient-ol.js"></script>
<script>
  new ol.supermap.DataReturnOption(options);
  
  // 弃用的写法
  new SuperMap.DataReturnOption(options);

</script>

// ES6 Import
import { DataReturnOption } from '@supermapgis/iclient-ol';

new DataReturnOption(options);

common/iServer/DataReturnOption.js, line 7
Name Type Description
options Object

参数。

Name Type Default Description
expectCount number 1000 可选

设置返回的最大记录数,小于或者等于 0 时表示返回所有记录数。

dataset string 可选

设置结果数据集标识,当 dataReturnMode 为 DataReturnMode.DATASET_ONLYDataReturnMode.DATASET_AND_RECORDSET时有效, 作为返回数据集的名称。该名称用形如“数据集名称@数据源别名”形式来表示。

dataReturnMode DataReturnMode DataReturnMode.RECORDSET_ONLY 可选

数据返回模式。

deleteExistResultDataset boolean true 可选

如果用户命名的结果数据集名称与已有的数据集重名,是否删除已有的数据集。

Members

dataReturnModeDataReturnMode

数据返回模式。

Default Value:
DataReturnMode.RECORDSET_ONLY

datasetstring

设置结果数据集标识,当dataReturnMode为 DataReturnMode.DATASET_ONLYDataReturnMode.DATASET_AND_RECORDSET时有效, 作为返回数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示。

deleteExistResultDatasetboolean

如果用户命名的结果数据集名称与已有的数据集重名,是否删除已有的数据集。

Default Value:
true

expectCountnumber

设置返回的最大记录数,小于或者等于0时表示返回所有记录数。

Default Value:
1000

Methods

destroy()

common/iServer/DataReturnOption.js, line 55

释放资源,将引用资源的属性置空。