Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Image.getThumbURL
Stay organized with collections
Save and categorize content based on your preferences.
Get a thumbnail URL for this image.
Returns a thumbnail URL, or undefined if a callback was specified.
| Usage | Returns | Image.getThumbURL(params, callback) | Object|String |
| Argument | Type | Details | this: image | Image | The Image instance. |
params | Object | Parameters identical to ee.data.getMapId, plus, optionally:
dimensions (a number or pair of numbers in format WIDTHxHEIGHT) Maximum dimensions of the thumbnail to render, in pixels. If only one number is passed, it is used as the maximum, and the other dimension is computed by proportional scaling. |
region Geospatial region of the image to render, it may be an ee.Geometry, GeoJSON, or an array of lat/lon points (E,S,W,N). If not set the default is the bounds image. |
format (string) Either 'png' or 'jpg'. |
|
callback | Function, optional | An optional callback. 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-02-20 UTC.
[null,null,["Last updated 2024-02-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eImage.getThumbURL\u003c/code\u003e function retrieves a thumbnail URL for a given image, offering options to customize dimensions, region, and format.\u003c/p\u003e\n"],["\u003cp\u003eThis function accepts parameters similar to \u003ccode\u003eee.data.getMapId\u003c/code\u003e to specify the desired thumbnail characteristics.\u003c/p\u003e\n"],["\u003cp\u003eUsers can provide a callback function for asynchronous execution or receive the URL directly in a synchronous call.\u003c/p\u003e\n"],["\u003cp\u003eThe thumbnail size can be controlled by specifying dimensions, with proportional scaling applied if only one dimension is given.\u003c/p\u003e\n"],["\u003cp\u003eThe region of the image to be included in the thumbnail can be defined using various geometry formats, defaulting to the image bounds if not specified.\u003c/p\u003e\n"]]],[],null,["# ee.Image.getThumbURL\n\n\u003cbr /\u003e\n\nGet a thumbnail URL for this image.\n\n\u003cbr /\u003e\n\nReturns a thumbnail URL, or undefined if a callback was specified.\n\n| Usage | Returns |\n|-------------------------------------------|----------------|\n| Image.getThumbURL`(params, `*callback*`)` | Object\\|String |\n\n| Argument | Type | Details |\n|---------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `image` | Image | The Image instance. |\n| `params` | Object | Parameters identical to ee.data.getMapId, plus, optionally: |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` dimensions ` (a number or pair of numbers in format WIDTHxHEIGHT) Maximum dimensions of the thumbnail to render, in pixels. If only one number is passed, it is used as the maximum, and the other dimension is computed by proportional scaling. | | ` region ` Geospatial region of the image to render, it may be an ee.Geometry, GeoJSON, or an array of lat/lon points (E,S,W,N). If not set the default is the bounds image. | | ` format ` (string) Either 'png' or 'jpg'. | |\n| `callback` | Function, optional | An optional callback. If not supplied, the call is made synchronously. |"]]