Stay organized with collections Save and categorize content based on your preferences.
CellImageBuilderBuilder for CellImage
. This builder creates the image value needed to add an image to a cell.
valueType
ValueType
The value type of the cell image, which is ValueType.IMAGE
. Methods Deprecated methods Method Return type Brief description getUrl()
String
Gets the image's source URL. Detailed documentation build()
Creates the image value type needed to add an image to a cell. The image value is built from the image properties added to the builder, such as the source URL.
ReturnCellImage
— A representation of the image to add to a cell.
getAltTextDescription()
Returns the alt text description for this image.
ReturnString
— The alt text description.
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.
ReturnString
— The alt text title.
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.
const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1"); const value = range.getValue(); if (value.valueType == SpreadsheetApp.ValueType.IMAGE) { console.log(value.getContentUrl()); }Return
String
— The Google-hosted URL of the image.
setAltTextDescription(description)
Sets the alt-text description for this image.
Parameters Name Type Descriptiondescription
String
The new alt text description for the image. Return
CellImage
— This image, for chaining.
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
setAltTextTitle(title)
Sets the alt text title for this image.
Parameters Name Type Descriptiontitle
String
The new alt text title for the image. Return
CellImage
— This image, for chaining.
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
setSourceUrl(url)
Sets the image source URL.
Parameters Name Type Descriptionurl
String
The URL for the image. Return
CellImageBuilder
— This builder, for chaining.
toBuilder()
Creates a cell image builder based on the current image properties. Use setSourceUrl(url)
to set the source URL of the new image. Then you can add it to a cell using Range.setValue(value)
or Range.setValues(values)
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const range = ss.getRange("Sheet1!A1"); const value = range.getValue(); if (value.valueType == SpreadsheetApp.ValueType.IMAGE) { const newImage = value.toBuilder() .setSourceUrl( 'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png', ) .build(); const newRange = ss.getRange("Sheet1!A2"); newRange.setValue(newImage); }Return
CellImageBuilder
— A builder that creates an image value type based on the given image properties.
getUrl()
Deprecated. For most newly inserted images, the source URL is unavailable.
Gets the image's source URL. Returns an empty string if the URL is unavailable. For most newly inserted images, the source URL is unavailable regardless how the image is inserted.
ReturnString
— The image's source URL if available; returns an empty string otherwise.
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
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-12-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-09 UTC."],[[["`CellImageBuilder` facilitates the creation and manipulation of images within Google Sheets cells."],["It provides methods for setting the image source, alt text, and retrieving a Google-hosted URL."],["You can build a `CellImage` to insert into a cell using the `build()` method."],["The `toBuilder()` method enables modification of existing cell images and insertion into new cells."],["The `getUrl()` method is deprecated as it often returns an empty string for newly inserted images."]]],["The `CellImageBuilder` facilitates adding images to spreadsheet cells. It constructs image values with `build()`, which requires a source URL set via `setSourceUrl()`. Alt text can be managed using `setAltTextDescription()` and `setAltTextTitle()`, and information can be retrieved by using `getAltTextDescription()` ,`getAltTextTitle()` and `getContentUrl()`. `toBuilder()` creates a new builder from an existing image. The value type for cell images is `ValueType.IMAGE`. A deprecated method, `getUrl()`, was used to retrieve source URLs.\n"]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4