Class Group

קבוצה

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

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

שיטות

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

תיעוד מפורט

collapse()

כיווץ הקבוצה הזו. 

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

הרחבת הקבוצה הזו. 

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

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

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

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

החזרות

Integer – לחצן החלפת המצב של הבקרה של הקבוצה הזו

הרשאות

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

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

getDepth()

מחזירה את העומק של קבוצה זו. 

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

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

החזרות

Integer - העומק של הקבוצה הזו

הרשאות

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

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

getRange()

מחזירה את הטווח שבו קיימת קבוצה זו. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var 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 אם הקבוצה הזו מכווצת. 

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

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

החזרות

Boolean – true אם הקבוצה הזו מכווצת; הפונקציה מחזירה false אחרת

הרשאות

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

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

remove()

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

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

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

הרשאות

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

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

כדאי לעיין גם בפרטים הבאים