Class Selection

בחירה

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

const activeSheet = SpreadsheetApp.getActiveSheet();
const rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']);
rangeList.activate();

const selection = activeSheet.getSelection();
// Current Cell: D1
console.log(`Current Cell: ${selection.getCurrentCell().getA1Notation()}`);
// Active Range: D1:E4
console.log(`Active Range: ${selection.getActiveRange().getA1Notation()}`);
// Active Ranges: A1:B4, D1:E4
const ranges = selection.getActiveRangeList().getRanges();
for (let i = 0; i < ranges.length; i++) {
  console.log(`Active Ranges: ${ranges[i].getA1Notation()}`);
}
console.log(`Active Sheet: ${selection.getActiveSheet().getName()}`);

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
getActiveRange()	Range	הפונקציה מחזירה את הטווח שנבחר בגיליון הפעיל, או את הערך null אם אין טווח פעיל.
getActiveRangeList()	RangeList	הפונקציה מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל, או את הערך null אם אין טווחים פעילים.
getActiveSheet()	Sheet	הפונקציה מחזירה את הגיליון הפעיל בגיליון האלקטרוני.
getCurrentCell()	Range	הפונקציה מחזירה את התא הנוכחי (המודגש) שנבחר באחד מהטווחים הפעילים, או את הערך null אם אין תא נוכחי.
getNextDataRange(direction)	Range	הפונקציה מתחילה ב-current cell וב-active range וממשיכה בכיוון הנתון, ומחזירה טווח מותאם שבו הקצה המתאים של הטווח הוסט כדי לכסות את next data cell ועדיין לכסות את התא הנוכחי.

מסמכים מפורטים

getActiveRange()

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

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const activeRange = selection.getActiveRange();

חזרה

Range – הטווח הפעיל.

אישור

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

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

---

getActiveRangeList()

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

אם נבחר טווח אחד, הפונקציה פועלת כמו קריאה ל-getActiveRange().

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

חזרה

RangeList – רשימת הטווחים הפעילים.

אישור

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

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

---

getActiveSheet()

הפונקציה מחזירה את הגיליון הפעיל בגיליון האלקטרוני.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const activeSheet = selection.getActiveSheet();

חזרה

Sheet — הגיליון הפעיל בגיליון האלקטרוני.

אישור

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

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

---

getCurrentCell()

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

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
// Returns the current highlighted cell in the one of the active ranges.
const currentCell = selection.getCurrentCell();

חזרה

Range – התא הנוכחי.

אישור

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

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

---

getNextDataRange(direction)

הפונקציה מתחילה ב-current cell וב-active range וממשיכה בכיוון הנתון, ומחזירה טווח מותאם שבו הקצה המתאים של הטווח הוסט כדי לכסות את next data cell ועדיין לכסות את התא הנוכחי. אם טווח הפעילות לא מוגבל לאורך dimension של הכיוון, מוחזר טווח הפעילות המקורי. אם אין תא נוכחי או טווח פעיל, הפונקציה מחזירה את הערך null. הפעולה הזו זהה לבחירת טווח בעורך והקשה על Ctrl+Shift+[arrow key].

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Makes C3 the current cell and C3:E5 the active range.
sheet.getRange('C3:E5').activate();
// Logs 'C1:E3'
console.log(
    SpreadsheetApp.getSelection()
        .getNextDataRange(SpreadsheetApp.Direction.UP)
        .getA1Notation(),
);

פרמטרים

שם	סוג	תיאור
direction	Direction	הכיוון שבו צריך למצוא את התא הבא בקצה של אזור הנתונים.

חזרה

Range – הטווח המותאם שכולל את תא הנתונים, או null אם אין בחירה.

אישור

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

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