A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.google.com/apps-script/reference/spreadsheet/over-grid-image below:

Class OverGridImage | Apps Script

Class OverGridImage

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

OverGridImage

Represents an image over the grid in a spreadsheet.

Methods Deprecated methods Method Return type Brief description getUrl() String Gets the image's source URL. Detailed documentation assignScript(functionName)

Assigns the function with the specified function name to this image.

Parameters Name Type Description functionName String The name of the function being specified. This must be a public top level function, not one ending in underscore such as privateFunction_. Return

OverGridImage — This image, for chaining.

Scripts that use this method require authorization with one or more of the following scopes:

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:

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:

getAnchorCell()

Returns the cell where an image is anchored.

Return

Range — The anchor cell.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getAnchorCellXOffset()

Returns the horizontal pixel offset from the anchor cell.

Return

Integer — The horizontal pixel offset.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getAnchorCellYOffset()

Returns the vertical pixel offset from the anchor cell.

Return

Integer — The vertical pixel offset.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getHeight()

Returns the actual height of this image in pixels.

// Logs the height of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getHeight());
}
Return

Integer — The height of the image in pixels.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getInherentHeight()

Returns the inherent height of this image in pixels.

Return

Integer — The inherent height in pixels.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getInherentWidth()

Returns the inherent height of this image in pixels.

Return

Integer — The inherent width in pixels.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getScript()

Returns the name of the function assigned to this image.

Return

String — The name of the function.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getSheet()

Returns the sheet this image appears on.

// Logs the parent sheet of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getSheet());
}
Return

Sheet — The sheet the image appears on.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getWidth()

Returns the actual width of this image in pixels.

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  Logger.log(images[i].getWidth());
}
Return

Integer — The width of the image in pixels.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

remove()

Deletes this image from the spreadsheet. Any further operation on the image results in a script error.

// Deletes all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  images[i].remove();
}
Authorization

Scripts that use this method require authorization with one or more of the following scopes:

replace(blob)

Replaces this image with the one specified by the provided BlobSource. The maximum supported blob size is 2MB.

Parameters Name Type Description blob BlobSource The new image as a Blob. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

replace(url)

Replaces this image with the one from the specified URL.

Parameters Name Type Description url String The URL of the new image. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

resetSize()

Resets this image to its inherent dimensions.

Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setAltTextDescription(description)

Sets the alt-text description for this image.

Parameters Name Type Description description String The new alt text description for the image. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setAltTextTitle(title)

Sets the alt text title for this image.

Parameters Name Type Description title String The new alt text title for the image. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setAnchorCell(cell)

Sets the cell where an image is anchored.

Parameters Name Type Description cell Range The new anchor cell. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setAnchorCellXOffset(offset)

Sets the horizontal pixel offset from the anchor cell.

Parameters Name Type Description offset Integer The new horizonal pixel offset. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setAnchorCellYOffset(offset)

Sets the vertical pixel offset from the anchor cell.

Parameters Name Type Description offset Integer The new vertical pixel offset. Return

OverGridImage — This image, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setHeight(height)

Sets the actual height of this image in pixels.

Parameters Name Type Description height Integer The desired height in pixels. Return

OverGridImage — The image for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setWidth(width)

Sets the actual width of this image in pixels.

Parameters Name Type Description width Integer The desired width in pixels. Return

OverGridImage — The image for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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:

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."],[[["`OverGridImage` represents an image overlaid on a spreadsheet grid, offering methods to control its properties and behavior."],["It provides methods for manipulating the image's size, position, anchoring, alt text, and assigned script."],["Users can replace the image, reset its size, get its URL and dimensions, and remove it from the spreadsheet."],["Each method requires specific authorization scopes, primarily `https://www.googleapis.com/auth/spreadsheets.currentonly` or `https://www.googleapis.com/auth/spreadsheets`, to execute."]]],[]]


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