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

ดูเพิ่มเติม