Class Group

グループ

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

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

メソッド

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

詳細なドキュメント

collapse()

このグループを折りたたみます。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const 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()

このグループを展開します。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const 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()

このグループのコントロール トグルのインデックスを返します。コントロール トグルがグループの前に表示される場合は、範囲の直前のインデックスです。それ以外の場合は、範囲の直後のインデックスです。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 4
const controlIndex = group.getControlIndex();

戻る

Integer - このグループのコントロール トグルのインデックス。

承認

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

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

getDepth()

このグループの深さを返します。

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
const depth = group.getDepth();

戻る

Integer - このグループの深さ。

承認

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

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

getRange()

このグループが存在する範囲を返します。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const 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 を返します。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
const isCollapsed = group.isCollapsed();

戻る

Boolean - このグループが折りたたまれている場合は true。それ以外の場合は false。

承認

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

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

remove()

このグループをシートから削除し、range のグループの深さを 1 減らします。これにより、他のグループが変更される可能性があります。この呼び出しの後、グループ オブジェクトは使用できなくなります。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Removes this group
range = group.remove();

承認

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

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

関連情報