Class Group

グループ

スプレッドシート グループにアクセスして変更する。グループは、連続する行または列の間隔を関連付け、1 つのユニットとして行または列を表示または非表示にすることができます。各グループには、（設定に応じて）グループの直前または直後に行または列の切り替えボタンがあり、グループ全体の展開と折りたたみを行うことができます。

グループの深さとは、グループのネストされた位置と、グループを含むより大きなグループの数のことです。グループの折りたたみ状態とは、親グループが展開された後でグループを折りたたんだ状態のままにするか展開したままにするかを指します。さらに、グループを折りたたんだり展開したりすると、グループ内の行または列は非表示または表示設定されますが、折りたたみ状態に関係なく、個々の行または列を非表示にするか、表示設定することができます。

Methods

メソッド戻り値の型概要
collapse()Groupこのグループを折りたたみます。
expand()Groupこのグループを展開します。
getControlIndex()Integerこのグループのコントロール切り替えインデックスを返します。
getDepth()Integerこのグループの深度を返します。
getRange()Rangeこのグループが存在する範囲を返します。
isCollapsed()Booleanこのグループが折りたたまれている場合、true を返します。
remove()voidシートからこのグループを削除し、range のグループの深度を 1 つ下げます。

詳細なドキュメント

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 - このグループ（チェーンの場合）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - このグループ（チェーンの場合）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - このグループのコントロール切り替えインデックス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - このグループの深さ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 - グループが存在する範囲

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • 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 を返します。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

remove()

シートからこのグループを削除し、range のグループの深度を 1 つ下げます。これにより、他のグループも変更される場合があります。これを呼び出すと、グループ オブジェクトが使用できなくなります。 

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

関連ドキュメント