• geoscene/smartMapping
    • labels

clusters

AMD: require(["geoscene/smartMapping/labels/clusters"], (clusterLabelCreator) => { /* code goes here */ });
ESM: import * as clusterLabelCreator from "@geoscene/core/smartMapping/labels/clusters";
类: geoscene/smartMapping/labels/clusters
起始版本:GeoScene Maps SDK for JavaScript 4.16

此对象包含一个辅助方法,用于生成要在图层的聚类配置上进行设置的默认标注。默认标注基于图层的渲染器。在大多数情况下,默认标注配置将是聚类中的要素总数。该值将被四舍五入并进行格式化 (例如,聚类标注将显示 2.4k,而不是 2385)。在某些情况下,例如带有 SizeVariable 的渲染器,默认标注将显示由 size 变量表示的属性的平均值。

clustering-generated-labels

这包括可在聚类中进行试用的次要标记方案。此模块仅适用于具有点几何类型的图层。

方法概述

名称 返回值类值 描述 对象
Promise<Schemes>

生成要在 FeatureLayer 的 featureReduction 配置中进行设置的默认 labelingInfo 方案。

更多详情
clusters

方法详细说明

getLabelSchemes(params){Promise<Schemes>}

生成要在 FeatureLayer 的 featureReduction 配置中进行设置的默认 labelingInfo 方案。根据给定图层的渲染器返回一个或多个建议的 LabelClasses。它还返回一个建议的 clusterMinSize 以确保标注适合聚类。

如果渲染器具有不依赖于比例的 SizeVariable,则建议将用于确定聚类大小的字段或表达式的平均值作为默认标注值。在所有其他情况下,建议的标注将在标注的中心显示聚类计数。

参数
规范
params Object

有关可能传递给此函数的每个参数的详细信息,请参阅下表。

规范

已启用或将启用聚类的点图层。

renderer Renderer
optional

启用聚类时,在输入图层上设置的渲染器。如果图层的渲染器与启用聚类时所用的渲染器不匹配,请指定此参数。这不能是 HeatmapRenderer

view MapView

将在其中渲染输入图层的视图。

返回
类型 描述
Promise<Schemes> 返回一个对象,其中包含要在图层的 featureReduction 属性上设置的建议的主要标注和次要标注方案。
示例
// Sets a suggested popupTemplate on the layer based on its renderer
clusterLabelCreator.getLabelSchemes({
  layer: featureLayer,
  view: view
}).then(function(labelSchemes){
  const featureReduction = featureLayer.featureReduction.clone();
  const { labelingInfo, clusterMinSize } = labelSchemes.primaryScheme;
  featureReduction.labelingInfo = labelingInfo;
  featureReduction.clusterMinSize = clusterMinSize;

  featureLayer.featureReduction = featureReduction;
}).catch(function(error){
  console.error(error);
});

类型定义

Scheme

包含要在图层的 featureReduction.labelingInfo 上设置的建议 labelingInfo。

属性
name String

生成的聚类标记方案的名称。这可在 web 地图创作应用程序的 UI 中使用。

fieldName String

标记方案所基于的 aggregate 字段的名称。这可在 web 地图创作应用程序的 UI 中使用。

labelingInfo LabelClass[]

要在图层的 featureReduction.labelingInfo 属性上设置的一组 LabelClass 对象。

clusterMinSize Number

建议的 featureReduction.clusterMinSize 需要在聚类中放置标注。

Schemes

getLabelSchemes() 方法返回的对象。

属性
primaryScheme Scheme

包括为输入图层的聚类建议的主要标记方案。

secondarySchemes Scheme[]

包括为输入图层的聚类建议的次要标记方案。

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