Class Group

Groupe

Accéder aux groupes de feuilles de calcul et les modifier. Les groupes sont une association entre un intervalle de lignes ou de colonnes contiguës qui peuvent être développées ou réduites en tant qu'unité pour masquer/afficher les lignes ou les colonnes. Chaque groupe comporte un bouton d'activation/désactivation sur la ligne ou la colonne qui le précède ou le suit directement (selon les paramètres). Il permet de développer ou de réduire le groupe dans son ensemble.

La profondeur d'un groupe fait référence à la position imbriquée du groupe et au nombre de groupes plus importants qui le contiennent. L'état réduit d'un groupe indique si le groupe doit rester réduit ou développé après le développement d'un groupe parent. De plus, lorsqu'un groupe est réduit ou développé, les lignes ou colonnes qu'il contient sont masquées ou rendues visibles. Toutefois, des lignes ou colonnes individuelles peuvent être masquées ou rendues visibles indépendamment de l'état réduit.

Méthodes

MéthodeType renvoyéBrève description
collapse()GroupRéduit ce groupe.
expand()GroupDéveloppe ce groupe.
getControlIndex()IntegerRenvoie l'index du bouton bascule de contrôle de ce groupe.
getDepth()IntegerRenvoie la profondeur de ce groupe.
getRange()RangeRenvoie la plage sur laquelle ce groupe existe.
isCollapsed()BooleanRenvoie true si ce groupe est réduit.
remove()voidSupprime ce groupe de la feuille, ce qui réduit la profondeur du groupe de range d'une unité.

Documentation détaillée

collapse()

Réduit ce groupe. 

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

Renvois

Group : ce groupe, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

expand()

Développe ce groupe. 

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

Renvois

Group : ce groupe, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getControlIndex()

Renvoie l'index du bouton bascule de contrôle de ce groupe. Il s'agit de l'index juste avant la plage lorsque le bouton de contrôle est affiché avant le groupe, ou de l'index juste après la plage dans le cas contraire. 

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

Renvois

Integer : index du bouton bascule de contrôle de ce groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDepth()

Renvoie la profondeur de ce groupe. 

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

Renvois

Integer : profondeur de ce groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Renvoie la plage sur laquelle ce groupe existe. 

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

Renvois

Range : plage sur laquelle le groupe existe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isCollapsed()

Renvoie true si ce groupe est réduit. 

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

Renvois

Boolean : true si ce groupe est réduit, false sinon.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Supprime ce groupe de la feuille, ce qui réduit la profondeur du groupe de range d'une unité. Cela peut modifier d'autres groupes. Après l'appel, l'objet de groupe devient inutilisable. 

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

Voir aussi