bins | References | ArcGIS Maps SDK for JavaScript

import { getLabelSchemes } from "@arcgis/core/smartMapping/labels/bins.js";

Since: ArcGIS Maps SDK for JavaScript 4.27

This object contains a helper method for generating default labels to be set on a layer's binning configuration. The default label is based on the FeatureReductionBinning.renderer. In most cases the default label configuration will be the total number of features in the bin. This value will be rounded and formatted (e.g. instead of 2385, the bin label will display 2.4k).

This includes secondary labeling schemes you can experiment with using on your bins. This module only applies to layers with a point geometry type.

See also

FeatureReductionBinning.labelingInfo

Functions

Name	Return Type	Object
`getLabelSchemes`	`Promise<Schemes \| null \| undefined>`
`SchemeParameters`
`Scheme`
`Schemes`

getLabelSchemes

Function

Generates default FeatureReductionBinning.labelingInfo schemes to be set on a FeatureLayer's FeatureLayer.featureReduction property. Returns one or more suggested LabelClasses for FeatureReductionBinning based on its renderer.

Signature: getLabelSchemes (parameters: SchemeParameters): Promise<Schemes | null | undefined>

Parameters

Parameter	Type	Description	Required
parameters	`SchemeParameters`	The function parameters.

Returns: Promise<Schemes | null | undefined>
Returns an object containing suggested primary and secondary labeling schemes to be set on the layer's featureReduction property.

Example

// Sets a suggested label scheme for the binning config based on its renderer
const { primaryScheme } = await binLabelCreator.getLabelSchemes({
  layer: featureLayer
});

const featureReduction = featureLayer.featureReduction.clone();
featureReduction.labelingInfo = primaryScheme.labelingInfo;
featureLayer.featureReduction = featureReduction;