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 expandidos ou recolhidos como uma unidade para ocultar/mostrar as linhas ou colunas. Cada grupo tem um controle de alternância 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 contêm o grupo. O estado recolhido de um grupo indica se ele precisa permanecer recolhido ou aberto depois que um grupo pai foi aberto. Além disso, quando um grupo é fechado ou aberto, as linhas ou colunas dentro dele são ocultadas ou tornadas visíveis, embora linhas ou colunas individuais possam ser ocultadas ou abertas, independentemente do estado fechado.

Métodos

MétodoTipo de retornoBreve descrição
collapse()GroupFechar este grupo.
expand()GroupAbre 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 fechado.
remove()voidRemove esse grupo da planilha, reduzindo a profundidade do grupo do range em um.

Documentação detalhada

collapse()

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

Abre 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: 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 desse grupo. Esse é o índice logo antes do intervalo quando o botão de controle é mostrado 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 do 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 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 fechado. 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 método, 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