Class Group

Grupo

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 alternância de controle na linha ou coluna diretamente 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 do grupo e a quantos grupos maiores o contêm. O estado recolhido de um grupo se refere a se o grupo deve permanecer recolhido ou expandido depois que um grupo pai for expandido. Além disso, no momento em que um grupo é recolhido ou expandido, as linhas ou colunas dentro do grupo são ocultadas ou definidas como visíveis, embora linhas ou colunas individuais possam ser ocultadas ou definidas como visíveis, independentemente do estado recolhido.

Métodos

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

Documentação detalhada

collapse()

Recolhe esse 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 — Esse 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 esse 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 — Esse 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 desse grupo. Esse é o índice logo antes do intervalo quando a alternância de controle é mostrada antes do grupo ou o índice logo após o intervalo. 

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 desse 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 desse 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 desse 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 esse grupo estiver recolhido. 

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 esse 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 esse comando, o objeto de grupo se torna 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