Class Group

Gruppo

Accedere ai gruppi di fogli di lavoro e modificarli. I gruppi sono un'associazione tra un intervallo di righe o colonne contigue che possono essere espanse o compresse come unità per nascondere/mostrare righe o colonne. Ogni gruppo è dotato di un'opzione di attivazione/disattivazione del controllo sulla riga o colonna direttamente prima o dopo il gruppo (a seconda delle impostazioni) che consente di espandere o comprimere il gruppo nel suo insieme.

La profondità di un gruppo fa riferimento alla posizione nidificata del gruppo e al numero di gruppi più grandi che lo contengono. Lo stato compresso di un gruppo indica se il gruppo deve rimanere compresso o espanso dopo l'espansione di un gruppo principale. Inoltre, quando un gruppo viene compresso o espanso, le righe o le colonne al suo interno vengono nascoste o impostate come visibili, anche se le singole righe o colonne possono essere nascoste o impostate come visibili indipendentemente dallo stato compresso.

Metodi

MetodoTipo restituitoBreve descrizione
collapse()GroupComprime questo gruppo.
expand()GroupEspande questo gruppo.
getControlIndex()IntegerRestituisce l'indice di attivazione/disattivazione del controllo di questo gruppo.
getDepth()IntegerRestituisce la profondità del gruppo.
getRange()RangeRestituisce l'intervallo in cui si trova il gruppo.
isCollapsed()BooleanRestituisce true se questo gruppo è compresso.
remove()voidRimuove questo gruppo dal foglio, riducendo di uno la profondità del gruppo di range.

Documentazione dettagliata

collapse()

Comprime questo gruppo. 

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

Ritorni

Group: questo gruppo, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

expand()

Espande questo gruppo. 

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

Ritorni

Group: questo gruppo, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getControlIndex()

Restituisce l'indice di attivazione/disattivazione del controllo di questo gruppo. Si tratta dell'indice subito prima dell'intervallo quando il pulsante di attivazione/disattivazione del controllo viene visualizzato prima del gruppo o dell'indice subito dopo l'intervallo. 

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

Ritorni

Integer: l'indice di attivazione/disattivazione del controllo di questo gruppo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDepth()

Restituisce la profondità del gruppo. 

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

Ritorni

Integer: la profondità di questo gruppo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange()

Restituisce l'intervallo in cui si trova il gruppo. 

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

Ritorni

Range: l'intervallo in cui si trova il gruppo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isCollapsed()

Restituisce true se questo gruppo è compresso. 

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

Ritorni

Boolean: true se questo gruppo è compresso; in caso contrario restituisce false

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

remove()

Rimuove questo gruppo dal foglio, riducendo di uno la profondità del gruppo di range. Questa operazione potrebbe modificare altri gruppi. Dopo la chiamata, l'oggetto gruppo non può più essere utilizzato. 

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche