Class Group

Groupe

Accédez aux groupes de feuilles de calcul et modifiez-les. Les groupes sont une association entre un intervalle de lignes ou de colonnes contiguës, qui peut être développé ou réduit en tant qu'unité pour masquer/afficher les lignes ou les colonnes. Chaque groupe dispose d'un bouton d'activation/de désactivation sur la ligne ou la colonne située juste avant ou après le groupe (selon les paramètres), qui 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 grands qui le contiennent. L'état réduit d'un groupe indique si celui-ci doit rester réduit ou développé après le développement d'un groupe parent. En outre, lorsqu'un groupe est réduit ou développé, ses lignes ou colonnes sont masquées ou visibles, même si des lignes ou des colonnes individuelles peuvent être masquées ou définies, quel que soit 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 d'activation/de désactivation des commandes de ce groupe.
getDepth()IntegerRenvoie la profondeur de ce groupe.
getRange()RangeRenvoie la plage dans laquelle ce groupe existe.
isCollapsed()BooleanRenvoie true si ce groupe est réduit.
remove()voidSupprime ce groupe de la feuille, ce qui réduit de un la profondeur de groupe de range.

Documentation détaillée

collapse()

Réduit ce groupe. 

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

Renvois

Group : ce groupe, pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

expand()

Développe ce groupe. 

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

Renvois

Group : ce groupe, pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getControlIndex()

Renvoie l'index d'activation/de désactivation des commandes de ce groupe. Il s'agit de l'index situé juste avant la plage lorsque le bouton d'activation des commandes est affiché avant le groupe, ou juste après la plage dans le cas contraire. 

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

Renvois

Integer : index d'activation/de désactivation des commandes de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getDepth()

Renvoie la profondeur de ce groupe. 

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

Renvois

Integer : profondeur de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getRange()

Renvoie la plage dans laquelle ce groupe existe. 

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

Renvois

Range : plage sur laquelle se situe le groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isCollapsed()

Renvoie true si ce groupe est réduit. 

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application 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 de un la profondeur de groupe de range. Cela peut modifier d'autres groupes. Après l'appel de cette méthode, l'objet de groupe n'est plus valide. 

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Voir aussi