גישה לטווחים בגיליון אלקטרוני ושינוי שלהם. טווח יכול להיות תא בודד בגיליון או קבוצה של תאים סמוכים בגיליון.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
activate() | Range | מגדיר את הטווח שצוין כ-active range, כשהתא השמאלי העליון בטווח הוא current cell. |
activate | Range | הגדרת התא שצוין כcurrent cell. |
add | Range | מוסיף מטא-נתונים של מפתח עם המפתח שצוין לטווח. |
add | Range | הפונקציה מוסיפה לטווח מטא-נתונים של מפתח עם סטטוס השיתוף שצוין. |
add | Range | הפונקציה מוסיפה לטווח מטא-נתונים של מפתח עם המפתח והערך שצוינו. |
add | Range | מוסיף לטווח מטא-נתונים של מפתח עם המפתח, הערך והסטטוס שצוינו. |
apply | Banding | החלת עיצוב ברירת מחדל של פסי צבע בעמודות על הטווח. |
apply | Banding | הפונקציה מחילה על הטווח עיצוב של פסי צבע בעמודות שצוין. |
apply | Banding | הפונקציה מחילה על הטווח עיצוב של פסי צבע בעמודות עם הגדרות שצוינו לכותרת ולכותרת התחתונה. |
apply | Banding | החלת עיצוב ברירת מחדל של פסי שורות על הטווח. |
apply | Banding | הפונקציה מחילה על הטווח עיצוב של פסי שורות שצוין. |
apply | Banding | הפונקציה מחילה עיצוב של פסי שורות על הטווח עם הגדרות הכותרת והכותרת התחתונה שצוינו. |
auto | void | הנתונים בטווח הזה ישמשו למילוי הנתונים ב-destination. |
auto | void | מחשבת טווח למילוי בנתונים חדשים על סמך תאים סמוכים וממלאת אוטומטית את הטווח הזה בערכים חדשים על סמך הנתונים שכלולים בטווח. |
break | Range | מבטלים את המיזוג של תאים רב-עמודתיים בטווח לתאים נפרדים. |
can | Boolean | ההגדרה קובעת אם למשתמש יש הרשאה לערוך כל תא בטווח. |
check() | Range | משנה את המצב של תיבות הסימון בטווח ל'מסומן'. |
clear() | Range | מנקה את טווח התוכן והפורמטים. |
clear(options) | Range | מנקה את טווח התוכן, הפורמט, כללי אימות הנתונים ו/או התגובות, כפי שצוין באפשרויות המתקדמות שניתנו. |
clear | Range | התוכן בטווח נמחק, אבל העיצוב נשאר. |
clear | Range | מנקה את הכללים לאימות נתונים בטווח. |
clear | Range | מנקה את העיצוב של הטווח הזה. |
clear | Range | מנקה את ההערה בתא או בתאים הנתונים. |
collapse | Range | מכווץ את כל הקבוצות שנמצאות כולן בטווח. |
copy | void | מעתינים את העיצוב של הטווח למיקום שצוין. |
copy | void | מעתינים את העיצוב של הטווח למיקום שצוין. |
copy | void | הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר. |
copy | void | הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר. |
copy | void | הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר. |
copy | void | העתקת התוכן של הטווח למיקום שצוין. |
copy | void | העתקת התוכן של הטווח למיקום שצוין. |
create | Data | יוצר טבלת צירים ריקה של מקור הנתונים, שמעוגנת בתא הראשון בטווח הזה. |
create | Data | יוצר טבלת מקור נתונים ריקה ממקור הנתונים, שמעוגנת בתא הראשון בטווח הזה. |
create | Developer | מחזירה DeveloperMetadataFinderApi כדי למצוא מטא-נתונים למפתחים בטווח של הטווח הזה. |
create | Filter | יוצרת מסנן ומחילת אותו על הטווח שצוין בגיליון. |
create | Pivot | יוצרת טבלת צירים ריקה מהטווח source שצוין, כשהתא הראשון בטווח משמש כנקודת עיגון. |
create | Text | יוצר כלי לחיפוש טקסט בטווח, שיכול למצוא ולהחליף טקסט בטווח הזה. |
delete | void | מחיקת הטווח הזה של תאים. |
expand | Range | הרחבה של הקבוצות המכווצות שהטווח שלהן או המתג שלהן חותך את הטווח הזה. |
getA1Notation() | String | מחזירה תיאור מחרוזת של הטווח, בסימון A1. |
get | String | הפונקציה מחזירה את צבע הרקע של התא הימני העליון בטווח (לדוגמה, '#ffffff'). |
get | Color | הפונקציה מחזירה את צבע הרקע של התא הימני העליון בטווח. |
get | Color[][] | הפונקציה מחזירה את צבעי הרקע של התאים בטווח. |
get | String[][] | הפונקציה מחזירה את צבעי הרקע של התאים בטווח (לדוגמה, '#ffffff'). |
get | Banding[] | הפונקציה מחזירה את כל הפסים שמוחלים על תאים בטווח הזה. |
get | Range | הפונקציה מחזירה תא נתון בטווח. |
get | Integer | הפונקציה מחזירה את מיקום העמודה ההתחלתי של הטווח הזה. |
get | Range | הפונקציה מחזירה עותק של הטווח שהורחב לארבעת הכיוונים הראשיים Direction כדי לכלול את כל התאים הסמוכים שמכילים נתונים. |
get | Range | מחזירה עותק של הטווח המורחב Direction.UP ו-Direction.DOWN אם המימד שצוין הוא Dimension.ROWS, או Direction.NEXT ו-Direction.PREVIOUS אם המימד הוא Dimension.COLUMNS. |
get | Data | הפונקציה מחזירה את הערך Data של התא הראשון בטווח, או את הערך null אם התא לא מכיל נוסחה של מקור נתונים. |
get | Data | הפונקציה מחזירה את ה-Data של התאים בטווח. |
get | Data | מחזירה את כל טבלאות הצירים של מקורות הנתונים שחופפות לטווח. |
get | Data | אחזור כל הטבלאות של מקורות הנתונים שחופפות לטווח. |
get | String | הפונקציה מחזירה כתובת URL לנתונים בטווח הזה, שאפשר להשתמש בה כדי ליצור תרשימים ושאילתות. |
get | Data | הפונקציה מחזירה את הנתונים בתוך האובייקט הזה כ-DataTable. |
get | Data | מחזירה את הנתונים בטווח הזה כ-DataTable. |
get | Data | הפונקציה מחזירה את כלל אימות הנתונים של התא בפינה הימנית העליונה בטווח. |
get | Data | הפונקציה מחזירה את כללי אימות הנתונים של כל התאים בטווח. |
get | Developer | מחזירה את מטא הנתונים של המפתח שמשויכים לטווח הזה. |
get | String | הפונקציה מחזירה את הערך המוצג של התא הימני העליון בטווח. |
get | String[][] | מחזירה את הרשת המלבנית של הערכים בטווח הזה. |
get | Filter|null | הפונקציה מחזירה את המסנן בגיליון שאליו שייך הטווח הזה, או null אם אין מסנן בגיליון. |
get | Color | הפונקציה מחזירה את צבע הגופן של התא בפינה הימנית העליונה של הטווח. |
get | Color[][] | הפונקציה מחזירה את צבעי הגופן של התאים בטווח. |
get | String[][] | הפונקציה מחזירה את משפחות הגופנים של התאים בטווח. |
get | String | הפונקציה מחזירה את משפחת הגופנים של התא בפינה הימנית העליונה של הטווח. |
get | String | מחזירה את סגנון הקו של התא בפינה הימנית העליונה של הטווח ('underline', 'line-through' או 'none'). |
get | String[][] | מחזירה את סגנון הקו של התאים בטווח ('underline', 'line-through' או 'none'). |
get | Integer | הפונקציה מחזירה את גודל הגופן בנקודות של התא בפינה הימנית העליונה של הטווח. |
get | Integer[][] | הפונקציה מחזירה את גדלי הגופן של התאים בטווח. |
get | String | הפונקציה מחזירה את סגנון הגופן ('italic' או 'normal') של התא בפינה הימנית העליונה של הטווח. |
get | String[][] | הפונקציה מחזירה את סגנונות הגופן של התאים בטווח. |
get | String | הפונקציה מחזירה את עובי הגופן (רגיל או מודגש) של התא בפינה הימנית העליונה של הטווח. |
get | String[][] | הפונקציה מחזירה את עובי הגופן של התאים בטווח. |
get | String | הפונקציה מחזירה את הנוסחה (בסימון A1) של התא הימני העליון בטווח, או מחרוזת ריקה אם התא ריק או לא מכיל נוסחה. |
get | String | הפונקציה מחזירה את הנוסחה (בסימון R1C1) של תא נתון, או null אם אין נוסחה. |
get | String[][] | הפונקציה מחזירה את הנוסחאות (בסימון A1) של התאים בטווח. |
get | String[][] | הפונקציה מחזירה את הנוסחאות (בסימון R1C1) של התאים בטווח. |
get | Integer | הפונקציה מחזירה את מזהה הרשת של גיליון האב של הטווח. |
get | Integer | הפונקציה מחזירה את הגובה של הטווח. |
get | String | הפונקציה מחזירה את היישור האופקי של הטקסט (שמאל/מרכז/ימין) בתא שבפינה הימנית העליונה של הטווח. |
get | String[][] | הפונקציה מחזירה את היישור האופקי של התאים בטווח. |
get | Integer | מחזירה את מיקום עמודת הסיום. |
get | Integer | מחזירה את מיקום שורת הסיום. |
get | Range[] | הפונקציה מחזירה מערך של אובייקטים מסוג Range שמייצגים תאים שמוזגו, שנמצאים במלואם בטווח הנוכחי או שמכילים לפחות תא אחד בטווח הנוכחי. |
get | Range | הפונקציה מתחילה בתא בעמודה ובשורה הראשונות של הטווח, ומחזירה את התא הבא בכיוון שצוין, שהוא הקצה של טווח רציף של תאים עם נתונים או התא בקצה של הגיליון האלקטרוני בכיוון הזה. |
get | String | הפונקציה מחזירה את ההערה שמשויכת לטווח הנתון. |
get | String[][] | הפונקציה מחזירה את ההערות שמשויכות לתאים בטווח. |
get | Integer | הפונקציה מחזירה את מספר העמודות בטווח הזה. |
get | Integer | הפונקציה מחזירה את מספר השורות בטווח הזה. |
get | String | מקבלים את עיצוב המספר או התאריך של התא הימני העליון בטווח הנתון. |
get | String[][] | הפונקציה מחזירה את הפורמטים של המספרים או התאריכים בתאים בטווח. |
get | Rich | הפונקציה מחזירה את הערך של הטקסט העשיר בתא הימני העליון בטווח, או null אם הערך בתא הוא לא טקסט. |
get | Rich | הפונקציה מחזירה את הערכים של הטקסט העשיר בתאים בטווח. |
get | Integer | מחזירה את מיקום השורה של הטווח הזה. |
get | Integer | מחזירה את מיקום השורה של הטווח הזה. |
get | Sheet | הפונקציה מחזירה את הגיליון שאליו שייך הטווח הזה. |
get | Text | הפונקציה מחזירה את כיוון הטקסט של התא הימני העליון בטווח. |
get | Text | הפונקציה מחזירה את כיווני הטקסט של התאים בטווח. |
get | Text | הפונקציה מחזירה את הגדרות סיבוב הטקסט של התא הימני העליון בטווח. |
get | Text | הפונקציה מחזירה את הגדרות סיבוב הטקסט של התאים בטווח. |
get | Text | הפונקציה מחזירה את סגנון הטקסט של התא הימני העליון בטווח. |
get | Text | הפונקציה מחזירה את סגנונות הטקסט של התאים בטווח. |
get | Object | הפונקציה מחזירה את הערך של התא הימני העליון בטווח. |
get | Object[][] | מחזירה את הרשת המלבנית של הערכים בטווח הזה. |
get | String | הפונקציה מחזירה את היישור האנכי (למעלה/אמצע/למטה) של התא בפינה הימנית העליונה של הטווח. |
get | String[][] | מחזירה את היישור האנכי של התאים בטווח. |
get | Integer | הפונקציה מחזירה את רוחב הטווח בעמודות. |
get | Boolean | הפונקציה מחזירה את הערך true אם הטקסט בתא מופיע בשורות נפרדות, אחרת היא מחזירה את הערך false. |
get | Wrap | הפונקציה מחזירה את אסטרטגיות גלישת הטקסט בתאים בטווח. |
get | Wrap | הפונקציה מחזירה את אסטרטגיית גלישת הטקסט של התא הימני העליון בטווח. |
get | Boolean[][] | הפונקציה מחזירה אם הטקסט בתאים עבר גלישה. |
insert | Range | הוספת תאים ריקים לטווח הזה. |
insert | Range | הפונקציה מוסיפה תיבות סימון לכל תא בטווח, עם הערך true אם התיבה מסומנת ועם הערך false אם היא לא מסומנת. |
insert | Range | מוסיפה תיבות סימון לכל תא בטווח, עם ערך מותאם אישית לסימון ומחרוזת ריקה לביטול הסימון. |
insert | Range | מוסיף תיבות סימון לכל תא בטווח, עם ערכים מותאמים אישית למצבים המסומנים והלא מסומנים. |
is | Boolean | הפונקציה מחזירה את הערך true אם הטווח ריק לחלוטין. |
is | Boolean | הפונקציה מחזירה את הערך TRUE אם כל התאים בטווח מסומנים בתיבת הסימון, ואת הערך FALSE אם לא. |
is | Boolean | קובע אם סוף הטווח קשור לעמודה מסוימת. |
is | Boolean | קובעת אם סוף הטווח קשור לשורה מסוימת. |
is | Boolean | הפונקציה מחזירה true אם התאים בטווח הנוכחי חופפים לתאים ממוזגים כלשהם. |
is | Boolean | קובעת אם תחילת הטווח קשורה לעמודה מסוימת. |
is | Boolean | קובעת אם תחילת הטווח קשורה לשורה מסוימת. |
merge() | Range | ממזגת את התאים בטווח לבלוק אחד. |
merge | Range | ממזגים את התאים בטווח לאורך העמודות של הטווח. |
merge | Range | ממזגת את התאים בטווח. |
move | void | גוזרים ומדביקים (גם את הפורמט וגם את הערכים) מהטווח הזה לטווח היעד. |
offset(rowOffset, columnOffset) | Range | מחזירה טווח חדש שמוסט מהטווח הזה במספר נתון של שורות ועמודות (יכול להיות שלילי). |
offset(rowOffset, columnOffset, numRows) | Range | הפונקציה מחזירה טווח חדש שקשור לטווח הנוכחי, שהנקודה הימנית העליונה שלו מוסטת מהטווח הנוכחי לפי השורות והעמודות שצוינו, ועם הגובה שצוין בתאים. |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | מחזירה טווח חדש ביחס לטווח הנוכחי, שנקודת הפינה הימנית העליונה שלו מוסטת מהטווח הנוכחי במספר השורות והעמודות שצוין, ועם הגובה והרוחב שצוינו בתאים. |
protect() | Protection | יוצר אובייקט שיכול להגן על הטווח מפני עריכה, למעט משתמשים שיש להם הרשאה. |
randomize() | Range | הפונקציה קובעת באופן אקראי את סדר השורות בטווח הנתון. |
remove | Range | מסיר את כל תיבות הסימון מהטווח. |
remove | Range | מסירה שורות בטווח הזה שמכילות ערכים שהם כפולים של ערכים בשורה קודמת כלשהי. |
remove | Range | הפעולה מסירה שורות בטווח הזה שמכילות ערכים בעמודות שצוינו שהם כפולים של ערכים בשורה קודמת כלשהי. |
set | Range | מגדיר את צבע הרקע של כל התאים בטווח בסימון CSS (למשל '#ffffff'
או 'white'). |
set | Range | מגדיר את צבע הרקע של כל התאים בטווח. |
set | Range | הגדרת רשת מלבנית של צבעי רקע (צריכה להתאים לממדים של הטווח הזה). |
set | Range | הגדרת הרקע לצבע שצוין באמצעות ערכי RGB (מספרים שלמים בין 0 ל-255, כולל). |
set | Range | הגדרת רשת מלבנית של צבעי רקע (צריכה להתאים לממדים של הטווח הזה). |
set | Range | הגדרת מאפיין הגבול. |
set | Range | מגדיר את מאפיין הגבול עם צבע ו/או סגנון. |
set | Range | מגדירה כלל אחד לאימות נתונים לכל התאים בטווח. |
set | Range | מגדירה את כללי אימות הנתונים לכל התאים בטווח. |
set | Range | הגדרת צבע הגופן בסימון CSS (למשל '#ffffff' או 'white'). |
set | Range | הגדרת צבע הגופן של הטווח הנתון. |
set | Range | מגדיר רשת מלבנית של צבעי גופן (חייב להתאים לממדים של הטווח הזה). |
set | Range | מגדיר רשת מלבנית של צבעי גופן (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת רשת מלבנית של משפחות גופנים (צריך להתאים את המידות לטווח הזה). |
set | Range | הגדרת משפחת הגופנים, כמו Arial או Helvetica. |
set | Range | מגדיר את סגנון הקו של הגופן בטווח הנתון ('underline', 'line-through' או 'none'). |
set | Range | מגדיר רשת מלבנית של סגנונות קווים (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת גודל הגופן, כאשר הגודל הוא גודל הנקודה שבה יש להשתמש. |
set | Range | מגדיר רשת מלבנית של גדלי גופן (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת סגנון הגופן לטווח הנתון ('italic' או 'normal'). |
set | Range | מגדיר רשת מלבנית של סגנונות גופן (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת עובי הגופן לטווח הנתון (רגיל/מודגש). |
set | Range | מגדיר רשת מלבנית של עובי הגופן (חייב להתאים לממדים של הטווח הזה). |
set | Range | מעדכנת את הנוסחה של הטווח הזה. |
set | Range | מעדכנת את הנוסחה של הטווח הזה. |
set | Range | מגדיר רשת מלבנית של נוסחאות (חייב להתאים לממדים של הטווח הזה). |
set | Range | מגדיר רשת מלבנית של נוסחאות (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת היישור האופקי (משמאל לימין) לטווח הנתון (שמאל/מרכז/ימין). |
set | Range | מגדירה רשת מלבנית של יישור אופקי. |
set | Range | מגדיר את ההערה לערך שצוין. |
set | Range | מגדיר רשת מלבנית של הערות (חייב להתאים לממדים של הטווח הזה). |
set | Range | מגדירה את הפורמט של המספר או התאריך למחרוזת הפורמט שצוינה. |
set | Range | מגדיר רשת מלבנית של פורמטים של מספרים או תאריכים (חייב להתאים לממדים של הטווח הזה). |
set | Range | מגדירה את הערך של הטקסט העשיר לתאים בטווח. |
set | Range | מגדירה רשת מלבנית של ערכי טקסט עשיר. |
set | Range | הגדרה שקובעת אם להציג היפר-קישורים בטווח או לא. |
set | Range | הגדרת כיוון הטקסט בתאים בטווח. |
set | Range | מגדירה רשת מלבנית של כיווני טקסט. |
set | Range | הגדרת סיבוב הטקסט בתאים בטווח. |
set | Range | הגדרת סיבוב הטקסט בתאים בטווח. |
set | Range | הגדרת רשת מלבנית של סיבובי טקסט. |
set | Range | הגדרת סגנון הטקסט של התאים בטווח. |
set | Range | מגדיר רשת מלבנית של סגנונות טקסט. |
set | Range | הגדרת הערך של הטווח. |
set | Range | מגדיר רשת מלבנית של ערכים (חייב להתאים לממדים של הטווח הזה). |
set | Range | הגדרת היישור האנכי (מלמעלה למטה) לטווח הנתון (למעלה/באמצע/למטה). |
set | Range | הגדרת רשת מלבנית של יישור אנכי (חייבת להתאים למידות של הטווח הזה). |
set | Range | הגדרה של האפשרות להציג את הטקסט בתאים בטווח אחד מעל השני. |
set | Range | מגדירים את גלישת הטקסט בתאים בטווח הנתון. |
set | Range | מגדירה רשת מלבנית של אסטרטגיות גלישת טקסט. |
set | Range | הגדרת אסטרטגיית גלישת הטקסט בתאים בטווח. |
set | Range | מגדיר רשת מלבנית של מדיניות גלישת מילים (חייבת להתאים לממדים של הטווח הזה). |
shift | Range | הפונקציה משנה את עומק הקיבוץ של העמודות בטווח בסכום שצוין. |
shift | Range | הפונקציה משנה את עומק הקיבוץ של השורות בטווח בסכום שצוין. |
sort(sortSpecObj) | Range | ממיינת את התאים בטווח הנתון לפי העמודה והסדר שצוינו. |
split | void | מפצלת עמודת טקסט לכמה עמודות על סמך מפריד שזוהה אוטומטית. |
split | void | מפצלת עמודת טקסט לכמה עמודות באמצעות המחרוזת שצוינה כמפריד בהתאמה אישית. |
split | void | מפצלת עמודת טקסט לכמה עמודות על סמך התו המפריד שצוין. |
trim | Range | מסירה את הרווחים הלבנים (כמו רווחים, טאבים או שורות חדשות) בכל תא בטווח הזה. |
uncheck() | Range | משנה את המצב של תיבות הסימון בטווח ל'לא מסומן'. |
תיעוד מפורט
activate()
מגדיר את הטווח שצוין כ-active range, כשהתא השמאלי העליון בטווח הוא current cell.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getRange('A1:D10'); range.activate(); const selection = sheet.getSelection(); // Current cell: A1 const currentCell = selection.getCurrentCell(); // Active Range: A1:D10 const activeRange = selection.getActiveRange();
חזרה
Range — הטווח הזה, לשרשור.
activateAsCurrentCell()
הגדרת התא שצוין כcurrent cell.
אם התא שצוין נמצא בטווח קיים, הטווח הזה הופך לטווח הפעיל והתא הופך לתא הנוכחי.
אם התא שצוין לא נמצא באף טווח קיים, הבחירה הקיימת תוסר והתא יהפוך לתא הנוכחי ולטווח הפעיל.
הערה: הערך של Range חייב להיות תא אחד, אחרת תתקבל חריגה.
// Gets the first sheet of the spreadsheet. const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Gets the cell B5 and sets it as the active cell. const range = sheet.getRange('B5'); const currentCell = range.activateAsCurrentCell(); // Logs the activated cell. console.log(currentCell.getA1Notation());
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Adds the key 'NAME' to the developer metadata for row 2. range.addDeveloperMetadata('NAME'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
key | String | המפתח של מטא הנתונים החדשים של המפתח. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on Sheet1. const range = sheet.getRange('2:2'); // Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT' // for row 2 on Sheet1. range.addDeveloperMetadata( 'NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
key | String | המפתח של מטא הנתונים החדשים של המפתח. |
visibility | Developer | סטטוס השיתוף של המטא נתונים החדשים של המפתח. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 of Sheet1. const range = sheet.getRange('2:2'); // Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2. range.addDeveloperMetadata('NAME', 'GOOGLE'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
key | String | המפתח של מטא הנתונים החדשים של המפתח. |
value | String | הערך של המטא נתונים החדשים של המפתח. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility // to PROJECT for row 2 on the sheet. range.addDeveloperMetadata( 'NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
key | String | המפתח של מטא הנתונים החדשים של המפתח. |
value | String | הערך של המטא נתונים החדשים של המפתח. |
visibility | Developer | סטטוס השיתוף של המטא נתונים החדשים של המפתח. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding()
החלת עיצוב ברירת מחדל של פסי צבע בעמודות על הטווח. כברירת מחדל, הצביעה לסירוגין כוללת צבע לכותרת העליונה אבל לא לכותרת התחתונה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Applies column banding to row 2. const colBanding = range.applyColumnBanding(); // Gets the first banding on the sheet and logs the color of the header column. console.log( sheet.getBandings()[0] .getHeaderColumnColorObject() .asRgbColor() .asHexString(), ); // Gets the first banding on the sheet and logs the color of the second column. console.log( sheet.getBandings()[0] .getSecondColumnColorObject() .asRgbColor() .asHexString(), );
חזרה
Banding — הדירוג החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme)
הפונקציה מחילה על הטווח עיצוב של פסי צבע בעמודות שצוין. כברירת מחדל, הצביעה לסירוגין כוללת צבע לכותרת העליונה, אבל לא לכותרת התחתונה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Applies the INDIGO color banding theme to the columns in row 2. const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO); // Gets the first banding on the sheet and logs the color of the second column. console.log( sheet.getBandings()[0] .getSecondColumnColorObject() .asRgbColor() .asHexString(), );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
banding | Banding | ערכת צבעים להחלה על העמודות בטווח. |
חזרה
Banding — הדירוג החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme, showHeader, showFooter)
הפונקציה מחילה על הטווח עיצוב של פסי צבע בעמודות עם הגדרות שצוינו לכותרת ולכותרת התחתונה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets rows 12-22 on the sheet. const range = sheet.getRange('12:22'); // Applies the BLUE color banding theme to rows 12-22. // Sets the header visibility to false and the footer visibility to true. const colBanding = range.applyColumnBanding( SpreadsheetApp.BandingTheme.BLUE, false, true, ); // Gets the banding color and logs it to the console. console.log( sheet.getBandings()[0] .getSecondColumnColorObject() .asRgbColor() .asHexString(), ); // Gets the header color object and logs it to the console. Returns null because // the header visibility is set to false. console.log(sheet.getBandings()[0].getHeaderColumnColorObject()); // Gets the footer color and logs it to the console. console.log( sheet.getBandings()[0] .getFooterColumnColorObject() .asRgbColor() .asHexString(), );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
banding | Banding | ערכת צבעים להחלה על העמודות בטווח. |
show | Boolean | אם הערך הוא true, צבע הכותרת של עיצוב הפסים מוחל על העמודה הראשונה. |
show | Boolean | אם true, צבע הכותרת התחתונה של העיצוב עם הפסים יוחל על העמודה האחרונה. |
חזרה
Banding — הדירוג החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyRowBanding()
החלת עיצוב ברירת מחדל של פסי שורות על הטווח. כברירת מחדל, הצביעה לסירוגין כוללת צבע לכותרת העליונה אבל לא לכותרת התחתונה.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies row banding to rows 1-30. range.applyRowBanding(); // Gets the hex color of the second banded row. const secondRowColor = range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString(); // Logs the hex color to console. console.log(secondRowColor);
חזרה
Banding — הגוונים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme)
הפונקציה מחילה על הטווח עיצוב של פסי שורות שצוין. כברירת מחדל, הצביעה לסירוגין כוללת צבע לכותרת העליונה אבל לא לכותרת התחתונה.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies the INDIGO row banding theme to rows 1-30. range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO); // Gets the hex color of the second banded row. const secondRowColor = range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString(); // Logs the hex color to console. console.log(secondRowColor);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
banding | Banding | ערכת צבעים להחלה על השורות בטווח. |
חזרה
Banding — הדירוג החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme, showHeader, showFooter)
מחילה על הטווח עיצוב של פסי שורות שצוין, עם הגדרות כותרת עליונה וכותרת תחתונה שצוינו.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies the INDIGO row banding to rows 1-30 and // specifies to hide the header and show the footer. range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
banding | Banding | ערכת צבעים להחלה על השורות בטווח. |
show | Boolean | אם true, צבע הכותרת של העיצוב עם הפסים יוחל על השורה הראשונה. |
show | Boolean | אם הערך הוא true, צבע הכותרת התחתונה של העיצוב עם הפסים יוחל על השורה האחרונה. |
חזרה
Banding — הדירוג החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
autoFill(destination, series)
הנתונים בטווח הזה ישמשו למילוי הנתונים ב-destinationRange. הערכים החדשים נקבעים גם לפי סוג המידע series שצוין. טווח היעד חייב להכיל את הטווח הזה ולהאריך אותו בכיוון אחד בלבד. לדוגמה, הפונקציה הבאה ממלאת את A1:A20
בסדרה של מספרים עולים על סמך הערכים הנוכחיים ב-A1:A4:
const sheet = SpreadsheetApp.getActiveSheet(); // Has values [1, 2, 3, 4]. const sourceRange = sheet.getRange('A1:A4'); // The range to fill with values. const destination = sheet.getRange('A1:A20'); // Inserts new values in A5:A20, continuing the pattern expressed in A1:A4 sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Range | הטווח שיש למלא אוטומטית בערכים. טווח היעד צריך לכלול את הטווח הזה ולהאריך אותו בכיוון אחד בלבד (למעלה, למטה, שמאלה או ימינה). |
series | Auto | סוג סדרת המילוי האוטומטי שצריך להשתמש בה כדי לחשב ערכים חדשים. ההשפעה של הסדרה הזו משתנה בהתאם לסוג ולכמות של נתוני המקור. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
autoFillToNeighbor(series)
מחשבת טווח למילוי בנתונים חדשים על סמך תאים סמוכים וממלאת אוטומטית את הטווח הזה בערכים חדשים על סמך הנתונים שכלולים בטווח. הערכים החדשים האלה נקבעים גם לפי סוג series שצוין.
טווח היעד המחושב מתבסס על הנתונים שמסביב כדי לקבוע איפה להוסיף את הערכים החדשים: אם יש נתונים מימין או משמאל לעמודה שממולאת אוטומטית, הערכים החדשים יתווספו רק עד הנתונים הסמוכים.
לדוגמה, אם A1:A20 מלא בסדרה של מספרים עולים והשיטה הזו נקראת בטווח B1:B4 שמכיל סדרה של תאריכים, ערכים חדשים מוכנסים רק ל-B5:B20. כך הערכים החדשים האלה 'נדבקים' לתאים שמכילים ערכים בעמודה א'.
const sheet = SpreadsheetApp.getActiveSheet(); // A1:A20 has values [1, 2, 3, ... 20]. // B1:B4 has values [1/1/2017, 1/2/2017, ...] const sourceRange = sheet.getRange('B1:B4'); // Results in B5:B20 having values [1/5/2017, ... 1/20/2017] sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
series | Auto | סוג סדרת המילוי האוטומטי שצריך להשתמש בה כדי לחשב ערכים חדשים. ההשפעה של הסדרה הזו משתנה בהתאם לסוג ולכמות של נתוני המקור. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
breakApart()
מבטלים את המיזוג של תאים רב-עמודתיים בטווח לתאים נפרדים.
הפעלת הפונקציה הזו בטווח שקולה לבחירת טווח וללחיצה על עיצוב > מיזוג תאים > ביטול המיזוג.
// Opens the spreadsheet 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 range A1:C6 on Sheet1. const range = sheet.getRange('A1:C6'); // Unmerges the range A1:C6 into individual cells. range.breakApart();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
canEdit()
ההגדרה קובעת אם למשתמש יש הרשאה לערוך כל תא בטווח. הבעלים של הגיליון האלקטרוני תמיד יכול לערוך טווחים וגיליונות מוגנים.
// Opens the spreadsheet 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 range A1:C6 on Sheet1. const range = sheet.getRange('A1:C6'); // Logs whether the user has permission to edit every cell in the range. console.log(range.canEdit());
חזרה
Boolean — true אם למשתמש יש הרשאה לערוך כל תא בטווח; false
אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
check()
משנה את המצב של תיבות הסימון בטווח ל'מסומן'. מתעלם מהתאים בטווח שלא מכילים כרגע את הערך המסומן או הלא מסומן שהוגדר.
// Changes the state of cells which currently contain either the checked or // unchecked value configured in the range A1:B10 to 'checked'. const range = SpreadsheetApp.getActive().getRange('A1:B10'); range.check();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear()
מנקה את טווח התוכן והפורמטים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.clear();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear(options)
מנקה את טווח התוכן, הפורמט, כללי אימות הנתונים ו/או התגובות, כפי שצוין באפשרויות המתקדמות שניתנו. כברירת מחדל, כל הנתונים נמחקים.
// The code below clears range C2:G7 in the active sheet, but preserves the // format, data validation rules, and comments. SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({ contentsOnly: true });
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כמו אלה שמופיעים בהמשך. |
פרמטרים מתקדמים
| שם | סוג | תיאור |
|---|---|---|
comments | Boolean | האם לנקות רק את התגובות. |
contents | Boolean | אם לנקות רק את התוכן. |
format | Boolean | האם לנקות רק את הפורמט. שימו לב: ניקוי הפורמט מנקה גם את הכללים לאימות נתונים. |
validations | Boolean | האם להסיר רק כללים לאימות נתונים. |
skip | Boolean | האם להימנע מניקוי שורות מסוננות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clearContent()
התוכן בטווח נמחק, אבל העיצוב נשאר.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.clearContent();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clearDataValidations()
מנקה את הכללים לאימות נתונים בטווח.
// Clear the data validation rules for cells A1:B5. const range = SpreadsheetApp.getActive().getRange('A1:B5'); range.clearDataValidations();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clearFormat()
ניקוי העיצוב של הטווח הזה.
הפעולה הזו מנקה את עיצוב הטקסט בתא או בתאים בטווח, אבל לא מאפסת כללים של עיצוב מספרים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.clearFormat();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clearNote()
מנקה את ההערה בתא או בתאים הנתונים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.clearNote();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
collapseGroups()
מכווץ את כל הקבוצות שנמצאות כולן בטווח. אם אף קבוצה לא נמצאת כולה בטווח, הקבוצה המורחבת הכי עמוקה שנמצאת חלקית בטווח מכווצת.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getActiveRange(); // All row and column groups within the range are collapsed. range.collapseGroups();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
מעתינים את העיצוב של הטווח למיקום שצוין. אם טווח היעד גדול יותר או קטן יותר מטווח המקור, המקור חוזר על עצמו או נחתך בהתאם. שימו לב שהשיטה הזו מעתיקה רק את העיצוב.
תיאור מפורט של הפרמטר gridId זמין getGridId().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const source = ss.getSheets()[0]; const range = source.getRange('B2:D4'); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId // of a sheet by calling sheet.getSheetId() or range.getGridId(). range.copyFormatToRange(1555299895, 4, 6, 4, 6);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
grid | Integer | המזהה הייחודי של הגיליון בגיליון האלקטרוני, ללא קשר למיקום. |
column | Integer | העמודה הראשונה בטווח היעד. |
column | Integer | העמודה האחרונה בטווח היעד. |
row | Integer | השורה הראשונה בטווח היעד. |
row | Integer | השורה האחרונה בטווח היעד. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)
מעתינים את העיצוב של הטווח למיקום שצוין. אם טווח היעד גדול יותר או קטן יותר מטווח המקור, המקור חוזר על עצמו או נחתך בהתאם. שימו לב שהשיטה הזו מעתיקה רק את העיצוב.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const source = ss.getSheets()[0]; const destination = ss.getSheets()[1]; const range = source.getRange('B2:D4'); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyFormatToRange(destination, 4, 6, 4, 6);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
sheet | Sheet | גיליון היעד. |
column | Integer | העמודה הראשונה בטווח היעד. |
column | Integer | העמודה האחרונה בטווח היעד. |
row | Integer | השורה הראשונה בטווח היעד. |
row | Integer | השורה האחרונה בטווח היעד. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copyTo(destination)
הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר. הערכים והפורמט מועתקים.
// The code below copies the first 5 columns over to the 6th column. const sheet = SpreadsheetApp.getActiveSheet(); const rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5); rangeToCopy.copyTo(sheet.getRange(1, 6));
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Range | טווח היעד להעתקה. רק המיקום של התא העליון השמאלי רלוונטי. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, copyPasteType, transposed)
הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר.
// The code below copies only the values of the first 5 columns over to the 6th // column. const sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange('A:E').copyTo( sheet.getRange('F1'), SpreadsheetApp.CopyPasteType.PASTE_VALUES, false, );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Range | טווח היעד להעתקה. רק המיקום של התא העליון השמאלי רלוונטי. |
copy | Copy | סוג שמציין איך התוכן של הטווח מודבק ביעד. |
transposed | Boolean | הארגומנט שקובע אם להדביק את הטווח בכיוון המועבר שלו. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, options)
הפונקציה מעתיקה את הנתונים מטווח תאים אחד לטווח תאים אחר. כברירת מחדל, גם הערכים וגם העיצוב מועתקים, אבל אפשר לשנות את זה באמצעות ארגומנטים מתקדמים.
// The code below copies only the values of the first 5 columns over to the 6th // column. const sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange('A:E').copyTo(sheet.getRange('F1'), {contentsOnly: true});
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
destination | Range | טווח היעד להעתקה. רק המיקום של התא העליון השמאלי רלוונטי. |
options | Object | אובייקט JavaScript שמציין פרמטרים מתקדמים, כמו אלה שמופיעים בהמשך. |
פרמטרים מתקדמים
| שם | סוג | תיאור |
|---|---|---|
format | Boolean | מציין שצריך להעתיק רק את הפורמט |
contents | Boolean | מציין שצריך להעתיק רק את התוכן |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)
העתקת התוכן של הטווח למיקום שצוין. אם טווח היעד גדול יותר או קטן יותר מטווח המקור, המקור חוזר על עצמו או נחתך בהתאם.
תיאור מפורט של הפרמטר gridId זמין getGridId().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const source = ss.getSheets()[0]; const range = source.getRange('B2:D4'); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 0 range.copyValuesToRange(0, 4, 6, 4, 6);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
grid | Integer | המזהה הייחודי של הגיליון בגיליון האלקטרוני, ללא קשר למיקום. |
column | Integer | העמודה הראשונה בטווח היעד. |
column | Integer | העמודה האחרונה בטווח היעד. |
row | Integer | השורה הראשונה בטווח היעד. |
row | Integer | השורה האחרונה בטווח היעד. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)
העתקת התוכן של הטווח למיקום שצוין. אם טווח היעד גדול יותר או קטן יותר מטווח המקור, המקור חוזר על עצמו או נחתך בהתאם.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const source = ss.getSheets()[0]; const destination = ss.getSheets()[1]; const range = source.getRange('B2:D4'); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyValuesToRange(destination, 4, 6, 4, 6);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
sheet | Sheet | גיליון היעד. |
column | Integer | העמודה הראשונה בטווח היעד. |
column | Integer | העמודה האחרונה בטווח היעד. |
row | Integer | השורה הראשונה בטווח היעד. |
row | Integer | השורה האחרונה בטווח היעד. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
createDataSourcePivotTable(dataSource)
יוצר טבלת צירים ריקה של מקור הנתונים, שמעוגנת בתא הראשון בטווח הזה.
בדוגמה הזו מוסבר איך ליצור ולהגדיר טבלת צירים חדשה של מקור נתונים.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const anchorCell = spreadsheet.getSheets()[0].getRange('A1'); const dataSource = spreadsheet.getDataSources()[0]; const pivotTable = anchorCell.createDataSourcePivotTable(dataSource); pivotTable.addRowGroup('dataColumnA'); pivotTable.addColumnGroup('dataColumnB'); pivotTable.addPivotValue( 'dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM, ); pivotTable.addFilter( 'dataColumnA', SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build(), );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
data | Data | מקור הנתונים שממנו רוצים ליצור את טבלת הצירים. |
חזרה
DataSourcePivotTable – טבלת הצירים של מקור הנתונים שנוצרה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
createDataSourceTable(dataSource)
יוצר טבלת מקור נתונים ריקה ממקור הנתונים, שמעוגנת בתא הראשון בטווח הזה.
בדוגמה הזו מוסבר איך ליצור ולהגדיר טבלה חדשה של מקור נתונים.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const anchorCell = spreadsheet.getSheets()[0].getRange('A1'); const dataSource = spreadsheet.getDataSources()[0]; const dataSourceTable = anchorCell.createDataSourceTable(dataSource) .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC') .addSortSpec('dataColumnA', true) // ascending=true .addSortSpec('dataColumnB', false); // ascending=false
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
data | Data | מקור הנתונים שממנו רוצים ליצור את טבלת הצירים. |
חזרה
DataSourceTable – הטבלה של מקור הנתונים שנוצרה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
createDeveloperMetadataFinder()
מחזירה DeveloperMetadataFinderApi כדי למצוא מטא-נתונים למפתחים בטווח של הטווח הזה. מטא-נתונים נמצאים בטווח רק אם הם כלולים בו באופן מלא. לדוגמה, מטא-נתונים שמשויכים לשורה '3:3' לא נמצאים בטווח 'A1:D5', אבל כן נמצאים בטווח '1:5'.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:C6. const range = sheet.getRange('A1:C6'); // Creates a developer metadata finder to search for metadata in the scope of // this range. const developerMetaDataFinder = range.createDeveloperMetadataFinder(); // Logs information about the developer metadata finder to the console. const developerMetaData = developerMetaDataFinder.find()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
חזרה
DeveloperMetadataFinder – כלי לחיפוש מטא נתונים למפתחים, לחיפוש מטא נתונים בהיקף של הטווח הזה.
createFilter()
יוצרת מסנן ומחילת אותו על הטווח שצוין בגיליון. אי אפשר ליצור יותר ממסנן אחד בגיליון. כדי לגשת למסנן ולשנות אותו אחרי שיוצרים אותו, משתמשים ב-getFilter() או ב-Sheet.getFilter().
const ss = SpreadsheetApp.getActiveSheet(); const range = ss.getRange('A1:C20'); // Creates a new filter and applies it to the range A1:C20 on the active sheet. function createFilter() { range.createFilter(); } // Gets the filter and applies criteria that only shows cells that aren't empty. function getFilterAddCriteria() { const filter = range.getFilter(); const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build(); filter.setColumnFilterCriteria(2, criteria); }
Grid, סוג הגיליון שמוגדר כברירת מחדל.
גיליונות רשת הם גיליונות שלא מקושרים למסד נתונים. כדי ליצור סוגים אחרים של מסננים, אפשר לעיין במאמרים הבאים:
- יצירת מסנן לטבלת צירים באמצעות
PivotTable.addFilter(sourceDataColumn, filterCriteria) - יצירת מסנן לגיליון שמחובר למסד נתונים באמצעות
DataSourceSheet.addFilter(columnName, filterCriteria) - יצירת מסנן לטבלת צירים שמחוברת למסד נתונים עם
DataSourcePivotTable.addFilter(columnName, filterCriteria)
חזרה
Filter – המסנן החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
createPivotTable(sourceData)
יוצרת טבלת צירים ריקה מהטווח שצוין sourceData, שמעוגנת לתא הראשון בטווח.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A1 as a range in order to place the pivot table. const range = sheet.getRange('A1'); // Gets the range of the source data for the pivot table. const dataRange = sheet.getRange('E12:G20'); // Creates an empty pivot table from the specified source data. const pivotTable = range.createPivotTable(dataRange); // Logs the values from the pivot table's source data to the console. console.log(pivotTable.getSourceDataRange().getValues());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
source | Range | הנתונים שמהם רוצים ליצור את טבלת הצירים. |
חזרה
PivotTable – PivotTable שנוצר לאחרונה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
createTextFinder(findText)
יוצר כלי לחיפוש טקסט בטווח, שיכול למצוא ולהחליף טקסט בטווח הזה.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getActiveRange(); // Creates a text finder for the range. const textFinder = range.createTextFinder('dog'); // Returns the first occurrence of 'dog'. const firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. const numOccurrencesReplaced = textFinder.replaceWith('cat');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
find | String | הטקסט שרוצים לחפש. |
חזרה
TextFinder – TextFinder לטווח
deleteCells(shiftDimension)
מחיקת הטווח הזה של תאים. הנתונים הקיימים בגיליון לפי המאפיין שצוין מוזזים לכיוון הטווח שנמחק.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
shift | Dimension | המאפיין שלפיו יזוזו הנתונים הקיימים. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
expandGroups()
הרחבה של הקבוצות המכווצות שהטווח שלהן או המתג שלהן חותך את הטווח הזה. המיקום של מתג הבקרה הוא האינדקס שבו מתג הבקרה מוצג, ישירות לפני או אחרי הקבוצה, בהתאם להגדרות. אם יש יותר מקבוצה אחת באותו מיקום, הקבוצה הרדודה ביותר מורחבת.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getActiveRange(); // All row and column groups within the range are expanded. range.expandGroups();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getA1Notation()
מחזירה תיאור מחרוזת של הטווח, בסימון A1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange(1, 1, 2, 5); // Logs "A1:E2" Logger.log(range.getA1Notation());
חזרה
String – תיאור המחרוזת של הטווח בסימון A1.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getBackground()
הפונקציה מחזירה את צבע הרקע של התא הימני העליון בטווח (לדוגמה, '#ffffff').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B5'); Logger.log(cell.getBackground());
חזרה
String — קוד הצבע של הרקע.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getBackgroundObject()
הפונקציה מחזירה את צבע הרקע של התא הימני העליון בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B5'); Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());
חזרה
Color – צבע הרקע של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getBackgroundObjects()
הפונקציה מחזירה את צבעי הרקע של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5:C6'); const bgColors = range.getBackgroundObjects(); for (const i in bgColors) { for (const j in bgColors[i]) { Logger.log(bgColors[i][j].asRgbColor().asHexString()); } }
חזרה
Color[][] — מערך דו-ממדי של צבעי רקע.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getBackgrounds()
הפונקציה מחזירה את צבעי הרקע של התאים בטווח (לדוגמה, '#ffffff').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5:C6'); const bgColors = range.getBackgrounds(); for (const i in bgColors) { for (const j in bgColors[i]) { Logger.log(bgColors[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של קודי צבע של הרקעים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets a range. const range = sheet.getRange('A1:K50'); // Gets the banding info for the range. const bandings = range.getBandings(); // Logs the second row color for each banding 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
getCell(row, column)
הפונקציה מחזירה תא נתון בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); // The row and column here are relative to the range // getCell(1,1) in this code returns the cell at B2 const cell = range.getCell(1, 1); Logger.log(cell.getValue());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
row | Integer | השורה של התא ביחס לטווח. |
column | Integer | העמודה של התא ביחס לטווח. |
חזרה
Range – טווח שמכיל תא יחיד בקואורדינטות שצוינו.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getColumn()
הפונקציה מחזירה את מיקום העמודה ההתחלתי של הטווח הזה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); // Logs "2.0" Logger.log(range.getColumn());
חזרה
Integer – מיקום העמודה הראשונה בטווח בגיליון האלקטרוני.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataRegion()
הפונקציה מחזירה עותק של הטווח שהורחב לארבעת הכיוונים הראשיים Direction כדי לכלול את כל התאים הסמוכים שמכילים נתונים. אם הטווח מוקף בתאים ריקים שלא כוללים את התאים לאורך האלכסונים, הטווח עצמו מוחזר. זה דומה לבחירת הטווח ולהקלדת Ctrl+A בכלי העריכה.
// Assume the active spreadsheet is blank. const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.getRange('C2').setValue(100); sheet.getRange('B3').setValue(100); sheet.getRange('D3').setValue(100); sheet.getRange('C4').setValue(100); // Logs "B2:D4" Logger.log(sheet.getRange('C3').getDataRegion().getA1Notation());
חזרה
Range — האזור הגיאוגרפי לאחסון נתונים של הטווח או טווח של הגיליון האלקטרוני כולו.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataRegion(dimension)
מחזירה עותק של הטווח המורחב Direction.UP ו-Direction.DOWN אם המימד שצוין הוא Dimension.ROWS, או Direction.NEXT ו-Direction.PREVIOUS אם המימד הוא Dimension.COLUMNS. הרחבת הטווח מבוססת על זיהוי נתונים ליד הטווח, שמאורגנים כמו טבלה. הטווח המורחב כולל את כל התאים הסמוכים עם נתונים לאורך המאפיין שצוין, כולל גבולות הטבלה. אם הטווח המקורי מוקף בתאים ריקים לאורך המימד שצוין,
הטווח עצמו מוחזר. השיטה הזו דומה לבחירת הטווח ולהקלדת
Ctrl+Space לעמודות או Shift+Space לשורות בכלי העריכה.
// Assume the active spreadsheet is blank. const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.getRange('C2').setValue(100); sheet.getRange('B3').setValue(100); sheet.getRange('D3').setValue(100); sheet.getRange('C4').setValue(100); // Logs "C2:C4" Logger.log( sheet.getRange('C3') .getDataRegion(SpreadsheetApp.Dimension.ROWS) .getA1Notation(), ); // Logs "B3:D3" Logger.log( sheet.getRange('C3') .getDataRegion(SpreadsheetApp.Dimension.COLUMNS) .getA1Notation(), );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
dimension | Dimension | המאפיין שלפיו מרחיבים את הטווח. |
חזרה
Range — אזור הנתונים בטווח או טווח שמכסה כל עמודה או כל שורה בטווח המקורי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormula()
הפונקציה מחזירה את הערך DataSourceFormula של התא הראשון בטווח, או את הערך null אם התא לא מכיל נוסחה של מקור נתונים.
// 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 the range A1 on Sheet1. const range = sheet.getRange('A1'); // Gets the data source formula from cell A1. const dataSourceFormula = range.getDataSourceFormula(); // Gets the formula. const formula = dataSourceFormula.getFormula(); // Logs the formula. console.log(formula);
חזרה
DataSourceFormula|null – DataSourceFormula של התא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
הפונקציה מחזירה את ה-DataSourceFormula של התאים בטווח.
// 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 the range A1:B5 on Sheet1. const range = sheet.getRange('A1:B5'); // Gets an array of the data source formulas in the range A1:B5. const dataSourceFormulas = range.getDataSourceFormulas(); // Logs the first formula in the array. console.log(dataSourceFormulas[0].getFormula());
חזרה
DataSourceFormula[] – מערך של 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 the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets an array of the data source pivot tables in the range A1:G50. const dataSourcePivotTables = range.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 the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets the first data source table in the range A1:G50. const dataSourceTable = range.getDataSourceTables()[0]; // Logs the time of the last completed data execution on the data source table. console.log(dataSourceTable.getStatus().getLastExecutionTime());
חזרה
DataSourceTable[] — רשימה של טבלאות ממקור הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSourceUrl()
הפונקציה מחזירה כתובת URL לנתונים בטווח הזה, שאפשר להשתמש בה כדי ליצור תרשימים ושאילתות.
Code.gs
function doGet() { const ss = SpreadsheetApp.openById( '1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c', ); const sheet = ss.getSheetByName('ContinentData'); const range = sheet.getRange('A1:B8'); const template = HtmlService.createTemplateFromFile('piechart'); template.dataSourceUrl = range.getDataSourceUrl(); return template.evaluate(); }
piechart.html
<!DOCTYPE html>
<html>
<head>
<!--Load the AJAX API-->
<script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
<script type="text/javascript">
// Load the Visualization API and the corechart package.
google.charts.load('current', {'packages': ['corechart']});
// Set a callback to run when the Google Visualization API is loaded.
google.charts.setOnLoadCallback(queryData);
function queryData() {
var query = new google.visualization.Query('<?= dataSourceUrl ?>');
query.send(drawChart);
}
// Callback that creates and populates a data table,
// instantiates the pie chart, passes in the data and
// draws it.
function drawChart(response) {
if (response.isError()) {
alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
return;
}
var data = response.getDataTable();
// Set chart options.
var options = {
title: 'Population by Continent',
width: 400,
height: 300
};
// Instantiate and draw the chart, passing in some options.
var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
chart.draw(data, options);
}
</script>
</head>
<body>
<!-- Div that holds the pie chart. -->
<div id="chart_div"></div>
</body>
</html>חזרה
String – כתובת URL של הטווח הזה כמקור נתונים שאפשר להעביר לממשקי API אחרים, כמו תרשימים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataTable()
הפונקציה מחזירה את הנתונים בתוך האובייקט הזה כ-DataTable.
// 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 the range A1:B7 on Sheet1. const range = sheet.getRange('A1:B7'); // Gets the range A1:B7 as a data table. The values in each column must be of // the same type. const datatable = range.getDataTable(); // Uses the Charts service to build a bar chart from the data table. // This doesn't build an embedded chart. To do that, use // sheet.newChart().addRange() instead. const chart = Charts.newBarChart() .setDataTable(datatable) .setOption('title', 'Your Chart Title Here') .build();
חזרה
DataTable – הנתונים כטבלת נתונים.
getDataTable(firstRowIsHeader)
מחזירה את הנתונים בטווח הזה כ-DataTable.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B7'); // Calling this method with "true" sets the first line to be the title of the // axes const datatable = range.getDataTable(true); // Note that this doesn't build an EmbeddedChart, so you can't just use // Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead. const chart = Charts.newBarChart() .setDataTable(datatable) .setOption('title', 'Your Title Here') .build();
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
first | Boolean | האם להתייחס לשורה הראשונה ככותרת. |
חזרה
DataTable — הנתונים כטבלת נתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataValidation()
הפונקציה מחזירה את כלל אימות הנתונים של התא בפינה הימנית העליונה בטווח. אם לא הוגדר אימות נתונים בתא, השיטה הזו מחזירה null.
// Log information about the data validation rule for cell A1. const cell = SpreadsheetApp.getActive().getRange('A1'); const rule = cell.getDataValidation(); if (rule != null) { const criteria = rule.getCriteriaType(); const args = rule.getCriteriaValues(); Logger.log('The data validation rule is %s %s', criteria, args); } else { Logger.log('The cell does not have a data validation rule.'); }
חזרה
DataValidation – כלל אימות הנתונים של התא בפינה הימנית העליונה בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataValidations()
הפונקציה מחזירה את כללי אימות הנתונים של כל התאים בטווח. אם לא הוגדר אימות נתונים בתא מסוים, הפונקציה הזו מחזירה null למיקום של התא במערך.
// Change existing data validation rules that require a date in 2013 to require // a date in 2014. const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; const newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); const rules = range.getDataValidations(); for (let i = 0; i < rules.length; i++) { for (let j = 0; j < rules[i].length; j++) { const rule = rules[i][j]; if (rule != null) { const criteria = rule.getCriteriaType(); const args = rule.getCriteriaValues(); if (criteria === SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN && args[0].getTime() === oldDates[0].getTime() && args[1].getTime() === oldDates[1].getTime()) { // Create a builder from the existing rule, then change the dates. rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); } } } } range.setDataValidations(rules);
חזרה
DataValidation[][] — מערך דו-ממדי של כללי אימות נתונים שמשויכים לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on Sheet1. const range = sheet.getRange('2:2'); // Adds metadata to row 2. range.addDeveloperMetadata('NAME', 'GOOGLE'); // Logs the metadata to console. for (const metadata of range.getDeveloperMetadata()) { console.log(`${metadata.getKey()}: ${metadata.getValue()}`); }
חזרה
DeveloperMetadata[] — המטא-נתונים של המפתח שמשויכים לטווח הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
הפונקציה מחזירה את הערך המוצג של התא הימני העליון בטווח. הערך הוא String.
הערך שמוצג לוקח בחשבון את הפורמט של התאריך, השעה והמטבע, כולל פורמטים שמוחלים אוטומטית על ידי הגדרת הלוקאל של הגיליון האלקטרוני. תאים ריקים מחזירים מחרוזת ריקה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A30 and sets its value to 'Test code.' const cell = sheet.getRange('A30'); cell.setValue('Test code'); // Gets the value and logs it to the console. console.log(cell.getDisplayValue());
חזרה
String — הערך שמוצג בתא הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDisplayValues()
מחזירה את הרשת המלבנית של הערכים בטווח הזה.
מחזירה מערך דו-ממדי של ערכים שמוצגים, עם אינדקס לפי שורה ואז לפי עמודה. הערכים הם אובייקטים של String. הערך שמוצג מתייחס לפורמט של התאריך, השעה והמטבע, כולל פורמטים שמוחלים באופן אוטומטי על ידי הגדרת הלוקאל של הגיליון האלקטרוני. תאים ריקים מיוצגים על ידי מחרוזת ריקה במערך. חשוב לזכור: האינדקס של טווח מתחיל ב-1, 1, אבל האינדקס של מערך JavaScript מתחיל ב-[0][0].
// The code below gets the displayed values for the range C2:G8 // in the active spreadsheet. Note that this is a JavaScript array. const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues(); Logger.log(values[0][0]);
חזרה
String[][] – מערך דו-ממדי של ערכים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFilter()
הפונקציה מחזירה את המסנן בגיליון שאליו שייך הטווח הזה, או null אם אין מסנן בגיליון.
const ss = SpreadsheetApp.getActiveSheet(); const range = ss.getRange('A1:C20'); // Gets the existing filter on the sheet that the given range belongs to. const filter = range.getFilter();
חזרה
Filter|null – המסנן.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontColorObject()
הפונקציה מחזירה את צבע הגופן של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontColorObject().asRgbColor().asHexString());
חזרה
Color — צבע הגופן של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontColorObjects()
הפונקציה מחזירה את צבעי הגופן של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontColorObjects(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j].asRgbColor().asHexString()); } }
חזרה
Color[][] — מערך דו-ממדי של צבעי גופן שמשויכים לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontFamilies()
הפונקציה מחזירה את משפחות הגופנים של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontFamilies(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] – מערך דו-ממדי של משפחות גופנים שמשויכות לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontFamily()
הפונקציה מחזירה את משפחת הגופנים של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontFamily());
חזרה
String – משפחת הגופנים של התא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontLine()
מחזירה את סגנון הקו של התא בפינה הימנית העליונה של הטווח ('underline', 'line-through' או 'none').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontLine());
חזרה
String — שורת הגופן.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontLines()
מחזירה את סגנון הקו של התאים בטווח ('underline', 'line-through' או 'none').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontLines(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של שורות גופן שמשויכות לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontSize()
הפונקציה מחזירה את גודל הגופן בנקודות של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontSize());
חזרה
Integer – גודל הגופן בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontSizes()
הפונקציה מחזירה את גדלי הגופן של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontSizes(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
Integer[][] — מערך דו-ממדי של גדלי הגופן של הטקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontStyle()
הפונקציה מחזירה את סגנון הגופן ('italic' או 'normal') של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontStyle());
חזרה
String — סגנון הגופן של הטקסט בתא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontStyles()
הפונקציה מחזירה את סגנונות הגופן של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontStyles(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] – מערך דו-ממדי של סגנונות גופן של טקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontWeight()
הפונקציה מחזירה את עובי הגופן (רגיל או מודגש) של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getFontWeight());
חזרה
String — משקל הגופן של הטקסט בתא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFontWeights()
הפונקציה מחזירה את עובי הגופן של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getFontWeights(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של משקלי גופן של טקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFormula()
הפונקציה מחזירה את הנוסחה (בסימון A1) של התא הימני העליון בטווח, או מחרוזת ריקה אם התא ריק או לא מכיל נוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This assumes you have a function in B5 that sums up // B2:B4 const range = sheet.getRange('B5'); // Logs the calculated value and the formula Logger.log( 'Calculated value: %s Formula: %s', range.getValue(), range.getFormula(), );
חזרה
String — הנוסחה של התא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFormulaR1C1()
הפונקציה מחזירה את הנוסחה (בסימון R1C1) של תא נתון, או null אם אין נוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5'); const formula = range.getFormulaR1C1(); Logger.log(formula);
חזרה
String — הנוסחה בשיטת הסימון R1C1.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFormulas()
הפונקציה מחזירה את הנוסחאות (בסימון A1) של התאים בטווח. הערכים במערך הדו-ממדי הם מחרוזות ריקות לתאים ללא נוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5:C6'); const formulas = range.getFormulas(); for (const i in formulas) { for (const j in formulas[i]) { Logger.log(formulas[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של נוסחאות בפורמט מחרוזת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFormulasR1C1()
הפונקציה מחזירה את הנוסחאות (בסימון R1C1) של התאים בטווח. הערכים במערך הדו-ממדי הם
null לתאים ללא נוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5:C6'); const formulas = range.getFormulasR1C1(); for (const i in formulas) { for (const j in formulas[i]) { Logger.log(formulas[i][j]); } }
חזרה
String[][] – מערך דו-ממדי של נוסחאות בסימון R1C1.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getGridId()
הפונקציה מחזירה את מזהה הרשת של גיליון האב של הטווח. המזהים הם ערכים אקראיים של מספרים שלמים לא שליליים.
// Log the grid ID of the first sheet (by tab position) in the spreadsheet. const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getGridId());
חזרה
Integer – מזהה הרשת של גיליון ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getHeight()
הפונקציה מחזירה את הגובה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); // logs 3.0 Logger.log(range.getHeight());
חזרה
Integer — גובה הטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getHorizontalAlignment()
הפונקציה מחזירה את היישור האופקי של הטקסט (שמאל/מרכז/ימין) בתא שבפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getHorizontalAlignment());
חזרה
String — היישור האופקי של הטקסט בתא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getHorizontalAlignments()
הפונקציה מחזירה את היישור האופקי של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getHorizontalAlignments(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של יישורים אופקיים של טקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getLastColumn()
מחזירה את מיקום עמודת הסיום.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); // Logs "4.0" Logger.log(range.getLastColumn());
חזרה
Integer – מיקום עמודת הסיום של הטווח בגיליון האלקטרוני.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getLastRow()
מחזירה את מיקום שורת הסיום.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); // Logs "4.0" Logger.log(range.getLastRow());
חזרה
Integer – מיקום שורת הסיום של הטווח בגיליון האלקטרוני.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getMergedRanges()
הפונקציה מחזירה מערך של אובייקטים מסוג Range שמייצגים תאים שמוזגו, שנמצאים במלואם בטווח הנוכחי או שמכילים לפחות תא אחד בטווח הנוכחי.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B3'); const mergedRanges = range.getMergedRanges(); for (let i = 0; i < mergedRanges.length; i++) { Logger.log(mergedRanges[i].getA1Notation()); Logger.log(mergedRanges[i].getDisplayValue()); }
חזרה
Range[] — מערך של אובייקטים מסוג Range שמייצגים תאים ממוזגים שחופפים לטווח.
getNextDataCell(direction)
הפונקציה מתחילה בתא בעמודה ובשורה הראשונות של הטווח, ומחזירה את התא הבא בכיוון שצוין, שהוא הקצה של טווח רציף של תאים עם נתונים או התא בקצה של הגיליון האלקטרוני בכיוון הזה. זה שווה ערך להקלדת
Ctrl+[arrow key] בכלי העריכה.
// Assume the active spreadsheet is blank. const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('C3:E5'); // Logs "C1" Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
direction | Direction | הכיוון שבו צריך לחפש את התא הבא בקצה של אזור הנתונים. |
חזרה
Range — התא בקצה של אזור הנתונים או התא בקצה של הגיליון האלקטרוני.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNote()
הפונקציה מחזירה את ההערה שמשויכת לטווח הנתון.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getNote());
חזרה
String – ההערה שמשויכת לתא הנתון.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNotes()
הפונקציה מחזירה את ההערות שמשויכות לתאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getNotes(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של הערות שמשויכות לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNumColumns()
הפונקציה מחזירה את מספר העמודות בטווח הזה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D5'); Logger.log(range.getNumColumns());
חזרה
Integer — מספר העמודות בטווח הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNumRows()
הפונקציה מחזירה את מספר השורות בטווח הזה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D5'); Logger.log(range.getNumRows());
חזרה
Integer — מספר השורות בטווח הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNumberFormat()
מקבלים את עיצוב המספר או התאריך של התא הימני העליון בטווח הנתון. דפוסי הפורמט שמוחזרים מתוארים במסמכי התיעוד של Sheets API.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('C4'); Logger.log(cell.getNumberFormat());
חזרה
String — פורמט המספר של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getNumberFormats()
הפונקציה מחזירה את הפורמטים של המספרים או התאריכים בתאים בטווח. דפוסי הפורמט שמוחזרים מתוארים במאמרי העזרה של ה-Sheets API.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B5:C6'); const formats = range.getNumberFormats(); for (const i in formats) { for (const j in formats[i]) { Logger.log(formats[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של פורמטים של מספרים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRichTextValue()
הפונקציה מחזירה את הערך של הטקסט העשיר בתא הימני העליון בטווח, או null אם הערך בתא הוא לא טקסט.
// Gets the Rich Text value of cell D4. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('D4:F6'); const richText = range.getRichTextValue(); console.log(richText.getText());
חזרה
RichTextValue|null — ערך הטקסט העשיר של התא הימני העליון בטווח, או null אם ערך התא הוא לא טקסט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRichTextValues()
הפונקציה מחזירה את הערכים של הטקסט העשיר בתאים בטווח.
// Gets the Rich Text values for all cells in range B5:C6 const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B5:C6'); const values = range.getRichTextValues(); for (let i = 0; i < values.length; i++) { for (let j = 0; j < values[i].length; j++) { console.log(values[i][j].getText()); } }
חזרה
RichTextValue[][] — מערך דו-ממדי של ערכי טקסט עשיר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRow()
מחזירה את מיקום השורה של הטווח הזה. זהה ל-getRowIndex().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2'); Logger.log(range.getRow());
חזרה
Integer — מיקום השורה של הטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRowIndex()
מחזירה את מיקום השורה של הטווח הזה. זהה ל-getRow().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2'); Logger.log(range.getRowIndex());
חזרה
Integer — מיקום השורה של הטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
getSheet()
הפונקציה מחזירה את הגיליון שאליו שייך הטווח הזה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the sheet that the range belongs to. const rangeSheet = range.getSheet(); // Gets the sheet name and logs it to the console. console.log(rangeSheet.getName());
חזרה
Sheet — הגיליון שהטווח הזה שייך לו.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextDirection()
הפונקציה מחזירה את כיוון הטקסט של התא הימני העליון בטווח. הפונקציה מחזירה את הערך null אם הכיוון של הטקסט בתא נקבע באמצעות זיהוי אוטומטי.
// Get the text direction of cell B1. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B1:D4'); Logger.log(range.getTextDirection());
חזרה
TextDirection — כיוון הטקסט של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextDirections()
הפונקציה מחזירה את כיווני הטקסט של התאים בטווח. הערכים במערך הדו-ממדי הם null לתאים שמשתמשים בזיהוי אוטומטי.
// Get the text directions for all cells in range B5:C6 const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B5:C6'); const directions = range.getTextDirections(); for (let i = 0; i < directions.length; i++) { for (let j = 0; j < directions[i].length; j++) { Logger.log(directions[i][j]); } }
חזרה
TextDirection[][] — מערך דו-ממדי של כיווני טקסט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextRotation()
הפונקציה מחזירה את הגדרות סיבוב הטקסט של התא הימני העליון בטווח.
// Log the text rotation settings for a cell. const sheet = SpreadsheetApp.getActiveSheet(); const cell = sheet.getRange('A1'); Logger.log(cell.getTextRotation());
חזרה
TextRotation — הגדרות סיבוב הטקסט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextRotations()
הפונקציה מחזירה את הגדרות סיבוב הטקסט של התאים בטווח.
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B2:D4'); const results = range.getTextRotations(); for (const i in results) { for (const j in results[i]) { const rotation = results[i][j]; Logger.log('Cell [%s, %s] has text rotation: %v', i, j, rotation); } }
חזרה
TextRotation[][] — מערך דו-ממדי של סיבובי טקסט שמשויכים לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextStyle()
הפונקציה מחזירה את סגנון הטקסט של התא הימני העליון בטווח.
// Get the text style of cell D4. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('D4:F6'); const style = range.getTextStyle(); Logger.log(style);
חזרה
TextStyle — סגנון הטקסט של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTextStyles()
הפונקציה מחזירה את סגנונות הטקסט של התאים בטווח.
// Get the text styles for all cells in range B5:C6 const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B5:C6'); const styles = range.getTextStyles(); for (let i = 0; i < styles.length; i++) { for (let j = 0; j < styles[i].length; j++) { Logger.log(styles[i][j]); } }
חזרה
TextStyle[][] – מערך דו-ממדי של סגנונות טקסט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getValue()
הפונקציה מחזירה את הערך של התא הימני העליון בטווח. הערך יכול להיות מסוג Number, Boolean, Date או String, בהתאם לערך של התא. תאים ריקים מחזירים מחרוזת ריקה.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the value of the top-left cell in the range and logs it to the console. console.log(range.getValue());
חזרה
Object – הערך בתא הזה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getValues()
מחזירה את הרשת המלבנית של הערכים בטווח הזה.
מחזירה מערך דו-ממדי של ערכים, עם אינדקס לפי שורה ואז לפי עמודה. הערכים יכולים להיות מהסוגים Number, Boolean, Date או String, בהתאם לערך של התא. תאים ריקים מיוצגים על ידי מחרוזת ריקה במערך. חשוב לזכור שאינדקס של טווח מתחיל ב-1, 1, אבל אינדקס של מערך JavaScript מתחיל ב-[0][0].
// The code below gets the values for the range C2:G8 // in the active spreadsheet. Note that this is a JavaScript array. const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues(); Logger.log(values[0][0]);
Date הוא לא פרמטר חוקי. הפונקציה getValues() לא מחזירה נתונים לאפליקציית אינטרנט אם הטווח מכיל תא עם ערך Date. במקום זאת, צריך להמיר את כל הערכים שאוחזרו מהגיליון לפרימיטיב נתמך של JavaScript, כמו Number, Boolean או String.חזרה
Object[][] – מערך דו-ממדי של ערכים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getVerticalAlignment()
הפונקציה מחזירה את היישור האנכי (למעלה/אמצע/למטה) של התא בפינה הימנית העליונה של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getVerticalAlignment());
חזרה
String — היישור האנכי של הטקסט בתא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getVerticalAlignments()
מחזירה את היישור האנכי של התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getVerticalAlignments(); for (const i in results) { for (const j in results[i]) { Logger.log(results[i][j]); } }
חזרה
String[][] — מערך דו-ממדי של יישור אנכי של טקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getWidth()
הפונקציה מחזירה את רוחב הטווח בעמודות.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the width of the range in number of columns and logs it to the console. console.log(range.getWidth());
חזרה
Integer – מספר העמודות בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getWrap()
הפונקציה מחזירה את הערך true אם הטקסט בתא מופיע בשורות נפרדות, אחרת היא מחזירה את הערך false. כדי לקבל אסטרטגיית גלישת טקסט מפורטת יותר, משתמשים ב-getWrapStrategy().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.getWrap());
חזרה
Boolean – אם הטקסט בתא הזה גולש או לא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getWrapStrategies()
הפונקציה מחזירה את אסטרטגיות גלישת הטקסט בתאים בטווח.
// Get the text wrapping strategies for all cells in range B5:C6 const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B5:C6'); const strategies = range.getWrapStrategies(); for (let i = 0; i < strategies.length; i++) { for (let j = 0; j < strategies[i].length; j++) { Logger.log(strategies[i][j]); } }
חזרה
WrapStrategy[][] — מערך דו-ממדי של אסטרטגיות לגלישת טקסט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getWrapStrategy()
הפונקציה מחזירה את אסטרטגיית גלישת הטקסט של התא הימני העליון בטווח.
// Get the text wrapping strategy of cell B1. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B1:D4'); Logger.log(range.getWrapStrategy());
חזרה
WrapStrategy — אסטרטגיית גלישת הטקסט של התא הימני העליון בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getWraps()
הפונקציה מחזירה אם הטקסט בתאים עבר גלישה. כדי לקבל אסטרטגיית גלישת טקסט מפורטת יותר, משתמשים ב-getWrapStrategies().
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); const results = range.getVerticalAlignments(); for (const i in results) { for (const j in results[i]) { const isWrapped = results[i][j]; if (isWrapped) { Logger.log('Cell [%s, %s] has wrapped text', i, j); } } }
חזרה
Boolean[][] — מערך דו-ממדי של יישור אנכי של טקסט שמשויך לתאים בטווח.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insertCells(shiftDimension)
הוספת תאים ריקים לטווח הזה. התאים החדשים שומרים על העיצוב של התאים שהיו בטווח הזה קודם. הנתונים הקיימים בגיליון לאורך המאפיין שצוין מוזזים מהטווח שהוסיפו.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D10'); range.insertCells(SpreadsheetApp.Dimension.COLUMNS);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
shift | Dimension | המאפיין שלפיו יזוזו הנתונים הקיימים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes()
הפונקציה מוסיפה תיבות סימון לכל תא בטווח, עם הערך true אם התיבה מסומנת ועם הערך false אם היא לא מסומנת. מגדירה את הערך של כל התאים בטווח ל-false.
const range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'true' // for checked and 'false' for unchecked. Also, sets the value of each cell in // the range A1:B10 to 'false'. range.insertCheckboxes();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes(checkedValue)
מוסיפה תיבות סימון לכל תא בטווח, עם ערך מותאם אישית לסימון ומחרוזת ריקה לביטול הסימון. מגדירה את הערך של כל תא בטווח למחרוזת הריקה.
const range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' // for checked and the empty string for unchecked. Also, sets the value of each // cell in the range A1:B10 to // the empty string. range.insertCheckboxes('yes');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
checked | Object | הערך שמסומן בתיבת הסימון לאימות נתונים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes(checkedValue, uncheckedValue)
מוסיף תיבות סימון לכל תא בטווח, עם ערכים מותאמים אישית למצבים המסומנים והלא מסומנים. מגדירה את הערך של כל תא בטווח לערך המותאם אישית של תיבת סימון לא מסומנת.
const range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' // for checked and 'no' for unchecked. Also, sets the value of each cell in the // range A1:B10 to 'no'. range.insertCheckboxes('yes', 'no');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
checked | Object | הערך שמסומן בתיבת הסימון לאימות נתונים. |
unchecked | Object | הערך של תיבת הסימון כשהיא לא מסומנת. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isBlank()
הפונקציה מחזירה את הערך true אם הטווח ריק לחלוטין.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D4'); Logger.log(range.isBlank());
חזרה
Boolean — true אם הטווח ריק; false אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isChecked()
הפונקציה מחזירה את הערך TRUE אם כל התאים בטווח מכילים תיבת סימון מסומנת, אחרת היא מחזירה את הערך FALSE. הפונקציה מחזירה null אם חלק מהתאים מסומנים וחלק לא, או אם בחלק מהתאים אין אימות נתונים של תיבת סימון.
const range = SpreadsheetApp.getActive().getRange('A1:A3'); // Inserts checkboxes and sets each cell value to 'no' in the range A1:A3. range.insertCheckboxes('yes', 'no'); const range1 = SpreadsheetApp.getActive().getRange('A1'); range1.setValue('yes'); // Sets the value of isRange1Checked as true as it contains the checked value. const isRange1Checked = range1.isChecked(); const range2 = SpreadsheetApp.getActive().getRange('A2'); range2.setValue('no'); // Sets the value of isRange2Checked as false as it contains the unchecked // value. const isRange2Checked = range2.isChecked(); const range3 = SpreadsheetApp.getActive().getRange('A3'); range3.setValue('random'); // Sets the value of isRange3Checked as null, as it contains an invalid checkbox // value. const isRange3Checked = range3.isChecked();
חזרה
Boolean — true אם כל התאים בטווח מסומנים, false אם כל התאים בטווח לא מסומנים, או null אם חלק מהתאים לא מסומנים או אם לא מוגדר אימות נתונים של תיבת סימון.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isEndColumnBounded()
קובע אם סוף הטווח קשור לעמודה מסוימת. לדוגמה, עבור הטווחים A1:B10 או B:B, שמוגבלים לעמודות בסוף הטווח, השיטה הזו מחזירה true. עבור הטווחים 3:7 או A1:5, שמוגבלים רק לשורות מסוימות בסוף הטווח, השיטה הזו מחזירה 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the end of the range is bound to a particular column and logs // it to the console. console.log(range.isEndColumnBounded());
חזרה
Boolean — true אם סוף הטווח קשור לעמודה מסוימת; false
אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isEndRowBounded()
קובעת אם סוף הטווח קשור לשורה מסוימת. לדוגמה, עבור הטווחים A1:B10 או 3:7, שמוגבלים לשורות בסוף הטווח, השיטה הזו מחזירה true. עבור הטווחים B:B או A1:C, שמוגבלים רק לעמודות מסוימות בסוף הטווח, השיטה הזו מחזירה 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the end of the range is bound to a particular row and logs it // to the console. console.log(range.isEndRowBounded());
חזרה
Boolean — true אם סוף הטווח קשור לשורה מסוימת; false
אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isPartOfMerge()
הפונקציה מחזירה true אם התאים בטווח הנוכחי חופפים לתאים ממוזגים כלשהם.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B3'); // True if any of the cells in A1:B3 is included in a merge. const isPartOfMerge = range.isPartOfMerge();
חזרה
Boolean — true אם הטווח חופף לתאים ממוזגים כלשהם, אחרת מחזירה false.
isStartColumnBounded()
קובעת אם תחילת הטווח קשורה לעמודה מסוימת. לדוגמה, עבור הטווחים A1:B10 או B:B, שמוגבלים לעמודות בתחילת הטווח, השיטה הזו מחזירה true. עבור הטווח 3:7, שמוגבל רק לשורה בתחילת הטווח, השיטה הזו מחזירה 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the start of the range is bound to a particular column and logs // it to the console. console.log(range.isStartColumnBounded());
חזרה
Boolean — true אם תחילת הטווח קשורה לעמודה מסוימת; false
אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isStartRowBounded()
קובעת אם תחילת הטווח קשורה לשורה מסוימת. לדוגמה, עבור הטווחים A1:B10 או 3:7, שמוגבלים לשורות בתחילת הטווח, השיטה הזו מחזירה true. עבור הטווח B:B, שמוגבל רק לעמודה מסוימת בתחילת הטווח, השיטה הזו מחזירה 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the start of the range is bound to a particular row and logs it // to the console. console.log(range.isStartRowBounded());
חזרה
Boolean — true אם תחילת הטווח קשורה לשורה מסוימת; false
אחרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
merge()
ממזגת את התאים בטווח לבלוק אחד.
const sheet = SpreadsheetApp.getActiveSheet(); // The code below 2-dimensionally merges the cells in A1 to B3 sheet.getRange('A1:B3').merge();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
mergeAcross()
ממזגים את התאים בטווח לאורך העמודות של הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The code below merges cells C5:E5 into one cell const range1 = sheet.getRange('C5:E5'); range1.mergeAcross(); // The code below creates 2 horizontal cells, F5:H5 and F6:H6 const range2 = sheet.getRange('F5:H6'); range2.mergeAcross();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
mergeVertically()
ממזגת את התאים בטווח.
const sheet = SpreadsheetApp.getActiveSheet(); // The code below vertically merges the cells in A1 to A10 sheet.getRange('A1:A10').mergeVertically(); // The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10 sheet.getRange('B1:D10').mergeVertically();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
moveTo(target)
גוזרים ומדביקים (גם את הפורמט וגם את הערכים) מהטווח הזה לטווח היעד.
// The code below moves the first 5 columns over to the 6th column const sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange('A1:E').moveTo(sheet.getRange('F1'));
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
target | Range | טווח יעד להעתקת הטווח הזה. רק המיקום של התא הימני העליון רלוונטי. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
offset(rowOffset, columnOffset)
מחזירה טווח חדש שמוסט מהטווח הזה במספר נתון של שורות ועמודות (יכול להיות שלילי). הטווח החדש זהה בגודל לטווח המקורי.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1'); // newCell references B2 const newCell = cell.offset(1, 1);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
row | Integer | מספר השורות מתחת לתא הימני העליון בטווח. ערכים שליליים מייצגים שורות מעל התא הימני העליון בטווח. |
column | Integer | מספר העמודות מימין לתא הימני העליון בטווח. ערכים שליליים מייצגים עמודות משמאל לתא הימני העליון בטווח. |
חזרה
Range — הטווח הזה, לשרשור.
offset(rowOffset, columnOffset, numRows)
הפונקציה מחזירה טווח חדש שקשור לטווח הנוכחי, שהנקודה הימנית העליונה שלו מוסטת מהטווח הנוכחי לפי השורות והעמודות שצוינו, ועם הגובה שצוין בתאים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1'); // newCell references B2:B3 const newRange = cell.offset(1, 1, 2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
row | Integer | מספר השורות מתחת לתא הימני העליון בטווח. ערכים שליליים מייצגים שורות מעל התא הימני העליון בטווח. |
column | Integer | מספר העמודות מימין לתא הימני העליון בטווח. ערכים שליליים מייצגים עמודות משמאל לתא הימני העליון בטווח. |
num | Integer | הגובה בשורות של הטווח החדש. |
חזרה
Range — הטווח הזה, לשרשור.
offset(rowOffset, columnOffset, numRows, numColumns)
מחזירה טווח חדש ביחס לטווח הנוכחי, שנקודת הפינה הימנית העליונה שלו מוסטת מהטווח הנוכחי במספר השורות והעמודות שצוין, ועם הגובה והרוחב שצוינו בתאים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1'); // newCell references B2:C3 const newRange = cell.offset(1, 1, 2, 2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
row | Integer | מספר השורות מתחת לתא הימני העליון בטווח. ערכים שליליים מייצגים שורות מעל התא הימני העליון בטווח. |
column | Integer | מספר העמודות מימין לתא הימני העליון בטווח. ערכים שליליים מייצגים עמודות משמאל לתא הימני העליון בטווח. |
num | Integer | הגובה בשורות של הטווח החדש. |
num | Integer | רוחב הטווח החדש בעמודות. |
חזרה
Range — הטווח הזה, לשרשור.
protect()
יוצר אובייקט שיכול להגן על הטווח מפני עריכה, למעט משתמשים שיש להם הרשאה. עד שהסקריפט ישנה בפועל את רשימת העורכים של הטווח (על ידי קריאה של Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) או הגדרה של ערך חדש ל-Protection.setDomainEdit(editable)), ההרשאות משקפות את ההרשאות של הגיליון האלקטרוני עצמו, מה שאומר למעשה שהטווח נשאר לא מוגן. אם הטווח כבר מוגן, השיטה הזו יוצרת טווח תאים מוגן חדש שחופף לטווח הקיים. אם תא מוגן על ידי כמה טווחים מוגנים, ואחד מהם מונע ממשתמש מסוים לערוך את התא, אז המשתמש הזה לא יכול לערוך את התא.
// Protect range A1:B10, then remove all other users from the list of editors. const ss = SpreadsheetApp.getActive(); const range = ss.getRange('A1:B10'); const protection = range.protect().setDescription('Sample protected range'); // Ensure the current user is an editor before removing others. Otherwise, if // the user's edit permission comes from a group, the script throws an exception // upon removing the group. const me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
חזרה
Protection – אובייקט שמייצג את הגדרות ההגנה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
randomize()
הפונקציה קובעת באופן אקראי את סדר השורות בטווח הנתון.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:C7'); // Randomizes the range range.randomize();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
removeCheckboxes()
מסיר את כל תיבות הסימון מהטווח. מנקה את אימות הנתונים של כל תא, ובנוסף מנקה את הערך שלו אם התא מכיל את הערך המסומן או הלא מסומן.
const range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes and sets each cell value to 'no' in the range A1:B10. range.insertCheckboxes('yes', 'no'); const range1 = SpreadsheetApp.getActive().getRange('A1'); range1.setValue('yes'); // Removes the checkbox data validation in cell A1 and clears its value. range1.removeCheckboxes(); const range2 = SpreadsheetApp.getActive().getRange('A2'); range2.setValue('random'); // Removes the checkbox data validation in cell A2 but does not clear its value. range2.removeCheckboxes();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
removeDuplicates()
מסירה שורות בטווח הזה שמכילות ערכים שהם כפולים של ערכים בשורה קודמת כלשהי. שורות שזהות זו לזו בערכים אך לא בסוג האותיות, בעיצוב או בנוסחאות נחשבות עדיין לכפולים. בנוסף, השיטה הזו מסירה שורות כפולות שמוסתרות מהתצוגה (לדוגמה, בגלל מסנן). תוכן שנמצא מחוץ לטווח הזה לא יוסר.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B1:D7'); // Remove duplicate rows in the range. range.removeDuplicates();
חזרה
Range — הטווח שמתקבל אחרי הסרת הכפילויות. גודל הטווח קטן בשורה אחת על כל שורה שמוסרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
removeDuplicates(columnsToCompare)
הפעולה מסירה שורות בטווח הזה שמכילות ערכים בעמודות שצוינו שהם כפולים של ערכים בשורה קודמת כלשהי. שורות שזהות זו לזו בערכים אך לא בסוג האותיות, בעיצוב או בנוסחאות נחשבות עדיין לכפולים. בנוסף, השיטה הזו מסירה שורות כפולות שמוסתרות מהתצוגה (לדוגמה, בגלל מסנן). תוכן שנמצא מחוץ לטווח הזה לא יוסר.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B1:D7'); // Remove rows which have duplicate values in column B. range.removeDuplicates([2]); // Remove rows which have duplicate values in both columns B and D. range.removeDuplicates([2, 4]);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
columns | Integer[] | העמודות שייבדקו לגבי ערכים כפולים. אם לא מציינים עמודות אז כל העמודות נבדקות כדי למצוא כפילויות. |
חזרה
Range — הטווח שמתקבל אחרי הסרת הכפילויות. גודל הטווח מצטמצם בשורה אחת על כל שורה שמוסרת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackground(color)
מגדיר את צבע הרקע של כל התאים בטווח בסימון CSS (למשל '#ffffff'
או 'white').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('B2:D5'); range.setBackground('red');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | String | קוד צבע בסימון CSS (למשל '#ffffff' או 'white'); ערך של null מאפס את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundObject(color)
הגדרת צבע הרקע של כל התאים בטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const bgColor = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND) .build(); const range = sheet.getRange('B2:D5'); range.setBackgroundObject(bgColor);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | Color | צבע הרקע שרוצים להגדיר. הערך null מאפס את צבע הרקע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundObjects(color)
הגדרת רשת מלבנית של צבעי רקע (צריכה להתאים לממדים של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const colorAccent1 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); const colorAccent2 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2) .build(); const colorAccent3 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3) .build(); const colorAccent4 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4) .build(); const colors = [ [colorAccent1, colorAccent2], [colorAccent3, colorAccent4], ]; const cell = sheet.getRange('B5:C6'); cell.setBackgroundObjects(colors);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | Color[][] | מערך דו-ממדי של צבעים. ערכי null מאפסים את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundRGB(red, green, blue)
הגדרת הרקע לצבע שצוין באמצעות ערכי RGB (מספרים שלמים בין 0 ל-255, כולל).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); // Sets the background to white cell.setBackgroundRGB(255, 255, 255); // Sets the background to red cell.setBackgroundRGB(255, 0, 0);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
red | Integer | הערך של האדום בסימון RGB. |
green | Integer | הערך הירוק בסימון RGB. |
blue | Integer | הערך של הכחול בסימון RGB. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgrounds(color)
הגדרת רשת מלבנית של צבעי רקע (צריכה להתאים לממדים של הטווח הזה). הצבעים
מוצגים בסימון CSS (למשל '#ffffff' או 'white').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const colors = [ ['red', 'white', 'blue'], ['#FF0000', '#FFFFFF', '#0000FF'], // These are the hex equivalents ]; const cell = sheet.getRange('B5:D6'); cell.setBackgrounds(colors);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | String[][] | מערך דו-ממדי של צבעים בסימון CSS (למשל '#ffffff' או
'white'); ערכים של null מאפסים את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBorder(top, left, bottom, right, vertical, horizontal)
הגדרת מאפיין הגבול. הערכים התקינים הם true (מופעל), false (מושבת) ו-null (ללא שינוי).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); // Sets borders on the top and bottom, but leaves the left and right unchanged cell.setBorder(true, null, true, null, false, false);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
top | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
left | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
bottom | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
right | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
vertical | Boolean | true לגבולות אנכיים פנימיים, false ללא גבולות, null ללא שינוי. |
horizontal | Boolean | true לגבולות אופקיים פנימיים, false ללא גבולות, null ללא שינוי. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBorder(top, left, bottom, right, vertical, horizontal, color, style)
מגדיר את מאפיין הגבול עם צבע ו/או סגנון. הערכים התקינים הם true (מופעל), false (מושבת) ו-null (ללא שינוי). לצבע, משתמשים בסימון צבע ב-CSS (למשל '#ffffff' או 'white').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); // Sets borders on the top and bottom, but leaves the left and right unchanged // Also sets the color to "red", and the border to "DASHED". cell.setBorder( true, null, true, null, false, false, 'red', SpreadsheetApp.BorderStyle.DASHED, );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
top | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
left | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
bottom | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
right | Boolean | true לגבול, false ללא גבול, null ללא שינוי. |
vertical | Boolean | true לגבולות אנכיים פנימיים, false ללא גבולות, null ללא שינוי. |
horizontal | Boolean | true לגבולות אופקיים פנימיים, false ללא גבולות, null ללא שינוי. |
color | String | צבע בסימון CSS (למשל '#ffffff' או 'white'), null לצבע ברירת מחדל (שחור). |
style | Border | סגנון לגבולות, null לסגנון ברירת המחדל (אחיד). |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setDataValidation(rule)
מגדירה כלל אחד לאימות נתונים לכל התאים בטווח.
// Set the data validation rule for cell A1 to require a value from B1:B10. const cell = SpreadsheetApp.getActive().getRange('A1'); const range = SpreadsheetApp.getActive().getRange('B1:B10'); const rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build(); cell.setDataValidation(rule);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
rule | Data | כלל אימות הנתונים שרוצים להגדיר, או null כדי להסיר את אימות הנתונים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setDataValidations(rules)
מגדירה את כללי אימות הנתונים לכל התאים בטווח. השיטה הזו מקבלת מערך דו-ממדי של אימותי נתונים, שממוינים לפי שורה ואז לפי עמודה. המידות של המערך צריכות להתאים למידות של הטווח.
// Set the data validation rules for Sheet1!A1:B5 to require a value from // Sheet2!A1:A10. const destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5'); const sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10'); const rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build(); const rules = destinationRange.getDataValidations(); for (let i = 0; i < rules.length; i++) { for (let j = 0; j < rules[i].length; j++) { rules[i][j] = rule; } } destinationRange.setDataValidations(rules);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
rules | Data | מערך דו-ממדי של כללים לאימות נתונים להגדרה; null ערכים
מסירים אימות נתונים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontColor(color)
הגדרת צבע הגופן בסימון CSS (למשל '#ffffff' או 'white').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontColor('red');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | String | צבע הגופן בסימון CSS (למשל '#ffffff' או 'white'); ערך של null מאפס את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontColorObject(color)
הגדרת צבע הגופן של הטווח הנתון.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT) .build(); const cell = sheet.getRange('B2'); cell.setFontColor(color);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | Color | צבע הגופן שרוצים להגדיר. ערך של null מאפס את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontColorObjects(colors)
מגדיר רשת מלבנית של צבעי גופן (חייב להתאים לממדים של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const colorAccent1 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); const colorAccent2 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2) .build(); const colorAccent3 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3) .build(); const colorAccent4 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4) .build(); const colors = [ [colorAccent1, colorAccent2], [colorAccent3, colorAccent4], ]; const cell = sheet.getRange('B5:C6'); cell.setFontColorObjects(colors);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
colors | Color[][] | מערך דו-ממדי של צבעים. ערכים של null מאפסים את צבע הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontColors(colors)
מגדיר רשת מלבנית של צבעי גופן (חייב להתאים לממדים של הטווח הזה). הצבעים הם בסימון CSS (למשל '#ffffff' או 'white').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const colors = [ ['red', 'white', 'blue'], ['#FF0000', '#FFFFFF', '#0000FF'], // These are the hex equivalents ]; const cell = sheet.getRange('B5:D6'); cell.setFontColors(colors);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
colors | Object[][] | מערך דו-ממדי של צבעים בסימון CSS (למשל '#ffffff' או
'white'); ערכים של null מאפסים את הצבע. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontFamilies(fontFamilies)
הגדרת רשת מלבנית של משפחות גופנים (צריך להתאים את המידות לטווח הזה). דוגמאות למשפחות גופנים: Arial או Helvetica.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const fonts = [ ['Arial', 'Helvetica', 'Verdana'], ['Courier New', 'Arial', 'Helvetica'], ]; const cell = sheet.getRange('B2:D3'); cell.setFontFamilies(fonts);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | Object[][] | מערך דו-ממדי של משפחות גופנים; ערכי null מאפסים את משפחת הגופנים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontFamily(fontFamily)
הגדרת משפחת הגופנים, כמו Arial או Helvetica.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontFamily('Helvetica');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | String | משפחת הגופנים להגדרה. ערך של null מאפס את משפחת הגופנים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontLine(fontLine)
מגדיר את סגנון הקו של הגופן בטווח הנתון ('underline', 'line-through' או 'none').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontLine('line-through');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | String | סגנון הקו של הגופן, 'underline', 'line-through' או 'none'. ערך של null מאפס את סגנון הקו של הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontLines(fontLines)
מגדיר רשת מלבנית של סגנונות קווים (חייב להתאים לממדים של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const fontLines = [['underline', 'line-through', 'none']]; const range = sheet.getRange('B2:D2'); range.setFontLines(fontLines);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | Object[][] | מערך דו-ממדי של סגנונות קו בגופן ('underline', 'line-through' או 'none'); ערכי null מאפסים את סגנון הקו בגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontSize(size)
הגדרת גודל הגופן, כאשר הגודל הוא גודל הנקודה שבה יש להשתמש.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontSize(20);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
size | Integer | גודל הגופן בנקודות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontSizes(sizes)
מגדיר רשת מלבנית של גדלי גופן (חייב להתאים לממדים של הטווח הזה). הגודל מצוין בנקודות.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const fontSizes = [[16, 20, 24]]; const range = sheet.getRange('B2:D2'); range.setFontSizes(fontSizes);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
sizes | Object[][] | מערך דו-ממדי של גדלים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontStyle(fontStyle)
הגדרת סגנון הגופן לטווח הנתון ('italic' או 'normal').
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontStyle('italic');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | String | סגנון הגופן, 'italic' או 'normal'. הערך null מאפס את סגנון הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontStyles(fontStyles)
מגדיר רשת מלבנית של סגנונות גופן (חייב להתאים לממדים של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const fontStyles = [['italic', 'normal']]; const range = sheet.getRange('B2:C2'); range.setFontStyles(fontStyles);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | Object[][] | מערך דו-ממדי של סגנונות גופן, 'italic' או 'normal'. ערכים של null מאפסים את סגנון הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontWeight(fontWeight)
הגדרת עובי הגופן לטווח הנתון (רגיל/מודגש).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setFontWeight('bold');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | String | עובי הגופן, 'bold' או 'normal'. ערך של null
מאפס את עובי הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFontWeights(fontWeights)
מגדיר רשת מלבנית של עובי הגופן (חייב להתאים לממדים של הטווח הזה). דוגמה למשקל גופן היא bold (מודגש).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const fontStyles = [['bold', 'bold', 'normal']]; const range = sheet.getRange('B2:D2'); range.setFontWeights(fontStyles);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
font | Object[][] | מערך דו-ממדי של משקלי גופן, 'bold' או 'normal'; ערכים של null מאפסים את משקל הגופן. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFormula(formula)
מעדכנת את הנוסחה של הטווח הזה. הנוסחה שצוינה חייבת להיות בסימון A1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B5'); cell.setFormula('=SUM(B3:B4)');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
formula | String | מחרוזת שמייצגת את הנוסחה להגדרה בתא. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFormulaR1C1(formula)
מעדכנת את הנוסחה של הטווח הזה. הנוסחה שצוינה חייבת להיות בסימון R1C1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B5'); // This sets the formula to be the sum of the 3 rows above B5 cell.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
formula | String | נוסחה של מחרוזת. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFormulas(formulas)
מגדיר רשת מלבנית של נוסחאות (חייב להתאים לממדים של הטווח הזה). הנוסחאות שצוינו צריכות להיות בסימון A1. השיטה הזו מקבלת מערך דו-מימדי של נוסחאות, שממוספרות לפי שורה ואז לפי עמודה. מידות המערך צריכות להתאים למידות הטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This sets the formulas to be a row of sums, followed by a row of averages // right below. The size of the two-dimensional array must match the size of the // range. const formulas = [ ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'], ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'], ]; const cell = sheet.getRange('B5:D6'); cell.setFormulas(formulas);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
formulas | String[][] | מערך מחרוזות דו-ממדי של נוסחאות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFormulasR1C1(formulas)
מגדיר רשת מלבנית של נוסחאות (חייב להתאים לממדים של הטווח הזה). הנוסחאות שצוינו צריכות להיות בסימון R1C1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This creates formulas for a row of sums, followed by a row of averages. const sumOfRowsAbove = '=SUM(R[-3]C[0]:R[-1]C[0])'; const averageOfRowsAbove = '=AVERAGE(R[-4]C[0]:R[-2]C[0])'; // The size of the two-dimensional array must match the size of the range. const formulas = [ [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove], [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove], ]; const cell = sheet.getRange('B5:D6'); // This sets the formula to be the sum of the 3 rows above B5. cell.setFormulasR1C1(formulas);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
formulas | String[][] | מערך דו-ממדי של נוסחאות בפורמט R1C1. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setHorizontalAlignment(alignment)
הגדרת היישור האופקי (משמאל לימין) לטווח הנתון (שמאל/מרכז/ימין).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setHorizontalAlignment('center');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignment | String | ההיערכות, 'left', 'center' או 'normal'. הערך null מאפס את ההיערכות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setHorizontalAlignments(alignments)
הגדרת רשת מלבנית של יישורים אופקיים. ראו setHorizontalAlignment(alignment)
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const horizontalAlignments = [['left', 'right', 'center']]; const range = sheet.getRange('B2:D2'); range.setHorizontalAlignments(horizontalAlignments);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignments | Object[][] | מערך דו-ממדי של יישור, 'left', 'center' או 'normal'; ערך של null מאפס את היישור. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
setNote(note)
מגדיר את ההערה לערך שצוין.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setNote('This is a note');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
note | String | ערך ההערה שרוצים להגדיר לטווח. ערך של null מסיר את ההערה. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setNotes(notes)
מגדיר רשת מלבנית של הערות (חייב להתאים לממדים של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const notes = [ ['it goes', 'like this', 'the fourth, the fifth'], ['the minor fall', 'and the', 'major lift'], ]; const cell = sheet.getRange('B2:D3'); cell.setNotes(notes);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
notes | Object[][] | מערך דו-ממדי של הערות. ערכים של null מסירים את ההערה. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
setNumberFormat(numberFormat)
מגדירה את הפורמט של המספר או התאריך למחרוזת הפורמט שצוינה. תבניות הפורמט הקבילות מתוארות במאמרי העזרה של ה-Sheets API.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); // Always show 3 decimal points cell.setNumberFormat('0.000');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
number | String | מחרוזת של פורמט מספרים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setNumberFormats(numberFormats)
מגדיר רשת מלבנית של פורמטים של מספרים או תאריכים (חייב להתאים לממדים של הטווח הזה). הערכים הם מחרוזות של דפוסי פורמט, כפי שמתואר ב מסמכי ה-API של Sheets.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const formats = [['0.000', '0,000,000', '$0.00']]; const range = sheet.getRange('B2:D2'); range.setNumberFormats(formats);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
number | Object[][] | מערך דו-ממדי של פורמטים של מספרים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setRichTextValue(value)
מגדירה את הערך של הטקסט העשיר לתאים בטווח.
// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" // bolded. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B2:D4'); const bold = SpreadsheetApp.newTextStyle().setBold(true).build(); const richText = SpreadsheetApp.newRichTextValue() .setText('Hello world') .setTextStyle(0, 5, bold) .build(); range.setRichTextValue(richText);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
value | Rich | הערך הרצוי של טקסט עשיר. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setRichTextValues(values)
מגדירה רשת מלבנית של ערכי טקסט עשיר.
// Sets the cells in range A1:A2 to have Rich Text values. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:A2'); const bold = SpreadsheetApp.newTextStyle().setBold(true).build(); const italic = SpreadsheetApp.newTextStyle().setItalic(true).build(); const richTextA1 = SpreadsheetApp.newRichTextValue() .setText('This cell is bold') .setTextStyle(bold) .build(); const richTextA2 = SpreadsheetApp.newRichTextValue() .setText('bold words, italic words') .setTextStyle(0, 11, bold) .setTextStyle(12, 24, italic) .build(); range.setRichTextValues([[richTextA1], [richTextA2]]);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
values | Rich | הערכים הרצויים של טקסט עשיר. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setShowHyperlink(showHyperlink)
הגדרה שקובעת אם להציג היפר-קישורים בטווח או לא.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A30 and sets its hyperlink value. const range = sheet.getRange('A30'); range.setValue('https://www.example.com'); // Sets cell A30 to show hyperlinks. range.setShowHyperlink(true);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
show | Boolean | האם להציג את ההיפר-קישור. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextDirection(direction)
הגדרת כיוון הטקסט בתאים בטווח. אם הכיוון שצוין הוא null,
המערכת מסיקה את הכיוון ואז מגדירה אותו.
// Sets right-to-left text direction for the range. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B5:C6'); range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
direction | Text | כיוון הטקסט הרצוי. אם null הכיוון מוסק לפני ההגדרה. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextDirections(directions)
מגדירה רשת מלבנית של כיווני טקסט. אם הכיוון שצוין הוא null, הכיוון מוסק ואז מוגדר.
// Copies all of the text directions from range A1:B2 over to range C5:D6. const sheet = SpreadsheetApp.getActiveSheet(); const range1 = sheet.getRange('A1:B2'); const range2 = sheet.getRange('C5:D6'); range2.setTextRotations(range1.getTextDirections());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
directions | Text | כיווני הטקסט הרצויים. אם הכיוון שצוין הוא null, המערכת מסיקה את הכיוון לפני ההגדרה. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextRotation(degrees)
הגדרת סיבוב הטקסט בתאים בטווח. הקלט תואם לזווית בין כיוון הטקסט הרגיל לבין הכיוון הרצוי. קלט של אפס מציין שהטקסט מוגדר לכיוון הרגיל.
בכיוון טקסט משמאל לימין, זוויות חיוביות הן בכיוון נגד השעון, ובכיוון טקסט מימין לשמאל, הן בכיוון השעון.
// Sets all cell's in range B2:D4 to have text rotated up 45 degrees. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B2:D4'); range.setTextRotation(45);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
degrees | Integer | הזווית הרצויה בין הכיוון הרגיל לבין הכיוון הרצוי. בטקסט משמאל לימין, זוויות חיוביות הן בכיוון נגד השעון. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextRotation(rotation)
הגדרת סיבוב הטקסט בתאים בטווח.
// Sets all cell's in range B2:D4 to have the same text rotation settings as // cell A1. const sheet = SpreadsheetApp.getActiveSheet(); const rotation = sheet.getRange('A1').getTextRotation(); sheet.getRange('B2:D4').setTextRotation(rotation);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
rotation | Text | הגדרות סיבוב הטקסט הרצויות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextRotations(rotations)
הגדרת רשת מלבנית של סיבובי טקסט.
// Copies all of the text rotations from range A1:B2 over to range C5:D6. const sheet = SpreadsheetApp.getActiveSheet(); const range1 = sheet.getRange('A1:B2'); const range2 = sheet.getRange('C5:D6'); range2.setTextRotations(range1.getTextRotations());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
rotations | Text | הגדרות סיבוב הטקסט הרצויות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextStyle(style)
הגדרת סגנון הטקסט של התאים בטווח.
// Sets the cells in range C5:D6 to have underlined size 15 font. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('C5:D6'); const style = SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build(); range.setTextStyle(style);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
style | Text | סגנון הטקסט הרצוי. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTextStyles(styles)
מגדיר רשת מלבנית של סגנונות טקסט.
// Sets text styles for cells in range A1:B2 const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:B2'); const bold = SpreadsheetApp.newTextStyle().setBold(true).build(); const otherStyle = SpreadsheetApp.newTextStyle() .setBold(true) .setUnderline(true) .setItalic(true) .setForegroundColor('#335522') .setFontSize(44) .build(); range.setTextStyles([ [bold, otherStyle], [otherStyle, bold], ]);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
styles | Text | סגנונות הטקסט הרצויים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setValue(value)
הגדרת הערך של הטווח. הערך יכול להיות מספרי, מחרוזת, בוליאני או תאריך. אם הוא מתחיל ב-'=', הוא יפורש כנוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setValue(100);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
value | Object | הערך של הטווח. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setValues(values)
מגדיר רשת מלבנית של ערכים (חייב להתאים לממדים של הטווח הזה). אם ערך מתחיל ב-=, המערכת מפרשת אותו כנוסחה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const values = [['2.000', '1,000,000', '$2.99']]; const range = sheet.getRange('B2:D2'); range.setValues(values);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
values | Object[][] | מערך דו-ממדי של ערכים. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setVerticalAlignment(alignment)
הגדרת היישור האנכי (מלמעלה למטה) לטווח הנתון (למעלה/באמצע/למטה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setVerticalAlignment('middle');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignment | String | ההיערכות, 'top', 'middle' או 'bottom'. הערך null מאפס את ההיערכות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setVerticalAlignments(alignments)
הגדרת רשת מלבנית של יישור אנכי (חייבת להתאים למידות של הטווח הזה).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const alignments = [['top', 'middle', 'bottom']]; const range = sheet.getRange('B2:D2'); range.setVerticalAlignments(alignments);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignments | Object[][] | מערך דו-ממדי של יישור, 'top', 'middle' או 'bottom'. ערך של null מאפס את היישור. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
setVerticalText(isVertical)
הגדרה של האפשרות להציג את הטקסט בתאים בטווח אחד מעל השני. אם הטקסט מוערם אנכית, המערכת מתעלמת מההגדרה של סיבוב הטקסט במעלות.
// Sets all cell's in range B2:D4 to have vertically stacked text. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B2:D4'); range.setVerticalText(true);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
is | Boolean | האם להציג את הטקסט בשורה אחת או בשתי שורות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setWrap(isWrapEnabled)
מגדירים את גלישת הטקסט בתאים בטווח הנתון.
תאים שהאפשרות 'הוספת גלישת טקסט' מופעלת בהם (ברירת המחדל) משנים את הגודל שלהם כדי להציג את התוכן המלא. בתאים שבהם ההגדרה 'גלישת טקסט' מושבתת, מוצג כמה שיותר מהטקסט בתא בלי לשנות את הגודל או להציג את הטקסט בכמה שורות.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const cell = sheet.getRange('B2'); cell.setWrap(true);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
is | Boolean | האם להחיל גלישת טקסט או לא. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setWrapStrategies(strategies)
מגדירה רשת מלבנית של אסטרטגיות גלישת טקסט.
// Copies all of the wrap strategies from range A1:B2 over to range C5:D6. const sheet = SpreadsheetApp.getActiveSheet(); const range1 = sheet.getRange('A1:B2'); const range2 = sheet.getRange('C5:D6'); range2.setWrapStrategies(range1.getWrapStrategies());
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
strategies | Wrap | אסטרטגיות הגלישה הרצויות. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setWrapStrategy(strategy)
הגדרת אסטרטגיית גלישת הטקסט בתאים בטווח.
// Sets all cells in range B2:D4 to use the clip wrap strategy. const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('B2:D4'); range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
strategy | Wrap | אסטרטגיית הגלישה הרצויה. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setWraps(isWrapEnabled)
מגדיר רשת מלבנית של מדיניות גלישת מילים (חייבת להתאים לממדים של הטווח הזה). תאים עם האפשרות 'גלישת טקסט' מופעלת (ברירת המחדל) משנים את הגודל שלהם כדי להציג את התוכן המלא. בתאים שבהם ההגדרה 'התאמה אוטומטית של גובה השורה' מושבתת, מוצג כמה שיותר תוכן בתא בלי לשנות את הגודל שלו או להציג את התוכן בכמה שורות.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. const wraps = [[true, true, false]]; const range = sheet.getRange('B2:D2'); range.setWraps(wraps);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
is | Object[][] | מערך דו-ממדי של משתני גלישה שקובעים אם הטקסט בתא יגלוש או לא. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
ראה גם
shiftColumnGroupDepth(delta)
הפונקציה משנה את עומק הקיבוץ של העמודות בטווח בסכום שצוין.
הפעולה הזו יוצרת, משנה או מוחקת קבוצות שחופפות לטווח. במקרה של דלתאות חיוביות, הקבוצות נוצרות או משתנות. במקרה של דלתאות שליליות, הקבוצות נמחקות או משתנות.
ההגדרה הזו לא משפיעה על הקטנת עומק הקבוצה מתחת לאפס או מעל שמונה.
אם הערך של column group control position הוא
BEFORE, תופיע שגיאה כשמנסים להזיז את העומק של השורה הראשונה.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getActiveRange(); // The column grouping depth is increased by 1. range.shiftColumnGroupDepth(1); // The column grouping depth is decreased by 1. range.shiftColumnGroupDepth(-1);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
delta | Integer | הערך שבו רוצים לשנות את העומק של קבוצת העמודות בטווח הזה. |
חזרה
Range — הטווח הזה, לשרשור.
מקפיצה את הודעות השגיאה (Throws)
Error — כשמנסים לשנות את העומק של העמודה הראשונה כשמיקום אמצעי הבקרה הוא GroupControlTogglePosition.BEFORE
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
shiftRowGroupDepth(delta)
הפונקציה משנה את עומק הקיבוץ של השורות בטווח בסכום שצוין.
הפעולה הזו יוצרת, משנה או מוחקת קבוצות שחופפות לטווח. במקרה של דלתאות חיוביות, הקבוצות נוצרות או משתנות. במקרה של דלתאות שליליות, הקבוצות נמחקות או משתנות.
ההגדרה הזו לא משפיעה על הקטנת עומק הקבוצה מתחת לאפס או מעל שמונה.
אם הערך של row group control position הוא BEFORE, תופיע שגיאה כשמנסים להזיז את העומק של השורה הראשונה.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getActiveRange(); // The row grouping depth is increased by 1. range.shiftRowGroupDepth(1); // The row grouping depth is decreased by 1. range.shiftRowGroupDepth(-1);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
delta | Integer | הערך שבו יש לשנות את העומק של קבוצת השורות בטווח הזה. |
חזרה
Range — הטווח הזה, לשרשור.
מקפיצה את הודעות השגיאה (Throws)
Error – כשמנסים לשנות את העומק של השורה הראשונה כשמיקום הפקד הוא GroupControlTogglePosition.BEFORE
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
sort(sortSpecObj)
ממיינת את התאים בטווח הנתון לפי העמודה והסדר שצוינו.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:C7'); // Sorts by the values in the first column (A) range.sort(1); // Sorts by the values in the second column (B) range.sort(2); // Sorts descending by column B range.sort({column: 2, ascending: false}); // Sorts descending by column B, then ascending by column A // Note the use of an array range.sort([ {column: 2, ascending: false}, {column: 1, ascending: true}, ]); // For rows that are sorted in ascending order, the "ascending" parameter is // optional, and just an integer with the column can be used instead. Note that // in general, keeping the sort specification consistent results in more // readable code. You can express the earlier sort as: range.sort([{column: 2, ascending: false}, 1]); // Alternatively, if you want all columns to be in ascending order, you can use // the following (this makes column 2 ascending) range.sort([2, 1]); // ... which is equivalent to range.sort([ {column: 2, ascending: true}, {column: 1, ascending: true}, ]);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
sort | Object | העמודות שלפיהן יבוצע המיון. |
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns()
מפצלת עמודת טקסט לכמה עמודות על סמך מפריד שזוהה אוטומטית.
// A1:A3 has the following values: // A B C // 1 |one,one,one | | | // 2 |two,two,two | | | // 3 |three,three,three| | | const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3'); range.splitTextToColumns(); // Result after splitting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns(delimiter)
מפצלת עמודת טקסט לכמה עמודות באמצעות המחרוזת שצוינה כמפריד בהתאמה אישית.
// A1:A3 has the following values: // A B C // 1 |one#one#one | | | // 2 |two#two#two | | | // 3 |three#three#three| | | const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3'); range.splitTextToColumns('#'); // Result after splitting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
delimiter | String | המפריד המותאם אישית שלפיו יתבצע הפיצול. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns(delimiter)
מפצלת עמודת טקסט לכמה עמודות על סמך התו המפריד שצוין.
// A1:A3 has the following values: // A B C // 1 |one;one;one | | | // 2 |two;two;two | | | // 3 |three;three;three| | | const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3'); range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON); // Result after splitting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
delimiter | Text | התו המפריד שמוגדר מראש לפיצול. |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
trimWhitespace()
מסירה את הרווחים הלבנים (כמו רווחים, טאבים או שורות חדשות) בכל תא בטווח הזה. הפונקציה מסירה את כל הרווחים הלבנים מתחילת הטקסט בכל תא ומסופו, ומצמצמת כל רצף של רווחים שנותרו לרווח בודד.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; const range = sheet.getRange('A1:A4'); range.activate(); range.setValues([ ' preceding space', 'following space ', 'two middle spaces', ' =SUM(1,2)', ]); range.trimWhitespace(); const values = range.getValues(); // Values are ['preceding space', 'following space', 'two middle spaces', // '=SUM(1,2)']
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
uncheck()
משנה את המצב של תיבות הסימון בטווח ל'לא מסומן'. הפונקציה מתעלמת מהתאים בטווח שלא מכילים כרגע את הערך המסומן או הלא מסומן שהוגדר.
// Changes the state of cells which currently contain either the checked or // unchecked value configured in the range A1:B10 to 'unchecked'. const range = SpreadsheetApp.getActive().getRange('A1:B10'); range.uncheck();
חזרה
Range — הטווח הזה, לשרשור.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets