דף זה תורגם על ידי Cloud Translation API.

Class Sheet
קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`activate()`	`Sheet`	הפעלת הגיליון הזה.
`addDeveloperMetadata(key)`	`Sheet`	הוספת מטא-נתונים למפתחים עם המפתח שצוין לגיליון.
`addDeveloperMetadata(key, visibility)`	`Sheet`	הוספת מטא-נתונים למפתחים לגיליון עם המפתח והחשיפה שצוינו.
`addDeveloperMetadata(key, value)`	`Sheet`	הוספת מטא-נתונים למפתחים לגיליון עם המפתח והערך שצוינו.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	הוספת מטא-נתונים למפתחים לגיליון עם המפתח, הערך והחשיפה שצוינו.
`appendRow(rowContents)`	`Sheet`	הוספת שורה לתחתית אזור הנתונים הנוכחי בגיליון.
`asDataSourceSheet()`	`DataSourceSheet`	הפונקציה מחזירה את הגיליון כ-`DataSourceSheet` אם הגיליון הוא מסוג `SheetType.DATASOURCE`, או `null` אחרת.
`autoResizeColumn(columnPosition)`	`Sheet`	הגדרת רוחב העמודה הנתונה כך שיתאים לתוכן שלה.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	הגדרת רוחב כל העמודות, החל ממיקום העמודה הנתון, כך שיתאים לתוכן שלהן.
`autoResizeRows(startRow, numRows)`	`Sheet`	הגדרת הגובה של כל השורות, החל מהמיקום של השורה הנתונה, כך שיתאים לתוכן שלהן.
`clear()`	`Sheet`	מחיקת התוכן ומידע העיצוב מהגיליון.
`clear(options)`	`Sheet`	ניקוי הגיליון של התוכן ו/או הפורמט, כפי שצוין באפשרויות המתקדמות הנתונות.
`clearConditionalFormatRules()`	`void`	הסרת כל הכללים של העיצוב המותנה מהגיליון.
`clearContents()`	`Sheet`	מחיקת תוכן העניינים, תוך שמירה על פרטי העיצוב.
`clearFormats()`	`Sheet`	מחיקת העיצוב מהגיליון, תוך שמירה על התוכן.
`clearNotes()`	`Sheet`	ניקוי כל ההערות מהגיליון.
`collapseAllColumnGroups()`	`Sheet`	כיווץ של כל קבוצות העמודות בגיליון.
`collapseAllRowGroups()`	`Sheet`	כיווץ של כל קבוצות השורות בגיליון.
`copyTo(spreadsheet)`	`Sheet`	העתקת הגיליון לגיליון אלקטרוני נתון, שיכול להיות אותו גיליון אלקטרוני כמו המקור.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	הפונקציה מחזירה את הערך `DeveloperMetadataFinder` אם נמצאו מטא-נתונים למפתחים בהיקף של הגיליונות.
`createTextFinder(findText)`	`TextFinder`	יצירת כלי לחיפוש טקסט בגיליון, שיכול למצוא ולהחליף טקסט בגיליון.
`deleteColumn(columnPosition)`	`Sheet`	מחיקה של העמודה במיקום העמודה הנתון.
`deleteColumns(columnPosition, howMany)`	`void`	מחיקה של מספר עמודות, החל ממיקום העמודה שצוין.
`deleteRow(rowPosition)`	`Sheet`	מחיקה של השורה במיקום השורה הנתון.
`deleteRows(rowPosition, howMany)`	`void`	מחיקה של מספר שורות, החל ממיקום השורה שצוין.
`expandAllColumnGroups()`	`Sheet`	הרחבה של כל קבוצות העמודות בגיליון.
`expandAllRowGroups()`	`Sheet`	הרחבה של כל קבוצות השורות בגיליון.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	הרחבה של כל קבוצות העמודות עד לעומק הנתון, וצמצום של כל הקבוצות האחרות.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	הרחבה של כל קבוצות השורות עד לעומק הנתון, וצמצום של כל הקבוצות האחרות.
`getActiveCell()`	`Range`	הפונקציה מחזירה את התא הפעיל בגיליון הזה.
`getActiveRange()`	`Range`	הפונקציה מחזירה את הטווח שנבחר בגיליון הפעיל, או את הערך `null` אם אין טווח פעיל.
`getActiveRangeList()`	`RangeList`	הפונקציה מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל, או את הערך `null` אם אין טווחים פעילים.
`getBandings()`	`Banding[]`	הפונקציה מחזירה את כל הפילוחים בגיליון הזה.
`getCharts()`	`EmbeddedChart[]`	הפונקציה מחזירה מערך של תרשימים בגיליון הזה.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	הפונקציה מחזירה את קבוצת העמודות באינדקס ובעומק הקבוצה שצוינו.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	הפונקציה מחזירה את הערך `GroupControlTogglePosition` לכל קבוצות העמודות בגיליון.
`getColumnGroupDepth(columnIndex)`	`Integer`	הפונקציה מחזירה את עומק הקבוצה של העמודה באינדקס הנתון.
`getColumnWidth(columnPosition)`	`Integer`	הפונקציה מקבלת את רוחב העמודה הנתונה בפיקסלים.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	הצגת כל הכללים של העיצוב המותנה בגיליון הזה.
`getCurrentCell()`	`Range`	הפונקציה מחזירה את התא הנוכחי בגיליון הפעיל, או את הערך `null` אם אין תא נוכחי.
`getDataRange()`	`Range`	הפונקציה מחזירה `Range` שתואם למאפיינים שבהם יש נתונים.
`getDataSourceFormulas()`	`DataSourceFormula[]`	הפונקציה מקבלת את כל הנוסחאות של מקורות הנתונים.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	הפונקציה מקבלת את כל טבלאות הצירים של מקור הנתונים.
`getDataSourceTables()`	`DataSourceTable[]`	הפונקציה מקבלת את כל הטבלאות של מקורות הנתונים.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	אחזור כל המטא-נתונים של המפתחים שמשויכים לגיליון הזה.
`getDrawings()`	`Drawing[]`	הפונקציה מחזירה מערך של ציורים בגיליון.
`getFilter()`	`Filter`	הפונקציה מחזירה את המסנן בגיליון הזה, או את הערך `null` אם אין מסנן.
`getFormUrl()`	`String`	הפונקציה מחזירה את כתובת ה-URL של הטופס ששולח את התשובות שלו לגיליון הזה, או את הערך `null` אם לגיליון הזה אין טופס משויך.
`getFrozenColumns()`	`Integer`	הפונקציה מחזירה את מספר העמודות הקפואות.
`getFrozenRows()`	`Integer`	הפונקציה מחזירה את מספר השורות הקפואות.
`getImages()`	`OverGridImage[]`	הפונקציה מחזירה את כל התמונות שמוצגות מעל לרשת התאים בגיליון.
`getIndex()`	`Integer`	הפונקציה מקבלת את המיקום של הגיליון בגיליון האלקטרוני ההורה שלו.
`getLastColumn()`	`Integer`	הפונקציה מחזירה את המיקום של העמודה האחרונה שיש בה תוכן.
`getLastRow()`	`Integer`	הפונקציה מחזירה את המיקום של השורה האחרונה שיש בה תוכן.
`getMaxColumns()`	`Integer`	הפונקציה מחזירה את המספר הנוכחי של העמודות בגיליון, ללא קשר לתוכן.
`getMaxRows()`	`Integer`	הפונקציה מחזירה את המספר הנוכחי של השורות בגיליון, ללא קשר לתוכן.
`getName()`	`String`	הפונקציה מחזירה את שם הגיליון.
`getNamedRanges()`	`NamedRange[]`	הפונקציה מקבלת את כל טווחי התאים בעלי השם בגיליון הזה.
`getParent()`	`Spreadsheet`	הפונקציה מחזירה את ה-`Spreadsheet` שמכיל את הגיליון הזה.
`getPivotTables()`	`PivotTable[]`	הפונקציה מחזירה את כל טבלאות הצירים בגיליון הזה.
`getProtections(type)`	`Protection[]`	הפונקציה מקבלת מערך של אובייקטים שמייצגים את כל טווחי התאים המוגנים בגיליון, או מערך של רכיב יחיד שמייצג את ההגנה על הגיליון עצמו.
`getRange(row, column)`	`Range`	הפונקציה מחזירה את הטווח עם התא הימני העליון בקואורדינטות הנתונות.
`getRange(row, column, numRows)`	`Range`	הפונקציה מחזירה את הטווח עם התא הימני העליון בקואורדינטות הנתונות, ומספר השורות הנתון.
`getRange(row, column, numRows, numColumns)`	`Range`	הפונקציה מחזירה את הטווח עם התא הימני העליון בקואורדינטות הנתונות, עם מספר השורות והעמודות הנתון.
`getRange(a1Notation)`	`Range`	הפונקציה מחזירה את הטווח כפי שצוין בסימון A1 או בסימון R1C1.
`getRangeList(a1Notations)`	`RangeList`	הפונקציה מחזירה את האוסף `RangeList` שמייצג את הטווחים באותו גיליון שצוינו באמצעות רשימה לא ריקה של סימוני A1 או סימוני R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	הפונקציה מחזירה את קבוצת השורות באינדקס ובעומק הקבוצה שצוינו.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	הפונקציה מחזירה את הערך `GroupControlTogglePosition` לכל קבוצות השורות בגיליון.
`getRowGroupDepth(rowIndex)`	`Integer`	הפונקציה מחזירה את עומק הקבוצה של השורה באינדקס הנתון.
`getRowHeight(rowPosition)`	`Integer`	הפונקציה מקבלת את הגובה בפיקסלים של השורה הנתונה.
`getSelection()`	`Selection`	הפונקציה מחזירה את הערך הנוכחי של `Selection` בגיליון האלקטרוני.
`getSheetId()`	`Integer`	הפונקציה מחזירה את המזהה של הגיליון שמיוצג על ידי האובייקט הזה.
`getSheetName()`	`String`	הפונקציה מחזירה את שם הגיליון.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	הפונקציה מחזירה את הרשת המלבנית של הערכים בטווח הזה, החל מהקואורדינטות שצוינו.
`getSlicers()`	`Slicer[]`	הפונקציה מחזירה מערך של כלי חיתוך בגיליון.
`getTabColorObject()`	`Color`	הפונקציה מקבלת את הצבע של כרטיסיית הגיליון, או את הערך `null` אם לכרטיסיית הגיליון אין צבע.
`getType()`	`SheetType`	הפונקציה מחזירה את הסוג של הגיליון.
`hasHiddenGridlines()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם קווים של רשת הגיליונות מוסתרים. אחרת, הפונקציה מחזירה את הערך `false`.
`hideColumn(column)`	`void`	הסתרת העמודה או העמודות בטווח הנתון.
`hideColumns(columnIndex)`	`void`	הסתרת עמודה אחת באינדקס הנתון.
`hideColumns(columnIndex, numColumns)`	`void`	הסתרת עמודה אחת או יותר ברצף, החל מהאינדקס שצוין.
`hideRow(row)`	`void`	הסתרת השורות בטווח שצוין.
`hideRows(rowIndex)`	`void`	הסתרת השורה לפי האינדקס שצוין.
`hideRows(rowIndex, numRows)`	`void`	הוספת פונקציה להסתרת שורה אחת או יותר ברציפות, החל מהאינדקס שצוין.
`hideSheet()`	`Sheet`	הסתרת הגיליון.
`insertChart(chart)`	`void`	הוספת תרשים חדש לגיליון הזה.
`insertColumnAfter(afterPosition)`	`Sheet`	הוספת עמודה אחרי מיקום העמודה שצוין.
`insertColumnBefore(beforePosition)`	`Sheet`	הוספת עמודה לפני מיקום העמודה שצוין.
`insertColumns(columnIndex)`	`void`	הוספת עמודה ריקה בגיליון במיקום שצוין.
`insertColumns(columnIndex, numColumns)`	`void`	הוספה של עמודה ריקה אחת או יותר ברצף בגיליון, החל מהמיקום שצוין.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	הוספת מספר עמודות נתון אחרי מיקום העמודה הנתון.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	הוספת מספר עמודות לפני מיקום העמודה שצוין.
`insertImage(blobSource, column, row)`	`OverGridImage`	הוספת `BlobSource` כתמונה במסמך בשורה ובעמודה נתונות.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	הוספת `BlobSource` כתמונה במסמך בשורה ובעמודה מסוימות, עם היסט בפיקסלים.
`insertImage(url, column, row)`	`OverGridImage`	הוספת תמונה למסמך בשורה ובעמודה נתונות.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	הוספת תמונה למסמך בשורה ובעמודה נתונות, עם היסט בפיקסלים.
`insertRowAfter(afterPosition)`	`Sheet`	הוספת שורה אחרי מיקום השורה שצוין.
`insertRowBefore(beforePosition)`	`Sheet`	הוספת שורה לפני מיקום השורה שצוין.
`insertRows(rowIndex)`	`void`	הוספת שורה ריקה בגיליון במיקום שצוין.
`insertRows(rowIndex, numRows)`	`void`	הוספת שורה אחת או יותר רצופות ריקות בגיליון, החל מהמיקום שצוין.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	הוספה של מספר שורות אחרי מיקום השורה שצוין.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	הוספת מספר שורות לפני מיקום השורה שצוין.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	הוספת חלונית סינון חדשה לגיליון הזה.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	הוספת חלונית סינון חדשה לגיליון הזה.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	הפונקציה מחזירה אם המשתמש החביא את העמודה הנתונה.
`isRightToLeft()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם פריסת הגיליון היא מימין לשמאל.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	הפונקציה מחזירה את הערך TRUE אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן).
`isRowHiddenByUser(rowPosition)`	`Boolean`	הפונקציה מחזירה אם המשתמש החביא את השורה הנתונה.
`isSheetHidden()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם הגיליון מוסתר כרגע.
`moveColumns(columnSpec, destinationIndex)`	`void`	העברת העמודות שנבחרו לפי הטווח הנתון למיקום שמצוין ב-`destinationIndex`.
`moveRows(rowSpec, destinationIndex)`	`void`	העברת השורות שנבחרו לפי הטווח הנתון למיקום שמצוין ב-`destinationIndex`.
`newChart()`	`EmbeddedChartBuilder`	הפונקציה מחזירה בונה ליצירת תרשים חדש בגיליון הזה.
`protect()`	`Protection`	יצירת אובייקט שיכול להגן על הגיליון מפני עריכה, מלבד משתמשים שיש להם הרשאה.
`removeChart(chart)`	`void`	הסרת תרשים מהגיליון הראשי.
`setActiveRange(range)`	`Range`	הפונקציה מגדירה את הטווח שצוין בתור `active range` בגיליון הפעיל, והתא הימני העליון בטווח בתור `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	הפונקציה מגדירה את רשימת הטווחים שצוינה בתור `active ranges` בגיליון הפעיל.
`setActiveSelection(range)`	`Range`	הגדרת אזור הבחירה הפעיל של הגיליון.
`setActiveSelection(a1Notation)`	`Range`	הגדרת הבחירה הפעילה, כפי שצוינה בשיטת הסימון A1 או R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	הגדרת המיקום של המתג לקבוצת העמודות בגיליון.
`setColumnWidth(columnPosition, width)`	`Sheet`	הגדרת רוחב העמודה הנתונה בפיקסלים.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	הגדרת רוחב העמודות הנתונות בפיקסלים.
`setConditionalFormatRules(rules)`	`void`	החלפת כל כללי העיצוב המותנה הקיימים בגיליון בכללי הקלט.
`setCurrentCell(cell)`	`Range`	הגדרת התא שצוין כ-`current cell`.
`setFrozenColumns(columns)`	`void`	הקפאת מספר העמודות שצוין.
`setFrozenRows(rows)`	`void`	הקפאת מספר השורות שצוין.
`setHiddenGridlines(hideGridlines)`	`Sheet`	הסתרה או חשיפת קווי הרשת בגיליון.
`setName(name)`	`Sheet`	הגדרת שם הגיליון.
`setRightToLeft(rightToLeft)`	`Sheet`	הגדרה או ביטול הגדרה של פריסת הגיליון מימין לשמאל.
`setRowGroupControlPosition(position)`	`Sheet`	מגדיר את המיקום של המתג לקבוצת שורות בגיליון.
`setRowHeight(rowPosition, height)`	`Sheet`	הגדרת גובה השורה של השורה הנתונה בפיקסלים.
`setRowHeights(startRow, numRows, height)`	`Sheet`	הגדרת הגובה של השורות הנתונות בפיקסלים.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	הגדרת הגובה של השורות הנתונות בפיקסלים.
`setTabColor(color)`	`Sheet`	הגדרת הצבע של הכרטיסייה של הגיליון.
`setTabColorObject(color)`	`Sheet`	הגדרת הצבע של הכרטיסייה של הגיליון.
`showColumns(columnIndex)`	`void`	הסרת ההסתרה של העמודה באינדקס הנתון.
`showColumns(columnIndex, numColumns)`	`void`	הסרת ההסתרה של עמודה אחת או יותר ברצף, החל מהאינדקס שצוין.
`showRows(rowIndex)`	`void`	הסרת ההסתרה של השורה באינדיקציה שצוינה.
`showRows(rowIndex, numRows)`	`void`	הסרת ההסתרה של שורה אחת או יותר ברציפות, החל מהאינדקס שצוין.
`showSheet()`	`Sheet`	הופכת את הגיליון לגלוי.
`sort(columnPosition)`	`Sheet`	מיון גיליון לפי עמודה, בסדר עולה.
`sort(columnPosition, ascending)`	`Sheet`	מיון גיליון לפי עמודה.
`unhideColumn(column)`	`void`	הסרת ההסתרה של העמודה בטווח הנתון.
`unhideRow(row)`	`void`	ביטול ההסתרה של השורה בטווח הנתון.
`updateChart(chart)`	`void`	עדכון התרשים בגיליון הזה.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
`getSheetProtection()`	`PageProtection`	הפונקציה מחזירה מופע של `PageProtection` שמתאר את ההרשאות בגיליון הנוכחי.
`getTabColor()`	`String`	הפונקציה מקבלת את הצבע של כרטיסיית הגיליון, או את הערך `null` אם לכרטיסיית הגיליון אין צבע.
`setSheetProtection(permissions)`	`void`	הגדרת ההרשאות לגיליון הנוכחי.

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

