Class OverGridImage

Imagen de OverGrid

Representa una imagen sobre la cuadrícula en 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 de texto alternativo de esta imagen.
getAltTextTitle()StringMuestra el título de texto alternativo de esta imagen.
getAnchorCell()RangeMuestra la celda en la que se anclan las imágenes.
getAnchorCellXOffset()IntegerMuestra el desplazamiento de píxeles horizontales de la celda de anclaje.
getAnchorCellYOffset()IntegerMuestra el desplazamiento de píxeles vertical de 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 con la que especifica el BlobSource proporcionado.
replace(url)OverGridImageReemplaza esta imagen con la de la URL especificada.
resetSize()OverGridImageRestablece esta imagen a sus dimensiones inherentes.
setAltTextDescription(description)OverGridImageEstablece la descripción de texto alternativo para esta imagen.
setAltTextTitle(title)OverGridImageEstablece el título de texto alternativo para esta imagen.
setAnchorCell(cell)OverGridImageEstablece la celda en la que se anclan las imágenes.
setAnchorCellXOffset(offset)OverGridImageEstablece el desplazamiento de píxeles horizontales 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
functionNameStringEl nombre de la función que se especifica. Debe ser una función de nivel superior pública, no una que termine con un 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()

Muestra la descripción de texto alternativo de esta imagen.

Volver

String: la descripción de 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()

Muestra el título de texto alternativo de esta imagen.

Volver

String: el título de 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()

Muestra la celda en la que se anclan las imágenes.

Volver

Range: 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()

Muestra el desplazamiento de píxeles horizontales de la celda de anclaje.

Volver

Integer: el desplazamiento de píxeles horizontal.

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()

Muestra el desplazamiento de píxeles vertical de la celda de anclaje.

Volver

Integer: el desplazamiento de píxeles verticales.

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()

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: 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()

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

Volver

Integer: 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()

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

Volver

Integer: 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()

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

Volver

String: 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()

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 alcances:

  • 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ó mediante una URL mediante una API, este método muestra la URL proporcionada durante la inserción de imágenes.

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 alcances:

  • 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: 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 operación posterior en la imagen da como resultado 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 alcances:

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

replace(blob)

Reemplaza esta imagen con la que especifica el BlobSource proporcionado. El tamaño de BLOB admitido 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 alcances:

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

replace(url)

Reemplaza esta imagen con la de la URL especificada.

Parámetros

NombreTipoDescripción
urlStringLa 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 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 alcances:

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

setAltTextDescription(description)

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

Parámetros

NombreTipoDescripción
descriptionStringLa 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 de texto alternativo para esta imagen.

Parámetros

NombreTipoDescripción
titleStringEl nuevo título de 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 anclan las imágenes.

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 alcances:

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

setAnchorCellXOffset(offset)

Establece el desplazamiento de píxeles horizontales 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 alcances:

  • 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
offsetIntegerDesplazamiento vertical de píxeles nuevo.

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

NombreTipoDescripción
heightIntegerLa altura deseada en píxeles.

Volver

OverGridImage: la 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

setWidth(width)

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

Parámetros

NombreTipoDescripción
widthIntegerEl ancho deseado en píxeles.

Volver

OverGridImage: la 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