Class Group

Grupo

Acceder a grupos de hojas de cálculo y modificarlos Los grupos son una asociación entre un intervalo de filas o columnas contiguas que se pueden expandir o contraer como una unidad para ocultar o mostrar las filas o columnas. Cada grupo tiene un botón de control en la fila o columna directamente antes o después del grupo (según la configuración) que puede expandir o contraer el grupo en su totalidad.

La profundidad de un grupo se refiere a la posición anidada del grupo y a la cantidad de grupos más grandes que contienen el grupo. El estado contraído de un grupo hace referencia a si el grupo debe permanecer contraído o expandido después de la expansión de un grupo superior. Además, en el momento en que un grupo se contrae o se expande, las filas o columnas dentro del grupo se ocultan o se configuran como visibles, aunque las filas o columnas individuales pueden ocultarse o configurarse independientemente del estado contraído.

Métodos

MétodoTipo de datos que se muestraDescripción breve
collapse()GroupContrae este grupo.
expand()GroupExpande este grupo.
getControlIndex()IntegerMuestra el índice de control de control de este grupo.
getDepth()IntegerMuestra la profundidad de este grupo.
getRange()RangeMuestra el rango en el que existe este grupo.
isCollapsed()BooleanMuestra true si este grupo está contraído.
remove()voidQuita este grupo de la hoja y reduce la profundidad del grupo de range en uno.

Documentación detallada

collapse()

Contrae este grupo. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Collapses this group.
group.collapse();

Volver

Group: Este grupo, para cadenas

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

expand()

Expande este grupo. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Expands this group.
group.expand();

Volver

Group: Este grupo, para cadenas

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

getControlIndex()

Muestra el índice de control de control de este grupo. Este es el índice justo antes del rango cuando el botón de activación se muestra antes del grupo o el índice justo después del rango. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns 4
var controlIndex = group.getControlIndex();

Volver

Integer: Es el índice de control de este grupo.

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

getDepth()

Muestra la profundidad de este grupo. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
var depth = group.getDepth();

Volver

Integer: la profundidad de este grupo

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

getRange()

Muestra el rango en el que existe este grupo. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(1, 1);

// Returns the range 2:3 if the group is over rows 2:3
range = group.getRange();

Volver

Range: el rango en el que existe el grupo

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

isCollapsed()

Muestra true si este grupo está contraído. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
var isCollapsed = group.isCollapsed();

Volver

Boolean: true si este grupo está contraído; de lo contrario, muestra false

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

Quita este grupo de la hoja y reduce la profundidad del grupo de range en uno. Esto puede modificar otros grupos. Después de llamar a esto, el objeto del grupo deja de ser válido. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Removes this group
var range = group.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

Consulta también