Represents an image to add to a cell. To add an image to a cell, you must create a new image
value for the image using SpreadsheetApp.newCellImage() and CellImageBuilder. Then you can use Range.setValue(value) or Range.setValues(values) to
add the image value to the cell.
Properties
| Property | Type | Description |
|---|---|---|
valueType | ValueType | A field set to ValueType.IMAGE, representing the image value type. |
Methods
| Method | Return type | Brief description |
|---|---|---|
getAltTextDescription() | String | Returns the alt text description for this image. |
getAltTextTitle() | String | Returns the alt text title for this image. |
getContentUrl() | String | Returns a Google-hosted URL to the image. |
getUrl() | String | Gets the image's source URL; returns null if the URL is unavailable. |
toBuilder() | CellImageBuilder | Creates a builder that turns an image into an image value type so that you can place it into a cell. |
Detailed documentation
getAltTextDescription()
Returns the alt text description for this image.
Return
String — The alt text description.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
Returns the alt text title for this image.
Return
String — The alt text title.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getContentUrl()
Returns a Google-hosted URL to the image. This URL is tagged with the account of the requester, so anyone with the URL effectively accesses the image as the original requester. Access to the image might be lost if the spreadsheet's sharing settings change. The returned URL expires after a short period of time.
Return
String — The Google-hosted URL of the image.
getUrl()
Gets the image's source URL; returns null if the URL is unavailable. If the image was
inserted by URL using an API, this method returns the URL provided during image insertion.
Return
String — The image URL if available; returns null if the image is unavailable or doesn't
have a source URL.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
toBuilder()
Creates a builder that turns an image into an image value type so that you can place it into a
cell. Before an image is placed into a cell, it needs to be created as an image value type.
Then you can add it to a cell using Range.setValue(value) or Range.setValues(values).
Return
CellImageBuilder — A builder that creates an image value type based on the given image properties.