@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/layers/support/FeatureReductionCluster.d.ts

@@ -1,4 +1,1189 @@
-import "../../interfaces";
+import type PopupTemplate from "../../PopupTemplate.js";
+import type AggregateField from "./AggregateField.js";
+import type LabelClass from "./LabelClass.js";
+import type CIMSymbol from "../../symbols/CIMSymbol.js";
+import type PictureMarkerSymbol from "../../symbols/PictureMarkerSymbol.js";
+import type SimpleMarkerSymbol from "../../symbols/SimpleMarkerSymbol.js";
+import type TextSymbol from "../../symbols/TextSymbol.js";
+import type WebStyleSymbol from "../../symbols/WebStyleSymbol.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { RendererUnion } from "../../renderers/support/typeUtils.js";
+import type { PopupTemplateProperties } from "../../PopupTemplate.js";
+import type { HeatmapRendererProperties } from "../../renderers/HeatmapRenderer.js";
+import type { PieChartRendererProperties } from "../../renderers/PieChartRenderer.js";
+import type { DictionaryRendererProperties } from "../../renderers/DictionaryRenderer.js";
+import type { DotDensityRendererProperties } from "../../renderers/DotDensityRenderer.js";
+import type { UniqueValueRendererProperties } from "../../renderers/UniqueValueRenderer.js";
+import type { ClassBreaksRendererProperties } from "../../renderers/ClassBreaksRenderer.js";
+import type { SimpleRendererProperties } from "../../renderers/SimpleRenderer.js";
+import type { CIMSymbolProperties } from "../../symbols/CIMSymbol.js";
+import type { WebStyleSymbolProperties } from "../../symbols/WebStyleSymbol.js";
+import type { TextSymbolProperties } from "../../symbols/TextSymbol.js";
+import type { SimpleMarkerSymbolProperties } from "../../symbols/SimpleMarkerSymbol.js";
+import type { PictureMarkerSymbolProperties } from "../../symbols/PictureMarkerSymbol.js";
+import type { LabelClassProperties } from "./LabelClass.js";
+import type { AggregateFieldProperties } from "./AggregateField.js";
 
