Class Range

Range

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
activate()Rangeהפונקציה מגדירה את הטווח שצוין בתור active range, והתא הימני העליון בטווח בתור current cell.
activateAsCurrentCell()Rangeהגדרת התא שצוין כ-current cell.
addDeveloperMetadata(key)Rangeהוספת מטא-נתונים של מפתח עם המפתח שצוין לטווח.
addDeveloperMetadata(key, visibility)Rangeהוספת מטא-נתונים של מפתח עם המפתח והחשיפה שצוינו לטווח.
addDeveloperMetadata(key, value)Rangeהוספת מטא-נתונים של מפתח עם המפתח והערך שצוינו לטווח.
addDeveloperMetadata(key, value, visibility)Rangeהוספת מטא-נתונים של מפתח עם המפתח, הערך והחשיפה שצוינו לטווח.
applyColumnBanding()Bandingהחלת עיצוב ברירת מחדל של חלוקה לעמודות על הטווח.
applyColumnBanding(bandingTheme)Bandingהחלת עיצוב פס עמודות ספציפי על הטווח.
applyColumnBanding(bandingTheme, showHeader, showFooter)Bandingהפונקציה מחילה על הטווח עיצוב של פס עמודות שצוין, עם הגדרות כותרת ותחתית ספציפיות.
applyRowBanding()Bandingהחלת עיצוב ברירת מחדל של קיבוץ שורות על הטווח.
applyRowBanding(bandingTheme)Bandingהחלת עיצוב נתון של פס כותרת על השורות בטווח.
applyRowBanding(bandingTheme, showHeader, showFooter)Bandingהחלת עיצוב ספציפי של פס כותרת בשורות על הטווח עם הגדרות ספציפיות של כותרת עליונה ותחתונה.
autoFill(destination, series)voidמילוי השדה destinationRange בנתונים על סמך הנתונים בטווח הזה.
autoFillToNeighbor(series)voidהפונקציה מחשבת טווח שרוצים למלא בנתונים חדשים על סמך תאים שכנים, וממלאת את הטווח הזה בערכים חדשים באופן אוטומטי על סמך הנתונים שמכיל הטווח הזה.
breakApart()Rangeמחלקים שוב את התאים בטווח שיש בהם כמה עמודות לתאים נפרדים.
canEdit()Booleanהפונקציה קובעת אם למשתמש יש הרשאה לערוך כל תא בטווח.
check()Rangeשינוי המצב של תיבות הסימון בטווח ל'מסומנות'.
clear()Rangeמחיקת מגוון התוכן והפורמטים.
clear(options)Rangeמחיקת טווח התוכן, הפורמט, כללי אימות הנתונים ו/או התגובות, כפי שצוין באפשרויות המתקדמות הנתונות.
clearContent()Rangeמחיקת התוכן של הטווח, תוך שמירה על העיצוב.
clearDataValidations()Rangeמחיקת כללי אימות הנתונים בטווח.
clearFormat()Rangeהסרת העיצוב מהטווח הזה.
clearNote()Rangeניקוי ההערה בתא או בתאים שצוינו.
collapseGroups()Rangeכיווץ של כל הקבוצות שנמצאות בטווח כולו.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidמעתיקים את העיצוב של הטווח למיקום הנתון.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidמעתיקים את העיצוב של הטווח למיקום הנתון.
copyTo(destination)voidהעתקת הנתונים מטווח תאים לטווח תאים אחר.
copyTo(destination, copyPasteType, transposed)voidהעתקת הנתונים מטווח תאים לטווח תאים אחר.
copyTo(destination, options)voidהעתקת הנתונים מטווח תאים לטווח תאים אחר.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidמעתיקים את התוכן של הטווח למיקום הנתון.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidמעתיקים את התוכן של הטווח למיקום הנתון.
createDataSourcePivotTable(dataSource)DataSourcePivotTableיצירת טבלת צירים ריקה של מקור נתונים ממקור הנתונים, עם עיגון בתא הראשון בטווח הזה.
createDataSourceTable(dataSource)DataSourceTableיצירת טבלה ריקה של מקור הנתונים ממקור הנתונים, עם עיגון בתא הראשון בטווח הזה.
createDeveloperMetadataFinder()DeveloperMetadataFinderהפונקציה מחזירה את DeveloperMetadataFinderApi לחיפוש מטא-נתונים למפתחים בטווח הזה.
createFilter()Filterיצירת מסנן והחלה שלו על הטווח שצוין בגיליון.
createPivotTable(sourceData)PivotTableיצירת טבלת צירים ריקה מ-sourceData שצוין, עם הצמדה לתא הראשון בטווח הזה.
createTextFinder(findText)TextFinderיצירת כלי לחיפוש טקסט בטווח, שיכול למצוא ולהחליף טקסט בטווח הזה.
deleteCells(shiftDimension)voidמחיקה של טווח התאים הזה.
expandGroups()Rangeהרחבה של הקבוצות המקופצות שהטווח או המתג שלהן מצטלבים עם הטווח הזה.
getA1Notation()Stringהפונקציה מחזירה תיאור של הטווח במחרוזת, בסימון A1.
getBackground()Stringהפונקציה מחזירה את צבע הרקע של התא הימני העליון בטווח (לדוגמה, '#ffffff').
getBackgroundObject()Colorהפונקציה מחזירה את צבע הרקע של התא בפינה הימנית העליונה בטווח.
getBackgroundObjects()Color[][]הפונקציה מחזירה את צבעי הרקע של התאים בטווח.
getBackgrounds()String[][]הפונקציה מחזירה את צבעי הרקע של התאים בטווח (לדוגמה, '#ffffff').
getBandings()Banding[]הפונקציה מחזירה את כל הפסקות הקווים שהוחלו על כל התאים בטווח הזה.
getCell(row, column)Rangeהפונקציה מחזירה תא נתון בטווח.
getColumn()Integerהפונקציה מחזירה את המיקום ההתחלתי של העמודה בטווח הזה.
getDataRegion()Rangeהפונקציה מחזירה עותק של הטווח שמורחב בארבע הכיוונים הראשיים Direction כדי לכסות את כל התאים הסמוכים שיש בהם נתונים.
getDataRegion(dimension)Rangeהפונקציה מחזירה עותק של הטווח המורחב Direction.UP ו-Direction.DOWN אם המאפיין שצוין הוא Dimension.ROWS, או Direction.NEXT ו-Direction.PREVIOUS אם המאפיין הוא Dimension.COLUMNS.
getDataSourceFormula()DataSourceFormulaהפונקציה מחזירה את הערך DataSourceFormula של התא הראשון בטווח, או את הערך null אם התא לא מכיל נוסחה של מקור נתונים.
getDataSourceFormulas()DataSourceFormula[]הפונקציה מחזירה את הערכים של DataSourceFormula בתאים בטווח.
getDataSourcePivotTables()DataSourcePivotTable[]הפונקציה מקבלת את כל טבלאות הצירים של מקורות הנתונים שמצטלבות עם הטווח.
getDataSourceTables()DataSourceTable[]הפונקציה מקבלת את כל הטבלאות של מקורות הנתונים שחופפות לטווח.
getDataSourceUrl()Stringהפונקציה מחזירה כתובת URL של הנתונים בטווח הזה, שאפשר להשתמש בה כדי ליצור תרשימים ושאילתות.
getDataTable()DataTableהחזרת הנתונים שבתוך האובייקט הזה כ-DataTable.
getDataTable(firstRowIsHeader)DataTableהחזרת הנתונים בטווח הזה כ-DataTable.
getDataValidation()DataValidationהפונקציה מחזירה את כלל אימות הנתונים של התא בפינה הימנית העליונה בטווח.
getDataValidations()DataValidation[][]הפונקציה מחזירה את כללי אימות הנתונים של כל התאים בטווח.
getDeveloperMetadata()DeveloperMetadata[]הפונקציה מקבלת את המטא-נתונים של המפתח שמשויכים לטווח הזה.
getDisplayValue()Stringהפונקציה מחזירה את הערך המוצג של התא הימני העליון בטווח.
getDisplayValues()String[][]הפונקציה מחזירה את הרשת המלבנית של הערכים בטווח הזה.
getFilter()Filterהפונקציה מחזירה את המסנן בגיליון שאליו שייך הטווח, או את הערך null אם אין מסנן בגיליון.
getFontColorObject()Colorהפונקציה מחזירה את צבע הגופן של התא בפינה הימנית העליונה של הטווח.
getFontColorObjects()Color[][]הפונקציה מחזירה את צבעי הגופן של התאים בטווח.
getFontFamilies()String[][]הפונקציה מחזירה את משפחות הגופנים של התאים בטווח.
getFontFamily()Stringהפונקציה מחזירה את משפחת הגופנים של התא בפינה הימנית העליונה של הטווח.
getFontLine()Stringהפונקציה מקבלת את סגנון הקו של התא בפינה הימנית העליונה של הטווח ('underline',‏ 'line-through' או 'none').
getFontLines()String[][]הפונקציה מקבלת את סגנון הקו של התאים בטווח ('underline',‏ 'line-through' או 'none').
getFontSize()Integerהפונקציה מחזירה את גודל הגופן בנקודה (pt) של התא בפינה הימנית העליונה של הטווח.
getFontSizes()Integer[][]הפונקציה מחזירה את גדלי הגופן של התאים בטווח.
getFontStyle()Stringהפונקציה מחזירה את סגנון הגופן ('italic' או 'normal') של התא בפינה הימנית העליונה של הטווח.
getFontStyles()String[][]הפונקציה מחזירה את סגנונות הגופן של התאים בטווח.
getFontWeight()Stringהפונקציה מחזירה את עובי הגופן (רגיל/מודגש) של התא בפינה הימנית העליונה של הטווח.
getFontWeights()String[][]הפונקציה מחזירה את עוצמות הגופן של התאים בטווח.
getFormula()Stringהפונקציה מחזירה את הנוסחה (סימון A1) של התא הימני העליון בטווח, או מחרוזת ריקה אם התא ריק או לא מכיל נוסחה.
getFormulaR1C1()Stringהפונקציה מחזירה את הנוסחה (סימון R1C1) של תא נתון, או את הערך null אם אין נוסחה.
getFormulas()String[][]הפונקציה מחזירה את הנוסחאות (סימון A1) של התאים בטווח.
getFormulasR1C1()String[][]הפונקציה מחזירה את הנוסחאות (סימון R1C1) של התאים בטווח.
getGridId()Integerהפונקציה מחזירה את מזהה הרשת של גיליון ההורה של הטווח.
getHeight()Integerהפונקציה מחזירה את הגובה של הטווח.
getHorizontalAlignment()Stringהפונקציה מחזירה את היישור האופקי של הטקסט (שמאל/מרכז/ימין) של התא בפינה הימנית העליונה של הטווח.
getHorizontalAlignments()String[][]הפונקציה מחזירה את ההתאמות האופקיות של התאים בטווח.
getLastColumn()Integerהפונקציה מחזירה את המיקום של עמודת הסיום.
getLastRow()Integerהפונקציה מחזירה את המיקום של שורת הסיום.
getMergedRanges()Range[]הפונקציה מחזירה מערך של אובייקטים מסוג Range שמייצגים תאים ממוזגים שנמצאים במלואם בטווח הנוכחי, או מכילים לפחות תא אחד בטווח הנוכחי.
getNextDataCell(direction)Rangeהפונקציה מתחילה מהתא בעמודה ובשורה הראשונות של הטווח ומחזירה את התא הבא בכיוון הנתון, שהוא הקצה של טווח רציף של תאים עם נתונים, או את התא בקצה גיליון האלקטרוני בכיוון הזה.
getNote()Stringהפונקציה מחזירה את ההערה שמשויכת לטווח הנתון.
getNotes()String[][]הפונקציה מחזירה את ההערות שמשויכות לתאים בטווח.
getNumColumns()Integerהפונקציה מחזירה את מספר העמודות בטווח הזה.
getNumRows()Integerהפונקציה מחזירה את מספר השורות בטווח הזה.
getNumberFormat()Stringהצגת עיצוב המספר או התאריך של התא בפינה הימנית העליונה של הטווח הנתון.
getNumberFormats()String[][]הפונקציה מחזירה את הפורמטים של המספרים או התאריכים של התאים בטווח.
getRichTextValue()RichTextValueהפונקציה מחזירה את הערך של טקסט עשיר בתא הימני העליון של הטווח, או את הערך null אם ערך התא הוא לא טקסט.
getRichTextValues()RichTextValue[][]הפונקציה מחזירה את הערכים של הטקסט העשיר בתאים בטווח.
getRow()Integerהפונקציה מחזירה את מיקום השורה של הטווח הזה.
getRowIndex()Integerהפונקציה מחזירה את מיקום השורה של הטווח הזה.
getSheet()Sheetהפונקציה מחזירה את הדף שאליו שייך הטווח.
getTextDirection()TextDirectionהפונקציה מחזירה את כיוון הטקסט של התא הימני העליון בטווח.
getTextDirections()TextDirection[][]הפונקציה מחזירה את כיווני הטקסט של התאים בטווח.
getTextRotation()TextRotationהפונקציה מחזירה את הגדרות סיבוב הטקסט של התא הימני העליון בטווח.
getTextRotations()TextRotation[][]הפונקציה מחזירה את הגדרות סיבוב הטקסט של התאים בטווח.
getTextStyle()TextStyleהפונקציה מחזירה את סגנון הטקסט של התא הימני העליון בטווח.
getTextStyles()TextStyle[][]הפונקציה מחזירה את סגנונות הטקסט של התאים בטווח.
getValue()Objectהפונקציה מחזירה את הערך של התא הימני העליון בטווח.
getValues()Object[][]הפונקציה מחזירה את הרשת המלבנית של הערכים בטווח הזה.
getVerticalAlignment()Stringהפונקציה מחזירה את היישור האנכי (למעלה/באמצע/למטה) של התא בפינה הימנית העליונה של הטווח.
getVerticalAlignments()String[][]הפונקציה מחזירה את היישורים האנכיים של התאים בטווח.
getWidth()Integerהפונקציה מחזירה את רוחב הטווח בעמודות.
getWrap()Booleanהפונקציה מחזירה אם הטקסט בתא מופיע ב-wrap.
getWrapStrategies()WrapStrategy[][]הפונקציה מחזירה את שיטות הגלישה של הטקסט בתאים בטווח.
getWrapStrategy()WrapStrategyהפונקציה מחזירה את אסטרטגיית הגלישה של הטקסט בתא הימני העליון של הטווח.
getWraps()Boolean[][]הפונקציה מחזירה אם הטקסט בתאים עבר גלישת שורה.
insertCells(shiftDimension)Rangeהוספת תאים ריקים לטווח הזה.
insertCheckboxes()Rangeהפונקציה מוסיפה תיבות סימון לכל תא בטווח, שמוגדרות כ-true לסימון וכ-false לביטול הסימון.
insertCheckboxes(checkedValue)Rangeהוספת תיבות סימון לכל תא בטווח, עם ערך מותאם אישית לתיבות מסומנות ומחרוזת ריקה לתיבות לא מסומנות.
insertCheckboxes(checkedValue, uncheckedValue)Rangeהוספת תיבות סימון לכל תא בטווח, עם הגדרות של ערכים מותאמים אישית למצבים 'מסומן' ו'לא מסומן'.
isBlank()Booleanהפונקציה מחזירה את הערך true אם הטווח ריק לחלוטין.
isChecked()Booleanהפונקציה מחזירה את הערך 'true' אם כל התאים בטווח מסומנים בתיבות סימון.
isEndColumnBounded()Booleanהפונקציה קובעת אם סוף הטווח קשור לעמודה מסוימת.
isEndRowBounded()Booleanהפונקציה קובעת אם סוף הטווח קשור לשורה מסוימת.
isPartOfMerge()Booleanהפונקציה מחזירה את הערך true אם התאים בטווח הנוכחי חופפים לתאים שמוזגו.
isStartColumnBounded()Booleanהפונקציה קובעת אם תחילת הטווח קשורה לעמודה מסוימת.
isStartRowBounded()Booleanקובעת אם תחילת הטווח קשורה לשורה מסוימת.
merge()Rangeמיזוג התאים בטווח לבלוק אחד.
mergeAcross()Rangeמיזוג התאים בטווח בעמודות של הטווח.
mergeVertically()Rangeמיזוג התאים בטווח.
moveTo(target)voidחותכים ומדביקים (גם את הפורמט וגם את הערכים) מהטווח הזה לטווח היעד.
offset(rowOffset, columnOffset)Rangeהפונקציה מחזירה טווח חדש שמשויך לטווח הזה, עם מספר השורות והעמודות שצוין (יכול להיות שהוא שלילי).
offset(rowOffset, columnOffset, numRows)Rangeהפונקציה מחזירה טווח חדש ביחס לטווח הנוכחי, שהנקודה הימנית העליונה שלו מוסטת מהטווח הנוכחי לפי השורות והעמודות שצוינו, ועם הגובה שצוין בתאים.
offset(rowOffset, columnOffset, numRows, numColumns)Rangeהפונקציה מחזירה טווח חדש ביחס לטווח הנוכחי, שהנקודה הימנית העליונה שלו מוסטת מהטווח הנוכחי לפי השורות והעמודות שצוינו, ועם הגובה והרוחב שצוינו בתאים.
protect()Protectionיצירת אובייקט שיכול להגן על הטווח מפני עריכה, מלבד משתמשים שיש להם הרשאה.
randomize()Rangeמערבבת את סדר השורות בטווח שצוין.
removeCheckboxes()Rangeהסרת כל תיבות הסימון מהטווח.
removeDuplicates()Rangeהפונקציה מסירה שורות בטווח הזה שמכילות ערכים שהם כפילויות של ערכים בשורות קודמות.
removeDuplicates(columnsToCompare)Rangeהפונקציה מסירה שורות בטווח הזה שמכילות ערכים בעמודות שצוינו שהם עותקים כפולים של ערכים בשורה קודמת כלשהי.
setBackground(color)Rangeהגדרת צבע הרקע של כל התאים בטווח בסימון CSS (כמו '#ffffff' או 'white').
setBackgroundObject(color)Rangeהגדרת צבע הרקע של כל התאים בטווח.
setBackgroundObjects(color)Rangeהגדרת רשת מלבנית של צבעי רקע (היא חייבת להתאים למימדים של הטווח הזה).
setBackgroundRGB(red, green, blue)Rangeהגדרת הרקע לצבע הנתון באמצעות ערכי RGB (מספרים שלמים בין 0 ל-255, כולל).
setBackgrounds(color)Rangeהגדרת רשת מלבנית של צבעי רקע (היא חייבת להתאים למימדים של הטווח הזה).
setBorder(top, left, bottom, right, vertical, horizontal)Rangeהגדרת מאפיין הגבול.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Rangeהגדרת מאפיין הגבול עם צבע ו/או סגנון.
setDataValidation(rule)Rangeמגדירה כלל אחד לאימות נתונים לכל התאים בטווח.
setDataValidations(rules)Rangeמגדירה את כללי אימות הנתונים לכל התאים בטווח.
setFontColor(color)Rangeהגדרת צבע הגופן בסימון CSS (כמו '#ffffff' או 'white').
setFontColorObject(color)Rangeהגדרת צבע הגופן של הטווח הנתון.
setFontColorObjects(colors)Rangeהגדרת רשת מלבנית של צבעי פונטים (היא חייבת להתאים למימדים של הטווח הזה).
setFontColors(colors)Rangeהגדרת רשת מלבנית של צבעי פונטים (היא חייבת להתאים למימדים של הטווח הזה).
setFontFamilies(fontFamilies)Rangeהגדרת רשת מלבנית של משפחות גופנים (היא חייבת להתאים למימדים של הטווח הזה).
setFontFamily(fontFamily)Rangeהגדרת משפחת הגופנים, למשל 'Arial' או 'Helvetica'.
setFontLine(fontLine)Rangeהגדרת סגנון הקו של הגופן בטווח הנתון ('underline',‏ 'line-through' או 'none').
setFontLines(fontLines)Rangeהגדרת רשת מלבנית של סגנונות קו (היא חייבת להתאים למאפייני הממדים של הטווח הזה).
setFontSize(size)Rangeהגדרת גודל הגופן, כאשר הגודל הוא גודל הנקודה שבו צריך להשתמש.
setFontSizes(sizes)Rangeהגדרת רשת מלבנית של גדלי גופן (היא חייבת להתאים למימדים של הטווח הזה).
setFontStyle(fontStyle)Rangeמגדירים את סגנון הגופן לטווח הנתון ('italic' או 'normal').
setFontStyles(fontStyles)Rangeהגדרת רשת מלבנית של סגנונות גופן (היא חייבת להתאים למימדים של הטווח הזה).
setFontWeight(fontWeight)Rangeהגדרת עובי הגופן לטווח הנתון (רגיל/מודגש).
setFontWeights(fontWeights)Rangeהגדרת רשת מלבנית של עובי גופן (היא חייבת להתאים למימדים של הטווח הזה).
setFormula(formula)Rangeעדכון הנוסחה של הטווח הזה.
setFormulaR1C1(formula)Rangeעדכון הנוסחה של הטווח הזה.
setFormulas(formulas)Rangeהגדרת רשת מלבנית של נוסחאות (היא חייבת להתאים למימדים של הטווח הזה).
setFormulasR1C1(formulas)Rangeהגדרת רשת מלבנית של נוסחאות (היא חייבת להתאים למימדים של הטווח הזה).
setHorizontalAlignment(alignment)Rangeמגדירים את היישור האנכי (משמאל לימין) של הטווח הנתון (שמאל/מרכז/ימין).
setHorizontalAlignments(alignments)Rangeמגדירה רשת מלבנית של יישור אופקיים.
setNote(note)Rangeהגדרת הערה לערך הנתון.
setNotes(notes)Rangeהגדרת רשת מלבנית של הערות (היא חייבת להתאים למימדים של הטווח הזה).
setNumberFormat(numberFormat)Rangeהגדרת פורמט המספר או התאריך למחרוזת העיצוב שצוינה.
setNumberFormats(numberFormats)Rangeהגדרת רשת מלבנית של פורמטים של מספרים או תאריכים (היא חייבת להתאים למאפייני הגודל של הטווח הזה).
setRichTextValue(value)Rangeהגדרת הערך של הטקסט העשיר בתאים בטווח.
setRichTextValues(values)Rangeהגדרת רשת מלבנית של ערכים של טקסט עשיר.
setShowHyperlink(showHyperlink)Rangeההגדרה קובעת אם להציג היפר-קישורים בטווח או לא.
setTextDirection(direction)Rangeהגדרת כיוון הטקסט בתאים בטווח.
setTextDirections(directions)Rangeמגדירה רשת מלבנית של כיווני טקסט.
setTextRotation(degrees)Rangeהגדרת הגדרות הטקסט לכיוון התאים בטווח.
setTextRotation(rotation)Rangeהגדרת הגדרות הטקסט לכיוון התאים בטווח.
setTextRotations(rotations)Rangeהגדרת רשת מלבנית של טקסטים מסתובבים.
setTextStyle(style)Rangeהגדרת סגנון הטקסט של התאים בטווח.
setTextStyles(styles)Rangeהגדרת רשת מלבנית של סגנונות טקסט.
setValue(value)Rangeהגדרת הערך של הטווח.
setValues(values)Rangeהגדרת רשת מלבנית של ערכים (היא חייבת להתאים למאפיינים של הטווח הזה).
setVerticalAlignment(alignment)Rangeמגדירים את היישור האנכי (למעלה ולמטה) לטווח הנתון (למעלה/באמצע/למטה).
setVerticalAlignments(alignments)Rangeהגדרת רשת מלבנית של התאמות אנכיות (היא חייבת להתאים למימדים של הטווח הזה).
setVerticalText(isVertical)Rangeמגדיר אם לערום את הטקסט של התאים בטווח או לא.
setWrap(isWrapEnabled)Rangeהגדרת הקיפול של התאים בטווח הנתון.
setWrapStrategies(strategies)Rangeהגדרת רשת מלבנית של שיטות גיבוב.
setWrapStrategy(strategy)Rangeהגדרת שיטת הגלישה של הטקסט בתאים בטווח.
setWraps(isWrapEnabled)Rangeהגדרת רשת מלבנית של כללי הקיפול של מילים (היא חייבת להתאים למימדים של הטווח הזה).
shiftColumnGroupDepth(delta)Rangeשינוי העומק של קיבוץ העמודות בטווח לפי הסכום שצוין.
shiftRowGroupDepth(delta)Rangeשינוי העומק של קיבוץ השורות בטווח לפי הסכום שצוין.
sort(sortSpecObj)Rangeממיינים את התאים בטווח שצוין לפי העמודה והסדר שצוינו.
splitTextToColumns()voidפיצול של עמודה של טקסט למספר עמודות על סמך מפריד שזוהה באופן אוטומטי.
splitTextToColumns(delimiter)voidהפונקציה מפצלת עמודה של טקסט למספר עמודות באמצעות המחרוזת שצוינה כמפריד בהתאמה אישית.
splitTextToColumns(delimiter)voidהפונקציה מפצלת עמודה של טקסט למספר עמודות על סמך המפריד שצוין.
trimWhitespace()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());

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
bandingThemeBandingThemeערכת צבעים להחלה על העמודות בטווח.

