Class OverGridImage

SobreCuadrículaImagen

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
assignScript(functionName)OverGridImageAsigna la función con el nombre especificado a esta imagen.
getAltTextDescription()StringMuestra la descripción del texto alternativo de esta imagen.
getAltTextTitle()StringMuestra el título del texto alternativo de esta imagen.
getAnchorCell()RangeMuestra la celda en la que se ancla una imagen.
getAnchorCellXOffset()IntegerMuestra el desplazamiento horizontal de píxeles desde la celda de anclaje.
getAnchorCellYOffset()IntegerMuestra el desplazamiento vertical de píxeles desde la celda de anclaje.
getHeight()IntegerMuestra la altura real de esta imagen en píxeles.
getInherentHeight()IntegerMuestra la altura inherente de esta imagen en píxeles.
getInherentWidth()IntegerMuestra la altura inherente de esta imagen en píxeles.
getScript()StringMuestra el nombre de la función asignada a esta imagen.
getSheet()SheetMuestra la hoja en la que aparece esta imagen.
getUrl()StringObtiene la URL de origen de la imagen y muestra null si la URL no está disponible.
getWidth()IntegerMuestra el ancho real de esta imagen en píxeles.
remove()voidBorra esta imagen de la hoja de cálculo.
replace(blob)OverGridImageReemplaza esta imagen por la que especifica el BlobSource proporcionado.
replace(url)OverGridImageReemplaza esta imagen por la de la URL especificada.
resetSize()OverGridImageRestablece esta imagen a sus dimensiones inherentes.
setAltTextDescription(description)OverGridImageEstablece la descripción del texto alternativo para esta imagen.
setAltTextTitle(title)OverGridImageEstablece el título del texto alternativo para esta imagen.
setAnchorCell(cell)OverGridImageEstablece la celda en la que se ancla una imagen.
setAnchorCellXOffset(offset)OverGridImageEstablece el desplazamiento horizontal de píxeles desde la celda de anclaje.
setAnchorCellYOffset(offset)OverGridImageEstablece el desplazamiento vertical de píxeles desde la celda de anclaje.
setHeight(height)OverGridImageEstablece la altura real de esta imagen en píxeles.
setWidth(width)OverGridImageEstablece el ancho real de esta imagen en píxeles.

Documentación detallada

assignScript(functionName)

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

Parámetros

NombreTipoDescripción
functionNameStringEs 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 ámbitos:

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

getAltTextDescription()

Muestra 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 ámbitos:

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

getAltTextTitle()

Muestra 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 ámbitos:

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

getAnchorCell()

Muestra 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 ámbitos:

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

getAnchorCellXOffset()

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

Volver

Integer: Es el desplazamiento horizontal de píxeles.

Autorización

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

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

getAnchorCellYOffset()

Muestra el desplazamiento vertical de 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 ámbitos:

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

getHeight()

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

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

Volver

Integer: Es 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 ámbitos:

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

getInherentHeight()

Muestra 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 ámbitos:

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

getInherentWidth()

Muestra 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 ámbitos:

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

getScript()

Muestra 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 ámbitos:

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

getSheet()

Muestra la hoja en la que aparece esta imagen.

// Logs the parent sheet of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 ámbitos:

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

getUrl()

Obtiene la URL de origen de la imagen y muestra null si la URL no está disponible. Si la imagen se insertó por URL con una API, este método muestra la URL proporcionada durante la inserción de la imagen.

Volver

String: Es la URL de la imagen si está disponible. Muestra null si la imagen no está disponible o no tiene una URL de origen.

Autorización

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

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

getWidth()

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

// Logs the width of all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 ámbitos:

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

remove()

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

// Deletes all images in a spreadsheet
var images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (var 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 ámbitos:

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

replace(blob)

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

Parámetros

NombreTipoDescripción
blobBlobSourceLa 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 ámbitos:

  • 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

NombreTipoDescripción
urlStringEs 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 ámbitos:

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

resetSize()

Restablece esta imagen a sus dimensiones inherentes.

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 ámbitos:

  • 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

NombreTipoDescripción
descriptionStringLa nueva descripción del 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 ámbitos:

  • 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

NombreTipoDescripción
titleStringEs 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 ámbitos:

  • 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

NombreTipoDescripción
cellRangeLa 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 ámbitos:

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

setAnchorCellXOffset(offset)

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

Parámetros

NombreTipoDescripción
offsetIntegerEl nuevo desplazamiento horizontal de píxeles.

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 ámbitos:

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

setAnchorCellYOffset(offset)

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

Parámetros

NombreTipoDescripción
offsetIntegerEl nuevo desplazamiento vertical de píxeles.

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 ámbitos:

  • 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

NombreTipoDescripción
heightIntegerEs la altura deseada en píxeles.

Volver

OverGridImage: Es 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 ámbitos:

  • 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

NombreTipoDescripción
widthIntegerEl ancho deseado en píxeles.

Volver

OverGridImage: Es 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 ámbitos:

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