Class Group

Group (Groupe)

Accéder à des groupes de feuilles de calcul et les modifier. 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 sur la ligne ou la colonne, juste avant ou après le groupe (selon les paramètres), qui peut le développer ou le réduire dans son ensemble.

La profondeur d'un groupe fait référence à sa position imbriquée et au nombre de groupes plus importants qui contiennent le groupe. L'état avant expansion d'un groupe indique si le groupe doit rester réduit ou développé après l'expansion du groupe parent. De plus, au moment où un groupe est réduit ou développé, les lignes ou les colonnes du groupe sont masquées ou définies, bien que des lignes ou des colonnes individuelles puissent être masquées ou définies, quel que soit l'état avant expansion.

Méthodes

MéthodeType renvoyéBrève description
collapse()GroupRéduit ce groupe.
expand()GroupDéveloppe ce groupe.
getControlIndex()IntegerAffiche l'index d'activation/de désactivation de ce groupe.
getDepth()IntegerAffiche la profondeur de ce groupe.
getRange()RangeRenvoie la plage sur laquelle ce groupe existe.
isCollapsed()BooleanAffiche true si ce groupe est réduit.
remove()voidSupprime ce groupe de la feuille, réduisant ainsi 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();

Aller-retour

Group : ce groupe, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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();

Aller-retour

Group : ce groupe, pour le chaînage

Autorisation

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

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

getControlIndex()

Affiche l'index d'activation/de désactivation de ce groupe. Il s'agit de l'index situé juste avant la plage lorsque le bouton d'activation du contrôle est affiché avant le groupe, ou de l'index situé juste après la plage. 

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

Aller-retour

Integer : index d'activation/de désactivation du groupe

Autorisation

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

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

getDepth()

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

Aller-retour

Integer : profondeur de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sur 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();

Aller-retour

Range : plage sur laquelle le groupe existe

Autorisation

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

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

isCollapsed()

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

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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, réduisant ainsi la profondeur de groupe de range. Cela peut modifier d'autres groupes. L'objet de groupe ne peut alors plus être utilisé. 

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 avec un ou plusieurs des champs d'application suivants :

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

Voir aussi