`activate()`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.activate();

חזרה

Sheet — הגיליון הפעיל החדש.

`addDeveloperMetadata(key)`

הוספת מטא-נתונים למפתחים עם המפתח שצוין לגיליון.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח של מטא-נתוני המפתח החדש.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, visibility)`

הוספת מטא-נתונים למפתחים לגיליון עם המפתח והחשיפה שצוינו.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח של מטא-נתוני המפתח החדש.
`visibility`	`DeveloperMetadataVisibility`	החשיפה של המטא נתונים החדשים של המפתח.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, value)`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for
// the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח של מטא-נתוני המפתח החדש.
`value`	`String`	הערך של המטא-נתונים החדשים של המפתח.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, value, visibility)`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and
// sets the visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
    'COMPANY',
    'TECH',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח של מטא-נתוני המפתח החדש.
`value`	`String`	הערך של המטא-נתונים החדשים של המפתח.
`visibility`	`DeveloperMetadataVisibility`	החשיפה של המטא נתונים החדשים של המפתח.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`appendRow(rowContents)`

הוספת שורה לתחתית אזור הנתונים הנוכחי בגיליון. אם התוכן של תא מתחיל ב-=, הוא מפורש כנוסחה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(['a man', 'a plan', 'panama']);

פרמטרים

שם	סוג	תיאור
`rowContents`	`Object[]`	מערך ערכים להוספה אחרי השורה האחרונה בגיליון.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות.

אישור

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

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

`asDataSourceSheet()`

הפונקציה מחזירה את הגיליון כ-DataSourceSheet אם הגיליון הוא מסוג SheetType.DATASOURCE, או null במקרה אחר.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

חזרה

DataSourceSheet – גיליון של מקור נתונים.

אישור

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

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

`autoResizeColumn(columnPosition)`

הגדרת רוחב העמודה הנתונה כך שיתאים לתוכן שלה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue(
    'Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה שרוצים לשנות את הגודל שלה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`autoResizeColumns(startColumn, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

פרמטרים

שם	סוג	תיאור
`startColumn`	`Integer`	עמודת ההתחלה שרוצים לשנות את הגודל שלה באופן אוטומטי.
`numColumns`	`Integer`	מספר העמודות שרוצים לשנות את הגודל שלהן באופן אוטומטי.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`autoResizeRows(startRow, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	מספר השורה שממנה יתבצע שינוי אוטומטי של הגודל.
`numRows`	`Integer`	מספר השורות שרוצים לשנות את הגודל שלהן באופן אוטומטי.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`clear()`

מחיקת התוכן ומידע העיצוב מהגיליון.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clear();

חזרה

Sheet — הגיליון שנמחק.

אישור

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

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

`clear(options)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.clear({formatOnly: true, contentsOnly: true});

פרמטרים

שם	סוג	תיאור
`options`	`Object`	מפת JavaScript שמכילה אפשרויות מתקדמות, שמפורטות בהמשך.

פרמטרים מתקדמים

שם	סוג	תיאור
`contentsOnly`	`Boolean`	אם לנקות את התוכן.
`formatOnly`	`Boolean`	האם לנקות את הפורמט.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`clearConditionalFormatRules()`

הסרת כל הכללים של העיצוב המותנה מהגיליון. זהו קריאה לפונקציה setConditionalFormatRules(rules) עם מערך ריק כקלט.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

אישור

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

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

`clearContents()`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearContents();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`clearFormats()`

מחיקת העיצוב מהגיליון, תוך שמירה על התוכן.

העיצוב מתייחס לאופן שבו הנתונים מעוצבים בהתאם לאפשרויות בתפריט 'עיצוב' (למשל: מודגש, נטוי, עיצוב מותנה), ולא לרוחב או לגובה של התאים.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearFormats();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`clearNotes()`

ניקוי כל ההערות מהגיליון.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`collapseAllColumnGroups()`

כיווץ של כל קבוצות העמודות בגיליון.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`collapseAllRowGroups()`

כיווץ של כל קבוצות השורות בגיליון.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`copyTo(spreadsheet)`

העתקת הגיליון לגיליון אלקטרוני נתון, שיכול להיות אותו גיליון אלקטרוני כמו המקור. שם הגיליון המועתק הוא 'עותק של [שם מקורי]'.

const source = SpreadsheetApp.getActiveSpreadsheet();
const sheet = source.getSheets()[0];

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

פרמטרים

שם	סוג	תיאור
`spreadsheet`	`Spreadsheet`	הגיליון האלקטרוני שאליו רוצים להעתיק את הגיליון הזה. יכול להיות שזהו אותו גיליון אלקטרוני של המקור.

חזרה

Sheet — הגיליון החדש, לשרשור.

אישור

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

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

`createDeveloperMetadataFinder()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

חזרה

DeveloperMetadataFinder – מאתר מטא-נתונים למפתחים לחיפוש מטא-נתונים בהיקף של הגיליון הזה.

`createTextFinder(findText)`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

פרמטרים

שם	סוג	תיאור
`findText`	`String`	הטקסט שרוצים לחפש.

חזרה

TextFinder – ה-TextFinder של הגיליון.

`deleteColumn(columnPosition)`

מחיקה של העמודה במיקום העמודה הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה, החל מ-1 עבור העמודה הראשונה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`deleteColumns(columnPosition, howMany)`

מחיקה של מספר עמודות, החל ממיקום העמודה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה הראשונה שרוצים למחוק.
`howMany`	`Integer`	מספר העמודות למחיקה.

אישור

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

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

`deleteRow(rowPosition)`

מחיקה של השורה במיקום השורה הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה, החל מ-1 בשורה הראשונה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`deleteRows(rowPosition, howMany)`

מחיקה של מספר שורות, החל ממיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה הראשונה שרוצים למחוק.
`howMany`	`Integer`	מספר השורות למחיקה.

אישור

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

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

`expandAllColumnGroups()`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`expandAllRowGroups()`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`expandColumnGroupsUpToDepth(groupDepth)`

הרחבה של כל קבוצות העמודות עד לעומק הנתון, וצמצום של כל הקבוצות האחרות.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

פרמטרים

שם	סוג	תיאור
`groupDepth`	`Integer`	עומק הקבוצה עד שאליו צריך להרחיב את קבוצות העמודות.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`expandRowGroupsUpToDepth(groupDepth)`

הרחבה של כל קבוצות השורות עד לעומק הנתון, וצמצום של כל הקבוצות האחרות.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

פרמטרים

שם	סוג	תיאור
`groupDepth`	`Integer`	עומק הקבוצה עד שאליו צריך להרחיב את קבוצות השורות.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`getActiveCell()`

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

הערה: מומלץ להשתמש ב-getCurrentCell(), שמחזיר את התא המודגש הנוכחי.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

חזרה

Range – התא הפעיל הנוכחי

אישור

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

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

`getActiveRange()`

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

חזרה

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

אישור

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

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

ראה גם

setActiveRange(range)

`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

ראה גם

setActiveRangeList(rangeList)

`getBandings()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the banding info for the sheet.
const bandings = sheet.getBandings();

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

חזרה

Banding[] — כל הפילוחים בגיליון הזה.

אישור

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

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

`getCharts()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const charts = sheet.getCharts();

for (const i in charts) {
  const chart = charts[i];
  // Do something with the chart
}

חזרה

EmbeddedChart[] – מערך של תרשימים.

אישור

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

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

`getColumnGroup(columnIndex, groupDepth)`

הפונקציה מחזירה את קבוצת העמודות באינדקס ובעומק הקבוצה שצוינו.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
const columnGroup = sheet.getColumnGroup(2, 1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	אינדקס העמודה של המתג לקבוצת הבקרה או אינדקס בתוך הקבוצה.
`groupDepth`	`Integer`	עומק הקבוצה.

חזרה

Group — קבוצת העמודות באינדקס ובעומק של קבוצת הבקרה, או שמופיעה חריגה אם הקבוצה לא קיימת.

אישור

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

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

`getColumnGroupControlPosition()`

הפונקציה מחזירה את הערך GroupControlTogglePosition לכל קבוצות העמודות בגיליון.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

חזרה

GroupControlTogglePosition — true אם המתג של בקרת קיבוץ העמודות מוצג אחרי הקבוצה בגיליון הזה, ו-false במקרים אחרים.

אישור

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

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

`getColumnGroupDepth(columnIndex)`

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

עומק הקבוצה מציין כמה קבוצות חופפות לעמודה. הערך יכול לנוע בין אפס לשמונה.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה.

חזרה

Integer – עומק הקבוצה של העמודה באינדקס הנתון.

אישור

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

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

`getColumnWidth(columnPosition)`

הפונקציה מקבלת את רוחב העמודה הנתונה בפיקסלים.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה לבדיקה.

חזרה

Integer – רוחב העמודה בפיקסלים

אישור

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

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

`getConditionalFormatRules()`

הצגת כל הכללים של העיצוב המותנה בגיליון הזה.

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const rule = rules[i];
  Logger.log(rule);
}

חזרה

ConditionalFormatRule[] – מערך של כל הכללים בגיליון.

אישור

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

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

`getCurrentCell()`

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

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

חזרה

Range – התא הנוכחי

אישור

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

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

`getDataRange()`

הפונקציה מחזירה Range שתואם למאפיינים שבהם יש נתונים.

מבחינה פונקציונלית, זה שווה ערך ליצירת טווח שמוגבל על ידי A1 ו-(Sheet.getLastColumn(), Sheet.getLastRow()).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

חזרה

Range – טווח שכולל את כל הנתונים בגיליון האלקטרוני

אישור

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

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

`getDataSourceFormulas()`

הפונקציה מקבלת את כל הנוסחאות של מקורות הנתונים.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

חזרה

DataSourceFormula[] – רשימה של נוסחאות של מקורות נתונים.

אישור

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

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

`getDataSourcePivotTables()`

הפונקציה מקבלת את כל טבלאות הצירים של מקור הנתונים.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

חזרה

DataSourcePivotTable[] – רשימה של טבלאות צירים של מקורות נתונים.

אישור

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

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

`getDataSourceTables()`

הפונקציה מקבלת את כל הטבלאות של מקורות הנתונים.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

חזרה

DataSourceTable[] – רשימה של טבלאות של מקורות נתונים.

אישור

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

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

`getDeveloperMetadata()`

אחזור כל המטא-נתונים של המפתחים שמשויכים לגיליון הזה.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

חזרה

DeveloperMetadata[] – המטא-נתונים של המפתח שמשויכים לגיליון הזה.

אישור

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

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

`getDrawings()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

// Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

חזרה

Drawing[] – רשימת השרטוטים שבדף הזה.

אישור

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

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

`getFilter()`

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

// Gets the filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();

חזרה

Filter — המסנן.

אישור

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

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

`getFormUrl()`

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

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

חזרה

String – כתובת ה-URL של הטופס שמציב את התשובות שלו בגיליון הזה, או null אם לגיליון הזה אין טופס משויך.

אישור

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

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

`getFrozenColumns()`

הפונקציה מחזירה את מספר העמודות הקפואות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

חזרה

Integer – מספר העמודות הקפואות

אישור

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

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

`getFrozenRows()`

הפונקציה מחזירה את מספר השורות הקפואות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

חזרה

Integer – מספר השורות שהוקפאו

אישור

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

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

`getImages()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

חזרה

OverGridImage[] – מערך של תמונות מעל הרשת.

אישור

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

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

`getIndex()`

הפונקציה מקבלת את המיקום של הגיליון בגיליון האלקטרוני ההורה שלו. מתחיל ב-1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

חזרה

Integer — המיקום של הגיליון בגיליון האלקטרוני ההורה שלו.

אישור

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

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

`getLastColumn()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

חזרה

Integer – העמודה האחרונה בגיליון שמכילה תוכן

אישור

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

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

`getLastRow()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

חזרה

Integer – השורה האחרונה בגיליון שמכילה תוכן

אישור

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

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

`getMaxColumns()`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxColumns());

חזרה

Integer – הרוחב המקסימלי של הגיליון.

אישור

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

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

`getMaxRows()`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxRows());

חזרה

Integer – הגובה המקסימלי של הגיליון.

אישור

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

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

`getName()`

הפונקציה מחזירה את שם הגיליון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getName());

חזרה

String – השם של הגיליון.

אישור

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

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

`getNamedRanges()`

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

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

חזרה

NamedRange[] – מערך של כל טווחי התאים בעלי השם בגיליון.

אישור

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

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

`getParent()`

הפונקציה מחזירה את ה-Spreadsheet שמכיל את הגיליון הזה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const parent = sheet.getParent();

חזרה

Spreadsheet – הגיליון האלקטרוני הראשי.

אישור

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

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

`getPivotTables()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

חזרה

PivotTable[] – טבלאות הצירים בגיליון הזה.

אישור

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

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

`getProtections(type)`

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

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

פרמטרים

שם	סוג	תיאור
`type`	`ProtectionType`	סוג האזור המוגן, `SpreadsheetApp.ProtectionType.RANGE` או `SpreadsheetApp.ProtectionType.SHEET`.

חזרה

Protection[] – מערך של אובייקטים שמייצג את כל טווחי התאים המוגנים בגיליון, או מערך של רכיב יחיד שמייצג את ההגנה על הגיליון עצמו.

אישור

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

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

`getRange(row, column)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
const range = sheet.getRange(1, 1);
const values = range.getValues();
Logger.log(values[0][0]);

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה של התא להחזרה. האינדקס של השורות מתחיל ב-1.
`column`	`Integer`	אינדקס העמודה של התא להחזרה. האינדקס של העמודות מתחיל ב-1.

