Class Range

טווח

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

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
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מחזירה את גודל הגופן בגודל הנקודה של התא בפינה הימנית העליונה של הטווח.
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מחזירה את הערך של Rich Text עבור התא הימני העליון של הטווח, או 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מחזירה אם הטקסט בתא גולש.
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מחזירה אם מצב תיבת הסימון שלהם של כל התאים בטווח הוא 'מסומן'.
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מגדיר את משפחת הגופנים, כגון "duration" או "H התראה".
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.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

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

החזרות

Range – הטווח הזה לשרשור.


activateAsCurrentCell()

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

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

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

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

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var 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:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var 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.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var 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());

החזרות

Boolean - true אם למשתמש יש הרשאה לערוך כל תא בטווח. אחרת, false.

הרשאות

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

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

check()

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

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

clear()

ניקוי טווח התוכן והפורמטים.

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

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

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

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

var 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.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

clearFormat()

ניקוי העיצוב של הטווח הזה.

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

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

clearNote()

ניקוי ההערה בתא או בתאים הנתונים.

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

var range = sheet.getRange("A1:D10");
range.clearNote();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

collapseGroups()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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().

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

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var 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.
var 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().

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

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

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

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

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

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

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

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* 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().

let ss = SpreadsheetApp.getActiveSheet();
let 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() {
  let filter = range.getFilter();
  let 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)

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

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

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

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

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

פרמטרים

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

החזרות

TextFinder - TextFinder של הטווח


deleteCells(shiftDimension)

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

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

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

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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').

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

החזרות

String - קוד הצבע של הרקע.

הרשאות

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

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

getBackgroundObject()

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

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

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

מחזירה את צבעי הרקע של התאים בטווח.

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var 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').

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var 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 (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

החזרות

Banding[] – כל גבולות הגבולות שהוחלו על כל התאים בטווח הזה.

הרשאות

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

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

getCell(row, column)

מחזירה תא נתון בתוך טווח.

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

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

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

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

var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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);

החזרות

DataSourceFormulaDataSourceFormula בתא.

הרשאות

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

  • 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() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var 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.
var 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.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var 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.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var 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.
var 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 אם אין מסנן בגיליון.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

החזרות

Filter – המסנן.

הרשאות

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

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

getFontColorObject()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var 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()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של משפחות גופנים המשויכות לתאים שבטווח.

הרשאות

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

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

getFontFamily()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של שורות גופנים המשויכות לתאים שבטווח.

הרשאות

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

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

getFontSize()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontSize());

החזרות

Integer - גודל הגופן בגודל הנקודות.

הרשאות

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

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

getFontSizes()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontSizes();

for (var i in results) {
  for (var 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') של התא בפינה הימנית העליונה של הטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontStyle());

החזרות

String - סגנון הגופן של הטקסט בתא.

הרשאות

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

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

getFontStyles()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של סגנונות גופנים בטקסט שמשויכים לתאים שבטווח.

הרשאות

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

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

getFontWeight()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontWeight());

החזרות

String - עובי הגופן של הטקסט בתא.

הרשאות

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

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

getFontWeights()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontWeights();

for (var i in results) {
  for (var 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) של התא הימני העליון של הטווח, או מחרוזת ריקה אם התא ריק או לא מכיל נוסחה.

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

// This assumes you have a function in B5 that sums up
// B2:B4
var 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 אם אין.

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

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

החזרות

String - הנוסחה בסימון R1C1.

הרשאות

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

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

getFormulas()

מחזירה את הנוסחאות (סימון A1) של התאים שבטווח. הערכים במערך הדו-ממדי הם מחרוזות ריקות לתאים ללא נוסחה.

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

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulas();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של נוסחאות בפורמט מחרוזת.

הרשאות

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

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

getFormulasR1C1()

מחזירה את הנוסחאות (סימון R1C1) עבור התאים שבטווח. הערכים במערך הדו-ממדי הם null לתאים שאין בהם נוסחה.

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

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var 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()

מחזירה את מזהה הרשת של גיליון ההורה של הטווח. מזהים הם ערכי int אקראיים לא שליליים.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

החזרות

Integer - מזהה הרשת של גיליון ההורה.

הרשאות

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

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

getHeight()

מחזירה את גובה הטווח.

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

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

מחזירה את היישור האופקי של הטקסט (שמאל/מרכז/ימין) של התא בפינה השמאלית העליונה של הטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getHorizontalAlignment());

החזרות

String - היישור האופקי של הטקסט בתא.

הרשאות

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

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

getHorizontalAlignments()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של יישורים אופקיים של טקסט המשויך לתאים שבטווח.

הרשאות

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

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

getLastColumn()

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

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

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

מחזירה את המיקום של השורה האחרונה.

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

var 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 שמייצגים תאים ממוזגים שנמצאים באופן מלא בטווח הנוכחי או שמכילים לפחות תא אחד בטווח הנוכחי.

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

var range = sheet.getRange("A1:B3");

var mergedRanges = range.getMergedRanges();
for (var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

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

מחזירה את ההערה המשויכת לטווח הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getNote());

החזרות

String - ההערה המשויכת לתא הנתון.

הרשאות

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

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

getNotes()

מחזירה את ההערות המשויכות לתאים שבטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של הערות המשויכות לתאים בטווח.

הרשאות

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

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

getNumColumns()

מחזירה את מספר העמודות בטווח.

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

החזרות

Integer - מספר העמודות בטווח הזה.

הרשאות

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

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

getNumRows()

מחזירה את מספר השורות בטווח הזה.

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

var 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.

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

var 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.

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

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

החזרות

String[][] - מערך דו-ממדי של פורמטים של מספרים.

הרשאות

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

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

getRichTextValue()

מחזירה את הערך של Rich Text עבור התא הימני העליון של הטווח, או null אם ערך התא אינו טקסט.

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var 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().

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

var range = sheet.getRange("B2");
Logger.log(range.getRow());

החזרות

Integer – מיקום השורה של הטווח.

הרשאות

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

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

getRowIndex()

מחזירה את מיקום השורה עבור טווח זה. זהה ל-getRow().

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

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

החזרות

TextDirection - כיוון הטקסט של התא הימני העליון בטווח.

הרשאות

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

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

getTextDirections()

מחזירה את הוראות הטקסט עבור התאים בטווח. הערכים במערך הדו-ממדי הם null עבור תאים שנעשה בהם שימוש בזיהוי אוטומטי.

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var 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.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

החזרות

TextRotation – ההגדרות של סיבוב הטקסט.

הרשאות

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

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

getTextRotations()

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

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var 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.
var 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()

מחזירה את היישור האנכי (למעלה/אמצע/תחתון) של התא בפינה השמאלית העליונה של הטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getVerticalAlignment());