חזרה

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

פרמטרים

שםסוגתיאור
bandingThemeBandingThemeערכת צבעים להחלה על העמודות בטווח.
showHeaderBooleanאם הערך הוא true, צבע הכותרת של נושא הפסילות יוחל על העמודה הראשונה.
showFooterBooleanאם הערך הוא 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);

פרמטרים

שםסוגתיאור
bandingThemeBandingThemeערכת צבעים שחלה על השורות בטווח.

חזרה

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

פרמטרים

שםסוגתיאור
bandingThemeBandingThemeערכת צבעים שחלה על השורות בטווח.
showHeaderBooleanאם הערך הוא true, צבע הכותרת של נושא הפסילות יחול על השורה הראשונה.
showFooterBooleanאם הערך הוא 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);

פרמטרים

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

אישור

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

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

autoFillToNeighbor(series)

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

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

לדוגמה, אם המשתנה A1:A20 מלא בסדרה של מספרים עולים, והשיטה הזו נקראת על הטווח B1:B4 שמכיל סדרה של תאריכים, ערכים חדשים מוכנסים רק ל-B5:B20. כך הערכים החדשים 'נצמדים' לתאים שמכילים ערכים בעמודה A.

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

פרמטרים

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

אישור

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

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

חזרה

Booleantrue אם למשתמש יש הרשאה לערוך כל תא בטווח, 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
});