חזרה

Range – טווח שמכיל רק את התא הזה.

אישור

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

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

`getRange(row, column, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה הפותחת של הטווח. האינדקס של השורות מתחיל ב-1.
`column`	`Integer`	אינדקס העמודה של הטווח. האינדקס של העמודות מתחיל ב-1.
`numRows`	`Integer`	מספר השורות שיש להחזיר.

חזרה

Range — טווח שמכיל עמודה אחת של נתונים עם מספר השורות שצוין.

אישור

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

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

`getRange(row, column, numRows, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה הפותחת של הטווח. האינדקס של השורות מתחיל ב-1.
`column`	`Integer`	אינדקס העמודה הפותחת של הטווח. האינדקס של העמודות מתחיל ב-1.
`numRows`	`Integer`	מספר השורות שיש להחזיר.
`numColumns`	`Integer`	מספר העמודות שיש להחזיר.

חזרה

Range – טווח שתואם לאזור שצוין.

אישור

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

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

`getRange(a1Notation)`

הפונקציה מחזירה את הטווח כפי שצוין בסימון A1 או בסימון R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

פרמטרים

שם	סוג	תיאור
`a1Notation`	`String`	הטווח להחזרה, כפי שצוין בשיטת הסימון A1 או R1C1.

חזרה

Range – הטווח במיקום שצוין

אישור

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

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

`getRangeList(a1Notations)`

הפונקציה מחזירה את האוסף RangeList שמייצג את הטווחים באותו גיליון שצוינו באמצעות רשימה לא ריקה של סימוני A1 או סימוני R1C1.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

פרמטרים

שם	סוג	תיאור
`a1Notations`	`String[]`	רשימת הטווחים להחזרה, כפי שצוינה בתחביר A1 או בתחביר R1C1.

חזרה

RangeList – רשימת הטווחים במיקום שצוין

אישור

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

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

`getRowGroup(rowIndex, groupDepth)`

הפונקציה מחזירה את קבוצת השורות באינדקס ובעומק הקבוצה שצוינו.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
const rowGroup = sheet.getRowGroup(2, 1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	אינדקס השורה של המתג לקבוצת הבקרה או אינדקס בתוך הקבוצה.
`groupDepth`	`Integer`	עומק הקבוצה.

חזרה

Group — קבוצת השורות באינדקס ובעומק של קבוצת הבקרה, או שמופיעה חריגה אם הקבוצה לא קיימת.

אישור

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

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

`getRowGroupControlPosition()`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

חזרה

GroupControlTogglePosition — true אם המתג של בקרת קיבוץ השורות מוצג אחרי הקבוצה בגיליון הזה, ו-false במקרים אחרים.

אישור

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

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

`getRowGroupDepth(rowIndex)`

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

עומק הקבוצה מציין כמה קבוצות חופפות לשורה. הערך יכול לנוע בין אפס לשמונה.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה.

חזרה

Integer – עומק הקבוצה של השורה באינדקס הנתון.

אישור

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

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

`getRowHeight(rowPosition)`

הפונקציה מקבלת את הגובה בפיקסלים של השורה הנתונה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה לבדיקה.

חזרה

Integer – גובה השורה בפיקסלים

אישור

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

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

`getSelection()`

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

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const currentCell = selection.getCurrentCell();

חזרה

Selection – הבחירה הנוכחית

אישור

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

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

`getSheetId()`

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

זהו מזהה של הגיליון שהוא ייחודי לגיליון האלקטרוני. המזהה הוא מספר שלם בעל עלייה מונוטונית שמוקצה בזמן יצירת הגיליון, והוא לא תלוי במיקום הגיליון. האפשרות הזו שימושית בשילוב עם שיטות כמו Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), שמקבלות פרמטר gridId במקום מכונה של Sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

חזרה

Integer – מזהה של הגיליון הייחודי לגיליון האלקטרוני

אישור

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

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

`getSheetName()`

הפונקציה מחזירה את שם הגיליון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

חזרה

String – שם הגיליון

אישור

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	המיקום של השורה הראשונה.
`startColumn`	`Integer`	המיקום של העמודה הפותחת.
`numRows`	`Integer`	מספר השורות שעבורן רוצים להחזיר ערכים.
`numColumns`	`Integer`	מספר העמודות שעבורן רוצים להחזיר ערכים.

חזרה

Object[][] – מערך דו-מימדי של ערכים

אישור

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

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

`getSlicers()`

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

חזרה

Slicer[] – רשימת הפילטרים בגיליון הזה.

אישור

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

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

`getTabColorObject()`

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

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = first.getTabColorObject();

חזרה

Color – הצבע של כרטיסיית הגיליון, או null אם לכרטיסיית הגיליון אין צבע.

אישור

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

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

`getType()`

הפונקציה מחזירה את הסוג של הגיליון.

סוג ברירת המחדל של הגיליון הוא SheetType.GRID. גיליון שמכיל אובייקט מוטמע אחד, כמו EmbeddedChart, הוא גיליון SheetType.OBJECT.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getType());