-import FeatureReductionCluster = __esri.FeatureReductionCluster;
-export default FeatureReductionCluster;
+export interface FeatureReductionClusterProperties extends JSONSupportMixinProperties, Partial<Pick<FeatureReductionCluster, "labelsVisible" | "maxScale" | "popupEnabled">> {
+  /**
+   * Defines the symbol size of the largest cluster in points (or pixels if specified). Adjusting `clusterMaxSize`
+   * generally should be considered if the [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius) is modified.
+   *
+   * For example, if you prefer cluster icons to not overlap, then the `clusterMaxSize`
+   * should be substantially smaller than the `clusterRadius`.
+   *
+   * If a custom [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) is defined for cluster, and that renderer contains a
+   * [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then this property is ignored and cluster sizes
+   * are determined using the renderer's size variable.
+   *
+   * @default 37.5
+   * @since 4.16
+   * @see [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize)
+   * @see [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius)
+   * @example
+   * // clusterMaxSize should be adjusted
+   * // appropriately to conform
+   * // to the clusterRadius
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: "50px",
+   *   clusterMaxSize: "32px"
+   * };
+   */
+  clusterMaxSize?: number | string;
+  /**
+   * Defines the symbol size of the smallest cluster in points (or pixels if specified). If [labeling](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) clusters
+   * with a count or some other information in the center of the cluster, then having a `clusterMinSize`
+   * larger than the default is generally preferred.
+   *
+   * Keep in mind that this size may be smaller than the symbol size of individual non-clustered features
+   * in the layer. In that scenario, you should either reduce the size of the symbol(s) in the layer's renderer
+   * or increase the `clusterMinSize` to be larger than the size of individual point symbols to avoid confusion
+   * for the end user. This is most likely to happen when cluster size represents feature count.
+   *
+   * If a custom [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) is defined for cluster, and that renderer contains a
+   * [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then this property is ignored and cluster sizes
+   * are determined using the renderer's size variable.
+   *
+   * @default 9
+   * @since 4.16
+   * @see [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize)
+   * @see [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo)
+   * @example
+   * // a larger clusterMinSize looks better when labels are enabled
+   * featureReduction.clusterMinSize = "24px";
+   * featureReduction.labelsVisible = true;
+   */
+  clusterMinSize?: number | string;
+  /**
+   * Defines the radius in points (or pixels if specified) of the area in which multiple features will be grouped
+   * and visualized as a single cluster. Adjusting `clusterRadius`
+   * generally should be considered if the [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) is modified.
+   *
+   * For example, if you prefer cluster graphics to not overlap, then the `clusterRadius`
+   * should be substantially larger than the `clusterMaxSize`.
+   *
+   * @default 60
+   * @see [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize)
+   * @example
+   * // enables clustering on the layer with a
+   * // clusterRadius of 40pt
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: 40,
+   *   clusterMaxSize: 24
+   * };
+   * @example
+   * // enables clustering on the layer with a
+   * // clusterRadius of 120px
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: "120px",
+   *   clusterMaxSize: "80px"
+   * };
+   */
+  clusterRadius?: number | string;
+  /**
+   * An array of aggregate fields that summarize layer [FeatureLayer#fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields)
+   * from features contained within each cluster. These fields may be used by the [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate),
+   * [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer).
+   *
+   * Some fields are internally automatically created by the JS API's rendering engine for use
+   * in default cluster renderers (not set by the developer). The
+   * [AggregateField#isAutoGenerated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#isAutoGenerated)
+   * property indicates whether a field was internally created by the JS API. All auto-generated fields
+   * are read-only. They are discarded and replaced with new fields each time the user changes the underlying layer's renderer. Therefore,
+   * auto-generated fields should always be used with caution.
+   *
+   * The table below describes the general rules for how the rendering engine names auto-generated aggregate fields.
+   *
+   * Field Name | Type | Description
+   * -----------|------|------------
+   * `cluster_count` | number | The number of features in the cluster.
+   * `cluster_avg_{fieldName}` | number | For renderers visualizing a number field either with size, opacity, continuous color, or class breaks, this field describes the average of the rendered field among all features in the cluster.
+   * `cluster_type_{fieldName}` | string | For layers with a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html), this field describes the mode, or predominant string of the rendered field among all features within the cluster.
+   *
+   * @since 4.25
+   * @example
+   * featureReduction.fields = [{
+   *   name: "aggregateCount",
+   *   statisticType: "count"
+   * }, {
+   *   name: "SUM_population",
+   *   onStatisticField: "population",
+   *   statisticType: "sum"
+   * }, {
+   *   name: "AVG_age",
+   *   onStatisticField: "age",
+   *   statisticType: "avg"
+   * }, {
+   *   name: "AVG_population_density",
+   *   alias: "Average population density",
+   *   onStatisticExpression: {
+   *     expression: "$feature.population / AreaGeodetic($feature, 'square-miles')",
+   *     title: "population density",
+   *     returnType: "number"
+   *   },
+   *   statisticType: "avg"
+   * }];
+   */
+  fields?: AggregateFieldProperties[];
+  /**
+   * Defines labels for clusters as an array of
+   * [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). When set, labels
+   * independent of the [layer.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) are used
+   * to convey information about the clusters, including the count of all features in the cluster,
+   * the average, or predominant values of fields mapped by the renderer.
+   *
+   * Label expressions may only refer to aggregate fields defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property. Auto-generated
+   * fields may be used, but are at risk of being discarded if the underlying layer's renderer changes. See [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields)
+   * for more information.
+   *
+   * It is advisable to turn off [label deconfliction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#deconflictionStrategy)
+   * when labeling clusters with a count in the center of the cluster. To generate suggested labels for your cluster configuration based on the layer's renderer,
+   * see [clusterLabelCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html).
+   *
+   * Multiple Label classes with different `where` clauses can be used to define several
+   * labels with varying styles on the same feature. Likewise, multiple label classes
+   * may be used to label different types of clusters (e.g. blue labels
+   * for small clusters and red labels for large ones).
+   *
+   * @since 4.16
+   * @see [clusterLabelCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html)
+   * @example
+   * // Displays the count inside the cluster
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   labelingInfo: [{
+   *     labelExpressionInfo: {
+   *       expression: "$feature.cluster_count"
+   *     },
+   *     deconflictionStrategy: "none",
+   *     labelPlacement: "center-center",
+   *     symbol: {
+   *       type: "text",
+   *       color: "white",
+   *       font: {
+   *         size: "12px"
+   *       },
+   *       haloSize: 1,
+   *       haloColor: "black"
+   *     }
+   *   }]
+   * };
+   */
+  labelingInfo?: LabelClassProperties[] | null;
+  /**
+   * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to clustered graphics. When set, a popupTemplate
+   * independent of the [layer.popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) is used.
+   * This popup can display summary information for the cluster, including the count of all features in the cluster
+   * and the average or predominant values of fields mapped by the renderer.
+   *
+   * To generate a suggested predefined popup template for your cluster configuration based on the layer's renderer,
+   * see [clusterPopupTemplateCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html).
+   *
+   * The PopupTemplate may contain one or more [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following
+   * the specification defined by the [Arcade Feature Reduction Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-reduction-popup).
+   * Expressions must return a string or a number and may access data values from the cluster and its aggregated features
+   * with the `$feature` and `$aggregatedFeatures` profile variables.
+   *
+   * Popup expressions may only refer to aggregate fields defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property. Auto-generated
+   * fields may be used, but are at risk of being discarded if the underlying layer's renderer changes. See [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields)
+   * for more information about this behavior.
+   *
+   * The following `popupTemplate` configurations will display the popups shown in the images below.
+   *
+   * ### Cluster count
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: "This cluster represents {cluster_count} earthquakes."
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-simple-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-simple-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+   *
+   * ### Clusters by predominant type
+   *
+   *
+   * The following featureReduction configuration assumes the layer's renderer is a UniqueValueRenderer
+   * who's field is named `religion`.
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> features."
+   *     }, {
+   *       type: "text",
+   *       text: "The predominant place of worship in this cluster is <b>{cluster_type_religion}</b>."
+   *     }]
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-types-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-types-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+   *
+   * ### Clusters with visual variables
+   *
+   * The following featureReduction configuration assumes the layer's renderer contains visual variables
+   * referencing fields named `WIND_SPEED`, `WIND_DIRECT`, `TEMP`.
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> weather stations."
+   *     }, {
+   *       type: "fields",
+   *       fieldInfos: [{
+   *         fieldName: "cluster_avg_WIND_SPEED",
+   *         label: "Average wind speed (km/h)",
+   *         format: {
+   *           places: 0
+   *         }
+   *       }, {
+   *         fieldName: "cluster_avg_WIND_DIRECT",
+   *         label: "Average wind direction (degrees)",
+   *           format: {
+   *             places: 0
+   *           }
+   *       }, {
+   *           fieldName: "cluster_avg_TEMP",
+   *           label: "Average temperature (°F)",
+   *           format: {
+   *            places: 0
+   *           }
+   *        }]
+   *     }]
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-color-size-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-color-size-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+   *
+   * @see [clusterPopupTemplateCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html)
+   * @see [Arcade Feature Reduction Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-reduction-popup)
+   * @see [Sample - Point clustering](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+   * @see [Sample - Point clustering with visual variables](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+   * @see [Sample - Filter clustered points](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+   * @example
+   * // enables clustering on the layer with a
+   * // popup describing the number of features represented by each cluster
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: "This cluster represents <b>{cluster_count}</b> features."
+   *     fieldInfos: [{
+   *       fieldName: "cluster_count",
+   *       format: {
+   *         digitSeparator: true,
+   *         places: 0
+   *       }
+   *     }]
+   *   }
+   * };
+   * @example
+   * // enables clustering on the layer with a
+   * // popup describing the average value of
+   * // the field mapped by the renderer
+   *
+   * layer.renderer = {
+   *   type: "simple",
+   *   symbol: {
+   *     type: "simple-marker",
+   *     size: 8
+   *   },
+   *   label: "Weather stations",
+   *   visualVariables: [
+   *     {
+   *       type: "color",
+   *       field: "Temperature",
+   *       stops: [
+   *         {
+   *           value: 32,
+   *           color: "blue",
+   *           label: "< 32° F"
+   *         },
+   *         {
+   *           value: 90,
+   *           color: "red",
+   *           label: ">90° F"
+   *         }
+   *       ]
+   *     }
+   *   ]
+   * };
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> features."
+   *     }, {
+   *       type: "text",
+   *       text: "The average temperature in this cluster is <b>{cluster_avg_Temperature}° F</b>."
+   *     }],
+   *     fieldInfos: [{
+   *       fieldName: "cluster_count",
+   *       format: {
+   *         digitSeparator: true,
+   *         places: 0
+   *       }
+   *     }, {
+   *       fieldName: "cluster_avg_Temperature",
+   *       format: {
+   *         places: 1
+   *       }
+   *     }]
+   *   }
+   * };
+   * @example
+   * // Displays an ordered list of the top 5 categories
+   * // of features contained within the cluster
+   * layer.popupTemplate = {
+   *   title: "Power plant summary",
+   *   content: [{
+   *    type: "expression",
+   *    // lists the top 5 most common fuel types in the cluster
+   *    expressionInfo: {
+   *      expression: `
+   *        Expects($aggregatedFeatures, "fuel1")
+   *
+   *        var statsFS = GroupBy($aggregatedFeatures,
+   *          [
+   *            { name: 'Type', expression: 'fuel1'},
+   *          ],
+   *          [
+   *            { name: 'num_features', expression: '1', statistic: 'COUNT' }
+   *          ]
+   *        );
+   *        var ordered = Top(OrderBy(statsFs, 'num_features DESC'), 5);
+   *
+   *        // create an HTML ordered list as a string and return in a rich text element
+   *        var list = "<ol>";
+   *
+   *        for (var group in ordered){
+   *          list += \`<li>\${group.Type} (\${Text(group.num_features, "#,###")})</li>\`
+   *        }
+   *        list += "</ol>";
+   *
+   *        return {
+   *          type: "text",
+   *          text: list
+   *        }
+   *      `,
+   *      title: "List of fuel types"
+   *    }
+   *  }]
+   * };
+   */
+  popupTemplate?: PopupTemplateProperties | null;
+  /**
+   * The renderer used to override the default style of the clusters. All fields used by this renderer
+   * must be [AggregateFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html)
+   * defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property of this class.
+   *
+   * For points, the default cluster style is inferred by the underlying layer's renderer.
+   * Each cluster will be styled with a symbol summarizing the
+   * points included in the cluster based on the underlying layer's renderer configuration.
+   * See [Styles and configurations](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#styles-and-configurations)
+   * for more information about this behavior. In this scenario, the renderer will be persisted when
+   * the layer is saved to the web map, but it will be flagged as "auto generated" in the
+   * [AuthoringInfo#isAutoGenerated](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated) property of the
+   * the [Renderer#authoringInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) object.
+   * All auto generated renderers are discarded and replaced each time the underlying layer's renderer is changed.
+   *
+   * This property allows you to override the auto generated cluster styling using any
+   * renderer type suitable for point geometries. For example, if you want to render clusters
+   * as pie charts, you can define a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) in
+   * this property. Custom renderers set on this property are not discarded when the underlying layer's
+   * renderer changes. Setting this property to `null` will cause clusters to render using the auto-generated renderer based on the layer's renderer.
+   *
+   * Defining a renderer here will override the symbols of **all aggregate and individual features**
+   * in the view. If you want to define a dedicated cluster symbol, but retain the layer's renderer for
+   * individual features, then use the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol) property (for point layers only).
+   *
+   * **For polyline and polygon layers, you must define a renderer with marker symbols (or pie charts) to display clusters as there is no auto generated
+   * cluster renderer for these geometry types.**
+   *
+   * > [!WARNING]
+   * >
+   * > The following rendering rules apply to cluster renderers:
+   * >
+   * > - If a renderer does not contain a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then
+   * > [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) and [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) are used to automatically size clusters based
+   * > on the cluster count at each view scale level. The `clusterMinSize` and `clusterMaxSize` properties only control the sizes of clusters, not individual features. Individual features are sized based on their respective symbols defined in the renderer.
+   * > - If a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is present in the renderer, then `clusterMinSize` and `clusterMaxSize` are ignored. **The size variable controls the size of both clusters and individual features**.
+   * > - Any renderer defined here overrides the symbols of all aggregate and individual features in the view. Symbol sizes in the renderer will apply to individual features, but not aggregate features. Therefore, symbol sizes should generally be less than or equal to the `clusterMinSize` if no size variable is present.
+   * > - If no renderer is defined, then a [default renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#styles-and-configurations) is used (and persisted in the web map) in this property.
+   * > - If defined alongside a defined [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol), then the renderer will always override the symbol.
+   * > - When a cluster `renderer` is defined, individual features are always rendered with the
+   * > symbols of the cluster renderer, even for polygon and polyline layers. Therefore,
+   * > individual line and polygon features will display as marker symbols according to the renderer.
+   *
+   * @since 4.25
+   * @see [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol)
+   * @example
+   * // colors clusters along a continuous gradient based on their cluster_count
+   * featureReduction.clusterMinSize = 16;
+   * featureReduction.clusterMaxSize = 16;
+   * featureReduction.renderer = {
+   *   type: "simple",  // autocasts as new SimpleRenderer()
+   *   symbol: {
+   *     type: "simple-fill",  // autocasts as new SimpleFillSymbol()
+   *     outline: {  // autocasts as new SimpleLineSymbol()
+   *       width: 0.5,
+   *       color: "white"
+   *     }
+   *   },
+   *   visualVariables: [{
+   *     type: "color",
+   *     field: "cluster_count",
+   *     stops: [
+   *       { value: 1, color: "white" },
+   *       { value: 1000, color: "blue" }
+   *     ]
+   *   }]
+   * };
+   * @example
+   * // sets the cluster renderer to the default style, which
+   * // is inferred by the underlying layer's renderer.
+   * featureReduction.renderer = null;
+   */
+  renderer?: (((SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })) | (HeatmapRendererProperties & { type: "heatmap" })) | null;
+  /**
+   * A symbol used to override the default cluster style. Unlike the [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) property, this symbol
+   * doesn't affect individual features (i.e. clusters of size 1). Use this property to create a dedicated cluster symbol
+   * while retaining the symbology of individual features.
+   *
+   * > [!CAUTION]
+   * >
+   * > This property is only applicable to point layers. For polyline and polygon layers, you
+   * > must define a [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) with marker symbols (or pie charts) to display clusters.
+   *
+   * @since 4.25
+   * @example
+   * featureReduction.symbol = {
+   *   type: "simple-marker",
+   *   color: "yellow",
+   *   style: "square",
+   *   outline: {
+   *     width: 4,
+   *     color: "orange"
+   *   }
+   * };
+   */
+  symbol?: (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (WebStyleSymbolProperties & { type: "web-style" }) | (CIMSymbolProperties & { type: "cim" }) | null;
+}
+
+/**
+ * Aggregates and summarizes dense features in a layer to clusters defined in screen space.
+ *
+ * This feature reduction method spatially groups
+ * features into _clusters_ based on an area of influence defined in screen space (i.e. the [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius)).
+ * By default, the size of each cluster is proportional to the number of features within the cluster.
+ *
+ * Clustering is typically used to visualize large point layers, but may be used with any geometry type _(since version 4.31)_.
+ * In the case of clustering polyline or polygon features, the centroid of the line or polygon is used to determine the cluster in which it is placed.
+ *
+ * The [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer), [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo), and [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate)
+ * of each cluster summarizes the features it represents.
+ *
+ * This documentation refers to two kinds of features: **aggregate features** and **individual features**.
+ * Aggregate features represent clusters. When clustering points, if a feature does not belong to a cluster, it is rendered as an
+ * _individual feature_ and therefore not represented as a cluster graphic. When clustering lines or polygons, individual features not
+ * belonging to a true cluster (of 2 or more features) are still represented as a cluster of size 1 according to the cluster [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) or
+ * [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol). This is so features exploding from clusters on zoom are clearly associated with the clustered layer.
+ *
+ * <span id="styles-and-configurations"></span>
+ * > [!WARNING]
+ * >
+ * > **Usage guidelines**
+ * >
+ * > - In the case of clustered points rendered with an [auto generated](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated)
+ * >   cluster renderer, if you want individual features to be smaller than the smallest clusters (two
+ * >   features), then you need to adjust the size of the symbols in the `layer.renderer` to sizes smaller
+ * >   than the [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize).
+ * > - The {@link layers/support/FeatureReductionCluster#maxClusterSize} and [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius) complement each other. If you adjust one, you should adjust the other (a larger
+ * >   `maxClusterSize` should have a larger `clusterRadius`).
+ * > - Turn off [label deconfliction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#deconflictionStrategy) when labeling clusters with a count in the center of the cluster.
+ * >   If label placement is outside the cluster, keep label deconfliction enabled.
+ * > - Increase the [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) to fit labels inside smaller clusters (16pt is a good starting point when labels are visible).
+ * > - If the layer's renderer has a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), increase the size of the smallest features (either in the variable stops, or
+ * > in the `minSize` property) to improve the cluster visualization, and so labels can fit inside the clusters.
+ * > - If multiple label classes are set on `featureReduction.labelingInfo`, set matching label classes on the `layer.labelingInfo`, especially when a size visual variable is included in the renderer.
+ * >   This helps the end user differentiate between clusters and individual features.
+ *
+ * <span id="styles-and-configurations"></span>
+ * ## Styles and configurations
+ *
+ * The following section describes various [auto generated](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated) cluster renderers
+ * created based on the layer's renderer. **This only applies to clustering point features**.
+ *
+ * <details>
+ * <summary>Read More</summary>
+ *
+ * ### Simple Renderer
+ *
+ * In the most basic scenario, where all points are styled with a [SimpleRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html) and no
+ * visual variables, the cluster size will indicate the number of features within the cluster.
+ *
+ * Display all points | Display clustered features
+ * ---------------------|-------------------
+ * [![clustering-simple-disabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-simple-disabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/) | [![clustering-simple-enabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-simple-enabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+ *
+ * ### Visual Variables
+ *
+ * When any numeric field is used by the renderer with one or more {@link renderers/support/visualVariable visual variables},
+ * the average value of that field will be used in the cluster symbology and made available to the developer in the [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).
+ *
+ * In the example below, the layer representing weather stations is rendered with three visual variables: color, size, and rotation. When clustering is enabled, the average of each field
+ * from the visual variables is computed for the features within each cluster. The color, rotation, and size of the cluster is then applied to the cluster graphic according to the average
+ * value of each respective field for the visual variables of features in that cluster.
+ *
+ * Display all points | Display clustered features
+ * ---------------------|-------------------
+ * [![clustering-color-size-disabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-color-size-disabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/) | [![clustering-color-size-enabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-color-size-enabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+ *
+ * ### Unique Value Renderer
+ *
+ * When a clustered layer contains a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) or a
+ * [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html), the clustered graphics are rendered with the
+ * symbol of the most common, or predominant, value of the [UniqueValueRenderer#uniqueValueInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#uniqueValueInfos)
+ * (or [ClassBreaksRenderer#classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)) of the features
+ * represented by the cluster.
+ *
+ * Display all points | Display clustered features
+ * ---------------------|-------------------
+ * [![clustering-type-disabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-type-disabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/) | [![clustering-type-enabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-type-enabled.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ *
+ * </details>
+ *
+ * <span id="known-limitations"></span>
+ * > [!CAUTION]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Clustering currently has the following limitations:
+ * >
+ * > - Unlike point layers, clustered polyline or polygon features, do not have an [auto generated](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated)
+ * >   renderer. You must define your own cluster [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) to view clustered line or polygon features. This renderer may only represent the clusters as marker symbols or pie charts.
+ * > - Not supported in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * > - Supported in [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),
+ * > [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html), and [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html).
+ * > - Not supported in all other layer types, including [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html).
+ * > - Not supported for any layer with a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) or a
+ * >   [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html) defined with multiple fields
+ * >   (i.e. [UniqueValueRenderer#field2](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field2), [UniqueValueRenderer#field3](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html#field3)).
+ * > - Layer views with an applied [FeatureEffect](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html) cannot be clustered.
+ *
+ * @since 4.14
+ * @see [Sample - Point clustering](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+ * @see [Sample - Point clustering with visual variables](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+ * @see [Sample - Filter clustered points](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ * @see [CSVLayer#featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#featureReduction)
+ * @see [FeatureLayer#featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction)
+ * @see [GeoJSONLayer#featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html#featureReduction)
+ * @see [OGCFeatureLayer#featureReduction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html#featureReduction)
+ * @example
+ * layer.featureReduction = {
+ *   type: "cluster",
+ *   clusterRadius: "120px",
+ *   popupTemplate: {
+ *     content: "This cluster represents <b>{cluster_count}</b> features.",
+ *     fieldInfos: [{
+ *       fieldName: "cluster_count",
+ *       format: {
+ *         digitSeparator: true,
+ *         places: 0
+ *       }
+ *     }]
+ *   }
+ * };
+ */
+export default class FeatureReductionCluster extends JSONSupport {
+  constructor(properties?: FeatureReductionClusterProperties);
+  /**
+   * Defines the symbol size of the largest cluster in points (or pixels if specified). Adjusting `clusterMaxSize`
+   * generally should be considered if the [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius) is modified.
+   *
+   * For example, if you prefer cluster icons to not overlap, then the `clusterMaxSize`
+   * should be substantially smaller than the `clusterRadius`.
+   *
+   * If a custom [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) is defined for cluster, and that renderer contains a
+   * [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then this property is ignored and cluster sizes
+   * are determined using the renderer's size variable.
+   *
+   * @default 37.5
+   * @since 4.16
+   * @see [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize)
+   * @see [clusterRadius](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterRadius)
+   * @example
+   * // clusterMaxSize should be adjusted
+   * // appropriately to conform
+   * // to the clusterRadius
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: "50px",
+   *   clusterMaxSize: "32px"
+   * };
+   */
+  get clusterMaxSize(): number;
+  set clusterMaxSize(value: number | string);
+  /**
+   * Defines the symbol size of the smallest cluster in points (or pixels if specified). If [labeling](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) clusters
+   * with a count or some other information in the center of the cluster, then having a `clusterMinSize`
+   * larger than the default is generally preferred.
+   *
+   * Keep in mind that this size may be smaller than the symbol size of individual non-clustered features
+   * in the layer. In that scenario, you should either reduce the size of the symbol(s) in the layer's renderer
+   * or increase the `clusterMinSize` to be larger than the size of individual point symbols to avoid confusion
+   * for the end user. This is most likely to happen when cluster size represents feature count.
+   *
+   * If a custom [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) is defined for cluster, and that renderer contains a
+   * [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then this property is ignored and cluster sizes
+   * are determined using the renderer's size variable.
+   *
+   * @default 9
+   * @since 4.16
+   * @see [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize)
+   * @see [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo)
+   * @example
+   * // a larger clusterMinSize looks better when labels are enabled
+   * featureReduction.clusterMinSize = "24px";
+   * featureReduction.labelsVisible = true;
+   */
+  get clusterMinSize(): number;
+  set clusterMinSize(value: number | string);
+  /**
+   * Defines the radius in points (or pixels if specified) of the area in which multiple features will be grouped
+   * and visualized as a single cluster. Adjusting `clusterRadius`
+   * generally should be considered if the [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) is modified.
+   *
+   * For example, if you prefer cluster graphics to not overlap, then the `clusterRadius`
+   * should be substantially larger than the `clusterMaxSize`.
+   *
+   * @default 60
+   * @see [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize)
+   * @example
+   * // enables clustering on the layer with a
+   * // clusterRadius of 40pt
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: 40,
+   *   clusterMaxSize: 24
+   * };
+   * @example
+   * // enables clustering on the layer with a
+   * // clusterRadius of 120px
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   clusterRadius: "120px",
+   *   clusterMaxSize: "80px"
+   * };
+   */
+  get clusterRadius(): number;
+  set clusterRadius(value: number | string);
+  /**
+   * An array of aggregate fields that summarize layer [FeatureLayer#fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#fields)
+   * from features contained within each cluster. These fields may be used by the [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate),
+   * [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo), and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer).
+   *
+   * Some fields are internally automatically created by the JS API's rendering engine for use
+   * in default cluster renderers (not set by the developer). The
+   * [AggregateField#isAutoGenerated](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html#isAutoGenerated)
+   * property indicates whether a field was internally created by the JS API. All auto-generated fields
+   * are read-only. They are discarded and replaced with new fields each time the user changes the underlying layer's renderer. Therefore,
+   * auto-generated fields should always be used with caution.
+   *
+   * The table below describes the general rules for how the rendering engine names auto-generated aggregate fields.
+   *
+   * Field Name | Type | Description
+   * -----------|------|------------
+   * `cluster_count` | number | The number of features in the cluster.
+   * `cluster_avg_{fieldName}` | number | For renderers visualizing a number field either with size, opacity, continuous color, or class breaks, this field describes the average of the rendered field among all features in the cluster.
+   * `cluster_type_{fieldName}` | string | For layers with a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html), this field describes the mode, or predominant string of the rendered field among all features within the cluster.
+   *
+   * @since 4.25
+   * @example
+   * featureReduction.fields = [{
+   *   name: "aggregateCount",
+   *   statisticType: "count"
+   * }, {
+   *   name: "SUM_population",
+   *   onStatisticField: "population",
+   *   statisticType: "sum"
+   * }, {
+   *   name: "AVG_age",
+   *   onStatisticField: "age",
+   *   statisticType: "avg"
+   * }, {
+   *   name: "AVG_population_density",
+   *   alias: "Average population density",
+   *   onStatisticExpression: {
+   *     expression: "$feature.population / AreaGeodetic($feature, 'square-miles')",
+   *     title: "population density",
+   *     returnType: "number"
+   *   },
+   *   statisticType: "avg"
+   * }];
+   */
+  get fields(): AggregateField[];
+  set fields(value: AggregateFieldProperties[]);
+  /**
+   * Defines labels for clusters as an array of
+   * [LabelClass](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html). When set, labels
+   * independent of the [layer.labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#labelingInfo) are used
+   * to convey information about the clusters, including the count of all features in the cluster,
+   * the average, or predominant values of fields mapped by the renderer.
+   *
+   * Label expressions may only refer to aggregate fields defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property. Auto-generated
+   * fields may be used, but are at risk of being discarded if the underlying layer's renderer changes. See [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields)
+   * for more information.
+   *
+   * It is advisable to turn off [label deconfliction](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html#deconflictionStrategy)
+   * when labeling clusters with a count in the center of the cluster. To generate suggested labels for your cluster configuration based on the layer's renderer,
+   * see [clusterLabelCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html).
+   *
+   * Multiple Label classes with different `where` clauses can be used to define several
+   * labels with varying styles on the same feature. Likewise, multiple label classes
+   * may be used to label different types of clusters (e.g. blue labels
+   * for small clusters and red labels for large ones).
+   *
+   * @since 4.16
+   * @see [clusterLabelCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-labels-clusters.html)
+   * @example
+   * // Displays the count inside the cluster
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   labelingInfo: [{
+   *     labelExpressionInfo: {
+   *       expression: "$feature.cluster_count"
+   *     },
+   *     deconflictionStrategy: "none",
+   *     labelPlacement: "center-center",
+   *     symbol: {
+   *       type: "text",
+   *       color: "white",
+   *       font: {
+   *         size: "12px"
+   *       },
+   *       haloSize: 1,
+   *       haloColor: "black"
+   *     }
+   *   }]
+   * };
+   */
+  get labelingInfo(): LabelClass[] | null | undefined;
+  set labelingInfo(value: LabelClassProperties[] | null | undefined);
+  /**
+   * Indicates whether to display labels for the clusters. If `true`, labels will
+   * appear as defined in the [labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo) property.
+   *
+   * @default true
+   * @since 4.16
+   * @example
+   * // Turns off cluster labels, but preserves labelingInfo
+   * const featureReduction = layer.featureReduction.clone();
+   * featureReduction.labelsVisible = false;
+   * layer.featureReduction = featureReduction;
+   */
+  accessor labelsVisible: boolean;
+  /**
+   * Defines the maximum [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which clustering is enabled.
+   * If the user zooms in beyond the scale specified here, clustering will be disabled and
+   * only individual features will be displayed in the view.
+   * Once the user zooms out past this scale, clustering will be re-enabled.
+   * A value of `0` means clustering is always enabled, and therefore clusters may be visible at
+   * any view scale.
+   *
+   * @default 0
+   * @since 4.26
+   * @example
+   * // clustering is disabled when the user zooms
+   * // in beyond a 1:50,000 view scale
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   maxScale: 50000
+   * };
+   */
+  accessor maxScale: number;
+  /**
+   * Indicates whether to display the cluster popup. If `true`, popups will
+   * open when the user clicks or taps a cluster. If `false`, the popup as defined
+   * in the [popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate) will be persisted, but won't be displayed
+   * on click/tap.
+   *
+   * @default true
+   * @since 4.16
+   * @example
+   * // Turns off cluster popups, but preserves popupTemplate
+   * const featureReduction = layer.featureReduction.clone();
+   * featureReduction.popupEnabled = false;
+   * layer.featureReduction = featureReduction;
+   */
+  accessor popupEnabled: boolean;
+  /**
+   * The [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) to apply to clustered graphics. When set, a popupTemplate
+   * independent of the [layer.popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate) is used.
+   * This popup can display summary information for the cluster, including the count of all features in the cluster
+   * and the average or predominant values of fields mapped by the renderer.
+   *
+   * To generate a suggested predefined popup template for your cluster configuration based on the layer's renderer,
+   * see [clusterPopupTemplateCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html).
+   *
+   * The PopupTemplate may contain one or more [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions following
+   * the specification defined by the [Arcade Feature Reduction Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-reduction-popup).
+   * Expressions must return a string or a number and may access data values from the cluster and its aggregated features
+   * with the `$feature` and `$aggregatedFeatures` profile variables.
+   *
+   * Popup expressions may only refer to aggregate fields defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property. Auto-generated
+   * fields may be used, but are at risk of being discarded if the underlying layer's renderer changes. See [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields)
+   * for more information about this behavior.
+   *
+   * The following `popupTemplate` configurations will display the popups shown in the images below.
+   *
+   * ### Cluster count
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: "This cluster represents {cluster_count} earthquakes."
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-simple-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-simple-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+   *
+   * ### Clusters by predominant type
+   *
+   *
+   * The following featureReduction configuration assumes the layer's renderer is a UniqueValueRenderer
+   * who's field is named `religion`.
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> features."
+   *     }, {
+   *       type: "text",
+   *       text: "The predominant place of worship in this cluster is <b>{cluster_type_religion}</b>."
+   *     }]
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-types-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-types-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+   *
+   * ### Clusters with visual variables
+   *
+   * The following featureReduction configuration assumes the layer's renderer contains visual variables
+   * referencing fields named `WIND_SPEED`, `WIND_DIRECT`, `TEMP`.
+   *
+   * ```js
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> weather stations."
+   *     }, {
+   *       type: "fields",
+   *       fieldInfos: [{
+   *         fieldName: "cluster_avg_WIND_SPEED",
+   *         label: "Average wind speed (km/h)",
+   *         format: {
+   *           places: 0
+   *         }
+   *       }, {
+   *         fieldName: "cluster_avg_WIND_DIRECT",
+   *         label: "Average wind direction (degrees)",
+   *           format: {
+   *             places: 0
+   *           }
+   *       }, {
+   *           fieldName: "cluster_avg_TEMP",
+   *           label: "Average temperature (°F)",
+   *           format: {
+   *            places: 0
+   *           }
+   *        }]
+   *     }]
+   *   }
+   * };
+   * ```
+   *
+   * [![clustering-color-size-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-color-size-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+   *
+   * @see [clusterPopupTemplateCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-popup-clusters.html)
+   * @see [Arcade Feature Reduction Popup Profile](https://developers.arcgis.com/javascript/latest/arcade/#feature-reduction-popup)
+   * @see [Sample - Point clustering](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster/)
+   * @see [Sample - Point clustering with visual variables](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-visualvariables/)
+   * @see [Sample - Filter clustered points](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+   * @example
+   * // enables clustering on the layer with a
+   * // popup describing the number of features represented by each cluster
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: "This cluster represents <b>{cluster_count}</b> features."
+   *     fieldInfos: [{
+   *       fieldName: "cluster_count",
+   *       format: {
+   *         digitSeparator: true,
+   *         places: 0
+   *       }
+   *     }]
+   *   }
+   * };
+   * @example
+   * // enables clustering on the layer with a
+   * // popup describing the average value of
+   * // the field mapped by the renderer
+   *
+   * layer.renderer = {
+   *   type: "simple",
+   *   symbol: {
+   *     type: "simple-marker",
+   *     size: 8
+   *   },
+   *   label: "Weather stations",
+   *   visualVariables: [
+   *     {
+   *       type: "color",
+   *       field: "Temperature",
+   *       stops: [
+   *         {
+   *           value: 32,
+   *           color: "blue",
+   *           label: "< 32° F"
+   *         },
+   *         {
+   *           value: 90,
+   *           color: "red",
+   *           label: ">90° F"
+   *         }
+   *       ]
+   *     }
+   *   ]
+   * };
+   * layer.featureReduction = {
+   *   type: "cluster",
+   *   popupTemplate: {
+   *     content: [{
+   *       type: "text",
+   *       text: "This cluster represents <b>{cluster_count}</b> features."
+   *     }, {
+   *       type: "text",
+   *       text: "The average temperature in this cluster is <b>{cluster_avg_Temperature}° F</b>."
+   *     }],
+   *     fieldInfos: [{
+   *       fieldName: "cluster_count",
+   *       format: {
+   *         digitSeparator: true,
+   *         places: 0
+   *       }
+   *     }, {
+   *       fieldName: "cluster_avg_Temperature",
+   *       format: {
+   *         places: 1
+   *       }
+   *     }]
+   *   }
+   * };
+   * @example
+   * // Displays an ordered list of the top 5 categories
+   * // of features contained within the cluster
+   * layer.popupTemplate = {
+   *   title: "Power plant summary",
+   *   content: [{
+   *    type: "expression",
+   *    // lists the top 5 most common fuel types in the cluster
+   *    expressionInfo: {
+   *      expression: `
+   *        Expects($aggregatedFeatures, "fuel1")
+   *
+   *        var statsFS = GroupBy($aggregatedFeatures,
+   *          [
+   *            { name: 'Type', expression: 'fuel1'},
+   *          ],
+   *          [
+   *            { name: 'num_features', expression: '1', statistic: 'COUNT' }
+   *          ]
+   *        );
+   *        var ordered = Top(OrderBy(statsFs, 'num_features DESC'), 5);
+   *
+   *        // create an HTML ordered list as a string and return in a rich text element
+   *        var list = "<ol>";
+   *
+   *        for (var group in ordered){
+   *          list += \`<li>\${group.Type} (\${Text(group.num_features, "#,###")})</li>\`
+   *        }
+   *        list += "</ol>";
+   *
+   *        return {
+   *          type: "text",
+   *          text: list
+   *        }
+   *      `,
+   *      title: "List of fuel types"
+   *    }
+   *  }]
+   * };
+   */
+  get popupTemplate(): PopupTemplate | null | undefined;
+  set popupTemplate(value: PopupTemplateProperties | null | undefined);
+  /**
+   * The renderer used to override the default style of the clusters. All fields used by this renderer
+   * must be [AggregateFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-AggregateField.html)
+   * defined in the [fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#fields) property of this class.
+   *
+   * For points, the default cluster style is inferred by the underlying layer's renderer.
+   * Each cluster will be styled with a symbol summarizing the
+   * points included in the cluster based on the underlying layer's renderer configuration.
+   * See [Styles and configurations](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#styles-and-configurations)
+   * for more information about this behavior. In this scenario, the renderer will be persisted when
+   * the layer is saved to the web map, but it will be flagged as "auto generated" in the
+   * [AuthoringInfo#isAutoGenerated](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-support-AuthoringInfo.html#isAutoGenerated) property of the
+   * the [Renderer#authoringInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html#authoringInfo) object.
+   * All auto generated renderers are discarded and replaced each time the underlying layer's renderer is changed.
+   *
+   * This property allows you to override the auto generated cluster styling using any
+   * renderer type suitable for point geometries. For example, if you want to render clusters
+   * as pie charts, you can define a [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) in
+   * this property. Custom renderers set on this property are not discarded when the underlying layer's
+   * renderer changes. Setting this property to `null` will cause clusters to render using the auto-generated renderer based on the layer's renderer.
+   *
+   * Defining a renderer here will override the symbols of **all aggregate and individual features**
+   * in the view. If you want to define a dedicated cluster symbol, but retain the layer's renderer for
+   * individual features, then use the [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol) property (for point layers only).
+   *
+   * **For polyline and polygon layers, you must define a renderer with marker symbols (or pie charts) to display clusters as there is no auto generated
+   * cluster renderer for these geometry types.**
+   *
+   * > [!WARNING]
+   * >
+   * > The following rendering rules apply to cluster renderers:
+   * >
+   * > - If a renderer does not contain a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html), then
+   * > [clusterMinSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMinSize) and [clusterMaxSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#clusterMaxSize) are used to automatically size clusters based
+   * > on the cluster count at each view scale level. The `clusterMinSize` and `clusterMaxSize` properties only control the sizes of clusters, not individual features. Individual features are sized based on their respective symbols defined in the renderer.
+   * > - If a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is present in the renderer, then `clusterMinSize` and `clusterMaxSize` are ignored. **The size variable controls the size of both clusters and individual features**.
+   * > - Any renderer defined here overrides the symbols of all aggregate and individual features in the view. Symbol sizes in the renderer will apply to individual features, but not aggregate features. Therefore, symbol sizes should generally be less than or equal to the `clusterMinSize` if no size variable is present.
+   * > - If no renderer is defined, then a [default renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#styles-and-configurations) is used (and persisted in the web map) in this property.
+   * > - If defined alongside a defined [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol), then the renderer will always override the symbol.
+   * > - When a cluster `renderer` is defined, individual features are always rendered with the
+   * > symbols of the cluster renderer, even for polygon and polyline layers. Therefore,
+   * > individual line and polygon features will display as marker symbols according to the renderer.
+   *
+   * @since 4.25
+   * @see [symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#symbol)
+   * @example
+   * // colors clusters along a continuous gradient based on their cluster_count
+   * featureReduction.clusterMinSize = 16;
+   * featureReduction.clusterMaxSize = 16;
+   * featureReduction.renderer = {
+   *   type: "simple",  // autocasts as new SimpleRenderer()
+   *   symbol: {
+   *     type: "simple-fill",  // autocasts as new SimpleFillSymbol()
+   *     outline: {  // autocasts as new SimpleLineSymbol()
+   *       width: 0.5,
+   *       color: "white"
+   *     }
+   *   },
+   *   visualVariables: [{
+   *     type: "color",
+   *     field: "cluster_count",
+   *     stops: [
+   *       { value: 1, color: "white" },
+   *       { value: 1000, color: "blue" }
+   *     ]
+   *   }]
+   * };
+   * @example
+   * // sets the cluster renderer to the default style, which
+   * // is inferred by the underlying layer's renderer.
+   * featureReduction.renderer = null;
+   */
+  get renderer(): RendererUnion | null | undefined;
+  set renderer(value: (((SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })) | (HeatmapRendererProperties & { type: "heatmap" })) | null | undefined);
+  /**
+   * A symbol used to override the default cluster style. Unlike the [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) property, this symbol
+   * doesn't affect individual features (i.e. clusters of size 1). Use this property to create a dedicated cluster symbol
+   * while retaining the symbology of individual features.
+   *
+   * > [!CAUTION]
+   * >
+   * > This property is only applicable to point layers. For polyline and polygon layers, you
+   * > must define a [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#renderer) with marker symbols (or pie charts) to display clusters.
+   *
+   * @since 4.25
+   * @example
+   * featureReduction.symbol = {
+   *   type: "simple-marker",
+   *   color: "yellow",
+   *   style: "square",
+   *   outline: {
+   *     width: 4,
+   *     color: "orange"
+   *   }
+   * };
+   */
+  get symbol(): PictureMarkerSymbol | SimpleMarkerSymbol | TextSymbol | WebStyleSymbol | CIMSymbol | null | undefined;
+  set symbol(value: (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (WebStyleSymbolProperties & { type: "web-style" }) | (CIMSymbolProperties & { type: "cim" }) | null | undefined);
+  /**
+   * The feature reduction type.
+   *
+   * @example
+   * // enables clustering on the layer with the default
+   * // clusterRadius (80px)
+   * layer.featureReduction = {
+   *   type: "cluster"
+   * };
+   */
+  get type(): "cluster";
+  /**
+   * Creates a deep clone of the FeatureReductionCluster object.
+   *
+   * @returns A deep clone of the object that
+   *   invoked this method.
+   * @example
+   * // Creates a deep clone of the feature reduction object
+   * const fr = layer.featureReduction.clone();
+   * fr.clusterMinSize = 18;
+   * layer.featureReduction = fr;
+   */
+  clone(): FeatureReductionCluster;
+}