פרמטרים

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

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

שםסוגתיאור
commentsOnlyBooleanהאם לנקות רק את התגובות.
contentsOnlyBooleanאם לנקות רק את התוכן.
formatOnlyBooleanאם לנקות רק את העיצוב. לתשומת ליבכם: ניקוי העיצוב מנקה גם את כללי אימות הנתונים.
validationsOnlyBooleanאם למחוק רק את הכללים לאימות נתונים.
skipFilteredRowsBooleanאם להימנע מניקוי של שורות מסוננות.

חזרה

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

פרמטרים

שםסוגתיאור
gridIdIntegerהמזהה הייחודי של הגיליון בתוך הגיליון האלקטרוני, ללא קשר למיקום שלו.
columnIntegerהעמודה הראשונה בטווח היעד.
columnEndIntegerהעמודה 'סיום' של טווח היעד.
rowIntegerשורת ההתחלה של טווח היעד.
rowEndIntegerשורת הסיום של טווח היעד.

אישור

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

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

פרמטרים

שםסוגתיאור
sheetSheetגיליון היעד.
columnIntegerהעמודה הראשונה בטווח היעד.
columnEndIntegerהעמודה 'סיום' של טווח היעד.
rowIntegerשורת ההתחלה של טווח היעד.
rowEndIntegerשורת הסיום של טווח היעד.

