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 le righe o le colonne. Ogni gruppo ha un controllo di attivazione/disattivazione nella riga o nella colonna direttamente prima o dopo il gruppo (a seconda delle impostazioni) che può espandere o comprimere il gruppo nel suo complesso.

La profondità di un gruppo si riferisce alla posizione nidificata del gruppo e al numero di gruppi più grandi che contengono il gruppo. 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 è 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()GroupComprimi questo gruppo.
expand()GroupEspande questo gruppo.
getControlIndex()IntegerRestituisce l'indice di attivazione/disattivazione del controllo di questo gruppo.
getDepth()IntegerRestituisce la profondità di questo gruppo.
getRange()RangeRestituisce l'intervallo in cui esiste questo 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()

Comprimi questo gruppo. 

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

Invio

Group: questo gruppo, per l'accodamento

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. 

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

Invio

Group: questo gruppo, per l'accodamento

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 appena prima dell'intervallo quando il pulsante di attivazione/disattivazione del controllo viene mostrato prima del gruppo oppure dell'indice appena dopo l'intervallo in caso contrario. 

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

Invio

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à di questo gruppo. 

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

Invio

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 esiste questo gruppo. 

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

Invio

Range: l'intervallo in cui esiste 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. 

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

Invio

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

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. Ciò potrebbe modificare altri gruppi. Dopo questa chiamata, l'oggetto gruppo non è più valido. 

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

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