Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Chart.image.byRegion
Stay organized with collections
Save and categorize content based on your preferences.
Generates a Chart from an image. Extracts and plots band values in one or more regions in the image, with each band in a separate series.
- X-axis = Region labeled by xProperty (default: 'system:index')
- Y-axis = Reducer output.
- Series = Band name.
Returns a chart.
| Usage | Returns | ui.Chart.image.byRegion(image, regions, reducer, scale, xProperty) | ui.Chart |
| Argument | Type | Details | image | Image | Image to extract band values from. |
regions | Feature|FeatureCollection|Geometry|List<Feature>|List<Geometry>, optional | Regions to reduce. Defaults to the image's footprint. |
reducer | Reducer, optional | Reducer that generates the value(s) for the y-axis. Must return a single value per band. Defaults to ee.Reducer.mean(). |
scale | Number, optional | Scale to use with the reducer in meters. |
xProperty | String, optional | Property to be used as the label for each Region on the x-axis. Defaults to 'system:index'. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-08 UTC.
[null,null,["Last updated 2025-07-08 UTC."],[[["\u003cp\u003eGenerates a chart that visualizes band values within specified regions of an image.\u003c/p\u003e\n"],["\u003cp\u003eCharts display band values on the y-axis, region labels on the x-axis, and separate series for each band.\u003c/p\u003e\n"],["\u003cp\u003eUsers can customize the chart by defining regions, specifying a reducer for calculations, setting a scale, and choosing a property for x-axis labels.\u003c/p\u003e\n"],["\u003cp\u003eThe default reducer is \u003ccode\u003eee.Reducer.mean()\u003c/code\u003e, and the default x-axis property is \u003ccode\u003e'system:index'\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe function returns a \u003ccode\u003eui.Chart\u003c/code\u003e object.\u003c/p\u003e\n"]]],["The core functionality involves creating a chart from an image by extracting and plotting band values from specified regions. Users define `image`, `regions`, `reducer`, `scale`, and `xProperty`. It extracts band values, uses the provided `reducer` to compute a single y-value per band, which are then plotted as separate series. `regions` are labeled on the x-axis, based on the provided `xProperty`. The chart plots the reduced values per band in different regions, returning a `ui.Chart` object.\n"],null,["# ui.Chart.image.byRegion\n\n\u003cbr /\u003e\n\nGenerates a Chart from an image. Extracts and plots band values in one or more regions in the image, with each band in a separate series.\n\n\u003cbr /\u003e\n\n- X-axis = Region labeled by xProperty (default: 'system:index')\n\n- Y-axis = Reducer output.\n\n- Series = Band name.\n\nReturns a chart.\n\n| Usage | Returns |\n|-----------------------------------------------------------------------------------------|----------|\n| `ui.Chart.image.byRegion(image, `*regions* `, `*reducer* `, `*scale* `, `*xProperty*`)` | ui.Chart |\n\n| Argument | Type | Details |\n|-------------|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|\n| `image` | Image | Image to extract band values from. |\n| `regions` | Feature\\|FeatureCollection\\|Geometry\\|List\\\u003cFeature\\\u003e\\|List\\\u003cGeometry\\\u003e, optional | Regions to reduce. Defaults to the image's footprint. |\n| `reducer` | Reducer, optional | Reducer that generates the value(s) for the y-axis. Must return a single value per band. Defaults to ee.Reducer.mean(). |\n| `scale` | Number, optional | Scale to use with the reducer in meters. |\n| `xProperty` | String, optional | Property to be used as the label for each Region on the x-axis. Defaults to 'system:index'. |"]]