אישור

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

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

פרמטרים

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

אישור

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

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

פרמטרים

שםסוגתיאור
destinationRangeטווח היעד שאליו רוצים להעתיק. רק המיקום של התא העליון השמאלי רלוונטי.
copyPasteTypeCopyPasteTypeסוג שמציין איך תוכן הטווח מודבק ליעד.
transposedBooleanהאם הטווח צריך להדביק בכיוון ההמרה שלו.

אישור

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

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

פרמטרים

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

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

שםסוגתיאור
formatOnlyBooleanמציין שצריך להעתיק רק את הפורמט
contentsOnlyBooleanמציין שצריך להעתיק רק את התוכן

אישור

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

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

פרמטרים

שםסוגתיאור
gridIdIntegerהמזהה הייחודי של הגיליון בתוך הגיליון האלקטרוני, ללא קשר למיקום שלו.
columnIntegerהעמודה הראשונה בטווח היעד.
columnEndIntegerהעמודה 'סיום' של טווח היעד.
rowIntegerשורת ההתחלה של טווח היעד.
rowEndIntegerשורת הסיום של טווח היעד.

אישור

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

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

פרמטרים

שםסוגתיאור
sheetSheetגיליון היעד.
columnIntegerהעמודה הראשונה בטווח היעד.
columnEndIntegerהעמודה 'סיום' של טווח היעד.
rowIntegerשורת ההתחלה של טווח היעד.
rowEndIntegerשורת הסיום של טווח היעד.