חזרה

SheetType – סוג הגיליון.

אישור

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

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

`hasHiddenGridlines()`

הפונקציה מחזירה את הערך true אם קווים של רשת הגיליונות מוסתרים. אחרת, הפונקציה מחזירה את הערך false. קווי הרשת גלויים כברירת מחדל.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the
// console.
console.log(sheet.hasHiddenGridlines());

חזרה

Boolean — true אם קווי הרשת מוסתרים, false אחרת.

אישור

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

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

`hideColumn(column)`

הסתרת העמודה או העמודות בטווח הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

פרמטרים

שם	סוג	תיאור
`column`	`Range`	טווח העמודות שרוצים להסתיר.

אישור

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

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

`hideColumns(columnIndex)`

הסתרת עמודה אחת באינדקס הנתון. בשיטה הזו צריך להשתמש במדד 1.

כדי להסתיר יותר מעמודה אחת באמצעות אינדקס, משתמשים ב-hideColumns(columnIndex, numColumns).

כדי להסתיר יותר מעמודה אחת באמצעות טווח, משתמשים ב-hideColumn().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה שרוצים להסתיר.

אישור

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

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

`hideColumns(columnIndex, numColumns)`

הסתרת עמודה אחת או יותר ברצף, החל מהאינדקס שצוין. בשיטה הזו צריך להשתמש במדד 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	אינדקס ההתחלה של העמודות שרוצים להסתיר.
`numColumns`	`Integer`	מספר העמודות להסתרה.

