Acessar e modificar 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 botão de controle na linha ou coluna logo 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 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 que o grupo principal for expandido. Além disso, no momento em que um grupo é recolhido ou expandido, as linhas ou colunas dentro dele ficam ocultas ou definidas como visíveis. No entanto, linhas ou colunas individuais podem ser ocultas ou definidas como visíveis, independentemente do estado recolhido.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
collapse() | Group | Recolhe este grupo. |
expand() | Group | Expande este grupo. |
getControlIndex() | Integer | Retorna o índice de alternância do controle desse grupo. |
getDepth() | Integer | Retorna a profundidade desse grupo. |
getRange() | Range | Retorna o intervalo no qual este grupo existe. |
isCollapsed() | Boolean | Retorna true se o grupo estiver recolhido. |
remove() | void | Remove esse grupo da página, reduzindo a profundidade do grupo do 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();
Retorno
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();
Retorno
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 desse grupo. Esse é o índice pouco antes do intervalo, quando a alternância de controle é mostrada antes do grupo. Caso contrário, é o índice 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();
Retorno
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 desse 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();
Retorno
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 no qual 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();
Retorno
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 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();
Retorno
Boolean
: true
se o grupo estiver recolhido. Caso contrário, retornará 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 do range
em
um. Isso pode modificar outros grupos. Depois de chamá-lo, 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 exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets