גישה לגיליונות אלקטרוניים ושינוי שלהם. פעולות נפוצות הן שינוי שם של גיליון וגישה לאובייקטים בטווח מהגיליון.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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 | מחזירה אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן). |
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 | עדכון התרשים בגיליון הזה. |
תיעוד מפורט
activate()
הפעלת הגיליון הזה. לא משנה את הגיליון עצמו, אלא רק את הדעה של ההורה של הגיליון הפעיל.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מצרפת שורה לתחתית של אזור הנתונים הנוכחי בגיליון. אם תוכן של תא מתחיל בערך =
, הוא יפורש כנוסחה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הגדרת רוחב העמודה הנתונה כך שתתאים לתוכן שלה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הגדרת הרוחב של כל העמודות החל מהמיקום הנתון של העמודה כך שיתאימו לתוכן שלהן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הגדרת הגובה של כל השורות החל במיקום השורה הנתון כך שיתאימו לתוכן שלהן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clear();
החזרות
Sheet
- הגיליון נוקה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear(options)
ניקוי גיליון התוכן ו/או הפורמט, כפי שצוינו באפשרויות המתקדמות הנתונות.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
עם מערך ריק כקלט.
var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearNotes();
החזרות
Sheet
– הגיליון הזה, לשרשורים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseAllColumnGroups()
מכווץ את כל קבוצות העמודות בגיליון.
var 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()
כיווץ של כל קבוצות השורות בגיליון.
var 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)
מעתיק את הגיליון לגיליון אלקטרוני נתון, שיכול להיות זהה לגיליון האלקטרוני המקורי. השם של הגיליון המועתק הוא "עותק של [השם המקורי]".
var source = SpreadsheetApp.getActiveSpreadsheet(); var sheet = source.getSheets()[0]; var 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)
יוצר כלי לחיפוש טקסט בגיליון, שיכול למצוא ולהחליף טקסט בתוך הגיליון.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. var textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = findOccurrence.replaceWith('cat');
פרמטרים
שם | סוג | תיאור |
---|---|---|
findText | String | הטקסט שיש לחפש. |
החזרות
TextFinder
- TextFinder
לגיליון.
deleteColumn(columnPosition)
מחיקת העמודה במיקום הנתון של העמודה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מוחקת מספר עמודות החל מהמיקום הנתון של העמודה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מחיקת השורה במיקום הנתון של השורה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מוחקת מספר שורות המתחילות במיקום השורה הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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()
הרחבה של כל קבוצות העמודות בגיליון. לשיטה הזו נדרשת קבוצת עמודות אחת לפחות.
var 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()
הרחבה של כל קבוצות השורות בגיליון. לשיטה הזו נדרשת קבוצת שורות אחת לפחות.
var 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)
מרחיב את כל קבוצות העמודות עד לעומק הנתון ומכווץ את כל האחרות.
var 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)
מרחיב את כל קבוצות השורות עד לעומק הנתון ומכווץ את כל הקבוצות האחרות.
var 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()
, שמחזיר את התא המודגש הנוכחי.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Returns the active cell var cell = sheet.getActiveCell();
החזרות
Range
– התא הפעיל הנוכחי
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getActiveRange()
מחזירה את הטווח שנבחר בגיליון הפעיל, או null
אם אין טווח פעיל. אם בוחרים כמה טווחים, השיטה מחזירה רק את הטווח האחרון שנבחר.
המונח Active range מתייחס לטווח שהמשתמש בחר בגיליון הפעיל, אבל בפונקציה מותאמת אישית הוא מתייחס לתא שחושב מחדש באופן פעיל.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
החזרות
Range
– הטווח הפעיל
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
כדאי לעיין גם בפרטים הבאים
getActiveRangeList()
הפונקציה מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל או ב-null
אם אין טווחים
פעילים.
אם נבחר טווח אחד, המערכת תפעל כמו קריאה ל-getActiveRange()
.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
החזרות
RangeList
– הרשימה של הטווחים הפעילים
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
כדאי לעיין גם בפרטים הבאים
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()
מחזירה מערך של תרשימים בגיליון הזה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var charts = sheet.getCharts(); for (var i in charts) { var 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)
מחזירה את קבוצת העמודות באינדקס ובעומק הקבוצה הנתונים.
var 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. var 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
לכל קבוצות העמודות בגיליון.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the // group. var columnGroupControlPosition = sheet.getColumnGroupControlPosition();
החזרות
GroupControlTogglePosition
- true
אם מתג הפקד של קיבוץ העמודות מוצג אחרי הקבוצה בגיליון הזה, ואם לא מוצג false
,
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroupDepth(columnIndex)
מחזירה את עומק הקבוצה של עמודה באינדקס הנתון.
עומק הקבוצה מציין כמה קבוצות חופפות לעמודה. הטווח יכול לנוע בין אפס לשמונה.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 var groupDepth = sheet.getColumnGroupDepth(1);
פרמטרים
שם | סוג | תיאור |
---|---|---|
columnIndex | Integer | האינדקס של העמודה. |
החזרות
Integer
- עומק הקבוצה של העמודה באינדקס הנתון.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnPosition)
הפונקציה מקבלת את הרוחב בפיקסלים של העמודה הנתונה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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. var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (var i = 0; i < rules.length; i++) { var rule = rules[i]; Logger.log(rule); }
החזרות
ConditionalFormatRule[]
- מערך של כל הכללים בגיליון.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCurrentCell()
מחזירה את התא הנוכחי בגיליון הפעיל או null
אם אין תא נוכחי. התא הנוכחי הוא התא שהמיקוד שלו בממשק המשתמש של Google Sheets, והוא מודגש באמצעות גבול כהה. אף פעם אין יותר מתא נוכחי אחד. כשמשתמש בוחר טווח תאים אחד או יותר, אחד מהתאים ברשימה הוא התא הנוכחי.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.getCurrentCell();
החזרות
Range
– התא הנוכחי
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRange()
מחזירה Range
שתואם למאפיינים שבהם קיימים נתונים.
הפונקציונליות שלו מקבילה מבחינה פונקציונלית ליצירת טווח שתחום על ידי A1 ו-(Sheet.getLastColumn(), Sheet.getLastRow()).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var 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. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter();
החזרות
Filter
– המסנן.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormUrl()
הפונקציה מחזירה את כתובת ה-URL של הטופס ששולח את התשובות שלו לגיליון הזה, או null
אם לגיליון אין טופס משויך.
var sheet = SpreadsheetApp.getActiveSheet(); var url = sheet.getFormUrl();
החזרות
String
– כתובת ה-URL של הטופס שמכיל את התגובות שלו בגיליון הזה, או null
אם אין טופס משויך לגיליון.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenColumns()
מחזירה את מספר העמודות שהוקפאו.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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()
מחזירה את מספר השורות שהוקפאו.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 var 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()
מחזירה את המיקום של העמודה האחרונה שמכילה תוכן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
החזרות
Integer
– העמודה האחרונה בגיליון שמכיל תוכן
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastRow()
מחזירה את המיקום של השורה האחרונה שמכילה תוכן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxRows());
החזרות
Integer
- הגובה המקסימלי של הגיליון.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getName()
מחזירה את שם הגיליון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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. var 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
שמכיל את הגיליון הזה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // parent is identical to ss var 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. var sheet = SpreadsheetApp.getActiveSheet(); var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to edit it. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection && 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)
מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונות.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. var range = sheet.getRange(1, 1); var 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)
מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונות, ועם מספר השורות הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is returned. var range = sheet.getRange(1, 1, 3); var values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (var row in values) { for (var 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)
מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונות עם מספר השורות והעמודות הנתונים.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 3, 3); var values = range.getValues(); // Print values from a 3x3 box. for (var row in values) { for (var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var range = ss.getRange("Invoices!A1:D4"); // Get cell A1 on the first sheet var sheet = ss.getSheets()[0]; var 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. var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var 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)
מחזירה את קבוצת השורות באינדקס ובעומק הקבוצה הנתונים.
var 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. var 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
עבור כל קבוצות השורות בגיליון.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the // group. var rowGroupControlPosition = sheet.getRowGroupControlPosition();
החזרות
GroupControlTogglePosition
– true
אם מתג הבקרה של קיבוץ השורות מוצג אחרי הקבוצה בגיליון הזה,
אחרת false
.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroupDepth(rowIndex)
מחזירה את עומק הקבוצה של השורה באינדקס הנתון.
עומק הקבוצה מציין כמה קבוצות חופפות לשורה. ערך זה יכול לנוע בין אפס לשמונה.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 var groupDepth = sheet.getRowGroupDepth(1);
פרמטרים
שם | סוג | תיאור |
---|---|---|
rowIndex | Integer | האינדקס של השורה. |
החזרות
Integer
- עומק הקבוצה של השורה באינדקס הנתון.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
הפונקציה מקבלת את הגובה בפיקסלים של השורה הנתונה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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
בגיליון האלקטרוני.
var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); var 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
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
החזרות
Integer
– מזהה לגיליון הייחודי של הגיליון האלקטרוני
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetName()
מחזירה את שם הגיליון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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- הנתון כמיקום של שורה או עמודה מקביל לערך של השורה או העמודה האחרונה שמכילה נתונים בגיליון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The two samples below produce the same output var values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = first.getTabColorObject();
החזרות
Color
– הצבע של כרטיסיית הגיליון. אם לא מציינים צבע בכרטיסייה, null
.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getType()
מחזירה את סוג הגיליון.
סוג ברירת המחדל של הגיליון הוא SheetType.GRID
. גיליון שמכיל אובייקט מוטמע יחיד, כמו EmbeddedChart
, הוא גיליון של SheetType.OBJECT
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הסתרת העמודה או העמודות בטווח הנתון.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange("A1"); sheet.hideColumn(range); // This hides the first 3 columns let 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()
.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let 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 לשיטה הזו.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הסתרת השורות בטווח הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This hides the first row var range = sheet.getRange("A1"); sheet.hideRow(range);
פרמטרים
שם | סוג | תיאור |
---|---|---|
row | Range | טווח השורות להסתרה. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideRows(rowIndex)
הסתרת השורה באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מסתירה שורה אחת או יותר ברצף המתחילה באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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()
הסתרת הגיליון הזה. אין השפעה אם הגיליון כבר מוסתר. אם מפעילים את השיטה הזו רק בגיליון שגלוי לכולם, היא גורמת לחריגה.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
החזרות
Sheet
- הגיליון הנוכחי.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertChart(chart)
הוספת תרשים חדש לגיליון הזה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet var 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)
הוספת עמודה אחרי המיקום של העמודה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת עמודה לפני המיקום של העמודה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת עמודה ריקה לגיליון במיקום שצוין.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת עמודה ריקה אחת או יותר בגיליון, החל מהמיקום שצוין.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת מספר נתון של עמודות אחרי המיקום הנתון של העמודה.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let 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)
הוספת מספר עמודות לפני המיקום הנתון של העמודה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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 שצוינה חייבת להיות נגישה לכולם.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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 שצוינה חייבת להיות נגישה לכולם.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת שורה אחרי מיקום השורה הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת שורה לפני מיקום השורה הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת שורה ריקה לגיליון במיקום שצוין.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת שורה ריקה ברצף לגיליון החל מהמיקום שצוין.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת מספר שורות אחרי מיקום השורה הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הוספת מספר שורות לפני מיקום השורה הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מחזירה אם העמודה הנתונה מוסתרת על ידי המשתמש.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מחזירה אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מחזירה אם השורה המסוימת מוסתרת על ידי המשתמש.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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
אם הגיליון מוסתר כרגע.
var 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. var sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. var 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. var sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. var 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()
מחזירה כלי לבניית תרשים כדי ליצור תרשים חדש עבור גיליון זה.
בדוגמה הבאה מוסבר איך ליצור תרשים חדש:
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var 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. var sheet = SpreadsheetApp.getActiveSheet(); var 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. var 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)
הסרת תרשים מגיליון ההורה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet var charts = sheet.getCharts(); for (var 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
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D4 var 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
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); var selection = sheet.getSelection(); // Current cell: B2 var currentCell = selection.getCurrentCell(); // Active range: B2:C4 var activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] var activeRangeList = selection.getActiveRangeList();
פרמטרים
שם | סוג | תיאור |
---|---|---|
rangeList | RangeList | רשימת הטווחים לבחירה. |
החזרות
RangeList
– הרשימה החדשה של הטווחים שנבחרו
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSelection(range)
מגדיר את אזור הבחירה הפעיל לגיליון זה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מגדיר את המיקום של מתג הפקד של קבוצת העמודות בגיליון.
var 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)
המדיניות מגדירה את רוחב העמודה הנתונה בפיקסלים.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מגדירה את רוחב העמודות הנתונות בפיקסלים.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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. var sheet = SpreadsheetApp.getActiveSheet(); var 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
שצוין חייב להכיל תא אחד, אחרת ייווצר חריג.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); var selection = sheet.getSelection(); // Current cell: B5 var currentCell = selection.getCurrentCell();
פרמטרים
שם | סוג | תיאור |
---|---|---|
cell | Range | התא שיש להגדיר בתור התא הנוכחי. |
החזרות
Range
– התא הנוכחי שהוגדר
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFrozenColumns(columns)
הקפאת מספר העמודות הנתון. אם הערך הוא אפס, אף עמודה לא מוקפאת.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
הקפאת מספר השורות הנתון. אם הערך הוא אפס, לא יוקפאו שורות.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
מגדיר את המיקום של מתג הפקד של קבוצת השורות בגיליון.
var 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)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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
, השורות נאלצות להגיע לגובה שצוין גם אם תוכן התא גבוה מגובה השורה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var 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)
ביטול ההסתרה של העמודה באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
ביטול הסתרה של עמודה אחת או יותר ברצף החל באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
ביטול ההסתרה של השורה באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
ביטול הסתרה של שורה אחת או יותר ברצף שמתחיל באינדקס הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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()
הופך את הגיליון לגלוי. אין השפעה אם הגיליון כבר גלוי.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
החזרות
Sheet
- הגיליון הנוכחי.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition)
ממיין גיליון לפי עמודה, בסדר עולה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
ממיין גיליון לפי עמודה. הפונקציה משתמשת בפרמטר כדי לציין סדר עולה או יורד.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var 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)
ביטול ההסתרה של העמודה בטווח הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideColumn(range);
פרמטרים
שם | סוג | תיאור |
---|---|---|
column | Range | הטווח שיש לבטל את ההסתרה שלו, אם הוא מוסתר. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
unhideRow(row)
ביטול ההסתרה של השורה בטווח הנתון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideRow(range);
פרמטרים
שם | סוג | תיאור |
---|---|---|
row | Range | הטווח שיש לבטל את ההסתרה שלו, אם הוא מוסתר. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateChart(chart)
עדכון התרשים בגיליון הזה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; var 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