ui.Thumbnail.setParams
Sets the parameters used to generate the thumbnail.
Returns this thumbnail.
| Usage | Returns | Thumbnail.setParams(params) | ui.Thumbnail |
| Argument | Type | Details | this: ui.thumbnail | ui.Thumbnail | The ui.Thumbnail instance. |
params | Object | The parameters used in generating the thumbnail.
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 (E,S,W,N or GeoJSON) Geospatial region of the image to render. By default, the whole image. |
format (string) Either 'png' or 'jpg'. |
bands (comma-separated strings) Comma-delimited list of band names to be mapped to RGB. |
min (comma-separated numbers) Value (or one per band) to map onto 00. |
max (comma-separated numbers) Value (or one per band) to map onto FF. |
gain (comma-separated numbers) Gain (or one per band) to map onto 00-FF. |
bias (comma-separated numbers) Offset (or one per band) to map onto 00-FF. |
gamma (comma-separated numbers) Gamma correction factor (or one per band) |
palette (comma-separated strings) List of CSS-style color strings (single-band previews only). |
opacity (number) a number between 0 and 1 for opacity. |
version (number) Version number of image (or latest). |
|
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."],[[["The `Thumbnail` class allows you to set parameters for generating thumbnails of images."],["The `setParams` method is used to configure the thumbnail generation process with options like dimensions, region, format, and color adjustments, and returns the `ui.Thumbnail` instance."],["You can control the size, area, and visual appearance of the thumbnail using parameters like `dimensions`, `region`, `bands`, `min`, `max`, `gain`, `bias`, `gamma`, `palette`, and `opacity`."],["It's possible to specify the image format (PNG or JPG) and opacity for the thumbnail."],["The `version` parameter lets you request a specific version of the image or the latest one."]]],[]]