Class CellImage  |  Apps Script  |  Google for Developers (original) (raw)

Class CellImage

Stay organized with collections Save and categorize content based on your preferences.

Properties

Methods

Deprecated methods

Detailed documentation

getAltTextDescription()

Returns the alt text description for this image.

Return

String — 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.

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.

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.

toBuilder()

Creates a cell image builder based on the current image properties. Use [CellImageBuilder.setSourceUrl(url)](/apps-script/reference/spreadsheet/cell-image-builder#setSourceUrl%28String%29) to set the source URL of the new image. Then you can add it to a cell using [Range.setValue(value)](/apps-script/reference/spreadsheet/range#setValue%28Object%29) or [Range.setValues(values)](/apps-script/reference/spreadsheet/range#setValues%28Object%29).

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](/apps-script/reference/spreadsheet/cell-image-builder) — A builder that creates an image value type based on the given image properties.

Deprecated methods

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.

Return

String — The image's source URL if available; returns an empty string otherwise.

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

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.