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

ראה גם