Class Group

Group

Mengakses dan mengubah grup spreadsheet. Grup adalah asosiasi antara interval baris atau kolom yang berdekatan yang dapat diperluas atau diciutkan sebagai unit untuk menyembunyikan/menampilkan baris atau kolom. Setiap grup memiliki tombol kontrol di baris atau kolom tepat sebelum atau setelah grup (bergantung pada setelan) yang dapat memperluas atau menciutkan grup secara keseluruhan.

Kedalaman grup mengacu pada posisi bertingkat grup dan jumlah grup yang lebih besar yang berisi grup tersebut. Status diciutkan grup mengacu pada apakah grup harus tetap diciutkan atau diperluas setelah grup induk diperluas. Selain itu, saat grup diciutkan atau diperluas, baris atau kolom dalam grup akan disembunyikan atau ditetapkan agar terlihat, meskipun baris atau kolom individual dapat disembunyikan atau ditetapkan agar terlihat terlepas dari status diciutkan.

Metode

MetodeJenis nilai yang ditampilkanDeskripsi singkat
collapse()GroupMenciutkan grup ini.
expand()GroupMemperluas grup ini.
getControlIndex()IntegerMenampilkan indeks tombol kontrol grup ini.
getDepth()IntegerMenampilkan kedalaman grup ini.
getRange()RangeMenampilkan rentang tempat grup ini berada.
isCollapsed()BooleanMenampilkan true jika grup ini diciutkan.
remove()voidMenghapus grup ini dari sheet, sehingga mengurangi kedalaman grup range sebanyak satu.

Dokumentasi mendetail

collapse()

Menciutkan grup ini. 

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

Nilai yang ditampilkan

Group — Grup ini, untuk dirangkaikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

expand()

Memperluas grup ini. 

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

Nilai yang ditampilkan

Group — Grup ini, untuk dirangkaikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getControlIndex()

Menampilkan indeks tombol kontrol grup ini. Ini adalah indeks tepat sebelum rentang saat tombol kontrol ditampilkan sebelum grup, atau indeks tepat setelah rentang. 

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

Nilai yang ditampilkan

Integer — Indeks tombol kontrol grup ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getDepth()

Menampilkan kedalaman grup ini. 

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

Nilai yang ditampilkan

Integer — Kedalaman grup ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getRange()

Menampilkan rentang tempat grup ini berada. 

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

Nilai yang ditampilkan

Range — Rentang tempat grup berada.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

isCollapsed()

Menampilkan true jika grup ini diciutkan. 

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

Nilai yang ditampilkan

Boolean — true Jika grup ini diciutkan; menampilkan false jika tidak.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

remove()

Menghapus grup ini dari sheet, sehingga mengurangi kedalaman grup range sebanyak satu. Tindakan ini dapat mengubah grup lain. Setelah memanggil metode ini, objek grup menjadi tidak valid untuk digunakan. 

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

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

Lihat juga