Class: DatasetBufferAnalystParameters

ol.supermap.DatasetBufferAnalystParameters

The DatasetBufferAnalystParameters class.

new ol.supermap.DatasetBufferAnalystParameters(options)

DatasetBufferAnalystParameters.js, line 7
Name Type Description
options Object

The parameters.

Name Type Default Description
dataset string

The name of the dataset in the datasource for buffer analysis. This identifier is the format "dataset name@datasource alias".

filterQueryParameter ol.supermap.FilterParameter optional

Sets the filter condition for the geometric objects in the dataset. Only the geometric objects that meet this condition will participate in the buffer analysis.

resultSetting ol.supermap.DataReturnOption optional

The DataReturnOption class.

isAttributeRetained boolean true optional

Whether to retain the field attribute of the object for buffer analysis. When the isUnion field is false, it is valid

isUnion boolean false optional

Whether to unite the buffer and the object in the source recordset and then return them. For the region object, it is required that the region object in the source dataset is not allowed to intersect.

bufferSetting ol.supermap.BufferSetting optional

Sets the general buffer parameters.

Extends

Members

Sets the general buffer parameter. Provides the necessary parameters information for buffer analysis, including the left buffer distance, right buffer distance, endpoint types, number of arc segment of the round.

datasetstring

The name of the dataset in the datasource for buffer analysis. This identifier is the format "dataset name@datasource alias".

filterQueryParameterol.supermap.FilterParameter

Sets the filter condition for the geometric objects in the dataset. Only the geometric objects that meet this condition will participate in the buffer analysis.

isAttributeRetainedboolean

Whether to retain the field attribute of the object for buffer analysis. When the isUnion field is false, it is valid

Default Value:
true

isUnionboolean

Whether to unite the buffer and the object in the source recordset and then return them. For the region object, it is required that the region object in the source dataset is not allowed to intersect. The default is false.

The DataReturnOption class.

Methods

static toObject(datasetBufferAnalystParameters, tempObj){Object}

DatasetBufferAnalystParameters.js, line 82

Transform the DatasetBufferAnalystParameters class to JSON.

Name Type Description
datasetBufferAnalystParameters ol.supermap.DatasetBufferAnalystParameters

The DatasetBufferAnalystParameters class.

tempObj ol.supermap.DatasetBufferAnalystParameters

The DatasetBufferAnalystParameters class.

Returns:
Type Description
Object The JSON object.

inherited destroy()

BufferAnalystParameters.js, line 27

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

inherited destroy()

BufferAnalystParameters.js, line 27

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