heatmapStatistics

import heatmapStatistics from "@arcgis/core/smartMapping/statistics/heatmapStatistics.js";

Since: ArcGIS Maps SDK for JavaScript 4.8

Function for generating statistics from a Layer for a HeatmapRenderer visualization.

It is important to note that the input layer must have features available in the input view for the heatmapStatistics() method to generate pixel intensity statistics.

Known Limitations

Only layers with point geometries are supported.

Functions

Name	Return Type	Object
`heatmapStatistics`	`Promise<HeatmapStatisticsResult>`

Function

Returns an object containing various statistics describing the intensity values for a heatmap visualization of a given point Layer.

Signature: heatmapStatistics (parameters: HeatmapStatisticsParameters): Promise<HeatmapStatisticsResult>

Parameters

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

Returns: Promise<HeatmapStatisticsResult>
Returns a promise that resolves to HeatmapStatisticsResult.

Example

heatmapStatistics({
  layer: featureLayer,
  view: mapView
}).then(function(stats){
  // `stats` contains statistics used to construct a heatmap renderer
});