Class Group

群組

存取及修改試算表群組。群組是連續區間之間的關聯 可以展開或收合的列或欄，以隱藏/顯示這些列或欄。 每個群組的資料列或資料欄在該群組的前面或後面都有控制項切換按鈕 (視設定而定) 可展開或收合整個群組。

群組的「depth」是指群組的巢狀位置，以及有多少較大的項目 群組包含群組。群組的「收合狀態」是指該群組是否會指出 上層群組展開後，應維持收合或展開狀態。此外， 群組收合或展開時，系統會隱藏該群組中的列或欄，或是 可隱藏個別列或欄，但您可以隱藏或設定可見的個別列或欄， 收合狀態。

方法

方法傳回類型簡短說明
collapse()Group收合這個群組。
expand()Group展開這個群組。
getControlIndex()Integer傳回這個群組的控制項切換索引。
getDepth()Integer傳回此群組的深度。
getRange()Range傳回這個群組存在的範圍。
isCollapsed()Boolean如果這個群組處於收合狀態，則傳回 true。
remove()void從工作表中移除這個群組，並降低range的群組深度： 第一項。

內容詳盡的說明文件

collapse()

收合這個群組。 

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

回攻員

Group：這個群組，用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

expand()

展開這個群組。 

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

回攻員

Group：這個群組，用於鏈結

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getControlIndex()

傳回這個群組的控制項切換索引。這是指範圍前的索引 控制項切換按鈕會顯示在群組前面，反之則會顯示在範圍之後。 

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

回攻員

Integer：這個群組的控制項切換鈕索引

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getDepth()

傳回此群組的深度。 

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

回攻員

Integer：這個群組的深度

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getRange()

傳回這個群組存在的範圍。 

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

回攻員

Range：群組存在的範圍

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

isCollapsed()

如果這個群組處於收合狀態，則傳回 true。 

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

回攻員

Boolean - 如果這個群組處於收合狀態，請true；否則會傳回 false

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

remove()

從工作表中移除這個群組，並降低range的群組深度： 第一項。這可能會修改其他群組。呼叫此方法後，群組物件將失效，無法再使用。 

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