Class Drawing

Dibujo

Representa un dibujo sobre 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()IntegerDevuelve la altura real de este dibujo en píxeles.
getOnAction()String|nullDevuelve el nombre de la macro adjunta a este dibujo.
getSheet()SheetDevuelve la hoja en la que aparece este dibujo.
getWidth()IntegerDevuelve el ancho real de este dibujo en píxeles.
getZIndex()NumberDevuelve el índice Z de este dibujo.
remove()voidBorra 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 de 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.

Volver

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

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

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

Volver

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

Devuelve el nombre de la macro adjunta a este dibujo.

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

Volver

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

Devuelve la hoja en la que aparece este dibujo.

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

Volver

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

Devuelve el ancho real de este dibujo en píxeles.

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

Volver

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

Devuelve el índice Z de este dibujo.

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

Volver

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

Borra este dibujo de la hoja de cálculo. Cualquier otra operación en el dibujo genera un error de secuencia de comandos.

// Deletes all drawings from the active sheet.
const drawings = SpreadsheetApp.getActiveSheet().getDrawings();
for (let 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
heightIntegerEs la altura deseada en píxeles.

Volver

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

setOnAction(macroName)

Asigna una función de macro a este dibujo.

Parámetros

NombreTipoDescripción
macroNameStringEs el nombre de la función de la macro.

Volver

Drawing: Este dibujo, para encadenar.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

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

Parámetros

NombreTipoDescripción
anchorRowPosIntegerLa parte superior del dibujo está anclada en esta fila.
anchorColPosIntegerLa parte superior del dibujo está anclada en esta columna.
offsetXIntegerEs el desplazamiento horizontal desde la esquina de la celda en píxeles.
offsetYIntegerEs el desplazamiento vertical desde la esquina de la celda en píxeles.

Volver

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

Parámetros

NombreTipoDescripción
widthIntegerEs el ancho deseado en píxeles.

Volver

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

setZIndex(zIndex)

Establece el índice Z de este dibujo.

Parámetros

NombreTipoDescripción
zIndexNumberÍndice Z de este dibujo.

Volver

Drawing: Este dibujo, para encadenar.