Class Sheet

גיליון

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

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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());

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
keyStringהמפתח למטא-נתונים החדשים של המפתח.
visibilityDeveloperMetadataVisibilityחשיפת המטא-נתונים החדשים של המפתח.

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
keyStringהמפתח למטא-נתונים החדשים של המפתח.
valueStringהערך של המטא-נתונים החדשים למפתחים.
visibilityDeveloperMetadataVisibilityחשיפת המטא-נתונים החדשים של המפתח.

חזרה

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"]);

פרמטרים

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

חזרה

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);

פרמטרים

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

חזרה

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);

פרמטרים

שםסוגתיאור
startColumnIntegerהעמודה הראשונה לשינוי גודל אוטומטי.
numColumnsIntegerמספר העמודות שיש לשנות את הגודל שלהן באופן אוטומטי.

חזרה

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);

פרמטרים

שםסוגתיאור
startRowIntegerשורת ההתחלה שיש לשנות את הגודל שלה באופן אוטומטי.
numRowsIntegerמספר השורות לשינוי גודל אוטומטי.

חזרה

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 });

פרמטרים

שםסוגתיאור
optionsObjectמפת JavaScript עם אפשרויות מתקדמות, כפי שמפורט בהמשך.

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

שםסוגתיאור
contentsOnlyBooleanהאם לנקות את התוכן.
formatOnlyBooleanהאם לנקות את הפורמט.

חזרה

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);

פרמטרים

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

חזרה

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');

פרמטרים

שםסוגתיאור
findTextStringהטקסט שיש לחפש.

חזרה

TextFinderTextFinder לגיליון.


deleteColumn(columnPosition)

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

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

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה, החל מ-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);

פרמטרים

שםסוגתיאור
columnPositionIntegerהמיקום של העמודה הראשונה למחיקה.
howManyIntegerמספר העמודות למחיקה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowPositionIntegerמיקום השורה, החל מ-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);

פרמטרים

שםסוגתיאור
rowPositionIntegerהמיקום של השורה הראשונה למחיקה.
howManyIntegerמספר השורות למחיקה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
groupDepthIntegerעומק הקבוצה שאליה רוצים להרחיב את קבוצות העמודות.

חזרה

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);

פרמטרים

שםסוגתיאור
groupDepthIntegerעומק הקבוצה שאליו רוצים להרחיב את קבוצות השורות.

חזרה

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 אם אין טווח פעיל. אם תבחרו כמה טווחים, השיטה הזו תחזיר רק את הטווח האחרון שנבחר.

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

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);

פרמטרים

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

חזרה

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

חזרה

GroupControlTogglePositiontrue אם מתג הפקד של קיבוץ העמודות מוצג אחרי הקבוצה בגיליון הזה, ואם לא, 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);

פרמטרים

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

חזרה

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));

פרמטרים

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

חזרה

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();
}

פרמטרים

שםסוגתיאור
typeProtectionTypeסוג האזור המוגן: 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]);

פרמטרים

שםסוגתיאור
rowIntegerאינדקס השורה של התא להחזרה. אינדקס השורה מתחיל ב-1.
columnIntegerאינדקס העמודה של התא להחזרה. אינדקס העמודה מתחיל ב-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]);
  }
}

פרמטרים

שםסוגתיאור
rowIntegerאינדקס השורה הראשונה של הטווח; אינדקס השורה מתחיל ב-1.
columnIntegerאינדקס העמודות של הטווח; אינדקס העמודה מתחיל ב-1.
numRowsIntegerמספר השורות שיש להחזיר.

חזרה

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]);
  }
}

פרמטרים

שםסוגתיאור
rowIntegerאינדקס השורה הראשונה של הטווח; אינדקס השורה מתחיל ב-1.
columnIntegerמספר העמודה הראשונה בטווח, אינדקס 1 מתחיל.
numRowsIntegerמספר השורות שיש להחזיר.
numColumnsIntegerמספר העמודות שיש להחזיר.

חזרה

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");

פרמטרים

שםסוגתיאור
a1NotationStringהטווח להחזרה, כפי שמצוין בסימון 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']);

פרמטרים

