Class OverGridImage

OverGridImage

Representa una imagen sobre la cuadrícula en una hoja de cálculo.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
assignScript(functionName)	OverGridImage	Asigna la función con el nombre especificado a esta imagen.
getAltTextDescription()	String	Devuelve la descripción del texto alternativo de esta imagen.
getAltTextTitle()	String	Devuelve el título del texto alternativo de esta imagen.
getAnchorCell()	Range	Devuelve la celda en la que se ancla una imagen.
getAnchorCellXOffset()	Integer	Devuelve el desplazamiento horizontal en píxeles desde la celda de anclaje.
getAnchorCellYOffset()	Integer	Devuelve el desplazamiento vertical en píxeles desde la celda de anclaje.
getHeight()	Integer	Devuelve la altura real de esta imagen en píxeles.
getInherentHeight()	Integer	Devuelve la altura inherente de esta imagen en píxeles.
getInherentWidth()	Integer	Devuelve la altura inherente de esta imagen en píxeles.
getScript()	String	Devuelve el nombre de la función asignada a esta imagen.
getSheet()	Sheet	Devuelve la hoja en la que aparece esta imagen.
getWidth()	Integer	Devuelve el ancho real de esta imagen en píxeles.
remove()	void	Borra esta imagen de la hoja de cálculo.
replace(blob)	OverGridImage	Reemplaza esta imagen por la que se especifica en el BlobSource proporcionado.
replace(url)	OverGridImage	Reemplaza esta imagen por la de la URL especificada.
resetSize()	OverGridImage	Restablece las dimensiones inherentes de esta imagen.
setAltTextDescription(description)	OverGridImage	Establece la descripción del texto alternativo para esta imagen.
setAltTextTitle(title)	OverGridImage	Establece el título del texto alternativo para esta imagen.
setAnchorCell(cell)	OverGridImage	Establece la celda en la que se ancla una imagen.
setAnchorCellXOffset(offset)	OverGridImage	Establece el desplazamiento horizontal en píxeles desde la celda de anclaje.
setAnchorCellYOffset(offset)	OverGridImage	Establece el desplazamiento vertical en píxeles desde la celda de anclaje.
setHeight(height)	OverGridImage	Establece la altura real de esta imagen en píxeles.
setWidth(width)	OverGridImage	Establece el ancho real de esta imagen en píxeles.

Métodos obsoletos

Método	Tipo de datos que se devuelve	Descripción breve
getUrl()	String	Obtiene la URL de origen de la imagen.

Documentación detallada

assignScript(functionName)

Asigna la función con el nombre especificado a esta imagen.

Parámetros

Nombre	Tipo	Descripción
functionName	String	Es el nombre de la función que se especifica. Debe ser una función pública de nivel superior, no una que termine en guion bajo, como privateFunction_.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAltTextDescription()

Devuelve la descripción del texto alternativo de esta imagen.

Volver

String: Es la descripción del texto alternativo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAltTextTitle()

Devuelve el título del texto alternativo de esta imagen.

Volver

String: Es el título del texto alternativo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAnchorCell()

Devuelve la celda en la que se ancla una imagen.

Volver

Range: Es la celda de anclaje.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAnchorCellXOffset()

Devuelve el desplazamiento horizontal en píxeles desde la celda de anclaje.

Volver

Integer: Es el desplazamiento horizontal en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAnchorCellYOffset()

Devuelve el desplazamiento vertical en píxeles desde la celda de anclaje.

Volver

Integer: Es el desplazamiento vertical en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getHeight()

Devuelve la altura real de esta imagen en píxeles.

// 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());
}

Volver

Integer: La altura de la imagen en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getInherentHeight()

Devuelve la altura inherente de esta imagen en píxeles.

Volver

Integer: Es la altura inherente en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getInherentWidth()

Devuelve la altura inherente de esta imagen en píxeles.

Volver

Integer: Es el ancho inherente en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getScript()

Devuelve el nombre de la función asignada a esta imagen.

Volver

String: Es el nombre de la función.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheet()

Devuelve la hoja en la que aparece esta imagen.

// 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());
}

Volver

Sheet: Es la hoja en la que aparece la imagen.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getWidth()

Devuelve el ancho real de esta imagen en píxeles.

// 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());
}

Volver

Integer: Es el ancho de la imagen en píxeles.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

remove()

Borra esta imagen de la hoja de cálculo. Cualquier otra operación en la imagen genera un error de secuencia de comandos.

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

replace(blob)

Reemplaza esta imagen por la que se especifica en el BlobSource proporcionado. El tamaño máximo permitido para un BLOB es 2 MB.

Parámetros

Nombre	Tipo	Descripción
blob	BlobSource	Es la imagen nueva como un Blob.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

replace(url)

Reemplaza esta imagen por la de la URL especificada.

Parámetros

Nombre	Tipo	Descripción
url	String	Es la URL de la imagen nueva.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

resetSize()

Restablece las dimensiones inherentes de esta imagen.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAltTextDescription(description)

Establece la descripción del texto alternativo para esta imagen.

Parámetros

Nombre	Tipo	Descripción
description	String	Es la nueva descripción de texto alternativo para la imagen.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAltTextTitle(title)

Establece el título del texto alternativo para esta imagen.

Parámetros

Nombre	Tipo	Descripción
title	String	Es el nuevo título del texto alternativo de la imagen.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAnchorCell(cell)

Establece la celda en la que se ancla una imagen.

Parámetros

Nombre	Tipo	Descripción
cell	Range	Es la nueva celda de anclaje.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAnchorCellXOffset(offset)

Establece el desplazamiento horizontal en píxeles desde la celda de anclaje.

Parámetros

Nombre	Tipo	Descripción
offset	Integer	Es el nuevo desplazamiento horizontal del píxel.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAnchorCellYOffset(offset)

Establece el desplazamiento vertical en píxeles desde la celda de anclaje.

Parámetros

Nombre	Tipo	Descripción
offset	Integer	Es el nuevo desplazamiento vertical del píxel.

Volver

OverGridImage: Esta imagen, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setHeight(height)

Establece la altura real de esta imagen en píxeles.

Parámetros

Nombre	Tipo	Descripción
height	Integer	Es la altura deseada en píxeles.

Volver

OverGridImage: La imagen para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setWidth(width)

Establece el ancho real de esta imagen en píxeles.

Parámetros

Nombre	Tipo	Descripción
width	Integer	Es el ancho deseado en píxeles.

Volver

OverGridImage: La imagen para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Métodos obsoletos

getUrl()

Obsoleto. En la mayoría de las imágenes insertadas recientemente, la URL de origen no está disponible.

Obtiene la URL de origen de la imagen. Devuelve una cadena vacía si la URL no está disponible. En la mayoría de las imágenes insertadas recientemente, la URL de origen no está disponible, independientemente de cómo se inserte la imagen.

Volver

String: URL de origen de la imagen, si está disponible; de lo contrario, devuelve una cadena vacía.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets