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

תיעוד מפורט

getActiveRange()

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

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

חזרה

‫Range|null — הטווח הפעיל.

אישור

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

  • 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|null – רשימת הטווחים הפעילים.

אישור

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

  • 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|null – התא הנוכחי.

אישור

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

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

פרמטרים

שםסוגתיאור
directionDirectionהכיוון שבו צריך לחפש את התא הבא בקצה של אזור הנתונים.

חזרה

‫Range|null — הטווח המותאם שכולל את תא הנתונים, או null אם לא נבחר כלום.

אישור

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

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