אישור

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

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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, סוג הגיליונות שמוגדר כברירת מחדל. גיליונות רשת הם גיליונות שלא מקושרים למסד נתונים. כדי ליצור מסננים מסוגים אחרים, תוכלו לעיין במאמרים הבאים:

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

TextFinder – ה-TextFinder של הטווח


deleteCells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

פרמטרים

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

אישור

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

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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 — המסנן.

אישור

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

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

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

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) של התאים בטווח. הרשומות במערך 2D הן מחרוזות ריקות בתאים ללא נוסחה.

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) של התאים בטווח. הערכים במערך 2D הם 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());

פרמטרים

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

חזרה

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 אם הערך בתא הוא לא טקסט.

אישור

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

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

הפונקציה מחזירה את כיווני הטקסט של התאים בטווח. הרשומות במערך 2D הן 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()

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
checkedValueObjectהערך המסומן לאימות הנתונים של תיבת הסימון.

חזרה

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

פרמטרים

שםסוגתיאור
checkedValueObjectהערך המסומן לאימות הנתונים של תיבת הסימון.
uncheckedValueObjectהערך שלא מסומן לאימות הנתונים של תיבת הסימון.

חזרה

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

חזרה

Booleantrue אם הטווח ריק, false אחרת.

אישור

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

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

