Class: EditFeaturesParameters

EditFeaturesParameters

数据集添加、修改、删除参数类。

new EditFeaturesParameters(options)

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

</script>

// ES6 Import
import { EditFeaturesParameters } from '@supermap/iclient-ol';

new EditFeaturesParameters(options);

common/iServer/EditFeaturesParameters.js, line 8
Name Type Description
options Object

参数。

Name Type Default Description
features Array.<(FeatureVector|GeoJSONObject|ol.Feature)>

当前需要创建或者是修改的要素集。

returnContent boolean false 可选

是否返回要素内容。如果为true则返回创建要素的 ID 数组,否则返回 featureResult 资源的 URI。

editType EditType EditType.ADD 可选

POST 动作类型 (ADD、UPDATE、DELETE)。

IDs Array.<(string|number)> 可选

删除要素时的要素的 ID 数组。

Members

dataSetNamestring

当前需要创建或者是修改的要素的数据集。

dataSourceNamestring

当前需要创建或者是修改的要素的数据源。

editTypeEditType

要素集更新类型 (add、update、delete)。

Default Value:
EditType.ADD

当前需要创建或者是修改的要素集。

IDsArray.<(string|number)>

执行删除时要素集 ID 集合。

isUseBatchboolean

是否使用批量添加要素功能,要素添加时有效。批量添加能够提高要素编辑效率。true 表示批量添加;false 表示不使用批量添加。

returnContentboolean

要素添加时,isUseBatch 不传或传为 false 的情况下有效。 true 表示直接返回新创建的要素的 ID 数组;false 表示返回创建的 featureResult 资源的 URI。

Methods

destroy()

common/iServer/EditFeaturesParameters.js, line 72

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

toJsonParameters(params){string}

common/iServer/EditFeaturesParameters.js, line 86

将 EditFeaturesParameters 对象参数转换为 JSON 字符串。

Name Type Description
params EditFeaturesParameters

地物编辑参数。

Returns:
Type Description
string JSON 字符串。