שםסוגתיאור
a1NotationsString[]רשימת הטווחים להחזרה, כפי שמצוין בסימון 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);

פרמטרים

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

חזרה

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

חזרה

GroupControlTogglePositiontrue אם מתג הפקד של קיבוץ השורות מוצג אחרי הקבוצה בגיליון הזה ובסמל 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);

פרמטרים

שםסוגתיאור
rowIndexIntegerהאינדקס של השורה.

חזרה

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));

פרמטרים

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

חזרה

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);

פרמטרים

שםסוגתיאור
startRowIntegerהמיקום של שורת ההתחלה.
startColumnIntegerהמיקום של עמודת ההתחלה.
numRowsIntegerמספר השורות שיש להחזיר ערכים שלהן.
numColumnsIntegerמספר העמודות שיש להחזיר ערכים.

חזרה

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

חזרה

Booleantrue אם קווי רשת מוסתרים, 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);

פרמטרים

שםסוגתיאור
columnRangeטווח העמודות להסתרה.

הרשאה

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

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

hideColumns(columnIndex)

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

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

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

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

פרמטרים

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

הרשאה

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

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

hideColumns(columnIndex, numColumns)

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

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

פרמטרים

שםסוגתיאור
columnIndexIntegerאינדקס ההתחלה של העמודות להסתרה.
numColumnsIntegerמספר העמודות להסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowRangeטווח השורות להסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowIndexIntegerהאינדקס של השורה להסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowIndexIntegerאינדקס ההתחלה של השורות להסתרה.
numRowsIntegerמספר השורות שרוצים להסתיר.

הרשאה

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

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

פרמטרים

שםסוגתיאור
chartEmbeddedChartהתרשים להוספה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
afterPositionIntegerאחרי העמודה הזו צריך להוסיף את העמודה החדשה.

חזרה

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);

פרמטרים

שםסוגתיאור
beforePositionIntegerהעמודה שלפניה יש להוסיף את העמודה החדשה.

חזרה

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);

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

פרמטרים

שםסוגתיאור
afterPositionIntegerאחרי העמודה הזו צריך להוסיף את העמודה החדשה.
howManyIntegerמספר העמודות להוספה.

חזרה

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);

פרמטרים

שםסוגתיאור
beforePositionIntegerהעמודה שלפניה יש להוסיף את העמודה החדשה.
howManyIntegerמספר העמודות להוספה.

חזרה

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);

פרמטרים

שםסוגתיאור
blobSourceBlobSourceה-blob שמכיל את תוכן התמונה, את סוג ה-MIME ואת השם (אופציונלי).
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.

חזרה

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);

פרמטרים

שםסוגתיאור
blobSourceBlobSourceה-blob שמכיל את תוכן התמונה, את סוג ה-MIME ואת השם (אופציונלי).
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.
offsetXIntegerההיסט האופקי מהפינה התא בפיקסלים.
offsetYIntegerההיסט האנכי מהפינה התא בפיקסלים.

חזרה

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);

פרמטרים

שםסוגתיאור
urlStringכתובת האתר של התמונה.
columnIntegerמיקום העמודה ברשת.
rowIntegerהמיקום ברשת.

חזרה

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);

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של התמונה.
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.
offsetXIntegerההיסט האופקי מהפינה התא בפיקסלים.
offsetYIntegerההיסט האנכי מהפינה התא בפיקסלים.

חזרה

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);

פרמטרים

שםסוגתיאור
afterPositionIntegerהשורה שאחריה יש להוסיף את השורה החדשה.

חזרה

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);

פרמטרים

שםסוגתיאור
beforePositionIntegerהשורה שלפניה יש להוסיף את השורה החדשה.

חזרה

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);

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
afterPositionIntegerהשורה שאחריה יש להוסיף את השורות החדשות.
howManyIntegerמספר השורות להוספה.

חזרה

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);

פרמטרים

שםסוגתיאור
beforePositionIntegerהשורה שלפניה יש להוסיף את השורות החדשות.
howManyIntegerמספר השורות להוספה.

חזרה

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);

פרמטרים

שםסוגתיאור
rangeRangeהטווח שעליו נוצר כלי סינון.
anchorRowPosIntegerהשורה העליונה של כלי החיתוך מעוגנת בשורה הזו.
anchorColPosIntegerצד עליון של כלי הסינון מעוגנת לקול הזה.