isChecked()

הפונקציה מחזירה את הערך 'true' אם כל התאים בטווח מסומנים בתיבות סימון. הפונקציה מחזירה את הערך 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();

חזרה

Booleantrue, אם כל התאים בטווח מסומנים, 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());

חזרה

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

חזרה

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

חזרה

Booleantrue אם הטווח חופף לתאים שמוזגו, אחרת מחזירה 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());

חזרה

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

חזרה

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

פרמטרים

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

אישור

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

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
rowOffsetIntegerמספר השורות למטה מהתא הימני העליון של הטווח. ערכים שליליים מייצגים שורות למעלה מהתא הימני העליון של הטווח.
columnOffsetIntegerמספר העמודות שמשמאל לתא הימני העליון של הטווח. ערכים שליליים מייצגים עמודות שמשמאל לתא הימני העליון של הטווח.
numRowsIntegerהגובה בשורות של הטווח החדש.
numColumnsIntegerרוחב העמודות של הטווח החדש.

חזרה

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

פרמטרים

שםסוגתיאור
columnsToCompareInteger[]העמודות לניתוח לצורך איתור ערכים כפולים. אם לא מציינים עמודות, המערכת תנתח את כל העמודות כדי לאתר כפילויות.

חזרה

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

פרמטרים

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

