JavaScript ArcGIS histogram.histogram用法及代码示例

基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/smartMapping/statistics/histogram"], (histogram) => { /* code goes here */ });

ESM: import histogram from "@arcgis/core/smartMapping/statistics/histogram";

函数： esri/smartMapping/statistics/histogram

自从：用于 JavaScript 4.2 的 ArcGIS API

用法说明

histogram.histogram函数(或属性)的定义如下：

histogram (params) {Promise<HistogramResult>}

为从给定 layer 中的 field 返回的数据生成直方图。返回的对象可用于在查询和显示统计信息的可视化创作应用程序和分析应用程序中向 UI 显示直方图。

参数：

规格：

类型说明

params Object

有关可以传递给此函数的参数的详细信息，请参见下表。

规格：

layer

要为其生成直方图的层。

field

String

可选的

将为其生成直方图的数值字段的名称。如果使用 valueExpression，则忽略此属性。

normalizationType

String

可选的

确定提供的 field 值如何标准化。此参数仅标准化由 field 引用的数据，不适用于从 valueExpression 或 sqlExpression 返回的值。有关可能值的列表，请参见下表。

可能的值	说明
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

可选的

仅在 normalizationType 为 percent-of-total 时适用。指示用于标准化字段值的总量。

classificationMethod

String

可选的

数据分类的方法。有关可能值的列表，请参见下表。

可能的值	说明
natural-breaks	聚类的数据值被放置在一个类中。类中断发生在簇之间存在间隙的地方。如果您的数据分布不均匀，则应使用此方法；也就是说，许多特征具有相同或相似的值，并且值组之间存在差距。
equal-interval	每个类都有相同的取值范围；换句话说，每个类别的高值和低值之间的差异是相等的。如果您的数据分布均匀，并且您想强调特征之间的值差异，则应使用此方法。
quantile	每个类都有大致相同数量的特征。如果你的数据是均匀分布的，并且你想强调特征之间相对位置的差异，你应该使用分位数分类方法。例如，如果将点值分为五个等级，则最高等级的点将落入所有点的前五分之一。
standard-deviation	以 `1` 、 `0.5` 或 `0.25` 标准差为间隔将分类分隔符放置在平均值上方和下方，直到所有数据值都包含在一个类中。

可能的值："equal-interval"|"natural-breaks"|"quantile"|"standard-deviation"

standardDeviationInterval

Number

可选的

当 classificationMethod = "standard-deviation" 时，这将设置应设置每个分类的间隔(例如 0.25 、 0.33 、 0.5 、 1 )。

minValue

Number

可选的

直方图的最小边界值。将此与 maxValue 结合使用以生成自定义下限和上限之间的直方图。

maxValue

Number

可选的

直方图的最大边界值。将此与 minValue 结合使用以生成自定义下限和上限之间的直方图。

numBins

Number

可选的

默认值： 10

指示要为直方图生成的类数。

valueExpression

String

可选的

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

sqlExpression

String

可选的

计算为数字的 SQL 表达式。

sqlWhere

String

可选的

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

view

View

可选的

当指定 valueExpression 时，需要 SceneView 或 MapView 实例。

features

Graphic []

已弃用从 4.23 版开始。请改用useFeaturesInView。

可选的

为其生成直方图的特征子集。

useFeaturesInView

Boolean

可选的

仅适用于输入layer是一个service-backed FeatureLayer。什么时候true，将根据视图中可见的函数在客户端上计算统计信息。如果false，将从服务中请求统计信息。从 4.23 版开始。

signal

AbortSignal

可选的

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

类型	说明
Promise<HistogramResult>	解析为 HistogramResult 的实例。

例子：

histogram({
  layer: featureLayer,
  valueExpression: "( ($feature.POP2020 - $feature.POP2010) / $feature.POP2010 ) * 100"
  view: mapView,
  numBins: 30
}).then(function(histogramResult){
  colorSlider.histogram = histogramResult;
});

histogram({
  layer: featureLayer,
  field: "Population",
  normalizationType: "natural-log",
  sqlWhere: "Population > 0",
  numBins: 100
}).then(function(histogramResult){
  const histogramWidget = Histogram.fromHistogramResult(histogramResult);
});

相关用法

注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 histogram.histogram。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。

基本信息

用法说明

参数：

返回：

例子：