Class: ClipParameter

SuperMap.ClipParameter

The parameter for clipping.

new SuperMap.ClipParameter(options)

ClipParameter.js, line 5

Uses the clip region polygon in precedence specified by users to clip, or uses the boundary polygon of the specified dataset to clip by specifying the name of datasource and dataset.

Name Type Description
options Object

The parameters.

Name Type Default Description
clipDatasetName string optional

The dataset name for clipping.

clipDatasourceName string optional

The datasource name which the dataset for clipping exists in.

clipRegion SuperMap.Geometry.Polygon | L.Polygon | L.GeoJSON | ol.geom.Polygon | ol.format.GeoJSON optional

The clip region specified by users.

isClipInRegion boolean true optional

Whether to clip the dataset in the clip region.

isExactClip boolean true optional

Whether to use the precision clip.

Members

clipDatasetNamestring

The name of the dataset to use for clipping, clipDatasetName and clipRegion must be set one.

clipDatasourceNamestring

The datasource name which the dataset for clipping exists in.

clipRegionSuperMap.Geometry.Polygon L.Polygon L.GeoJSON ol.geom.Polygon ol.format.GeoJSON

The user-specified crop area is used preferentially.

isClipInRegionboolean

Whether to clip the dataset in the clip region, clipDatasetName and clipRegion must be set one.

Default Value:
true

isExactClipboolean

Whether to use the precision clip.

Default Value:
true

Methods

destroy()

ClipParameter.js, line 59

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

toJSON(){string}

ClipParameter.js, line 73

Transform the ClipParameter to JSON string.

Returns:
Type Description
string The JSON string.