require(["esri/smartMapping/labels/clusters"], (clusterLabelCreator) => { /* code goes here */ });
import * as clusterLabelCreator from "@arcgis/core/smartMapping/labels/clusters.js";
esri/smartMapping/labels/clusters
This object contains a helper method for generating default labels to be set on
a layer's cluster configuration.
The default label is based on the layer's renderer. In most cases the default label configuration will
be the total number of features in the cluster. This value will be rounded and formatted (e.g. instead of 2385, the
cluster label will display 2.4k). In some cases, such as renderers with a SizeVariable,
the default label will display the average value of the attribute represented by the size variable.
This includes secondary labeling schemes you can experiment with in your clusters. This module only applies to layers with a point geometry type.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Promise<Schemes> | Generates default labelingInfo schemes to be set on a FeatureLayer's featureReduction configuration. | clusters |
Method Details
-
getLabelSchemes
MethodgetLabelSchemes(params){Promise<Schemes>} -
Generates default labelingInfo schemes to be set on a FeatureLayer's featureReduction configuration. Returns one or more suggested LabelClasses for a given layer based on its renderer. It also returns a suggested clusterMinSize to ensure labels fit inside clusters.
If a renderer has a non-scale dependent SizeVariable, then the average value of the field or expression used to determine the cluster size will be suggested as the default label value. In all other scenarios, the suggested label will display the cluster count in the center of the label.
ParametersSpecificationparams ObjectSee the table below for details of each parameter that may be passed to this function.
Specificationlayer FeatureLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer|StreamLayer|OrientedImageryLayer|KnowledgeGraphSublayerThe point layer that has or will have clustering enabled.
view MapViewThe view where the input layer will be rendered.
field StringoptionalThe name of the AggregateField to use in the primary label scheme. If not specified, then the label will be based on the data used to vary cluster size.
renderer RendereroptionalThe renderer to set on the input layer when clustering is enabled. Specify this parameter if the layer's renderer does not match the renderer that will be used when clustering is enabled. This cannot be a HeatmapRenderer.
ReturnsType Description Promise<Schemes> Returns an object containing suggested primary and secondary labeling schemes to be set on the layer's featureReductionproperty.Example// Sets suggested labels on the clusters based on the underlying 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); });
Type Definitions
-
Contains a suggested labelingInfo to be set on the layer's featureReduction.labelingInfo.
- Properties
-
name String
The name of the generated cluster labeling scheme. This can be used in the UI of web map authoring apps.
fieldName StringThe name of the aggregate field the labeling scheme is based on. This can be used in the UI of web map authoring apps.
labelingInfo LabelClass[]An array of LabelClass objects to set on the layer's featureReduction.labelingInfo property.
clusterMinSize NumberThe suggested featureReduction.clusterMinSize required to fit labels within clusters.
-
The return object of the getLabelSchemes() method.