Class Group

קבוצה

אפשר לגשת לקבוצות של גיליונות אלקטרוניים ולשנות אותן. קבוצות הן שילוב של טווח של שורות או עמודות סמוכות שאפשר להרחיב או לכווץ כיחידה כדי להסתיר או להציג את השורות או העמודות. לכל קבוצה יש מתג בקרה בשורה או בעמודה שלפני הקבוצה או אחריה (בהתאם להגדרות), שאפשר להשתמש בו כדי להרחיב או לכווץ את הקבוצה כולה.

העומק של קבוצה מתייחס למיקום המקונן של הקבוצה ולמספר הקבוצות הגדולות יותר שמכילות את הקבוצה. מצב מכווץ של קבוצה מתייחס לשאלה אם הקבוצה צריכה להישאר מכווצת או מורחבת אחרי שהקבוצה הראשית הורחבה. בנוסף, בזמן שמכווצים או מרחיבים קבוצה, השורות או העמודות בתוך הקבוצה מוסתרות או מוצגות, אבל אפשר להסתיר או להציג שורות או עמודות בנפרד בלי קשר למצב הכיווץ.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
collapse()Groupכיווץ הקבוצה.
expand()Groupהרחבת הקבוצה.
getControlIndex()Integerהפונקציה מחזירה את אינדקס המתג של אמצעי הבקרה בקבוצה הזו.
getDepth()Integerמחזירה את העומק של הקבוצה הזו.
getRange()Rangeהפונקציה מחזירה את הטווח שבו הקבוצה הזו קיימת.
isCollapsed()Booleanמחזירה true אם הקבוצה מכווצת.
remove()voidהקבוצה תוסר מהגיליון, ועומק הקבוצה של range יקטן באחד.

תיעוד מפורט

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 – הקבוצה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 – הקבוצה הזו, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 — אינדקס המתג של הפקד בקבוצה הזו.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 – העומק של הקבוצה הזו.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 — הטווח שבו הקבוצה קיימת.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

remove()

הקבוצה תוסר מהגיליון, ועומק הקבוצה של range יקטן באחד. יכול להיות שהשינוי הזה ישפיע על קבוצות אחרות. אחרי שמפעילים את הפונקציה הזו, אי אפשר יותר להשתמש באובייקט של הקבוצה. 

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

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

ראה גם