Skip to main content
Version: Next

clusterReduceCallback

Description

Callback for clusterReduce

The first time the callback function is called, the values provided as arguments depend on whether the reduce method has an initialValue argument.

If an initialValue is provided to the reduce method:

  • The previousValue argument is initialValue.
  • The currentValue argument is the value of the first element present in the array.

If an initialValue is not provided:

  • The previousValue argument is the value of the first element present in the array.
  • The currentValue argument is the value of the second element present in the array.

Definition

function (

NameTypeDescription
previousValue?*The accumulated value previously returned in the last invocation of the callback, or initialValue, if supplied.
cluster?FeatureCollectionThe current cluster being processed.
clusterValue?*Value used to create cluster being processed.
currentIndex?numberThe index of the current element being processed in the array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise.

)

Returns

void