חזרה

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);

פרמטרים

שםסוגתיאור
rangeRangeהטווח שעליו נוצר כלי סינון.
anchorRowPosIntegerהשורה העליונה של כלי החיתוך מעוגנת בשורה הזו.
anchorColPosIntegerצד עליון של כלי הסינון מעוגנת לקול הזה.
offsetXIntegerההיסט האופקי מהפינה התא בפיקסלים.
offsetYIntegerההיסט האנכי מהפינה התא בפיקסלים.

חזרה

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));

פרמטרים

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

חזרה

Booleantrue אם העמודה מוסתרת, 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());

חזרה

Booleantrue אם מימין לשמאל, 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));

פרמטרים

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

חזרה

Booleantrue אם השורה מוסתרת, 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));

פרמטרים

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

חזרה

Booleantrue אם השורה מוסתרת, 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...
}

חזרה

Booleantrue אם הגיליון מוסתר, 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);

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

  • 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]);
}

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
rangeRangeהטווח שיש להגדיר כטווח הפעיל.

חזרה

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

פרמטרים

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

חזרה

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);

פרמטרים

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

חזרה

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");

פרמטרים

שםסוגתיאור
a1NotationStringהטווח שיש להגדיר כפעיל, כפי שצוין בסימון 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);

פרמטרים

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

חזרה

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);

פרמטרים

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

חזרה

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);

פרמטרים

שםסוגתיאור
startColumnIntegerמיקום העמודה הראשונה לשינוי.
numColumnsIntegerמספר העמודות שרוצים לשנות.
widthIntegerהרוחב בפיקסלים להגדרה.

חזרה

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);

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
cellRangeהתא שיש להגדיר כתא הנוכחי.

חזרה

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);

פרמטרים

שםסוגתיאור
columnsIntegerמספר העמודות שהקפאת.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowsIntegerמספר השורות שקופאות.

הרשאה

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

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

פרמטרים

שםסוגתיאור
hideGridlinesBooleanאם האפשרות 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");

פרמטרים

שםסוגתיאור
nameStringהשם החדש של הגיליון.

חזרה

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);

פרמטרים

שםסוגתיאור
rightToLeftBooleanאם 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);

פרמטרים

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

חזרה

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);

פרמטרים

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

חזרה

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);

פרמטרים

שםסוגתיאור
startRowIntegerמיקום השורה הראשונה לשינוי.
numRowsIntegerמספר השורות שרוצים לשנות.
heightIntegerהגובה בפיקסלים כדי להגדיר אותו.

חזרה

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);

פרמטרים

שםסוגתיאור
startRowIntegerמיקום השורה הראשונה לשינוי.
numRowsIntegerמספר השורות שרוצים לשנות.
heightIntegerהגובה בפיקסלים כדי להגדיר אותו.

חזרה

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.

פרמטרים

שםסוגתיאור
colorStringקוד צבע בסימון 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.

פרמטרים

שםסוגתיאור
colorColorהצבע של כרטיסיית הגיליון להגדרה.

חזרה

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);

פרמטרים

שםסוגתיאור
columnIndexIntegerהאינדקס של העמודה לביטול ההסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
columnIndexIntegerהאינדקס הראשוני של העמודות לביטול הסתרה.
numColumnsIntegerמספר העמודות שיש לבטל הסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowIndexIntegerהאינדקס של השורה לביטול הסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowIndexIntegerאינדקס ההתחלה של השורות שיש לבטל הסתרה.
numRowsIntegerמספר השורות לביטול הסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
columnPositionIntegerמיון העמודה.

חזרה

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);

פרמטרים

שםסוגתיאור
columnPositionIntegerמיון העמודה.
ascendingBooleantrue למיון עולה, 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);

פרמטרים

שםסוגתיאור
columnRangeהטווח להסתרה, אם הוא מוסתר.

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowRangeהטווח להסתרה, אם הוא מוסתר.

הרשאה

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

  • 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);
}

פרמטרים

שםסוגתיאור
chartEmbeddedChartהתרשים לעדכון.

הרשאה

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

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

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