Class: DatasetSurfaceAnalystParameters

ol.supermap.DatasetSurfaceAnalystParameters

The DatasetSurfaceAnalystParameters class. The class sets the parameters used in the dataset surface analysis.

new ol.supermap.DatasetSurfaceAnalystParameters(options)

DatasetSurfaceAnalystParameters.js, line 8
Name Type Description
options Object

The parameters.

Name Type Default Description
dataset string

The name of the dataset in the datasource for dataset surface analysis.
zValueFieldName string

Gets or sets the field name used for extraction operation.
extractParameter ol.supermap.SurfaceAnalystParametersSetting

The surface analysis parameters setting class. Gets or sets the parameters of surface analysis.
resolution integer

Gets or sets the resolution of the specified intermediate results (raster dataset).
filterQueryParameter ol.supermap.FilterParameter optional

Gets or sets the query filter parameter.
resultSetting ol.supermap.DataReturnOption optional

The DataReturnOption class.
surfaceAnalystMethod ol.supermap.SurfaceAnalystMethod ol.supermap.SurfaceAnalystMethod.ISOLINE optional

Gets or sets the extraction methods for isoline and isoregion extraction of surface analysis.

Extends

Members

datasetstring

The name of the dataset in the datasource for dataset surface analysis.This identifier is the format "dataset name@datasource alias". For example: Country@World.

extractParameterol.supermap.SurfaceAnalystParametersSetting

Gets or sets the parameters of surface analysis. When using point dataset for isoregion extraction analysis, the expectedZValues field in the SurfaceAnalystParametersSetting class is not supported now.

filterQueryParameterol.supermap.FilterParameter

Gets or sets the query filter parameter.

resolutionnumber

Specifies the resolution of the intermediate results (raster dataset).

resultSettingol.supermap.DataReturnOption

The DataReturnOption class.

surfaceAnalystMethodol.supermap.SurfaceAnalystMethod

Gets or sets the extraction methods for isoline and isoregion extraction of surface analysis. Default is the isoline analysis.

Default Value:
ol.supermap.SurfaceAnalystMethod.ISOLINE

zValueFieldNamestring

Gets or sets the field name used for extraction operation. When extracting the isoline, you can use the value in the field, implement the interpolation analysis to the point data in the Recordset, get the raster dataset (intermediate result), and extract the isoline from the raster dataset.

Methods

static toObject(datasetSurfaceAnalystParameters, tempObj)

DatasetSurfaceAnalystParameters.js, line 67

Transform the DatasetSurfaceAnalystParameters to JSON

Name Type Description
datasetSurfaceAnalystParameters ol.supermap.DatasetSurfaceAnalystParameters

The DatasetSurfaceAnalystParameters class.
tempObj ol.supermap.DatasetSurfaceAnalystParameters

The DatasetSurfaceAnalystParameters
Returns:
The JSON object.

inherited destroy()

SurfaceAnalystParameters.js, line 54

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

inherited destroy()

SurfaceAnalystParameters.js, line 54

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