Class: DatasetOverlayAnalystParameters

DatasetOverlayAnalystParameters

数据集叠加分析参数类。 该类用于设置要进行叠加分析的数据集和叠加操作类型、容限、空间对象过滤条件、保留在结果数据集中的字段等参数。 在叠加分析中至少涉及到三个数据集,其中一个数据集的类型可以是点、线、面等,被称作源数据集;另一个数据集是面数据集,被称作叠加对象数据集;还有一个数据集就是叠加结果数据集,包含叠加后数据的几何信息和属性信息。

new DatasetOverlayAnalystParameters(options)

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

</script>

// ES6 Import
import { DatasetOverlayAnalystParameters } from '@supermapgis/iclient-ol';

new DatasetOverlayAnalystParameters(options);

common/iServer/DatasetOverlayAnalystParameters.js, line 10
Name Type Description
options Object

参数。

Name Type Default Description
operateDataset string

操作数据集的名称,即叠加对象数据集的名称。该名称用形如 "数据集名称@数据源别名" 形式来表示,例如:Neighbor_R@Jingjin。

sourceDataset string

源数据集名称。该名称用形如 "数据集名称@数据源别名" 形式来表示,例如:BaseMap_R@Jingjin。

operateDatasetFields Array.<string> 可选

叠加分析中操作数据集保留在结果数据集中的字段名列表。

operateDatasetFilter FilterParameter 可选

设置操作数据集中空间对象过滤条件。

operateRegions Array.<(GeometryPolygon|L.Polygon|ol.geom.Polygon|GeoJSONObject)> 可选

操作面对象集合,表示与这些面对象进行叠加分析。与 operateDataset 参数互斥,冲突时以 operateDataset 为准。

sourceDatasetFields Array.<string> 可选

叠加分析中源数据集保留在结果数据集中的字段名列表。

sourceDatasetFilter FilterParameter 可选

设置源数据集中空间对象过滤条件。设置了过滤参数后,只有满足条件的对象参与叠加分析。

tolerance number 0 可选

容限。

operation OverlayOperationType

叠加操作枚举值。

resultSetting DataReturnOption 可选

结果返回设置类。

Extends

Members

聚合查询参数,该参数仅支持数据来源为 Elasticsearch 服务的 SuperMap iServer 的 REST 数据服务。

datasetNameArray.<string>

数据集集合中的数据集名称列表。

filterQueryParameterFilterParameter

设置源数据集中空间对象过滤条件。

fromIndexnumber

查询结果的最小索引号。如果该值大于查询结果的最大索引号,则查询结果为空。

hasGeometrynumber

返回结果是否包含 Geometry。

Default Value:
true

maxFeaturesnumber

进行 SQL 查询时,用于设置服务端返回查询结果条目数量。

Default Value:
1000

operateDatasetstring

叠加分析中操作数据集的名称。

operateDatasetFieldsArray.<string>

叠加分析中操作数据集保留在结果数据集中的字段名列表。

operateDatasetFilterFilterParameter

设置操作数据集中空间对象过滤条件。

操作面对象集合,表示与这些面对象进行叠加分析。与 operateDataset 参数互斥,冲突时以 operateDataset 为准。

resultSettingDataReturnOption

结果返回设置类。

returnContentboolean

是否立即返回新创建资源的表述还是返回新资源的 URI。 如果为 true,则直接返回新创建资源,即查询结果的表述。 如果为 false,则返回的是查询结果资源的 URI。

Default Value:
true

returnFeaturesOnlyboolean

仅返回要素信息。

sourceDatasetstring

叠加分析中源数据集的名称。

sourceDatasetFieldsArray.<string>

叠加分析中源数据集保留在结果数据集中的字段名列表。

targetEpsgCodestring

动态投影的目标坐标系对应的 EPSG Code,使用时需设置 returnContent 参数为 true。

targetPrjObject

动态投影的目标坐标系。使用时需设置 returnContent 参数为 true。如:prjCoordSys={"epsgCode":3857}。当同时设置 targetEpsgCode 参数时,此参数不生效。

toIndexnumber

查询结果的最大索引号。如果该值大于查询结果的最大索引号,则以查询结果的最大索引号为终止索引号。

Default Value:
19

tolerancenumber

容限。

Methods

static toObject(datasetOverlayAnalystParameters, tempObj){Object}

common/iServer/DatasetOverlayAnalystParameters.js, line 132

将数据集叠加分析参数类转换为 JSON 对象。

Name Type Description
datasetOverlayAnalystParameters DatasetOverlayAnalystParameters

数据集叠加分析参数类。

tempObj DatasetOverlayAnalystParameters

数据集叠加分析参数对象。

Returns:
Type Description
Object JSON 对象。

inherited destroy()

common/iServer/DatasetOverlayAnalystParameters.js, line 99

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