פרמטרים

שםסוגתיאור
colorColorצבע הרקע שרוצים להגדיר. הערך 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);

פרמטרים

שםסוגתיאור
colorColor[][]מערך דו-מימדי של צבעים. ערכים של 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);

פרמטרים

שםסוגתיאור
redIntegerערך האדום בסימון RGB.
greenIntegerהערך הירוק בסימון RGB.
blueIntegerערך הכחול בסימון 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);

פרמטרים

שםסוגתיאור
colorString[][]מערך דו-מימדי של צבעים בסימון 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);

פרמטרים

שםסוגתיאור
topBooleantrue לגבול, false ללא גבול, null ללא שינוי.
leftBooleantrue לגבול, false ללא גבול, null ללא שינוי.
bottomBooleantrue לגבול, false ללא גבול, null ללא שינוי.
rightBooleantrue לגבול, false ללא גבול, null ללא שינוי.
verticalBooleantrue לגבולות אנכיים פנימיים, false ללא גבולות, null ללא שינוי.
horizontalBooleantrue לגבולות אופקיים פנימיים, 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,
);

פרמטרים

שםסוגתיאור
topBooleantrue לגבול, false ללא גבול, null ללא שינוי.
leftBooleantrue לגבול, false ללא גבול, null ללא שינוי.
bottomBooleantrue לגבול, false ללא גבול, null ללא שינוי.
rightBooleantrue לגבול, false ללא גבול, null ללא שינוי.
verticalBooleantrue לגבולות אנכיים פנימיים, false ללא גבולות, null ללא שינוי.
horizontalBooleantrue לגבולות אופקיים פנימיים, false ללא גבולות, null ללא שינוי.
colorStringצבע בתחביר CSS (כמו '#ffffff' או 'white'), null לצבע ברירת המחדל (שחור).
styleBorderStyleסגנון לגבולות, 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);

פרמטרים

שםסוגתיאור
ruleDataValidationכלל אימות הנתונים שרוצים להגדיר, או 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);

פרמטרים

שםסוגתיאור
rulesDataValidation[][]מערך דו-מימדי של כללי אימות נתונים להגדרה. ערכים של 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');

פרמטרים

שםסוגתיאור
colorStringצבע הגופן בסימון 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);

פרמטרים

שםסוגתיאור
colorColorצבע הגופן שרוצים להגדיר. ערך 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);

פרמטרים

שםסוגתיאור
colorsColor[][]מערך דו-מימדי של צבעים. ערכים של 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);

פרמטרים

שםסוגתיאור
colorsObject[][]מערך דו-מימדי של צבעים בסימון 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);

פרמטרים

שםסוגתיאור
fontFamiliesObject[][]מערך דו-מימדי של משפחות גופנים. ערכים של 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');

פרמטרים

שםסוגתיאור
fontFamilyStringמשפחת הגופנים שתוגדר. ערך 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');

פרמטרים

שםסוגתיאור
fontLineStringסגנון הקו של הגופן, '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);

פרמטרים

שםסוגתיאור
fontLinesObject[][]מערך דו-מימדי של סגנונות קו של גופן ('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);

פרמטרים

שםסוגתיאור
sizeIntegerגודל גופן בנקודות.

חזרה

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

פרמטרים

שםסוגתיאור
sizesObject[][]מערך דו-מימדי של גדלים.

חזרה

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

פרמטרים

שםסוגתיאור
fontStyleStringסגנון הגופן, '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);

פרמטרים

שםסוגתיאור
fontStylesObject[][]מערך דו-מימדי של סגנונות גופן, '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');

פרמטרים

