Class: GeoRelationAnalystParameters

GeoRelationAnalystParameters

空间关系分析服务参数类。该类可指定用于空间关系分析的源数据集和参考数据集,以及空间判断关系类型、边界处理方式等参数, 还可以对分析结果进行一系列设置。支持的空间关系判断类型:包含、被包含、相交。

new GeoRelationAnalystParameters(options)

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

</script>

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

new GeoRelationAnalystParameters(options);

common/iServer/GeoRelationAnalystParameters.js, line 6
Name Type Description
options Object

参数。

Name Type Default Description
sourceFilter FilterParameter

空间关系分析中的源数据集查询参数。仅 name, ids, attributeFilter 和 fields 字段有效。

referenceFilter FilterParameter

空间关系分析中的参考数据集查询参数。仅 name, ids, attributeFilter 和 fields 字段有效。

spatialRelationType SpatialRelationType

指定的空间关系类型。

isBorderInside boolean 可选

边界处理方式,即位于面边线上的点是否被面包含。此参数仅用于空间关系为包含或被包含的情况。

returnFeature boolean 可选

是否返回 Feature 信息。

returnGeoRelatedOnly boolean true 可选

仅返回满足指定空间关系的空间对象。

startRecord number 0 可选

分析结果起始记录位置。

expectCount number 500 可选

空间关系分析期望返回结果记录数,如果实际不足500条结果则返回所有分析结果。

Members

datasetstring

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

expectCountnumber

空间关系分析期望返回结果记录数,如果实际不足 500 条结果则返回所有分析结果。

Default Value:
500

isBorderInsideboolean

边界处理方式,即位于面边线上的点是否被面包含。此参数仅用于空间关系为包含或被包含的情况。

referenceFilterFilterParameter

空间关系分析中的参考数据集查询参数。仅 name,ids,attributeFilter 和 fields 字段有效。

returnFeatureboolean

是否返回 Feature 信息。

returnGeoRelatedOnlyboolean

是否仅返回满足指定空间关系的空间对象。

Default Value:
true

returnGeoRelatedOnlynumber

分析结果起始记录位置。

sourceFilterFilterParameter

空间关系分析中的源数据集查询参数。仅 ids、attributeFilter 和 fields 字段有效。

spatialRelationTypeSpatialRelationType

指定的空间关系类型。

Methods

destroy()

common/iServer/GeoRelationAnalystParameters.js, line 87

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