summaryStatistics

AMD: require(["geoscene/smartMapping/statistics/summaryStatistics"], (summaryStatistics) => { /* code goes here */ });
ESM: import summaryStatistics from "@geoscene/core/smartMapping/statistics/summaryStatistics";
函数: geoscene/smartMapping/statistics/summaryStatistics
起始版本:GeoScene API for JavaScript 4.2

用于根据从给定字段返回的值在图层中生成属性统计数据的函数。

已知限制

  • SceneLayers 必须启用 supportsRenderersupportsLayerQuery 功能,除非为方法的 statistics 参数提供了预定义的统计对象。要检查 SceneLayer 的功能,请使用 getFieldInfoUsage() 方法。
  • 您无法使用 SQL 表达式为 SceneView 中的客户端 FeatureLayers 生成统计信息。
  • normalizationType 参数仅对 field 返回的数据进行规范化。它不适用于从 valueExpressionsqlExpression 返回的值。

方法概述

名称 返回类型 描述 函数
Promise<SummaryStatisticsResult>更多信息

返回一个对象,其中包含描述从图层中的字段(或表达式)返回的一组值的统计信息。

更多信息summaryStatistics

方法详情

summaryStatistics(params){Promise<SummaryStatisticsResult>}

返回一个对象,其中包含描述从图层中的字段(或表达式)返回的一组值的统计信息。

参数:
详述:
params Object

有关每个参数的详细信息,请参阅下表。

详述:

从中为给定 field 生成统计信息的图层。

field String
可选

将为其生成汇总统计信息的数字或字符串字段的名称。如果使用 valueExpression,则忽略此属性。

valueExpression String
可选

遵循 Arcade Visualization Profile 定义的规范的 Arcade 表达式。表达式可以使用 $feature 全局变量引用字段值,并且必须返回一个数字。此属性覆盖 field 属性,因此用于代替输入field 值。

sqlExpression String
可选

计算为数字的 SQL 表达式。

sqlWhere String
可选

用于过滤统计查询要素的 SQL where 子句。例如,这在您希望避免除以零的情况下很有用,就像创建优势可视化的情况一样。

normalizationType String
可选

确定提供的 field 值将如何标准化。此参数仅对 field 引用的数据进行规范化,不适用于从 valueExpressionsqlExpression 返回的值。有关可能值的列表,请参阅下表。

可能值 说明
field 使用 normalizationField 参数中指定的字段值除数据值。如果使用此值,则必须提供 normalizationField
percent-of-total 将数据值除以所有数据值的总和,然后乘以 100。使用 normalizationTotal 定义标准化的总值。
log 计算数据值的以 10 为底数的对数。对于查看高度偏斜的数据分布可能是一种有用的方法,因为它可以减少异常值的影响。仅计算正值。如果数据包含大量负值,则应避免此规范化类型。
natural-log 计算数据值的自然对数。对于查看高度偏斜的数据分布可能是一种有用的方法,因为它可以减少异常值的影响。仅计算正值。如果数据包含大量负值,则应避免此规范化类型。
square-root 计算数据值的平方根。对于查看高度偏斜的数据分布可能是一种有用的方法,因为它可以减少异常值的影响。仅计算正值。如果数据包含大量负值,则应避免此规范化类型。

可能值:"field"|"log"|"percent-of-total"|"natural-log"|"square-root"

normalizationField String
可选

用于规范化从给定 field 返回的值的字段。

normalizationTotal Number
可选

仅在 normalizationTypepercent-of-total 时,才适用。指示用于标准化字段值的总量。

minValue Number
可选

统计计算的最小边界值。将此与 maxValue 结合使用以生成上下限之间的统计信息。

maxValue Number
可选

统计计算的最大边界值。将此与 minValue 结合使用以生成上下限之间的统计信息。

view View
可选

指定 valueExpression 时需要 SceneViewMapView 实例。

features Graphic[]
已弃用起始版本 4.23。请改用 useFeaturesInView
可选

要为其计算统计数据的要素子集。

useFeaturesInView Boolean
可选

仅当输入 layer 是服务支持的 FeatureLayer 时才适用。当为 true 时,将根据视图中可见的要素在客户端上计算统计信息。若为 false,将从服务中请求统计信息。起始版本 4.23。

可选

允许可取消的请求。如果取消,promise 将被拒绝并出现名为 AbortError 的错误。另请参阅 AbortController

返回:
类型 说明
Promise<SummaryStatisticsResult> 返回解析为 SummaryStatisticsResult 的承诺。
示例:
summaryStatistics({
  layer: featureLayer,
  valueExpression: "( ($feature.POP2020 - $feature.POP2010) / $feature.POP2010 ) * 100"
  view: mapView
}).then(function(stats){
  colorSlider.statistics = stats;
});
summaryStatistics({
  layer: featureLayer,
  field: "Population",
  normalizationType: "natural-log",
  sqlWhere: "Population > 0",
  numBins: 100
}).then(function(stats){
  histogramWidget.average = stats.avg;
});

类型定义

SummaryStatisticsResult

summaryStatistics() 查询返回的统计信息。

属性:
avg Number

从字段或表达式返回的所有值的平均值。

count Number

给定字段具有非空值的要素总数。

max Number

从字段或表达式返回的所有值的最大值。

median Number

从字段或表达式返回的所有值的中位数。起始版本 4.22。

min Number

从字段或表达式返回的所有值的最小值。

stddev Number

根据从字段或表达式返回的值计算得出的标准差。

sum Number

从字段或表达式返回的所有值的总和。

variance Number

从字段或表达式返回的所有值计算出的方差。

nullcount Number
可选

存储在给定字段中的空值数。仅适用于 版本 4.20 或更高版本的字段值计算的汇总统计数据。

您的浏览器已不再受支持。请升级您的浏览器以获得最佳体验。请参阅 我们的浏览器弃用帖子以获取详细信息