Class Group

Group

Acesse e modifique grupos de planilhas. 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 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 refere-se à posição aninhada do grupo e a quantos grupos maiores contêm o grupo. O estado recolhido de um grupo indica se o grupo precisa permanecer recolhido ou expandido depois da expansão de um grupo pai. Além disso, no momento em que um grupo é recolhido ou expandido, as linhas ou colunas dentro do grupo ficam ocultas ou visíveis, embora linhas ou colunas individuais possam ser ocultadas ou definidas visíveis, independentemente do estado recolhido.

Métodos

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

Documentação detalhada

collapse()

Recolhe o grupo. 

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

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. 

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

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 do controle deste grupo. Esse é o índice logo antes do intervalo quando o botão de controle é mostrado antes do grupo ou o índice logo depois do intervalo. 

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

Retornar

Integer: o índice de alternância do 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. 

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

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 este grupo existe. 

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

Retornar

Range: o intervalo pelo qual 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()

Retornará true se este grupo estiver recolhido. 

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

Retornar

Boolean: true se este 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 página, reduzindo a profundidade do grupo de range por um. Isso pode modificar outros grupos. Após chamar esse objeto, o objeto de grupo se torna inválido para uso. 

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

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

Veja também