ee.FeatureCollection.aggregate_array

  • aggregate_array() compiles a list of all the values of a specified property from a FeatureCollection.

  • It takes the FeatureCollection and the property name as inputs.

  • The output is an ee.List object containing all the values of the chosen property across the collection's features.

  • This function is helpful for understanding the distribution of a specific property within a dataset, like finding all fuel types used by power plants in a region.

 Aggregates over a given property of the objects in a collection, calculating a list of all the values of the selected property.

UsageReturns
FeatureCollection.aggregate_array(property)List
ArgumentTypeDetails
this: collectionFeatureCollectionThe collection to aggregate over.
propertyStringThe property to use from each element of the collection.

Examples

Code Editor (JavaScript)

// FeatureCollection of power plants in Belgium.
var fc = ee.FeatureCollection('WRI/GPPD/power_plants')
             .filter('country_lg == "Belgium"');

print('Power plant fuel sources',
      fc.aggregate_array('fuel1'));  // ee.List

Python setup

See the Python Environment page for information on the Python API and using geemap for interactive development.

import ee
import geemap.core as geemap

Colab (Python)

# FeatureCollection of power plants in Belgium.
fc = ee.FeatureCollection('WRI/GPPD/power_plants').filter(
    'country_lg == "Belgium"')

print('Power plant fuel sources:',
      fc.aggregate_array('fuel1').getInfo())  # ee.List