Class Group

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 activació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 hace referencia a la posición anidada del grupo y a cuántos grupos más grandes lo contienen. El estado contraído de un grupo hace referencia a si el grupo debe permanecer contraído o expandido después de que se ha expandido un grupo superior. Además, cuando se contrae o expande un grupo, las filas o columnas dentro del grupo se ocultan o se establecen como visibles, aunque las filas o columnas individuales se pueden ocultar o configurar como visibles, 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 activación de control de este grupo.
getDepth()IntegerMuestra la profundidad de este grupo.
getRange()RangeMuestra el rango sobre el que existe este grupo.
isCollapsed()BooleanMuestra true si este grupo está contraído.
remove()voidQuita este grupo de la hoja, lo que 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();

Devolvedor

Group: Este grupo se usa 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

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

Devolvedor

Group: Este grupo se usa 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

getControlIndex()

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

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

Devolvedor

Integer: Es el índice de activación o desactivación de los controles 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();

Devolvedor

Integer: El alcance 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 sobre 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();

Devolvedor

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

Devolvedor

Boolean: Es 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, lo que reduce la profundidad del grupo de range en uno. Esta acción puede modificar otros grupos. Después de llamar a este método, el objeto de grupo deja de ser válido para usarse. 

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