classBreaks

方法概述

方法详细说明

classBreaks(params){Promise<ClassBreaksResult>}

用于根据给定的分类方法和规范化类型为 FeatureLayer 中的输入字段 (或表达式) 生成分类间隔。

参数

规范

params Object 有关可能传递给此函数的参数的详细信息，请参阅下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|PointCloudLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 从中生成分类间隔的图层。 field String optional 分类间隔将基于此字段的值生成。如果提供了字段，则将在服务中查询来自所有要素的给定字段中的值。 normalizationField String optional 用于规范化从给定 field 返回的值的字段。 classificationMethod String optional 对数据进行分类的方法。有关可能值列表，请参见下表。 可能值 描述 natural-breaks 将聚类的数据值放置到单个类中。分类间隔发生在聚类之间存在间隙的地方。如果您的数据分布不均匀，则应使用此方法；也就是说，许多要素具有相同或相似的值，并且值组之间存在间隙。 equal-interval 每个类具有相等的值范围；换句话说，每个类的高值和低值之间的差异是相等的。如果数据分布均匀，并且想要强调要素之间值的差异，则应使用此方法。 quantile 每个类具有大致相同的要素数。如果数据分布均匀，并且想要强调要素之间相对位置处的差异，则应使用分位数分类方法。例如，如果将点值分为五个类，则最高类中的点将落入所有点的前五分之一。 standard-deviation 以 1、0.5 或 0.25 个标准差的间隔将分类分隔放置在平均值上方和下方，直到所有数据值都包含在一个类中。 可能值："equal-interval"|"natural-breaks"|"quantile"|"standard-deviation" standardDeviationInterval Number optional 当 classificationMethod = "standard-deviation" 时，这将设置间隔，在此处可设置每个分类间隔 (例如 0.25, 0.33, 0.5, 1)。 minValue Number optional 分类间隔定义的最小边界值。将此参数与 maxValue 结合使用以在下限和上限之间生成分类中断。 maxValue Number optional 分类间隔定义的最大边界值。将此参数与 minValue 结合使用以在下限和上限之间生成分类中断。 numClasses Number optional 指示要为分类间隔定义生成的类数。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 view View optional 当指定 valueExpression 时，需要 SceneView 或 MapView 实例。 filter FeatureFilter optional 用于按几何过滤统计查询的要素过滤器。此参数仅用于按几何过滤统计信息。忽略 FeatureFilter.where 属性上设置的任何属性过滤器。目前，仅支持 intersects 空间关系。如果您已按图层上的几何定义了要素过滤器，并且希望计算包含要素的统计信息，则此选项非常有用。从 4.25 版开始。 features Graphic[] 已弃用从 4.23 版开始。请改为使用 useFeaturesInView。 optional 要为其生成分类间隔的要素子集。 useFeaturesInView Boolean optional 仅当输入 layer 是服务支持的 FeatureLayer 时才适用。当为 true，将根据视图中可见的要素在客户端上计算统计信息。如果为 false，则将从服务请求统计信息。从 4.23 版开始。 forBinning Boolean optional 指示生成的统计信息是用于图格可视化还是用于聚类可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

类型	描述
Promise<ClassBreaksResult>	解析为 ClassBreaksResult 的实例。

示例

classBreaks({
  layer: featureLayer,
  field: "COL_DEG",
  normalizationField: "TOT_POP",
  classificationMethod: "quantile",
  numClasses: 5
}).then(function(response){
  // class break infos that may be passed to the
  // constructor of a ClassBreaksRenderer
  let breakInfos = response.classBreakInfos;
});

类型定义

ClassBreak

描述从 classBreaks() 方法生成的单个分类间隔的对象。

属性

label String 描述在图例中使用的给定分类间隔的标注。

minValue Number 分类间隔的下限。

maxValue Number 分类间隔的上限。

ClassBreaksResult

从 classBreaks() 方法返回的对象。此对象描述了使用指定分类方法从 FeatureLayer 数据为给定字段生成的类。

属性

classBreakInfos ClassBreak[] 描述从 classBreaks() 方法生成的分类间隔的对象数组。

minValue Number 数据集中要素的最小值。这将是最低分类间隔的下限。

maxValue Number 数据集中要素的最大值。这将是最高分类间隔的上限。

normalizationTotal Number 在使用 createClassBreaksRenderer() 生成分类间隔时，如果 normalizationType 设置为 percent-of-total，则归一化总数。