new DataReturnOption(options)

Usage

import { DataReturnOption } from '@supermapgis/iclient-leaflet';

new DataReturnOption(options);

<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.DataReturnOption({paramsNames});
  // 弃用的写法
  new SuperMap.DataReturnOption(options);
</script>

common/iServer/DataReturnOption.js, line 7

Name Type Description

options

Object

参数。

Name	Type	Default	Description
`expectCount`	number	1000	可选设置返回的最大记录数，小于或者等于 0 时表示返回所有记录数。
`dataset`	string		可选设置结果数据集标识，当 dataReturnMode 为 `DataReturnMode.DATASET_ONLY`或`DataReturnMode.DATASET_AND_RECORDSET`时有效，作为返回数据集的名称。该名称用形如“数据集名称@数据源别名”形式来表示。
`dataReturnMode`	DataReturnMode	DataReturnMode.RECORDSET_ONLY	可选数据返回模式。
`deleteExistResultDataset`	boolean	true	可选如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。

API Relations

As constructor parameter: DatasetBufferAnalystParameters , DatasetOverlayAnalystParameters , DatasetSurfaceAnalystParameters , GenerateSpatialDataParameters , GeometrySurfaceAnalystParameters , SurfaceAnalystParameters.

Members

dataReturnModeDataReturnMode

数据返回模式。

Default Value:

datasetstring

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

deleteExistResultDatasetboolean

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

Default Value:

expectCountnumber

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

Default Value:

Methods

destroy() common/iServer/DataReturnOption.js, line 55

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

Class: DataReturnOption