Class Group

Group

Acessar e modificar grupos de planilhas. Os grupos são uma associação entre um intervalo de linhas ou colunas contíguas que podem ser expandidas ou recolhidas como uma unidade para ocultar/mostrar as linhas ou colunas. Cada grupo tem uma chave de controle na linha ou coluna imediatamente antes ou depois do grupo (dependendo das configurações) que pode expandir ou recolher o grupo como um todo.

A profundidade de um grupo se refere à posição aninhada dele e a quantos grupos maiores o contêm. O estado recolhido de um grupo se refere a se ele deve permanecer recolhido ou ser expandido depois que um grupo principal é aberto. Além disso, quando um grupo é recolhido ou expandido, as linhas ou colunas dentro dele são ocultadas ou definidas como visíveis, mas linhas ou colunas individuais podem ser ocultadas ou definidas como visíveis independentemente do estado recolhido.

Métodos

MétodoTipo de retornoBreve descrição
collapse()GroupFecha este grupo.
expand()GroupExpande este grupo.
getControlIndex()IntegerRetorna o índice de alternância de controle deste grupo.
getDepth()IntegerRetorna a profundidade deste grupo.
getRange()RangeRetorna o intervalo em que esse grupo existe.
isCollapsed()BooleanRetorna true se o grupo estiver fechado.
remove()voidRemove esse grupo da planilha, reduzindo a profundidade do grupo do range em um.

Documentação detalhada

collapse()

Fecha este grupo. 

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

Retornar

Group: este grupo, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

expand()

Expande este grupo. 

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

Retornar

Group: este grupo, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getControlIndex()

Retorna o índice de alternância de controle deste grupo. Esse é o índice logo antes do intervalo quando a chave de controle é mostrada antes do grupo ou o índice logo após o intervalo, caso contrário. 

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

Retornar

Integer: o índice de alternância de controle deste grupo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getDepth()

Retorna a profundidade deste grupo. 

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

Retornar

Integer: a profundidade deste grupo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getRange()

Retorna o intervalo em que esse grupo 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();

Retornar

Range: o intervalo em que o grupo existe.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isCollapsed()

Retorna true se o grupo estiver fechado. 

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

Retornar

Boolean: true se o grupo estiver recolhido. Caso contrário, retorna false.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

remove()

Remove esse grupo da planilha, reduzindo a profundidade do grupo do range em um. Isso pode modificar outros grupos. Depois de chamar isso, o objeto do grupo fica inválido para uso. 

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também