Class: SummaryRegionJobParameter

SummaryRegionJobParameter

区域汇总分析任务参数类。此类用于设置区域汇总分析的数据集、分析范围、标准属性字段、 权重字段、统计方式、汇总类型、网格类型和大小等参数,还可以对分析结果的输出参数、可视化参数进行一系列设置。

new SummaryRegionJobParameter(options)

Usage
import { SummaryRegionJobParameter } from '@supermapgis/iclient-leaflet';

new SummaryRegionJobParameter(options);
<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.SummaryRegionJobParameter({paramsNames});
  // 弃用的写法
  new SuperMap.SummaryRegionJobParameter(options);
</script>
common/iServer/SummaryRegionJobParameter.js, line 9
Name Type Description
options Object

参数。

Name Type Default Description
datasetName string

数据集名称,只支持线数据集和面数据集。

regionDataset string 可选

汇总数据集,在多边形汇总时需指定的参数,只支持面数据集。

query L.Bounds | L.LatLngBounds | GeoJSONObject 可选

区域汇总分析范围,默认为全图范围。

standardFields string 可选

标准属性字段名称。

weightedFields string 可选

权重字段名称。

standardStatisticModes StatisticAnalystMode 可选

标准属性字段的统计模式。standardSummaryFields 为 true 时必填。

weightedStatisticModes StatisticAnalystMode 可选

权重字段的统计模式。weightedSummaryFields 为 true 时必填。

sumShape boolean true 可选

如果源数据集是线数据集,则同时统计线的长度作为统计结果的一部分;如果源数据集是面数据集,则同时统计面的面积作为统计结果的一部分。

standardSummaryFields boolean false 可选

是否以标准属性字段统计。即对通过网格单元内的线或面对象的原有属性字段信息进行统计。

weightedSummaryFields boolean false 可选

是否以权重字段统计。即对通过网格单元内的线或面对象与网格单元相交部分的对象属性信息进行统计,相交部分的属性信息由标准属性字段的值加权计算得出。

resolution number 100 可选

指定网格大小,当 type 为网格面汇总时必选,对于四边形网格为网格的边长;对于六边形网格为六边形顶点到中心点的距离。

meshType number 0 可选

指定网格面汇总类型,当 type 为网格面汇总时必选,0 表示四边形网格,1 表示六边形网格。

meshSizeUnit AnalystSizeUnit AnalystSizeUnit.METER 可选

网格大小单位。

type SummaryType SummaryType.SUMMARYMESH 可选

区域汇总分析的类型,包括 SUMMARYMESH 网格面汇总,SUMMARYREGION 多边形汇总。

output OutputSetting 可选

输出参数设置。

mappingParameters MappingParameters 可选

分析后结果可视化的参数类。

API Relations

As method parameter: ProcessingService.addSummaryRegionJob.

Members

datasetNamestring

数据集名称。

mappingParametersMappingParameters

分析后结果可视化的参数类。

meshSizeUnitAnalystSizeUnit

网格大小单位。

Default Value:
AnalystSizeUnit.METER

meshTypenumber

指定网格面汇总类型,当 type 为网格面汇总时必选,0 表示四边形网格,1 表示六边形网格。

输出参数设置类。

分析范围。

regionDatasetstring

汇总数据集,在多边形汇总时需指定的参数,只支持面数据集。

resolutionnumber

指定网格大小,当 type 为网格面汇总时必选,对于四边形网格为网格的边长;对于六边形网格为六边形顶点到中心点的距离。

Default Value:
100

standardFieldsstring

标准属性字段名称。仅支持系统字段以外的整形、长整形、浮点型的字段的名称。standardSummaryFields 为 true 时必填。

standardStatisticModesStatisticAnalystMode

标准属性字段的统计模式。standardSummaryFields 为 true 时必填。

standardSummaryFieldsboolean

是否以标准属性字段统计。即对通过网格单元内的线或面对象的原有属性字段信息进行统计。

sumShapeboolean

是否统计被汇总对象的面积或者长度。

Default Value:
true

区域汇总分析的类型,包括 SUMMARYMESH 网格面汇总,SUMMARYREGION 多边形汇总。

Default Value:
SummaryType.SUMMARYMESH

weightedFieldsstring

权重字段名称。仅支持系统字段以外的整形、长整形、浮点型的字段的名称。weightedSummaryFields 为 true 时必填。

weightedStatisticModesStatisticAnalystMode

以权重字段统计的统计模式。权重字段的统计模式。weightedSummaryFields 为 true 时必填。

weightedSummaryFieldsboolean

是否以权重字段统计。即对通过网格单元内的线或面对象与网格单元相交部分的对象属性信息进行统计,相交部分的属性信息由标准属性字段的值加权计算得出。

Methods

static toObject(summaryRegionJobParameter, tempObj)

common/iServer/SummaryRegionJobParameter.js, line 171

生成区域汇总分析服务对象。

Name Type Description
summaryRegionJobParameter Object

区域汇总分析任务参数。

tempObj Object

目标对象。

destroy()

common/iServer/SummaryRegionJobParameter.js, line 142

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