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

ראה גם