Class Group

Group

Acessar e modificar grupos de planilhas. Grupos são uma associação entre um intervalo de linhas ou colunas que podem ser expandidas ou recolhidas como uma unidade para ocultar/mostrar as linhas ou colunas. Cada grupo tem um botão de controle na linha ou coluna 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 quantas grupos contêm o grupo. O estado recolhido de um grupo indica se ele devem permanecer recolhidos ou expandidos depois que um grupo principal for aberto. Além disso, no momento em que um grupo é recolhido ou expandido, as linhas ou colunas do grupo ficam ocultas ou definidos como visíveis, embora linhas ou colunas individuais possam ser ocultadas ou definidas como visíveis, recolhido.

Métodos

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

Documentação detalhada

collapse()

Recolhe este 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 precisam de 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 precisam de 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 controles deste grupo. Este é o índice imediatamente antes do intervalo quando o controle é exibido antes do grupo. Caso contrário, o índice aparece logo após o 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 de controles deste grupo.

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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. 

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 em que o grupo existe.

Autorização

Os scripts que usam esse método precisam de 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 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. retorna false, caso contrário

Autorização

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

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

remove()

Remove este grupo da página, reduzindo a profundidade do grupo range em um. Isso pode modificar outros grupos. Depois de chamar isso, o objeto do 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 precisam de 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