אישור

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

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

`hideRow(row)`

הסתרת השורות בטווח שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

פרמטרים

שם	סוג	תיאור
`row`	`Range`	טווח השורות שרוצים להסתיר.

אישור

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

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

`hideRows(rowIndex)`

הסתרת השורה לפי האינדקס שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה שרוצים להסתיר.

אישור

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

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

`hideRows(rowIndex, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס ההתחלתי של השורות שרוצים להסתיר.
`numRows`	`Integer`	מספר השורות שרוצים להסתיר.

אישור

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

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

`hideSheet()`

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

const sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

חזרה

Sheet – הגיליון הנוכחי.

אישור

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

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

`insertChart(chart)`

הוספת תרשים חדש לגיליון הזה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(sheet.getRange('A1:B4'))
                  .setPosition(5, 5, 0, 0)
                  .setOption('title', 'Dynamic Chart')
                  .build();
sheet.insertChart(chart);

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים שרוצים להוסיף.

אישור

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

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

`insertColumnAfter(afterPosition)`

הוספת עמודה אחרי מיקום העמודה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	העמודה שאחרי שהעמודה החדשה צריכה להתווסף.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertColumnBefore(beforePosition)`

הוספת עמודה לפני מיקום העמודה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	העמודה שלפניה צריך להוסיף את העמודה החדשה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertColumns(columnIndex)`

הוספת עמודה ריקה בגיליון במיקום שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס שמציין איפה להוסיף עמודה.

אישור

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

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

`insertColumns(columnIndex, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס שמציין איפה להוסיף עמודה.
`numColumns`	`Integer`	מספר העמודות להוספה.

אישור

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

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

`insertColumnsAfter(afterPosition, howMany)`

הוספת מספר עמודות נתון אחרי מיקום העמודה הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	העמודה שאחרייה צריך להוסיף את העמודה החדשה.
`howMany`	`Integer`	מספר העמודות להוספה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertColumnsBefore(beforePosition, howMany)`

הוספת מספר עמודות לפני מיקום העמודה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	העמודה שלפניה צריך להוסיף את העמודה החדשה.
`howMany`	`Integer`	מספר העמודות להוספה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertImage(blobSource, column, row)`

הוספת BlobSource כתמונה במסמך בשורה ובעמודה נתונות. גודל התמונה מאוחזר מתוכן ה-blob. גודל ה-blob המקסימלי שנתמך הוא 2MB.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג ה-MIME והשם (אופציונלי).
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

הוספת BlobSource כתמונה במסמך בשורה ובעמודה מסוימות, עם היסט בפיקסלים. גודל התמונה מאוחזר מתוכן ה-blob. גודל ה-blob המקסימלי שנתמך הוא 2MB.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג ה-MIME והשם (אופציונלי).
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.
`offsetX`	`Integer`	הסטייה האופקית מפינה של תא, בפיקסלים.
`offsetY`	`Integer`	הסטייה האנכית מפינה של התא, בפיקסלים.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(url, column, row)`

הוספת תמונה למסמך בשורה ובעמודה נתונות.

כתובת ה-URL שצוינה צריכה להיות נגישה לכולם.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת האתר של התמונה.
`column`	`Integer`	המיקום של העמודה ברשת.
`row`	`Integer`	המיקום של שורת התצוגה.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(url, column, row, offsetX, offsetY)`

הוספת תמונה למסמך בשורה ובעמודה נתונות, עם היסט בפיקסלים.

כתובת ה-URL שצוינה צריכה להיות נגישה לכולם.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של התמונה.
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.
`offsetX`	`Integer`	הסטייה האופקית מפינה של תא, בפיקסלים.
`offsetY`	`Integer`	הסטייה האנכית מפינה של התא, בפיקסלים.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertRowAfter(afterPosition)`

הוספת שורה אחרי מיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	השורה שאחרי שהשורה החדשה צריכה להתווסף.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertRowBefore(beforePosition)`

הוספת שורה לפני מיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	השורה שלפניה צריך להוסיף את השורה החדשה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertRows(rowIndex)`

הוספת שורה ריקה בגיליון במיקום שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס שמציין איפה להוסיף שורה.

אישור

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

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

`insertRows(rowIndex, numRows)`

הוספת שורה אחת או יותר רצופות ריקות בגיליון, החל מהמיקום שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס שמציין איפה להוסיף שורה.
`numRows`	`Integer`	מספר השורות להוספה.

אישור

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

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

`insertRowsAfter(afterPosition, howMany)`

הוספה של מספר שורות אחרי מיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	השורה שאחרי שהשורות החדשות צריכות להתווסף.
`howMany`	`Integer`	מספר השורות להוספה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertRowsBefore(beforePosition, howMany)`

הוספת מספר שורות לפני מיקום השורה הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	השורה שלפניה צריך להוסיף את השורות החדשות.
`howMany`	`Integer`	מספר השורות להוספה.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`insertSlicer(range, anchorRowPos, anchorColPos)`

הוספת חלונית סינון חדשה לגיליון הזה.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range of the sheet.
const range = sheet.getRange('A1:D10');

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שבו נוצר כלי הסינון.
`anchorRowPos`	`Integer`	הצד העליון של הכלי לחתימה על נתונים מקובע בשורה הזו.
`anchorColPos`	`Integer`	הצד העליון של הכלי לחתימה על נתונים מקובע בעמודה הזו.

חזרה

Slicer – כלי הסינון החדש שנוסף.

אישור

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

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

`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`

הוספת חלונית סינון חדשה לגיליון הזה.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range.
const range = sheet.getRange('A1:D10');

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שבו נוצר כלי הסינון.
`anchorRowPos`	`Integer`	הצד העליון של הכלי לחתימה על נתונים מקובע בשורה הזו.
`anchorColPos`	`Integer`	הצד העליון של הכלי לחתימה על נתונים מקובע בעמודה הזו.
`offsetX`	`Integer`	הסטייה האופקית מפינה של תא, בפיקסלים.
`offsetY`	`Integer`	הסטייה האנכית מפינה של התא, בפיקסלים.

חזרה

Slicer — כלי הסינון החדש שנוסף.

אישור

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

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

`isColumnHiddenByUser(columnPosition)`

הפונקציה מחזירה אם המשתמש החביא את העמודה הנתונה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה לבדיקה.

חזרה

Boolean — true אם העמודה מוסתרת, false אחרת.

אישור

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

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

`isRightToLeft()`

הפונקציה מחזירה את הערך true אם פריסת הגיליון היא מימין לשמאל. הפונקציה מחזירה את הערך false אם הגדרת ברירת המחדל של הגיליון היא פריסת שמאל לימין.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to
// the console.
console.log(sheet.isRightToLeft());

חזרה

Boolean — true אם מימין לשמאל, false אחרת.

אישור

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

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

`isRowHiddenByFilter(rowPosition)`

הפונקציה מחזירה את הערך TRUE אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה לבדיקה.

חזרה

Boolean — true אם השורה מוסתרת, false אחרת.

אישור

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

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

`isRowHiddenByUser(rowPosition)`

הפונקציה מחזירה אם המשתמש החביא את השורה הנתונה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה לבדיקה.

חזרה

Boolean — true אם השורה מוסתרת, false אחרת.

אישור

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

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

`isSheetHidden()`

הפונקציה מחזירה את הערך true אם הגיליון מוסתר כרגע.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

חזרה

Boolean — true אם הגיליון מוסתר, false אחרת.

אישור

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

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

`moveColumns(columnSpec, destinationIndex)`

העברת העמודות שנבחרו לפי הטווח הנתון למיקום שמצוין ב-destinationIndex. columnSpec עצמו לא חייב לייצג בדיוק עמודה שלמה או קבוצה של עמודות להעברה – הוא בוחר את כל העמודות שעליהן חל הטווח.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

פרמטרים

שם	סוג	תיאור
`columnSpec`	`Range`	טווח שכולל את העמודות שרוצים להעביר.
`destinationIndex`	`Integer`	המדד שאליו צריך להעביר את העמודות. חשוב לזכור שהאינדקס הזה מבוסס על הקואורדינטות לפני העברת העמודות. הנתונים הקיימים מוסטים ימינה כדי לפנות מקום לעמודות שהועברנו, ואילו עמודות המקור מוסרות מהרשת. לכן, יכול להיות שהנתונים יסתיימו במדד אחר מזה שצוין במקור.

אישור

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

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

`moveRows(rowSpec, destinationIndex)`

העברת השורות שנבחרו לפי הטווח הנתון למיקום שמצוין ב-destinationIndex. rowSpec עצמו לא חייב לייצג שורה שלמה או קבוצה של שורות כדי להעביר אותו – הוא בוחר את כל השורות שעליהן חל הטווח.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

פרמטרים

שם	סוג	תיאור
`rowSpec`	`Range`	טווח שכולל את השורות שרוצים להעביר.
`destinationIndex`	`Integer`	האינדקס שאליו צריך להעביר את השורות. חשוב לזכור שהאינדקס הזה מבוסס על הקואורדינטות לפני שהשורות הועברו. הנתונים הקיימים מוסטים למטה כדי לפנות מקום לשורות שהועברנו, בזמן שהשורות של המקור יוסרו מהרשת. לכן, יכול להיות שהנתונים יסתיימו במדד שונה מזה שצוין במקור.

אישור

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

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

`newChart()`

הפונקציה מחזירה בונה ליצירת תרשים חדש בגיליון הזה.

בדוגמה הזו מוסבר איך יוצרים תרשים חדש:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

חזרה

EmbeddedChartBuilder – כלי ליצירת תרשים חדש.

`protect()`

יצירת אובייקט שיכול להגן על הגיליון מפני עריכה, מלבד משתמשים שיש להם הרשאה. עד שהסקריפט ישנה בפועל את רשימת העורכים של הגיליון (על ידי קריאה לפונקציות Protection.removeEditor(emailAddress),‏ Protection.removeEditor(user),‏ Protection.removeEditors(emailAddresses),‏ Protection.addEditor(emailAddress),‏ Protection.addEditor(user),‏ Protection.addEditors(emailAddresses) או הגדרת ערך חדש לפונקציה Protection.setDomainEdit(editable)), ההרשאות משקפות את ההרשאות של הגיליון האלקטרוני עצמו, כלומר הגיליון נשאר ללא הגנה. אם הגיליון כבר מוגן, השיטה מחזירה אובייקט שמייצג את הגדרות ההגנה הקיימות שלו. גיליון מוגן יכול לכלול אזורים לא מוגנים.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

חזרה

Protection – אובייקט שמייצג את הגדרות ההגנה.

אישור

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

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

`removeChart(chart)`

הסרת תרשים מהגיליון הראשי.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים שרוצים להסיר.

אישור

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

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

`setActiveRange(range)`

הפונקציה מגדירה את הטווח שצוין בתור active range בגיליון הפעיל, והתא הימני העליון בטווח בתור current cell.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שרוצים להגדיר כטווח הפעיל.

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setActiveRangeList(rangeList)`

הפונקציה מגדירה את רשימת הטווחים שצוינה בתור active ranges בגיליון הפעיל. הטווח האחרון ברשימה מוגדר כ-active range.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

פרמטרים

שם	סוג	תיאור
`rangeList`	`RangeList`	רשימת הטווחים לבחירה.

חזרה

RangeList – רשימת הטווחים שנבחרה לאחרונה

אישור

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

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

`setActiveSelection(range)`

הגדרת אזור הבחירה הפעיל של הגיליון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח להגדרה כבחירה הפעילה.

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setActiveSelection(a1Notation)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

פרמטרים

שם	סוג	תיאור
`a1Notation`	`String`	הטווח שרוצים להגדיר כפעיל, כפי שמצוין בשיטת הסימון A1 או בשיטת הסימון R1C1.

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setColumnGroupControlPosition(position)`

הגדרת המיקום של המתג לקבוצת העמודות בגיליון.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

פרמטרים

שם	סוג	תיאור
`position`	`GroupControlTogglePosition`	המיקום של המתג לקבוצת העמודות.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setColumnWidth(columnPosition, width)`

הגדרת רוחב העמודה הנתונה בפיקסלים.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה שרוצים להגדיר.
`width`	`Integer`	הרוחב בפיקסלים שאליו רוצים להגדיר אותו.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`setColumnWidths(startColumn, numColumns, width)`

הגדרת רוחב העמודות הנתונות בפיקסלים.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

פרמטרים

שם	סוג	תיאור
`startColumn`	`Integer`	המיקום של העמודה שממנה מתחילים לשנות.
`numColumns`	`Integer`	מספר העמודות שרוצים לשנות.
`width`	`Integer`	הרוחב בפיקסלים שאליו רוצים להגדיר אותו.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setConditionalFormatRules(rules)`

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

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

פרמטרים

שם	סוג	תיאור
`rules`	`ConditionalFormatRule[]`	הכללים החדשים של העיצוב המותנה.

אישור

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

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

`setCurrentCell(cell)`

הגדרת התא שצוין כ-current cell.

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

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

הערה:הערך של Range שצוין חייב להיות תא אחד, אחרת תופיע חריגה.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

פרמטרים

שם	סוג	תיאור
`cell`	`Range`	התא שרוצים להגדיר כתא הנוכחי.

חזרה

Range – התא הנוכחי שהוגדר מחדש

אישור

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

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

`setFrozenColumns(columns)`

הקפאת מספר העמודות שצוין. אם הערך הוא אפס, לא תוקפאו עמודות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

פרמטרים

שם	סוג	תיאור
`columns`	`Integer`	מספר העמודות שרוצים להקפיא.

אישור

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

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

`setFrozenRows(rows)`

הקפאת מספר השורות שצוין. אם הערך הוא אפס, לא תוקפאו שורות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

פרמטרים

שם	סוג	תיאור
`rows`	`Integer`	מספר השורות שרוצים להקפיא.

אישור

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

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

`setHiddenGridlines(hideGridlines)`

הסתרה או חשיפת קווי הרשת בגיליון.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

פרמטרים

שם	סוג	תיאור
`hideGridlines`	`Boolean`	אם הערך הוא `true`, קווי הרשת בגיליון הזה מוסתרים. אחרת, קווי הרשת מוצגים.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setName(name)`

הגדרת שם הגיליון.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם החדש של הגיליון.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setRightToLeft(rightToLeft)`

הגדרה או ביטול הגדרה של פריסת הגיליון מימין לשמאל.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

פרמטרים

שם	סוג	תיאור
`rightToLeft`	`Boolean`	אם הערך הוא `true`, פריסת הגיליון מוגדרת מימין לשמאל, והתא A1 נמצא בפינה השמאלית העליונה. אם הערך הוא `false`, פריסת הגיליון מוגדרת כברירת מחדל משמאל לימין, והתא A1 נמצא בפינה הימנית העליונה.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setRowGroupControlPosition(position)`

מגדיר את המיקום של המתג לקבוצת השורות בגיליון.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

פרמטרים

שם	סוג	תיאור
`position`	`GroupControlTogglePosition`	המיקום של המתג לקבוצת השורות.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setRowHeight(rowPosition, height)`

הגדרת גובה השורה של השורה הנתונה בפיקסלים. כברירת מחדל, השורות מתרחבות בהתאם לתוכן התאים. אם רוצים לאלץ את השורות להיות בגובה מסוים, משתמשים ב-setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	מיקום השורה שרוצים לשנות.
`height`	`Integer`	הגובה בפיקסלים שאליו רוצים להגדיר אותו.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות.

אישור

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

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

`setRowHeights(startRow, numRows, height)`

הגדרת הגובה של השורות הנתונות בפיקסלים. כברירת מחדל, השורות מתרחבות בהתאם לתוכן התאים. אם רוצים לאלץ את השורות להיות בגובה מסוים, משתמשים ב-setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	מיקום השורה ההתחלתי שרוצים לשנות.
`numRows`	`Integer`	מספר השורות שרוצים לשנות.
`height`	`Integer`	הגובה בפיקסלים שאליו רוצים להגדיר אותו.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setRowHeightsForced(startRow, numRows, height)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	מיקום השורה ההתחלתי שרוצים לשנות.
`numRows`	`Integer`	מספר השורות שרוצים לשנות.
`height`	`Integer`	הגובה בפיקסלים שאליו רוצים להגדיר אותו.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setTabColor(color)`

הגדרת הצבע של כרטיסיית הגיליון.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

פרמטרים

שם	סוג	תיאור
`color`	`String`	קוד צבע בסימון CSS (כמו `'#ffffff'` או `'white'`), או `null` כדי לאפס את צבע הכרטיסייה.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`setTabColorObject(color)`

הגדרת הצבע של כרטיסיית הגיליון.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

פרמטרים

שם	סוג	תיאור
`color`	`Color`	הצבע של כרטיסיית הגיליון שרוצים להגדיר.

חזרה

Sheet — הגיליון הזה, לשרשור.

אישור

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

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

`showColumns(columnIndex)`

הסרת ההסתרה של העמודה באינדקס הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה שרוצים לבטל את ההסתרה שלה.

אישור

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

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

`showColumns(columnIndex, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	אינדקס ההתחלה של העמודות שרוצים לבטל את ההסתרה שלהן.
`numColumns`	`Integer`	מספר העמודות שרוצים לבטל את ההסתרה שלהן.

אישור

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

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

`showRows(rowIndex)`

הסרת ההסתרה של השורה באינדיקציה הנתונה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה שרוצים לבטל את ההסתרה שלה.

אישור

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

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

`showRows(rowIndex, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס ההתחלתי של השורות שרוצים לבטל את ההסתרה שלהן.
`numRows`	`Integer`	מספר השורות שרוצים לבטל את ההסתרה שלהן.

אישור

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

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

`showSheet()`

הופכת את הגיליון לגלוי. אין לה השפעה אם הגיליון כבר גלוי.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

חזרה

Sheet – הגיליון הנוכחי.

אישור

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

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

`sort(columnPosition)`

מיון גיליון לפי עמודה, בסדר עולה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	העמודה שלפיה יבוצע המיון.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`sort(columnPosition, ascending)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	העמודה שלפיה יבוצע המיון.
`ascending`	`Boolean`	`true` למיון בסדר עולה, `false` למיון בסדר יורד.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

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

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

`unhideColumn(column)`

הסרת ההסתרה של העמודה בטווח הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

פרמטרים

שם	סוג	תיאור
`column`	`Range`	הטווח שרוצים לבטל את ההסתרה שלו, אם הוא מוסתר.

אישור

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

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

`unhideRow(row)`

הסרת ההסתרה של השורה בטווח הנתון.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

פרמטרים

שם	סוג	תיאור
`row`	`Range`	הטווח שרוצים לבטל את ההסתרה שלו, אם הוא מוסתר.

אישור

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

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

`updateChart(chart)`

עדכון התרשים בגיליון הזה.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים שרוצים לעדכן.

אישור

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

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

שיטות שהוצאו משימוש

`getSheetProtection()`

הוצא משימוש. לגיליונות אלקטרוניים שנוצרו בגרסה החדשה יותר של Google Sheets, משתמשים ב-getProtections(type), שמחזיר את הכיתה החזקה יותר Protection. השיטה הזו הוצאה משימוש, אבל היא עדיין זמינה לצורך תאימות לגרסה הקודמת של Sheets

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

חזרה

PageProtection – אובייקט שמתאר את הרשאות הגישה של הגיליון

אישור

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

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

`getTabColor()`

הוצא משימוש. הוחלף על ידי getTabColorObject()

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

חזרה

String – קוד צבע בסימון CSS (למשל '#ffffff').

אישור

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

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

`setSheetProtection(permissions)`

הוצא משימוש. לגיליונות אלקטרוניים שנוצרו בגרסה החדשה יותר של Google Sheets, צריך להשתמש ב-protect(), שמחזיר את הכיתה החזקה יותר Protection. השיטה הזו הוצאה משימוש, אבל היא עדיין זמינה לצורך תאימות לגרסה הקודמת של Sheets.

הגדרת ההרשאות לגיליון הנוכחי.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

פרמטרים

שם	סוג	תיאור
`permissions`	`PageProtection`	אובייקט הרשאות הגישה שרוצים להגדיר בגיליון הזה.

אישור

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

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

Class Sheet קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

שיטות שהוצאו משימוש

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

activate()

חזרה

addDeveloperMetadata(key)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, visibility)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, value)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, value, visibility)

