Class Group

グループ

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

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

メソッド

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

関連情報