שםסוגתיאור
fontWeightStringעובי הגופן, 'bold' או 'normal'. ערך null מחזיר את עובי הגופן להגדרה המקורית.

חזרה

Range — הטווח הזה, לשרשור.

אישור

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

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

setFontWeights(fontWeights)

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

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

פרמטרים

שםסוגתיאור
fontWeightsObject[][]מערך דו-מימדי של משקלי גופן, '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)');

פרמטרים

שםסוגתיאור
formulaStringמחרוזת שמייצגת את הנוסחה שרוצים להגדיר לתא.

חזרה

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

פרמטרים

שםסוגתיאור
formulaStringנוסחת מחרוזת.

חזרה

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

פרמטרים

שםסוגתיאור
formulasString[][]מערך מחרוזות דו-ממדי של נוסחאות.

חזרה

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

פרמטרים

שםסוגתיאור
formulasString[][]מערך דו-מימדי של נוסחאות בפורמט 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');

פרמטרים

שםסוגתיאור
alignmentStringהיישור, '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);

פרמטרים

שםסוגתיאור
alignmentsObject[][]מערך דו-מימדי של ערכי התאמה, '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');

פרמטרים

שםסוגתיאור
noteStringערך ההערה שרוצים להגדיר לטווח. ערך 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);

פרמטרים

שםסוגתיאור
notesObject[][]מערך דו-מימדי של הערות. ערכים של 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');

פרמטרים

שםסוגתיאור
numberFormatStringמחרוזת של פורמט מספר.

חזרה

Range — הטווח הזה, לשרשור.

אישור

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

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

setNumberFormats(numberFormats)

הגדרת רשת מלבנית של פורמטים של מספרים או תאריכים (היא חייבת להתאים למאפייני הגודל של הטווח הזה). הערכים הם מחרוזות של דפוסי פורמט כפי שמתואר ב מסמכי התיעוד של Sheets API.

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

פרמטרים

שםסוגתיאור
numberFormatsObject[][]מערך דו-מימדי של פורמטים של מספרים.

חזרה

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

פרמטרים

שםסוגתיאור
valueRichTextValueהערך הרצוי של הטקסט העשיר.

חזרה

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

פרמטרים

שםסוגתיאור
valuesRichTextValue[][]הערכים הרצויים של הטקסט העשיר.

חזרה

Range — הטווח הזה, לשרשור.

אישור

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

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

ההגדרה קובעת אם להציג היפר-קישורים בטווח או לא.

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

פרמטרים

שםסוגתיאור
showHyperlinkBooleanאם להציג את ההיפר-קישור או לא.

חזרה

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

פרמטרים

שםסוגתיאור
directionTextDirectionכיוון הטקסט הרצוי. אם הערך הוא 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());

פרמטרים

שםסוגתיאור
directionsTextDirection[][]כיווני הטקסט הרצויים. אם הכיוון שצוין הוא 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);

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
rotationTextRotationהגדרות סיבוב הטקסט הרצויות.

חזרה

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

פרמטרים

שםסוגתיאור
rotationsTextRotation[][]הגדרות סיבוב הטקסט הרצויות.

חזרה

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

פרמטרים

שםסוגתיאור
styleTextStyleסגנון הטקסט הרצוי.

חזרה

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

פרמטרים

שםסוגתיאור
stylesTextStyle[][]סגנונות הטקסט הרצויים.

חזרה

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

פרמטרים

שםסוגתיאור
valueObjectהערך של הטווח.

חזרה

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

פרמטרים

שםסוגתיאור
valuesObject[][]מערך דו-מימדי של ערכים.

חזרה

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

פרמטרים

שםסוגתיאור
alignmentStringהיישור, '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);

פרמטרים

שםסוגתיאור
alignmentsObject[][]מערך דו-מימדי של ערכי התאמה, 'top', ‏ 'middle' או 'bottom'. ערך null מאפס את ההתאמה.

חזרה

Range — הטווח הזה, לשרשור.

אישור

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

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

ראה גם


setVerticalText(isVertical)

מגדיר אם לערום את הטקסט של התאים בטווח או לא. אם הטקסט ממוצב בערימה אנכית, המערכת מתעלמת מההגדרה של סיבוב הטקסט ב-degrees.

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
isWrapEnabledBooleanאם הטקסט יגולגל או לא.

חזרה

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

פרמטרים

שםסוגתיאור
strategiesWrapStrategy[][]שיטות הגלישה הרצויות.

חזרה

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

פרמטרים

שםסוגתיאור
strategyWrapStrategyאסטרטגיית הגלישה הרצויה.

חזרה

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

פרמטרים

שםסוגתיאור
isWrapEnabledObject[][]מערך דו-מימדי של משתני גלישת טקסט שקובעים אם הטקסט יגלוש בתא או לא.

חזרה

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

פרמטרים

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

חזרה

Range — הטווח הזה, לשרשור.

זריקות

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

פרמטרים

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

חזרה

Range — הטווח הזה, לשרשור.

זריקות

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

פרמטרים

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

חזרה

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            |

פרמטרים

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

אישור

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

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

פרמטרים

שםסוגתיאור
delimiterTextToColumnsDelimiterהתו המפריד שהוגדר מראש לפצל לפיו.

אישור

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

  • 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

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