פרמטרים

חזרה

אישור

appendRow(rowContents)

פרמטרים

חזרה

אישור

asDataSourceSheet()

חזרה

אישור

autoResizeColumn(columnPosition)

פרמטרים

חזרה

אישור

autoResizeColumns(startColumn, numColumns)

פרמטרים

חזרה

אישור

autoResizeRows(startRow, numRows)

פרמטרים

חזרה

אישור

clear()

חזרה

אישור

clear(options)

פרמטרים

פרמטרים מתקדמים

חזרה

אישור

clearConditionalFormatRules()

אישור

clearContents()

חזרה

אישור

clearFormats()

חזרה

אישור

clearNotes()

חזרה

אישור

collapseAllColumnGroups()

חזרה

אישור

collapseAllRowGroups()

חזרה

אישור

copyTo(spreadsheet)

פרמטרים

חזרה

אישור

createDeveloperMetadataFinder()

חזרה

createTextFinder(findText)

פרמטרים

חזרה

deleteColumn(columnPosition)

פרמטרים

חזרה

אישור

deleteColumns(columnPosition, howMany)

Class Sheet
קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

`activate()`

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`appendRow(rowContents)`

`asDataSourceSheet()`

`autoResizeColumn(columnPosition)`

`autoResizeColumns(startColumn, numColumns)`

`autoResizeRows(startRow, numRows)`

`clear()`

`clear(options)`

`clearConditionalFormatRules()`

`clearContents()`

`clearFormats()`

`clearNotes()`

`collapseAllColumnGroups()`

`collapseAllRowGroups()`

`copyTo(spreadsheet)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`expandAllColumnGroups()`

`expandAllRowGroups()`

`expandColumnGroupsUpToDepth(groupDepth)`

`expandRowGroupsUpToDepth(groupDepth)`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getBandings()`

`getCharts()`

`getColumnGroup(columnIndex, groupDepth)`

`getColumnGroupControlPosition()`

`getColumnGroupDepth(columnIndex)`

`getColumnWidth(columnPosition)`

`getConditionalFormatRules()`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`