Class Drawing

Dibujo

Representa un dibujo sobre una hoja en una hoja de cálculo.

Métodos

MétodoTipo de datos que se muestraDescripción breve
getContainerInfo()ContainerInfoObtiene información sobre la posición del dibujo en la hoja.
getHeight()IntegerMuestra la altura real de este dibujo en píxeles.
getOnAction()StringMuestra el nombre de la macro adjunta a este dibujo.
getSheet()SheetMuestra la hoja en la que aparece este dibujo.
getWidth()IntegerMuestra el ancho real de este dibujo en píxeles.
getZIndex()NumberMuestra el índice z de este dibujo.
remove()voidElimina este dibujo de la hoja de cálculo.
setHeight(height)DrawingEstablece la altura real de este dibujo en píxeles.
setOnAction(macroName)DrawingAsigna una función macro a este dibujo.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingEstablece la posición en la que aparece el dibujo en la hoja.
setWidth(width)DrawingEstablece el ancho real de este dibujo en píxeles.
setZIndex(zIndex)DrawingEstablece el índice z de este dibujo.

Documentación detallada

getContainerInfo()

Obtiene información sobre la posición del dibujo en la hoja.

Devolvedor

ContainerInfo: Es un objeto que contiene la posición del contenedor del dibujo.

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 este dibujo en píxeles.

// Logs the height of all drawings in a sheet
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getHeight());
}

Devolvedor

Integer: Es la altura del dibujo 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

getOnAction()

Muestra el nombre de la macro adjunta a este dibujo.

// Logs the macro name of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getOnAction());
}

Devolvedor

String: Es el nombre de la macro adjunta a este dibujo.

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 este dibujo.

// Logs the parent sheet of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getSheet());
}

Devolvedor

Sheet: Es la hoja en la que aparece el dibujo.

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 este dibujo en píxeles.

// Logs the width of all drawings in a sheet
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getWidth());
}

Devolvedor

Integer: Es el ancho del dibujo 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

getZIndex()

Muestra el índice z de este dibujo.

// Logs the z-index of all drawings on the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  Logger.log(drawings[i].getZIndex());
}

Devolvedor

Number: Índice Z de este dibujo.

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

Elimina este dibujo de la hoja de cálculo. Cualquier operación adicional en el dibujo generará un error de secuencia de comandos.

// Deletes all drawings from the active sheet.
var drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (var i = 0; i < drawings.length; i++) {
  drawings[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

setHeight(height)

Establece la altura real de este dibujo en píxeles.

Parámetros

NombreTipoDescripción
heightIntegerLa altura deseada en píxeles.

Devolvedor

Drawing: Este dibujo, para 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

setOnAction(macroName)

Asigna una función macro a este dibujo.

Parámetros

NombreTipoDescripción
macroNameStringNombre de la función macro.

Devolvedor

Drawing: Este dibujo, para encadenamiento.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Establece la posición en la que aparece el dibujo en la hoja. Los índices de posición de fila y columna de anclaje se indexan con el valor 1.

Parámetros

NombreTipoDescripción
anchorRowPosIntegerEl lado superior del dibujo está anclado en esta fila.
anchorColPosIntegerEl lado superior del dibujo está anclado en esta columna.
offsetXIntegerDesplazamiento horizontal desde la esquina de la celda en píxeles.
offsetYIntegerDesplazamiento vertical desde la esquina de la celda en píxeles.

Devolvedor

Drawing: Este dibujo, para 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 este dibujo en píxeles.

Parámetros

NombreTipoDescripción
widthIntegerEl ancho deseado en píxeles.

Devolvedor

Drawing: Este dibujo, para 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

setZIndex(zIndex)

Establece el índice z de este dibujo.

Parámetros

NombreTipoDescripción
zIndexNumberÍndice Z de este dibujo.

Devolvedor

Drawing: Este dibujo, para encadenamiento.