Class Group

グループ

スプレッドシート グループにアクセスして変更する。グループは、連続する 1 つの期間と 行や列は、1 つのユニットとして展開したり折りたたんだりして、表示/非表示を切り替えられます。 各グループの直前または直後の行または列に、コントロールの切り替えがあります。 （設定に応じて）グループ全体を展開または折りたたむことができます。

グループの深さとは、グループのネストされた位置と、 作成されます。グループの折りたたみ状態とは、グループが 親グループが展開された後でも 閉じたままか開いたままになりますまた、 グループが折りたたまれたり展開されていたりしたとき、グループ内の行や列が非表示または 表示設定が可能です。ただし、個々の行や列を非表示にしたり、 折りたたみ状態になっています。

メソッド

メソッド戻り値の型概要
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

関連情報