Class: SummaryRegionJobParameter

SuperMap.SummaryRegionJobParameter

The SummaryRegionJobParameter class,

new SuperMap.SummaryRegionJobParameter(options)

SummaryRegionJobParameter.js, line 11
Name Type Description
options Object

The parameters.

Name Type Default Description
datasetName string

The dataset name
query SuperMap.Bounds | L.Bounds | ol.extent

The query bounds.
standardFields string optional

Standard attribute field name.
weightedFields string optional

The field name of statistic with the weight.
standardStatisticModes SuperMap.StatisticAnalystMode optional

The statistical mode of the standard attribute field.
weightedStatisticModes SuperMap.StatisticAnalystMode optional

The statistical mode of the weight field.
sumShape boolean true optional

Whether to count the length or area.
standardSummaryFields boolean false optional

Whether to count in the standard genus field.
weightedSummaryFields boolean false optional

Whether to count in the weight field.
resolution number 100 optional

The resolution.
meshType number 0 optional

The mesh type.
meshSizeUnit SuperMap.AnalystSizeUnit SuperMap.AnalystSizeUnit.METER optional

The unit of the mesh size
type SuperMap.SummaryType SuperMap.SummaryType.SUMMARYMESH optional

The summary type
output SuperMap.OutputSetting optional

Output parameter setting class.
mappingParameters SuperMap.MappingParameters optional

The parameter class for visualizing the results after analysis.

Members

datasetNamestring

The dataset name。

mappingParametersSuperMap.MappingParameters

The parameter class for visualizing the results after analysis.

meshSizeUnitSuperMap.AnalystSizeUnit

The unit of the mesh size.

Default Value:
SuperMap.AnalystSizeUnit.METER

meshTypenumber

The mesh type.

outputSuperMap.OutputSetting

Output parameter setting class.

querySuperMap.Bounds L.Bounds ol.extent

The query bounds.

regionDatasetstring

Dataset of the region. (It's valid when mesh type is by polygons).

resolutionnumber

The resolution.

Default Value:
100

standardFieldsstring

Standard attribute field name. Only the names of fields other than system fields, such as shaping, long shaping, and floating point, are supported. Required if standardSummaryFields is true.

standardStatisticModesSuperMap.StatisticAnalystMode

The statistical mode of the standard attribute field. Required if standardSummaryFields is true.

standardSummaryFieldsboolean

Whether to count in the standard genus field.

sumShapeboolean

Whether to count the length or area.

Default Value:
true

typeSuperMap.SummaryType

The summary type.

Default Value:
SuperMap.SummaryType.SUMMARYMESH

weightedFieldsstring

The field name of statistic with the weight. Only the names of fields other than system fields, such as shaping, long shaping, and floating point, are supported. Required if standardSummaryFields is true.

weightedStatisticModesSuperMap.StatisticAnalystMode

The statistical mode that is counted in the weight field. The statistical mode of the weight field. Required when weightedSummaryFields is true.

weightedSummaryFieldsboolean

Whether to count in the weight field.

Methods

SuperMap.SummaryRegionJobParameter.toObject(summaryRegionJobParameter, tempObj)

SummaryRegionJobParameter.js, line 169

Get the area summary analysis of service object.

Name Type Description
summaryRegionJobParameter Object

The SummaryRegionJobParameter.
tempObj Object

The target object.

destroy()

SummaryRegionJobParameter.js, line 140

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