החזרות

String - היישור האנכי של הטקסט בתא.

הרשאות

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

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

getVerticalAlignments()

מחזירה את היישור האנכי של התאים בטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var 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()

מחזירה אם הטקסט בתא גולש. כדי לקבל אסטרטגיית גלישת טקסט ממוקדת יותר, אפשר להשתמש ב-getWrapStrategy().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var 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)

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

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

var 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.

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

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

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

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

var 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 אם הטווח ריק לחלוטין.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.isBlank());

החזרות

Boolean - true אם הטווח ריק. אחרת, false.

הרשאות

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

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

isChecked()

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

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

החזרות

Boolean - true, אם כל התאים בטווח מסומנים, false אם כל התאים בטווח לא מסומנים, או null אם אחד מהתאים לא מסומן או אם אין בהם אימות נתונים של תיבות סימון.

הרשאות

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

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

isEndColumnBounded()

קובעת אם סוף הטווח קשור לעמודה מסוימת. לדוגמה, לטווחים A1:B10 או B:B, שקשורים לעמודות שבקצה הטווח, השיטה הזו מחזירה את הערך true. בטווחים 3:7 או A1:5, שמקושרים רק לשורות מסוימות בסוף הטווח, השיטה הזו מחזירה false.

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

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

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

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

החזרות

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 אם התאים בטווח הנוכחי חופפים לתאים ממוזגים.

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

var range = sheet.getRange("A1:B3");

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

החזרות

Boolean - true אם הטווח חופף לתאים ממוזגים, אחרת מוחזר false.


isStartColumnBounded()

קובעת אם תחילת הטווח קשורה לעמודה מסוימת. לדוגמה, לטווחים A1:B10 או B:B, שקשורים לעמודות בתחילת הטווח, השיטה הזו מחזירה את הערך true. אם הטווח 3:7 שמקושר רק לשורה בתחילת הטווח, השיטה הזו מחזירה את הערך false.

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

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

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

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

החזרות

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

מיזוג של התאים שבטווח לבלוק אחד.

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

ממזגים את התאים שבטווח בין העמודות שבטווח.

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

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

mergeVertically()

מיזוג של התאים בטווח.

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

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

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

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

פרמטרים

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

החזרות

Range – הטווח הזה לשרשור.


offset(rowOffset, columnOffset, numRows)

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

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

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

פרמטרים

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

החזרות

Range – הטווח הזה לשרשור.


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

var cell = sheet.getRange("A1");

// newCell references B2:C3
var 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.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var 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.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

החזרות

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

הרשאות

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

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

randomize()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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()

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

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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').

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

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

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

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

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var 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, כולל).

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

var 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').

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var 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 (ללא שינוי).

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

var 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').

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

var 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.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var 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.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var 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').

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

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

הגדרת צבע הגופן של הטווח הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

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

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

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var 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').

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

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

מגדיר רשת מלבנית של משפחות גופנים (חייבת להתאים למידות של הטווח הזה). דוגמאות למשפחות גופנים הן "CLIENT" או "H התראה".

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

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

מגדיר את משפחת הגופנים, כגון "duration" או "H התראה".

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

var 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').

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

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

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

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

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

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

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

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

פרמטרים

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

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

setFontSizes(sizes)

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

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

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var 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').

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

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

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

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

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

הגדרת עובי הגופן בטווח הנתון (רגיל/מודגש).

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

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

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

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var 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.

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

var 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.

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var 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.

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

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

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

הגדרת היישור האופקי (משמאל לימין) לטווח הנתון (שמאל/מרכז/ימין).

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

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

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

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

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

מגדיר את ההערה לערך הנתון.

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

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

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

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

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var 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.

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

var 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.

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

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var sheet = SpreadsheetApp.getActiveSheet();

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var 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)

מגדיר את הערך של הטווח. הערך יכול להיות מספרי, מחרוזת, בוליאני או תאריך. אם הוא מתחיל ב-'=', הוא מפורש כנוסחה.

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

var cell = sheet.getRange("B2");
cell.setValue(100);

פרמטרים

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

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

setValues(values)

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

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

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

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

הגדרת היישור האנכי (מלמעלה למטה) לטווח הנתון (למעלה/אמצע/תחתון).

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

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

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

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

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

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

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

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var 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)

מגדירים את גלישת התא של הטווח הנתון.

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

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

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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)

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

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

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var 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, תתקבל הודעת שגיאה במהלך הניסיון להזיז את העומק של השורה הראשונה.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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, תתקבל הודעת שגיאה במהלך הניסיון להזיז את העומק של השורה הראשונה.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting 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|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting 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|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting 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()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var 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'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

החזרות

Range – הטווח הזה לשרשור.

הרשאות

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

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

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