ee.data.listImages
Returns a list of the contents in an image collection, in an object that includes an
images array and an optional
nextPageToken.
| Usage | Returns |
|---|
ee.data.listImages(parent, params, callback) | ListImagesResponse |
| Argument | Type | Details |
|---|
parent | String | The ID of the image collection to list. |
params | Object, optional | An object containing optional request parameters with the following possible values:
pageSize (string) The number of results to return. If not specified, all results are returned. |
pageToken (string) The token page of results to return. |
startTime (ISO 8601 string) The minimum start time (inclusive). |
endTime (ISO 8601 string) The maximum end time (exclusive). |
region (GeoJSON or WKT string) A region to filter on. |
properties (list of strings) A list of property filters to apply, for example:
["classification=urban", "size>=2"]. |
filter (string) An additional filter query to apply. Example query: properties.my_property>=1 AND properties.my_property<2 AND startTime >= "2019-01-01T00:00:00.000Z" AND endTime < "2020-01-01T00:00:00.000Z" AND intersects("{'type':'Point','coordinates':[0,0]}") See https://google.aip.dev/160 for how to construct a query. |
view (string) Specifies how much detail is returned in the list. Either "FULL" (default) for all image properties or "BASIC". |
|
callback | Function, optional | If not supplied, the call is made synchronously. |
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 2024-06-05 UTC.
[null,null,["Last updated 2024-06-05 UTC."],[[["Returns a list of image contents within a specified image collection, including image details and a page token for navigation."],["Utilizes the `ee.data.listImages()` function, accepting parameters like parent collection ID, optional filters, and a callback function."],["Optional parameters allow filtering by date, region, properties, and view, enabling retrieval of specific image subsets."],["Results are provided within a `ListImagesResponse` object, containing an array of images and a token for accessing further pages if available."]]],["The function `ee.data.listImages` retrieves a list of image collection contents. It requires a `parent` ID and optionally accepts `params` for filtering results, including `pageSize`, `pageToken`, time ranges (`startTime`, `endTime`), `region`, `properties`, and a custom `filter`. The `view` parameter controls the detail level returned. Results are returned in a `ListImagesResponse` object, which contains an `images` array and an optional `nextPageToken`. A `callback` function can be used for asynchronous calls.\n"]]