@arcgis/core/smartMapping/statistics/heatmapStatistics.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

/**
 * Function for generating statistics from a [Layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/) for
 * a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/) visualization.
 *
 * It is important to note that the input layer must have features available in the input view
 * for the [heatmapStatistics()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/heatmapStatistics/#heatmapStatistics) method to generate pixel intensity statistics.
 *
 * > [!WARNING]
 * >
 * > **Known Limitations**
 * >
 * > Only layers with point geometries are supported.
 *
 * @since 4.8
 */
import type { HeatmapStatisticsParameters, HeatmapStatisticsResult } from "./types.js";

/**
 * Returns an object containing various statistics describing the intensity values
 * for a heatmap visualization of a given point [Layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/).
 *
 * @param parameters - The function parameters.
 * @returns Returns
 *   a promise that resolves to [HeatmapStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#HeatmapStatisticsResult).
 * @example
 * heatmapStatistics({
 *   layer: featureLayer,
 *   view: mapView
 * }).then(function(stats){
 *   // `stats` contains statistics used to construct a heatmap renderer
 * });
 */
export default function heatmapStatistics(parameters: HeatmapStatisticsParameters): Promise<HeatmapStatisticsResult>;