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 interruptor de control en la fila o columna inmediatamente anterior o posterior al 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 la cantidad de grupos más grandes que lo contienen. El estado contraído de un grupo se refiere a si el grupo debe permanecer contraído o expandido después de que se haya expandido un grupo principal. Además, en el momento en que se contrae o expande un grupo, las filas o columnas dentro del grupo se ocultan o se configuran 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()IntegerDevuelve el índice de alternancia de control de este grupo.
getDepth()IntegerDevuelve la profundidad de este grupo.
getRange()RangeDevuelve el rango en 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. 

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

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

Volver

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

expand()

Expande este grupo. 

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

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

Volver

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

getControlIndex()

Devuelve el índice de alternancia de control de este grupo. Es el índice justo antes del rango cuando el botón de activación de control se muestra antes del grupo o el índice justo después del rango en otros casos. 

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

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

Volver

Integer: Es el índice de activación del 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()

Devuelve la profundidad de este grupo. 

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

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

Volver

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

Devuelve el rango en el que existe este grupo. 

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

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

Volver

Range: Es el rango durante el cual 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. 

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

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

Volver

Boolean: true si este grupo está contraído; de lo contrario, devuelve 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. Esto puede modificar otros grupos. Después de llamar a este método, el objeto del grupo deja de ser válido para su uso. 

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

// Removes this group
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