Class: ClipParameter

ClipParameter

用于裁剪的参数。优先使用用户指定的裁剪区域多边形进行裁剪，也可以通过指定数据源和数据集名，从而使用指定数据集的边界多边形进行裁剪。

new ClipParameter(options)

Usage
import { ClipParameter } from '@supermapgis/iclient-mapboxgl';

new ClipParameter(options);
<script type="text/javascript" src="https://iclient.supermap.io/dist/mapboxgl/iclient-mapboxgl.js"></script>
<script>
  new mapboxgl.supermap.ClipParameter({paramsNames});
  // 弃用的写法
  new SuperMap.ClipParameter(options);
</script>
common/iServer/ClipParameter.js, line 7
Name Type Description
options Object

可选参数。

Name Type Default Description
clipDatasetName string 可选

裁剪的数据集名称。当不设置 clipRegion 时起作用。
clipDatasourceName string 可选

裁剪的数据集所在数据源的名称。
clipRegion GeoJSONObject 可选

用户指定的裁剪区域。
isClipInRegion boolean true 可选

是否对裁剪区内的数据集进行裁剪。若为 true，则对裁剪区域内的结果进行裁剪，若为 false，则对裁剪区域外的结果进行裁剪。
isExactClip boolean true 可选

是否使用精确裁剪。若为 true，表示使用精确裁剪对栅格或影像数据集进行裁剪，false 表示使用显示裁剪。

Members

clipDatasetNamestring

用于裁剪的数据集名称，clipDatasetName 与 clipRegion 必须设置一个。

clipDatasourceNamestring

用于裁剪的数据集所在数据源的名称。当 clipRegion 不设置时起作用。

clipRegionGeoJSONObject

用户指定的裁剪区域，当与 clipDatasetName 同时设置时，优先使用 clipRegion。不设置时则使用指定数据集的边界多边形进行裁剪。clipDatasetName 与 clipRegion 必须设置一个。

isClipInRegionboolean

是否对裁剪区内的数据集进行裁剪。若为 true，则对裁剪区域内的结果进行裁剪，若为 false，则对裁剪区域外的结果进行裁剪。

Default Value:
true

isExactClipboolean

是否使用精确裁剪。

Default Value:
true

Methods

destroy()

common/iServer/ClipParameter.js, line 62

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

toJSON(){string}

common/iServer/ClipParameter.js, line 76

将 ClipParameter 对象转化为 JSON 字符串。

Returns:
Type Description
string 返回转换后的 JSON 字符串。