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تعرض هذه الدالة قيمة النص المنسّق للخلية أعلى اليمين في النطاق، أو 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يضبط الخلفية على اللون المحدّد باستخدام قيم الأحمر والأخضر والأزرق (أعداد صحيحة بين 0 و255 ضِمنًا).
setBackgrounds(color)Rangeتضبط هذه السمة شبكة مستطيلة من ألوان الخلفية (يجب أن تتطابق مع أبعاد هذا النطاق).
setBorder(top, left, bottom, right, vertical, horizontal)Rangeتضبط هذه السمة حدود العنصر.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Rangeتضبط هذه السمة حدود العنصر باستخدام اللون و/أو النمط.
setDataValidation(rule)Rangeتضبط هذه السمة قاعدة واحدة للتحقّق من صحة البيانات لجميع الخلايا في النطاق.
setDataValidations(rules)Rangeتضبط هذه السمة قواعد التحقّق من صحة البيانات لجميع الخلايا في النطاق.
setFontColor(color)Rangeتضبط هذه السمة لون الخط بتنسيق CSS (مثل '#ffffff' أو 'white').
setFontColorObject(color)Rangeتضبط هذه السمة لون الخط للنطاق المحدّد.
setFontColorObjects(colors)Rangeتضبط هذه السمة شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontColors(colors)Rangeتضبط هذه السمة شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontFamilies(fontFamilies)Rangeتضبط هذه السمة شبكة مستطيلة من مجموعات الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontFamily(fontFamily)Rangeتضبط هذه السمة مجموعة الخطوط، مثل "Arial" أو "Helvetica".
setFontLine(fontLine)Rangeتضبط هذه السمة نمط خط النص في النطاق المحدّد ('underline' أو 'line-through' أو 'none').
setFontLines(fontLines)Rangeتضبط هذه السمة شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontSize(size)Rangeتضبط هذه السمة حجم الخط، ويكون الحجم هو حجم النقطة المطلوب استخدامها.
setFontSizes(sizes)Rangeتضبط هذه السمة شبكة مستطيلة من أحجام الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontStyle(fontStyle)Rangeضبط نمط الخط للنطاق المحدّد ('italic' أو 'normal').
setFontStyles(fontStyles)Rangeتضبط هذه السمة شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFontWeight(fontWeight)Rangeضبط عرض الخط للنطاق المحدّد (عادي/غامق)
setFontWeights(fontWeights)Rangeتضبط هذه السمة شبكة مستطيلة من أوزان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).
setFormula(formula)Rangeتعدّل هذه السمة الصيغة لهذا النطاق.
setFormulaR1C1(formula)Rangeتعدّل هذه السمة الصيغة لهذا النطاق.
setFormulas(formulas)Rangeتضبط هذه السمة شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق).
setFormulasR1C1(formulas)Rangeتضبط هذه السمة شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق).
setHorizontalAlignment(alignment)Rangeضبط المحاذاة الأفقية (من اليسار إلى اليمين) للنطاق المحدّد (يسار/وسط/يمين)
setHorizontalAlignments(alignments)Rangeتضبط هذه السمة شبكة مستطيلة من عمليات المحاذاة الأفقية.
setNote(note)Rangeتضبط هذه السمة الملاحظة على القيمة المحدّدة.
setNotes(notes)Rangeتضبط هذه السمة شبكة مستطيلة من النوتات (يجب أن تتطابق مع أبعاد هذا النطاق).
setNumberFormat(numberFormat)Rangeتضبط هذه السمة تنسيق الأرقام أو التواريخ على سلسلة التنسيق المحدّدة.
setNumberFormats(numberFormats)Rangeتضبط هذه السمة شبكة مستطيلة من تنسيقات الأرقام أو التواريخ (يجب أن تتطابق مع أبعاد هذا النطاق).
setRichTextValue(value)Rangeتضبط هذه السمة قيمة النص المنسّق للخلايا في النطاق.
setRichTextValues(values)Rangeتضبط هذه السمة شبكة مستطيلة من قيم "النص المنسّق".
setShowHyperlink(showHyperlink)Rangeيحدّد ما إذا كان يجب أن يعرض النطاق روابط تشعّبية أم لا.
setTextDirection(direction)Rangeتضبط هذه السمة اتجاه النص للخلايا في النطاق.
setTextDirections(directions)Rangeتضبط هذه السمة شبكة مستطيلة من اتجاهات النص.
setTextRotation(degrees)Rangeتضبط هذه السمة إعدادات تدوير النص للخلايا في النطاق.
setTextRotation(rotation)Rangeتضبط هذه السمة إعدادات تدوير النص للخلايا في النطاق.
setTextRotations(rotations)Rangeتضبط هذه السمة شبكة مستطيلة من عمليات تدوير النص.
setTextStyle(style)Rangeتضبط هذه السمة نمط النص للخلايا في النطاق.
setTextStyles(styles)Rangeتضبط هذه السمة شبكة مستطيلة من أنماط النصوص.
setValue(value)Rangeتضبط هذه السمة قيمة النطاق.
setValues(values)Rangeتضبط هذه السمة شبكة مستطيلة من القيم (يجب أن تتطابق مع أبعاد هذا النطاق).
setVerticalAlignment(alignment)Rangeاضبط المحاذاة العمودية (من الأعلى إلى الأسفل) للنطاق المحدّد (أعلى/وسط/أسفل).
setVerticalAlignments(alignments)Rangeتضبط هذه السمة شبكة مستطيلة من عمليات المحاذاة العمودية (يجب أن تتطابق مع أبعاد هذا النطاق).
setVerticalText(isVertical)Rangeتضبط هذه السمة ما إذا كان سيتم ترتيب النص في الخلايا ضمن النطاق فوق بعضه أم لا.
setWrap(isWrapEnabled)Rangeاضبط التفاف الخلية للنطاق المحدّد.
setWrapStrategies(strategies)Rangeتضبط هذه السمة شبكة مستطيلة من استراتيجيات الالتفاف.
setWrapStrategy(strategy)Rangeتضبط هذه السمة استراتيجية التفاف النص للخلايا في النطاق.
setWraps(isWrapEnabled)Rangeتضبط هذه السمة شبكة مستطيلة من سياسات التفاف النص (يجب أن تتطابق مع أبعاد هذا النطاق).
shiftColumnGroupDepth(delta)Rangeتغيّر هذه السمة عمق تجميع الأعمدة للنطاق بالمقدار المحدّد.
shiftRowGroupDepth(delta)Rangeتغيّر هذه السمة عمق تجميع الصفوف للنطاق بالمقدار المحدّد.
sort(sortSpecObj)Rangeلترتيب الخلايا في النطاق المحدّد حسب العمود والترتيب المحدّدَين.
splitTextToColumns()voidتقسّم هذه الدالة عمودًا من النص إلى أعمدة متعددة استنادًا إلى محدد يتم رصده تلقائيًا.
splitTextToColumns(delimiter)voidتقسيم عمود من النص إلى عدة أعمدة باستخدام السلسلة المحدّدة كمحدّد مخصّص
splitTextToColumns(delimiter)voidتقسّم هذه الدالة عمودًا من النص إلى أعمدة متعددة استنادًا إلى المحدد الذي تم تحديده.
trimWhitespace()Rangeتزيل هذه الدالة المسافات البيضاء (مثل المسافات أو علامات التبويب أو الأسطر الجديدة) في كل خلية ضمن هذا النطاق.
uncheck()Rangeتغيير حالة مربّعات الاختيار في النطاق إلى "غير محدّدة"

مستندات مفصّلة

activate()

يضبط النطاق المحدّد على active range، مع اعتبار الخلية العلوية اليمنى في النطاق current cell.

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

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

الإرجاع

Range: هذا النطاق، للسلسلة.


activateAsCurrentCell()

تضبط هذه السمة الخلية المحدّدة على current cell.

إذا كانت الخلية المحدّدة متوفّرة في نطاق حالي، يصبح هذا النطاق هو النطاق النشط وتصبح الخلية هي الخلية الحالية.

إذا لم تكن الخلية المحدّدة متوفّرة في أي نطاق حالي، تتم إزالة التحديد الحالي وتصبح الخلية هي الخلية الحالية والنطاق النشط.

ملاحظة: يجب أن يتألف Range المحدّد من خلية واحدة، وإلا سيتم عرض استثناء.

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

// Gets the cell B5 and sets it as the active cell.
const range = sheet.getRange('B5');
const currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

addDeveloperMetadata(key)

تضيف هذه الدالة بيانات وصفية للمطوّر مع المفتاح المحدّد إلى النطاق.

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

المعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة للمطوّر

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

addDeveloperMetadata(key, visibility)

تضيف هذه الطريقة بيانات وصفية للمطوّرين بالمفتاح ومستوى الظهور المحدّدَين إلى النطاق.

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

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

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

المعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة للمطوّر
visibilityDeveloperMetadataVisibilityمستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

addDeveloperMetadata(key, value)

تضيف هذه الطريقة بيانات وصفية للمطوّرين بالمفتاح والقيمة المحدّدين إلى النطاق.

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

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

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

المعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة للمطوّر
valueStringقيمة البيانات الوصفية الجديدة للمطوّر.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

addDeveloperMetadata(key, value, visibility)

تضيف هذه الطريقة بيانات وصفية للمطوّرين تتضمّن المفتاح والقيمة ومستوى الظهور المحدّدين إلى النطاق.

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
    'NAME',
    'GOOGLE',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

المعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة للمطوّر
valueStringقيمة البيانات الوصفية الجديدة للمطوّر.
visibilityDeveloperMetadataVisibilityمستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyColumnBanding()

تطبيق مظهر تلقائي لتلوين الأعمدة على النطاق تتضمّن التخطيطات الشريطية تلقائيًا رأسًا ولا تتضمّن لون تذييل.

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(
    sheet.getBandings()[0]
        .getHeaderColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

الإرجاع

Banding: يشير إلى النطاق الجديد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyColumnBanding(bandingTheme)

تطبِّق هذه الدالة مظهرًا محدّدًا لتمييز الأعمدة على النطاق. بشكلٍ تلقائي، يتضمّن التخطيط المخطّط رأسًا ولا يتضمّن لون تذييل.

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

المعلمات

الاسمالنوعالوصف
bandingThemeBandingThemeمظهر ألوان لتطبيقه على الأعمدة في النطاق

الإرجاع

Banding: يشير إلى النطاق الجديد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

تطبِّق هذه الدالة تصميمًا محدّدًا لتقسيم الأعمدة إلى نطاقات على النطاق مع إعدادات محدّدة للرأس والتذييل.

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

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

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(
    SpreadsheetApp.BandingTheme.BLUE,
    false,
    true,
);

// Gets the banding color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the header color object and logs it to the console. Returns null because
// the header visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getFooterColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

المعلمات

الاسمالنوعالوصف
bandingThemeBandingThemeمظهر ألوان لتطبيقه على الأعمدة في النطاق
showHeaderBooleanفي حال ضبط القيمة على true، يتم تطبيق لون عنوان تصميم النطاق على العمود الأول.
showFooterBooleanإذا كانت القيمة true، يتم تطبيق لون تذييل مظهر التخطيط النطاقي على العمود الأخير.

الإرجاع

Banding: يشير إلى النطاق الجديد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyRowBanding()

تطبِّق هذه السمة مظهرًا تلقائيًا لتقسيم الصفوف إلى نطاقات على النطاق. تتضمّن التخطيطات الشريطية تلقائيًا رأسًا ولا تتضمّن لون تذييل.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

الإرجاع

Banding: التباين

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyRowBanding(bandingTheme)

تطبِّق هذه الدالة مظهرًا محدّدًا لتلوين الصفوف بالتناوب على النطاق. تتضمّن التخطيطات الشريطية تلقائيًا رأسًا ولا تتضمّن لون تذييل.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

المعلمات

الاسمالنوعالوصف
bandingThemeBandingThemeمظهر الألوان المطلوب تطبيقه على الصفوف في النطاق

الإرجاع

Banding: يشير إلى النطاق الجديد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

applyRowBanding(bandingTheme, showHeader, showFooter)

تطبِّق هذه الدالة مظهرًا محدّدًا لتقسيم الصفوف على النطاق مع إعدادات محدّدة للرأس والتذييل.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

المعلمات

الاسمالنوعالوصف
bandingThemeBandingThemeمظهر الألوان المطلوب تطبيقه على الصفوف في النطاق
showHeaderBooleanإذا كانت القيمة true، يتم تطبيق لون عنوان المظهر المخطّط على الصف الأول.
showFooterBooleanإذا كانت القيمة true، يتم تطبيق لون تذييل مظهر النطاقات على الصف الأخير.

الإرجاع

Banding: يشير إلى النطاق الجديد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

autoFill(destination, series)

يملأ destinationRange بالبيانات استنادًا إلى البيانات في هذا النطاق. يتم تحديد القيم الجديدة أيضًا حسب نوع series المحدّد. يجب أن يحتوي نطاق الوجهة على هذا النطاق وأن يمتد في اتجاه واحد فقط. على سبيل المثال، يملأ ما يلي A1:A20 بسلسلة من الأرقام المتزايدة استنادًا إلى القيم الحالية في A1:A4:

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const destination = sheet.getRange('A1:A20');

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

المعلمات

الاسمالنوعالوصف
destinationRangeالنطاق الذي سيتم ملؤه تلقائيًا بالقيم. يجب أن يحتوي نطاق الوجهة على هذا النطاق وأن يوسّعه في اتجاه واحد فقط (للأعلى أو للأسفل أو لليمين أو لليسار).
seriesAutoFillSeriesنوع سلسلة الملء التلقائي التي يجب استخدامها لاحتساب القيم الجديدة.  ويختلف تأثير هذه السلسلة استنادًا إلى نوع بيانات المصدر وكميتها.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

autoFillToNeighbor(series)

تحسب هذه الدالة نطاقًا ليتم ملؤه ببيانات جديدة استنادًا إلى الخلايا المجاورة، وتملأ هذا النطاق تلقائيًا بقيم جديدة استنادًا إلى البيانات الواردة فيه. يتم تحديد هذه القيم الجديدة أيضًا حسب نوع series المحدّد.

يأخذ نطاق الوجهة المحسوب في الاعتبار البيانات المحيطة لتحديد مكان إدراج القيم الجديدة: إذا كانت هناك بيانات على يسار أو يمين عمود تتم تعبئته تلقائيًا، لن تمتد القيم الجديدة إلا بقدر هذه البيانات المجاورة.

على سبيل المثال، إذا تم ملء العمود A1:A20 بسلسلة من الأرقام المتزايدة وتم استدعاء هذه الطريقة على النطاق B1:B4 الذي يحتوي على سلسلة من التواريخ، لن يتم إدراج قيم جديدة إلا في B5:B20. بهذه الطريقة، "تلتصق" هذه القيم الجديدة بالخلايا التي تحتوي على قيم في العمود A.

const sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
const sourceRange = sheet.getRange('B1:B4');

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

المعلمات

الاسمالنوعالوصف
seriesAutoFillSeriesنوع سلسلة الملء التلقائي التي يجب استخدامها لاحتساب القيم الجديدة.  ويختلف تأثير هذه السلسلة استنادًا إلى نوع بيانات المصدر وكميتها.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

breakApart()

قسِّم أي خلايا متعدّدة الأعمدة في النطاق إلى خلايا فردية مرة أخرى.

إنّ استدعاء هذه الدالة على نطاق يعادل اختيار نطاق والنقر على التنسيق > دمج الخلايا > إلغاء الدمج.

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

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

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

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

canEdit()

تُحدِّد هذه السمة ما إذا كان لدى المستخدم الإذن بتعديل كل خلية في النطاق. يمكن لمالك جدول البيانات دائمًا تعديل النطاقات والأوراق المحمية.

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

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

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

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

الإرجاع

Booleantrue إذا كان لدى المستخدم إذن بتعديل كل خلية في النطاق، أو false في حال عدم توفّر هذا الإذن.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

check()

تغيّر هذه السمة حالة مربّعات الاختيار في النطاق إلى "محدّد"، وتتجاهل الخلايا في النطاق التي لا تحتوي حاليًا على القيمة المحدّدة أو غير المحدّدة التي تم ضبطها.

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

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clear()

يمحو نطاق المحتوى والتنسيقات.

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

const range = sheet.getRange('A1:D10');
range.clear();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clear(options)

يمحو هذا العنصر نطاق المحتوى والتنسيق وقواعد التحقّق من صحة البيانات و/أو التعليقات، كما هو محدّد باستخدام الخيارات المتقدّمة المحدّدة. يتم محو جميع البيانات تلقائيًا.

// The code below clears range C2:G7 in the active sheet, but preserves the
// format, data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({
  contentsOnly: true
});

المعلمات

الاسمالنوعالوصف
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسمالنوعالوصف
commentsOnlyBooleanتحديد ما إذا كان سيتم محو التعليقات فقط
contentsOnlyBooleanتحديد ما إذا كان سيتم محو المحتوى فقط
formatOnlyBooleanما إذا كان سيتم محو التنسيق فقط، مع العلم أنّ محو التنسيق يؤدي أيضًا إلى محو قواعد التحقّق من صحة البيانات
validationsOnlyBooleanما إذا كان سيتم محو قواعد التحقّق من صحة البيانات فقط
skipFilteredRowsBooleanتحديد ما إذا كان يجب تجنُّب محو الصفوف التي تمت فلترتها

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clearContent()

يمحو محتوى النطاق مع الحفاظ على التنسيق.

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

const range = sheet.getRange('A1:D10');
range.clearContent();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clearDataValidations()

يمحو قواعد التحقّق من صحة البيانات للنطاق.

// Clear the data validation rules for cells A1:B5.
const range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clearFormat()

يمحو التنسيق لهذا النطاق.

يؤدي ذلك إلى محو تنسيق النص في الخلية أو الخلايا ضمن النطاق، ولكنّه لا يعيد ضبط أي قواعد تنسيق أرقام.

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

clearNote()

لمحو الملاحظة في الخلية أو الخلايا المحدّدة

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

const range = sheet.getRange('A1:D10');
range.clearNote();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

collapseGroups()

يصغّر جميع المجموعات التي يتم تضمينها بالكامل في النطاق. إذا لم تكن أي مجموعة ضمن النطاق بالكامل، يتم تصغير المجموعة الموسّعة الأعمق التي تقع جزئيًا ضمن النطاق.

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

copyFormatToRange(gridId, column, columnEnd, row, rowEnd)

نسخ تنسيق النطاق إلى الموقع الجغرافي المحدّد إذا كان حجم الوجهة أكبر أو أصغر من نطاق المصدر، سيتم تكرار المصدر أو اقتطاعه وفقًا لذلك. يُرجى العِلم أنّ هذه الطريقة تنسخ التنسيق فقط.

للحصول على وصف تفصيلي للمَعلمة gridId، يُرجى الاطّلاع على getGridId().

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

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

المعلمات

الاسمالنوعالوصف
gridIdIntegerالمعرّف الفريد للورقة داخل جدول البيانات، بغض النظر عن موضعها
columnIntegerالعمود الأول من النطاق المستهدَف
columnEndIntegerعمود نهاية النطاق المستهدَف
rowIntegerتمثّل هذه السمة صف البداية للنطاق المستهدف.
rowEndIntegerصف النهاية للنطاق المستهدَف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


copyFormatToRange(sheet, column, columnEnd, row, rowEnd)

نسخ تنسيق النطاق إلى الموقع الجغرافي المحدّد إذا كان حجم الوجهة أكبر أو أصغر من نطاق المصدر، سيتم تكرار المصدر أو اقتطاعه وفقًا لذلك. يُرجى العِلم أنّ هذه الطريقة تنسخ التنسيق فقط.

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

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

المعلمات

الاسمالنوعالوصف
sheetSheetورقة البيانات المستهدَفة
columnIntegerالعمود الأول من النطاق المستهدَف
columnEndIntegerعمود نهاية النطاق المستهدَف
rowIntegerتمثّل هذه السمة صف البداية للنطاق المستهدف.
rowEndIntegerصف النهاية للنطاق المستهدَف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

copyTo(destination)

تنسخ هذه الدالة البيانات من نطاق خلايا إلى نطاق خلايا آخر. يتم نسخ القيم والتنسيق.

// The code below copies the first 5 columns over to the 6th column.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

المعلمات

الاسمالنوعالوصف
destinationRangeنطاق الوجهة الذي سيتم النسخ إليه، ولا يهم سوى موضع الخلية في أعلى اليسار.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

copyTo(destination, copyPasteType, transposed)

تنسخ هذه الدالة البيانات من نطاق خلايا إلى نطاق خلايا آخر.

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(
    sheet.getRange('F1'),
    SpreadsheetApp.CopyPasteType.PASTE_VALUES,
    false,
);

المعلمات

الاسمالنوعالوصف
destinationRangeنطاق الوجهة الذي سيتم النسخ إليه، ولا يهم سوى موضع الخلية في أعلى اليسار.
copyPasteTypeCopyPasteTypeنوع يحدّد كيفية لصق محتوى النطاق في الوجهة.
transposedBooleanلتحديد ما إذا كان يجب لصق النطاق في اتجاهه المنقول أم لا.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

copyTo(destination, options)

تنسخ هذه الدالة البيانات من نطاق خلايا إلى نطاق خلايا آخر. يتم تلقائيًا نسخ القيم والتنسيق، ولكن يمكن إلغاء ذلك باستخدام وسيطات متقدّمة.

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(sheet.getRange('F1'), {contentsOnly: true});

المعلمات

الاسمالنوعالوصف
destinationRangeنطاق الوجهة الذي سيتم النسخ إليه، ولا يهم سوى موضع الخلية في أعلى اليسار.
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسمالنوعالوصف
formatOnlyBooleanيشير إلى أنّه يجب نسخ التنسيق فقط
contentsOnlyBooleanيشير إلى أنّه يجب نسخ المحتوى فقط

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

copyValuesToRange(gridId, column, columnEnd, row, rowEnd)

نسخ محتوى النطاق إلى الموقع الجغرافي المحدّد إذا كان حجم الوجهة أكبر أو أصغر من نطاق المصدر، سيتم تكرار المصدر أو اقتطاعه وفقًا لذلك.

للحصول على وصف تفصيلي للمَعلمة gridId، يُرجى الاطّلاع على getGridId().

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

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

المعلمات

الاسمالنوعالوصف
gridIdIntegerالمعرّف الفريد للورقة داخل جدول البيانات، بغض النظر عن موضعها
columnIntegerالعمود الأول من النطاق المستهدَف
columnEndIntegerعمود نهاية النطاق المستهدَف
rowIntegerتمثّل هذه السمة صف البداية للنطاق المستهدف.
rowEndIntegerصف النهاية للنطاق المستهدَف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


copyValuesToRange(sheet, column, columnEnd, row, rowEnd)

نسخ محتوى النطاق إلى الموقع الجغرافي المحدّد إذا كان حجم الوجهة أكبر أو أصغر من نطاق المصدر، سيتم تكرار المصدر أو اقتطاعه وفقًا لذلك.

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

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

المعلمات

الاسمالنوعالوصف
sheetSheetورقة البيانات المستهدَفة
columnIntegerالعمود الأول من النطاق المستهدَف
columnEndIntegerعمود نهاية النطاق المستهدَف
rowIntegerتمثّل هذه السمة صف البداية للنطاق المستهدف.
rowEndIntegerصف النهاية للنطاق المستهدَف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

createDataSourcePivotTable(dataSource)

تُنشئ هذه الدالة جدولاً محوريًا فارغًا لمصدر البيانات من مصدر البيانات، ويتم تثبيته في الخلية الأولى في هذا النطاق.

يوضّح هذا المثال كيفية إنشاء جدول محوري جديد لمصدر بيانات وتكوينه.

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

const pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue(
    'dataColumnC',
    SpreadsheetApp.PivotTableSummarizeFunction.SUM,
);
pivotTable.addFilter(
    'dataColumnA',
    SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build(),
);

المعلمات

الاسمالنوعالوصف
dataSourceDataSourceمصدر البيانات الذي سيتم إنشاء الجدول المحوري منه

الإرجاع

DataSourcePivotTable: الجدول المحوري لمصدر البيانات الذي تم إنشاؤه حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

createDataSourceTable(dataSource)

ينشئ جدول مصدر بيانات فارغًا من مصدر البيانات، ويتم تثبيته في الخلية الأولى في هذا النطاق.

يوضّح هذا المثال كيفية إنشاء جدول مصدر بيانات جديد وإعداده.

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

const dataSourceTable =
    anchorCell.createDataSourceTable(dataSource)
        .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
        .addSortSpec('dataColumnA', true)    // ascending=true
        .addSortSpec('dataColumnB', false);  // ascending=false

المعلمات

الاسمالنوعالوصف
dataSourceDataSourceمصدر البيانات الذي سيتم إنشاء الجدول المحوري منه

الإرجاع

DataSourceTable: جدول مصدر البيانات الذي تم إنشاؤه حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

createDeveloperMetadataFinder()

تعرض هذه الدالة DeveloperMetadataFinderApi للعثور على البيانات الوصفية للمطوّرين ضمن نطاق هذا النطاق. تكون البيانات الوصفية ضمن نطاق السلسلة فقط إذا كانت مضمّنة بالكامل في هذا النطاق. على سبيل المثال، لا تندرج البيانات الوصفية المرتبطة بالصف "3:3" ضمن نطاق "A1:D5"، ولكنها تندرج ضمن نطاق "1:5".

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

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

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of
// this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

الإرجاع

DeveloperMetadataFinder: أداة بحث عن البيانات الوصفية لمطوّر البرامج للبحث عن البيانات الوصفية في نطاق هذا النطاق.


createFilter()

تُنشئ هذه الدالة فلترًا وتطبّقه على النطاق المحدّد في ورقة البيانات. لا يمكنك إنشاء أكثر من فلتر واحد في ورقة. للوصول إلى الفلتر وتعديله بعد إنشائه، استخدِم getFilter() أو Sheet.getFilter().

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}
استخدِم هذه الطريقة لإنشاء فلاتر لجداول بيانات Grid، وهو النوع التلقائي من جداول البيانات. أوراق البيانات الشبكية هي أوراق بيانات غير مرتبطة بقاعدة بيانات. لإنشاء أنواع أخرى من الفلاتر، يُرجى الرجوع إلى ما يلي:

الإرجاع

Filter: الفلتر الجديد

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

createPivotTable(sourceData)

تنشئ هذه الدالة جدولاً محوريًا فارغًا من sourceData المحدّد والمرتكز على الخلية الأولى في هذا النطاق.

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

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

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

المعلمات

الاسمالنوعالوصف
sourceDataRangeالبيانات التي سيتم إنشاء الجدول المحوري منها

الإرجاع

PivotTable: PivotTable الذي تم إنشاؤه حديثًا.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

createTextFinder(findText)

تنشئ هذه الدالة أداة بحث عن النص في النطاق، ويمكنها العثور على النص في هذا النطاق واستبداله.

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

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

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

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

المعلمات

الاسمالنوعالوصف
findTextStringالنص المطلوب البحث عنه.

الإرجاع

TextFinder: TextFinder للنطاق


deleteCells(shiftDimension)

لحذف نطاق الخلايا هذا يتم نقل البيانات الحالية في الورقة على طول السمة المقدَّمة إلى النطاق المحذوف.

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

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

المعلمات

الاسمالنوعالوصف
shiftDimensionDimensionالسمة التي سيتم نقل البيانات الحالية على طولها.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

expandGroups()

توسيع المجموعات المصغّرة التي يتقاطع نطاقها أو مفتاح التحكّم الخاص بها مع هذا النطاق موضع زر التبديل الخاص بعنصر التحكّم هو الفهرس الذي يظهر فيه زر التبديل الخاص بعنصر التحكّم، إما قبل المجموعة أو بعدها مباشرةً، وذلك حسب الإعدادات. إذا كان هناك أكثر من مجموعة واحدة في الموقع الجغرافي نفسه، يتم توسيع المجموعة الأقل عمقًا.

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

// All row and column groups within the range are expanded.
range.expandGroups();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getA1Notation()

تعرض هذه الدالة وصفًا نصيًا للنطاق بتنسيق A1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

الإرجاع

String: وصف السلسلة للنطاق بتنسيق A1.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getBackground()

تعرض هذه الدالة لون الخلفية للخلية أعلى اليمين في النطاق (على سبيل المثال، '#ffffff').

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

الإرجاع

String: رمز لون الخلفية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getBackgroundObject()

تعرض هذه الدالة لون الخلفية للخلية أعلى اليمين في النطاق.

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

الإرجاع

Color: لون خلفية الخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getBackgroundObjects()

تعرض هذه الدالة ألوان الخلفية للخلايا في النطاق.

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

الإرجاع

Color[][]: مصفوفة ثنائية الأبعاد لألوان الخلفية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getBackgrounds()

تعرض هذه السمة ألوان الخلفية للخلايا في النطاق (على سبيل المثال، '#ffffff').

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgrounds();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد لرموز ألوان الخلفيات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getBandings()

تعرِض هذه الدالة جميع النطاقات التي يتم تطبيقها على أي خلايا في هذا النطاق.

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

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

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

الإرجاع

Banding[]: جميع النطاقات التي يتم تطبيقها على أي خلايا في هذا النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getCell(row, column)

لعرض خلية معيّنة ضمن نطاق.

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

const range = sheet.getRange('B2:D4');

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
const cell = range.getCell(1, 1);
Logger.log(cell.getValue());

المعلمات

الاسمالنوعالوصف
rowIntegerتمثّل هذه السمة صف الخلية بالنسبة إلى النطاق.
columnIntegerعمود الخلية بالنسبة إلى النطاق

الإرجاع

Range: نطاق يحتوي على خلية واحدة بالإحداثيات المحدّدة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getColumn()

تعرِض هذه السمة موضع عمود البداية لهذا النطاق.

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

const range = sheet.getRange('B2:D4');
// Logs "2.0"
Logger.log(range.getColumn());

الإرجاع

Integer: موضع عمود بداية النطاق في جدول البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataRegion()

تعرض هذه الدالة نسخة من النطاق الموسّع في الاتجاهات الأساسية الأربعة Direction لتغطية جميع الخلايا المجاورة التي تحتوي على بيانات. إذا كان النطاق محاطًا بخلايا فارغة لا تتضمّن الخلايا الواقعة على الأقطار، يتم عرض النطاق نفسه. يشبه ذلك اختيار النطاق وكتابة Ctrl+A في المحرّر.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange('C3').getDataRegion().getA1Notation());

الإرجاع

Range: منطقة بيانات النطاق أو نطاق جدول البيانات بأكمله

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataRegion(dimension)

تعرض نسخة من النطاق الموسّع Direction.UP وDirection.DOWN إذا كان البُعد المحدّد هو Dimension.ROWS، أو Direction.NEXT وDirection.PREVIOUS إذا كان البُعد هو Dimension.COLUMNS. يستند توسيع النطاق إلى رصد بيانات بجانب النطاق منظَّمة على شكل جدول. يغطّي النطاق الموسّع جميع الخلايا المجاورة التي تحتوي على بيانات في البُعد المحدّد، بما في ذلك حدود الجدول. إذا كان النطاق الأصلي محاطًا بخلايا فارغة على طول البُعد المحدّد، يتم عرض النطاق نفسه. تشبه هذه الطريقة اختيار النطاق وكتابة Ctrl+Space للأعمدة أو Shift+Space للصفوف في أداة التعديل.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "C2:C4"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.ROWS)
        .getA1Notation(),
);
// Logs "B3:D3"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.COLUMNS)
        .getA1Notation(),
);

المعلمات

الاسمالنوعالوصف
dimensionDimensionالسمة التي سيتم توسيع النطاق على طولها.

الإرجاع

Range: منطقة بيانات النطاق أو نطاق يغطي كل عمود أو كل صف يمتد على النطاق الأصلي.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataSourceFormula()

تعرض هذه الدالة DataSourceFormula للخلية الأولى في النطاق، أو null إذا كانت الخلية لا تحتوي على صيغة مصدر بيانات.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

الإرجاع

DataSourceFormula: DataSourceFormula للخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataSourceFormulas()

تعرض هذه الدالة DataSourceFormula للخلايا في النطاق.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

الإرجاع

DataSourceFormula[]: مصفوفة من DataSourceFormula

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataSourcePivotTables()

تعرض هذه الدالة جميع جداول البيانات المحورية لمصدر البيانات التي تتقاطع مع النطاق.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

الإرجاع

DataSourcePivotTable[]: قائمة بالجداول المحورية لمصادر البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataSourceTables()

تعرض هذه الدالة جميع جداول مصادر البيانات التي تتقاطع مع النطاق.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

الإرجاع

DataSourceTable[]: قائمة بجداول مصادر البيانات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataSourceUrl()

تعرض هذه الدالة عنوان URL للبيانات في هذا النطاق، ويمكن استخدامها لإنشاء رسوم بيانية واستعلامات.

Code.gs

function doGet() {
  const ss = SpreadsheetApp.openById(
      '1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c',
  );
  const sheet = ss.getSheetByName('ContinentData');
  const range = sheet.getRange('A1:B8');

  const template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

الإرجاع

String: عنوان URL لهذا النطاق كمصدر بيانات يمكن تمريره إلى واجهات برمجة تطبيقات أخرى، مثل الرسوم البيانية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataTable()

تعرض هذه الدالة البيانات داخل هذا العنصر كـ DataTable.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets the range A1:B7 as a data table. The values in each column must be of
// the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use
// sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

الإرجاع

DataTable: البيانات كجدول بيانات


getDataTable(firstRowIsHeader)

لعرض البيانات داخل هذا النطاق كـ DataTable.

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

// Calling this method with "true" sets the first line to be the title of the
// axes
const datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

المعلمات

الاسمالنوعالوصف
firstRowIsHeaderBooleanتحديد ما إذا كان سيتم التعامل مع الصف الأول كعنوان

الإرجاع

DataTable: البيانات كجدول بيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataValidation()

تعرض هذه الدالة قاعدة التحقّق من صحة البيانات للخلية أعلى اليمين في النطاق. إذا لم يتم ضبط التحقّق من صحة البيانات في الخلية، ستعرض هذه الطريقة null.

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

الإرجاع

DataValidation: قاعدة التحقّق من صحة البيانات للخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDataValidations()

تعرض هذه الدالة قواعد التحقّق من صحة البيانات لجميع الخلايا في النطاق. إذا لم يتم ضبط التحقّق من صحة البيانات في خلية معيّنة، تعرض هذه الطريقة null لموضع تلك الخلية في المصفوفة.

// Change existing data validation rules that require a date in 2013 to require
// a date in 2014.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

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

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const args = rule.getCriteriaValues();

      if (criteria === SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN &&
          args[0].getTime() === oldDates[0].getTime() &&
          args[1].getTime() === oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

الإرجاع

DataValidation[][]: مصفوفة ثنائية الأبعاد لقواعد التحقّق من صحة البيانات المرتبطة بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDeveloperMetadata()

تعرض هذه الدالة البيانات الوصفية للمطوّر المرتبطة بهذا النطاق.

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

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

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

الإرجاع

DeveloperMetadata[]: البيانات الوصفية للمطوّر المرتبطة بهذا النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDisplayValue()

تعرض هذه الدالة القيمة المعروضة للخلية أعلى اليمين في النطاق. القيمة هي String. تأخذ القيمة المعروضة في الاعتبار تنسيق التاريخ والوقت والعملة، بما في ذلك التنسيقات التي يتم تطبيقها تلقائيًا من خلال إعدادات اللغة في جدول البيانات. تعرض الخلايا الفارغة سلسلة فارغة.

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

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

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

الإرجاع

String: القيمة المعروضة في هذه الخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getDisplayValues()

تعرض هذه السمة شبكة مستطيلة من القيم لهذا النطاق.

تعرض هذه الدالة صفيفًا ثنائي الأبعاد للقيم المعروضة، مفهرسًا حسب الصف ثم حسب العمود. القيم هي String عنصر. تأخذ القيمة المعروضة في الاعتبار تنسيق التاريخ والوقت والعملة، بما في ذلك التنسيقات التي يتم تطبيقها تلقائيًا من خلال إعدادات اللغة في جدول البيانات. يتم تمثيل الخلايا الفارغة بسلسلة فارغة في الصفيف. تذكَّر أنّه على الرغم من أنّ فهرس النطاق يبدأ من 1, 1، يتم فهرسة مصفوفة JavaScript من [0][0].

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values =
    SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد من القيم.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFilter()

تعرض هذه الدالة الفلتر في الورقة التي ينتمي إليها هذا النطاق، أو null إذا لم يكن هناك فلتر في الورقة.

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

الإرجاع

Filter: الفلتر

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontColorObject()

تعرض هذه الدالة لون الخط للخلية في أعلى يمين النطاق.

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

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

الإرجاع

Color: لون خط الخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontColorObjects()

تعرض هذه الدالة ألوان الخطوط في الخلايا ضمن النطاق.

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

const results = range.getFontColorObjects();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

الإرجاع

Color[][]: مصفوفة ثنائية الأبعاد لألوان الخطوط المرتبطة بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontFamilies()

تعرض هذه السمة عائلات الخطوط للخلايا في النطاق.

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

const results = range.getFontFamilies();

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد لعائلات الخطوط المرتبطة بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontFamily()

تعرض هذه الدالة مجموعة الخطوط للخلية في الزاوية العلوية اليمنى من النطاق.

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

Logger.log(range.getFontFamily());

الإرجاع

String: مجموعة خطوط الخلية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontLine()

تعرض هذه السمة نمط الخط للخلية في أعلى يمين النطاق ('underline' أو 'line-through' أو 'none').

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

Logger.log(range.getFontLine());

الإرجاع

String — سطر الخط

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontLines()

تعرض هذه الدالة نمط الخط للخلايا في النطاق ('underline' أو 'line-through' أو 'none').

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

const results = range.getFontLines();

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد لخطوط الخطوط المرتبطة بالخلايا في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontSize()

تعرض هذه الدالة حجم الخط بنقاط الخلية في أعلى يمين النطاق.

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

Logger.log(range.getFontSize());

الإرجاع

Integer: حجم الخط بالنقاط

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontSizes()

تعرض هذه السمة أحجام خطوط الخلايا في النطاق.

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

const results = range.getFontSizes();

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

الإرجاع

Integer[][]: هي مصفوفة ثنائية الأبعاد لأحجام خطوط النص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontStyle()

تعرض هذه السمة نمط الخط ('italic' أو 'normal') للخلية في أعلى يمين النطاق.

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

Logger.log(range.getFontStyle());

الإرجاع

String: نمط خط النص في الخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontStyles()

تعرض هذه السمة أنماط الخطوط للخلايا في النطاق.

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

const results = range.getFontStyles();

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

الإرجاع

String[][]: هي مصفوفة ثنائية الأبعاد لأنماط خطوط النص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontWeight()

تعرض هذه الدالة وزن الخط (عادي أو غامق) للخلية في الزاوية العلوية اليمنى من النطاق.

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

Logger.log(range.getFontWeight());

الإرجاع

String: تمثّل كثافة الخط للنص في الخلية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFontWeights()

تعرض هذه السمة أوزان الخطوط للخلايا في النطاق.

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

const results = range.getFontWeights();

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

الإرجاع

String[][]: هي مصفوفة ثنائية الأبعاد لأوزان خطوط النص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFormula()

تعرض هذه الدالة الصيغة (تنسيق A1) للخلية أعلى اليمين في النطاق، أو سلسلة فارغة إذا كانت الخلية فارغة أو لا تحتوي على صيغة.

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

// This assumes you have a function in B5 that sums up
// B2:B4
const range = sheet.getRange('B5');

// Logs the calculated value and the formula
Logger.log(
    'Calculated value: %s Formula: %s',
    range.getValue(),
    range.getFormula(),
);

الإرجاع

String: صيغة الخلية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFormulaR1C1()

تعرض هذه الدالة الصيغة (بالتنسيق R1C1) لخلية معيّنة، أو null إذا لم تكن هناك صيغة.

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

الإرجاع

String: الصيغة في ترميز R1C1.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFormulas()

لعرض الصِيَغ (تنسيق A1) للخلايا في النطاق. تكون الإدخالات في المصفوفة الثنائية الأبعاد سلاسل فارغة للخلايا التي لا تحتوي على صيغة.

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

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد من الصيغ بتنسيق السلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getFormulasR1C1()

لعرض الصِيَغ (تنسيق R1C1) للخلايا في النطاق. تكون الإدخالات في المصفوفة الثنائية الأبعاد null للخلايا التي لا تحتوي على صيغة.

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulasR1C1();
for (const i in formulas) {
  for (const j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

الإرجاع

String[][]: صفيف ثنائي الأبعاد من الصيغ بتنسيق R1C1.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getGridId()

تعرض هذه السمة رقم تعريف الشبكة للورقة الرئيسية للنطاق. المعرّفات هي قيم أعداد صحيحة غير سالبة عشوائية.

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

Logger.log(range.getGridId());

الإرجاع

استبدِل Integer بمعرّف الشبكة للورقة الرئيسية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getHeight()

تعرِض هذه السمة ارتفاع النطاق.

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

const range = sheet.getRange('B2:D4');
// logs 3.0
Logger.log(range.getHeight());

الإرجاع

Integer: يمثّل ارتفاع النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getHorizontalAlignment()

تعرض هذه الدالة المحاذاة الأفقية للنص (يمين/وسط/يسار) في الخلية في الزاوية العليا اليسرى من النطاق.

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

Logger.log(range.getHorizontalAlignment());

الإرجاع

String: المحاذاة الأفقية للنص في الخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getHorizontalAlignments()

تعرض هذه السمة المحاذاة الأفقية للخلايا في النطاق.

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

const results = range.getHorizontalAlignments();

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد للمحاذاة الأفقية للنص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getLastColumn()

تعرِض هذه السمة موضع العمود الأخير.

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastColumn());

الإرجاع

Integer: موضع عمود نهاية النطاق في جدول البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getLastRow()

تعرِض هذه السمة موضع صف النهاية.

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastRow());

الإرجاع

Integer: موضع نهاية النطاق في الصف في جدول البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getMergedRanges()

تعرض هذه الطريقة مصفوفة من عناصر Range تمثّل الخلايا المدمجة التي تقع بالكامل ضمن النطاق الحالي أو تحتوي على خلية واحدة على الأقل في النطاق الحالي.

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

const range = sheet.getRange('A1:B3');

const mergedRanges = range.getMergedRanges();
for (let i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

الإرجاع

Range[]: مصفوفة من عناصر Range تمثّل الخلايا المدمجة التي تتداخل مع النطاق.


getNextDataCell(direction)

بدءًا من الخلية في العمود والصف الأولين من النطاق، تعرض هذه الدالة الخلية التالية في الاتجاه المحدّد، وهي إما حافة نطاق متجاور من الخلايا التي تحتوي على بيانات أو الخلية الواقعة على حافة جدول البيانات في ذلك الاتجاه. هذا الإجراء مكافئ لكتابة Ctrl+[arrow key] في المحرّر.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('C3:E5');
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

المعلمات

الاسمالنوعالوصف
directionDirectionالاتجاه الذي سيتم فيه البحث عن خلية حافة منطقة البيانات التالية.

الإرجاع

Range: خلية حافة منطقة البيانات أو الخلية الموجودة على حافة جدول البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNote()

تعرض الملاحظة المرتبطة بالنطاق المحدّد.

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

Logger.log(range.getNote());

الإرجاع

String: الملاحظة المرتبطة بالخلية المحدّدة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNotes()

تعرض هذه الدالة الملاحظات المرتبطة بالخلايا في النطاق.

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

const results = range.getNotes();

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد من الملاحظات المرتبطة بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNumColumns()

تعرض هذه الدالة عدد الأعمدة في هذا النطاق.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

الإرجاع

Integer: عدد الأعمدة في هذا النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNumRows()

تعرض هذه الدالة عدد الصفوف في هذا النطاق.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

الإرجاع

Integer: عدد الصفوف في هذا النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNumberFormat()

تعرض هذه الدالة تنسيق الأرقام أو التواريخ في الخلية العلوية اليسرى للنطاق المحدّد. يمكن الاطّلاع على أنماط التنسيق التي يتم عرضها في مستندات Sheets API.

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

الإرجاع

String: تنسيق الأرقام في الخلية أعلى يمين النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getNumberFormats()

تعرض هذه الدالة تنسيقات الأرقام أو التواريخ للخلايا في النطاق. يتم وصف أنماط التنسيق التي يتم عرضها في مستندات Sheets API.

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

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

الإرجاع

String[][]: هي مصفوفة ثنائية الأبعاد لتنسيقات الأرقام.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getRichTextValue()

تعرض هذه الدالة قيمة النص المنسّق للخلية أعلى اليمين في النطاق، أو null إذا كانت قيمة الخلية ليست نصًا.

// Gets the Rich Text value of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const richText = range.getRichTextValue();
console.log(richText.getText());

الإرجاع

RichTextValue: قيمة النص المنسّق للخلية أعلى اليمين في النطاق، أو null إذا كانت قيمة الخلية ليست نصًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getRichTextValues()

تعرض هذه الدالة قيم النص المنسّق للخلايا في النطاق.

// Gets the Rich Text values for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const values = range.getRichTextValues();

for (let i = 0; i < values.length; i++) {
  for (let j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

الإرجاع

RichTextValue[][]: هي مصفوفة ثنائية الأبعاد من قيم النص المنسّق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getRow()

تعرِض هذه السمة موضع الصف لهذا النطاق. وهي مماثلة للدالة getRowIndex().

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

const range = sheet.getRange('B2');
Logger.log(range.getRow());

الإرجاع

استبدِل Integer بموضع الصف للنطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getRowIndex()

تعرِض هذه السمة موضع الصف لهذا النطاق. تتطابق مع getRow()‎.

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

const range = sheet.getRange('B2');
Logger.log(range.getRowIndex());

الإرجاع

استبدِل Integer بموضع الصف للنطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


getSheet()

تعرِض ورقة البيانات التي ينتمي إليها هذا النطاق.

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

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

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

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

الإرجاع

Sheet: ورقة البيانات التي ينتمي إليها هذا النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextDirection()

تعرض هذه الدالة اتجاه النص للخلية أعلى اليمين في النطاق. تعرِض هذه السمة القيمة null إذا تم تحديد اتجاه نص الخلية من خلال ميزة الرصد التلقائي.

// Get the text direction of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getTextDirection());

الإرجاع

TextDirection: اتجاه النص في الخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextDirections()

تعرض هذه الدالة اتجاهات النص للخلايا في النطاق. تكون الإدخالات في مصفوفة ثنائية الأبعاد null للخلايا التي تستخدم ميزة "الاكتشاف التلقائي".

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

for (let i = 0; i < directions.length; i++) {
  for (let j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

الإرجاع

TextDirection[][]: صفيف ثنائي الأبعاد لاتجاهات النص.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextRotation()

تعرض إعدادات تدوير النص للخلية أعلى اليمين في النطاق.

// Log the text rotation settings for a cell.
const sheet = SpreadsheetApp.getActiveSheet();

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

الإرجاع

TextRotation: إعدادات تدوير النص

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextRotations()

تعرض هذه الدالة إعدادات تدوير النص للخلايا في النطاق.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

for (const i in results) {
  for (const j in results[i]) {
    const rotation = results[i][j];
    Logger.log('Cell [%s, %s] has text rotation: %v', i, j, rotation);
  }
}

الإرجاع

TextRotation[][]: صفيف ثنائي الأبعاد لعمليات تدوير النص المرتبطة بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextStyle()

تعرض هذه السمة نمط النص للخلية أعلى اليمين في النطاق.

// Get the text style of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const style = range.getTextStyle();
Logger.log(style);

الإرجاع

TextStyle: نمط النص للخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getTextStyles()

تعرض هذه الدالة أنماط النص للخلايا في النطاق.

// Get the text styles for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const styles = range.getTextStyles();

for (let i = 0; i < styles.length; i++) {
  for (let j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

الإرجاع

TextStyle[][]: مصفوفة ثنائية الأبعاد لأنماط النص

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getValue()

تعرض هذه الدالة قيمة الخلية أعلى اليمين في النطاق. قد تكون القيمة من النوع Number أو Boolean أو Date أو String، وذلك حسب قيمة الخلية. تعرض الخلايا الفارغة سلسلة فارغة.

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

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

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

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

الإرجاع

Object: القيمة في هذه الخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getValues()

تعرض هذه السمة شبكة مستطيلة من القيم لهذا النطاق.

تعرض هذه الدالة صفيفًا ثنائي الأبعاد من القيم، مفهرسًا حسب الصف، ثم حسب العمود. قد تكون القيم من النوع Number أو Boolean أو Date أو String، وذلك حسب قيمة الخلية. يتم تمثيل الخلايا الفارغة بسلسلة فارغة في الصفيف. تذكَّر أنّه على الرغم من أنّ فهرس النطاق يبدأ عند 1, 1، يتم فهرسة صفيف JavaScript من [0][0].

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
في تطبيقات الويب، لا تُعدّ القيمة Date مَعلمة قانونية. لا تعرض الدالة getValues() البيانات لتطبيق ويب إذا كان النطاق يحتوي على خلية بقيمة Date. بدلاً من ذلك، عليك تحويل جميع القيم التي تم استردادها من ورقة البيانات إلى نوع بيانات JavaScript أساسي متوافق، مثل Number أو Boolean أو String.

الإرجاع

Object[][]: مصفوفة ثنائية الأبعاد من القيم.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getVerticalAlignment()

تعرض هذه السمة المحاذاة العمودية (أعلى/وسط/أسفل) للخلية في الزاوية العلوية اليمنى من النطاق.

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

Logger.log(range.getVerticalAlignment());

الإرجاع

String: المحاذاة العمودية للنص في الخلية

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getVerticalAlignments()

تعرض هذه السمة المحاذاة العمودية للخلايا في النطاق.

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

const results = range.getVerticalAlignments();

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

الإرجاع

String[][]: مصفوفة ثنائية الأبعاد لعمليات المحاذاة العمودية للنص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getWidth()

تعرض هذه الدالة عرض النطاق بالأعمدة.

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

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

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

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

الإرجاع

Integer: عدد الأعمدة في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getWrap()

تعرِض هذه السمة ما إذا كان النص في الخلية يلتف. للحصول على استراتيجية التفاف أكثر دقة، استخدِم getWrapStrategy().

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

Logger.log(range.getWrap());

الإرجاع

Boolean: ما إذا كان النص في هذه الخلية يلتف أم لا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getWrapStrategies()

تعرض هذه الدالة استراتيجيات التفاف النص للخلايا في النطاق.

// Get the text wrapping strategies for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const strategies = range.getWrapStrategies();

for (let i = 0; i < strategies.length; i++) {
  for (let j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

الإرجاع

WrapStrategy[][]: مصفوفة ثنائية الأبعاد لاستراتيجيات التفاف النص

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getWrapStrategy()

تعرض هذه السمة استراتيجية التفاف النص للخلية أعلى اليمين في النطاق.

// Get the text wrapping strategy of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getWrapStrategy());

الإرجاع

WrapStrategy: استراتيجية التفاف النص في الخلية أعلى اليمين في النطاق

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

getWraps()

تعرِض هذه السمة ما إذا كان النص في الخلايا يلتف. للحصول على استراتيجية التفاف أكثر دقة، استخدِم getWrapStrategies().

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

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const isWrapped = results[i][j];
    if (isWrapped) {
      Logger.log('Cell [%s, %s] has wrapped text', i, j);
    }
  }
}

الإرجاع

Boolean[][]: مصفوفة ثنائية الأبعاد لعمليات المحاذاة العمودية للنص المرتبط بالخلايا في النطاق.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

insertCells(shiftDimension)

يُدرج خلايا فارغة في هذا النطاق. تحتفظ الخلايا الجديدة بأي تنسيق متوفّر في الخلايا التي كانت تشغل هذا النطاق سابقًا. يتم نقل البيانات الحالية في ورقة البيانات على طول السمة المقدَّمة بعيدًا عن النطاق المُدرَج.

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

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

المعلمات

الاسمالنوعالوصف
shiftDimensionDimensionالسمة التي سيتم نقل البيانات الحالية على طولها.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

insertCheckboxes()

تُدرج مربّعات اختيار في كل خلية في النطاق، ويتم ضبطها باستخدام true للخلايا المحدّدة وfalse للخلايا غير المحدّدة. تضبط هذه السمة قيمة جميع الخلايا في النطاق على false.

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

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true'
// for checked and 'false' for unchecked. Also, sets the value of each cell in
// the range A1:B10 to 'false'.
range.insertCheckboxes();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

insertCheckboxes(checkedValue)

تُدرِج مربّعات اختيار في كل خلية ضمن النطاق، ويتم ضبطها بقيمة مخصّصة للخلايا المحدّدة وسلسلة فارغة للخلايا غير المحدّدة. تضبط هذه الدالة قيمة كل خلية في النطاق على السلسلة الفارغة.

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

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and the empty string for unchecked. Also, sets the value of each
// cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

المعلمات

الاسمالنوعالوصف
checkedValueObjectالقيمة المحدّدة للتحقّق من صحة بيانات مربّع الاختيار.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

insertCheckboxes(checkedValue, uncheckedValue)

يُدرج مربّعات اختيار في كل خلية ضمن النطاق، ويتم ضبطها باستخدام قيم مخصّصة للحالتَين المحدّدة وغير المحدّدة. تضبط هذه السمة قيمة كل خلية في النطاق على القيمة المخصّصة غير المحدّدة.

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

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and 'no' for unchecked. Also, sets the value of each cell in the
// range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

المعلمات

الاسمالنوعالوصف
checkedValueObjectالقيمة المحدّدة للتحقّق من صحة بيانات مربّع الاختيار.
uncheckedValueObjectالقيمة غير المحدّدة للتحقّق من صحة بيانات مربّع الاختيار

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isBlank()

تعرِض الدالة القيمة true إذا كان النطاق فارغًا تمامًا.

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

Logger.log(range.isBlank());

الإرجاع

Booleantrue إذا كان النطاق فارغًا، أو false في الحالات الأخرى

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isChecked()

تعرض هذه الدالة ما إذا كانت حالة مربّع الاختيار في جميع الخلايا في النطاق هي "تم وضع علامة فيه". تعرض الدالة null إذا تم وضع علامة في بعض الخلايا وإزالة العلامة من الباقي، أو إذا كانت بعض الخلايا لا تتضمّن عملية التحقّق من صحة البيانات في مربّع الاختيار.

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

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

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

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

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

الإرجاع

Boolean: true إذا تم وضع علامة في جميع الخلايا في النطاق، أو false إذا لم يتم وضع علامة في جميع الخلايا في النطاق، أو null إذا لم يتم وضع علامة في أي من الخلايا أو إذا لم تتضمّن أي من الخلايا عملية التحقّق من صحة البيانات باستخدام مربّع الاختيار

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isEndColumnBounded()

تحدّد ما إذا كانت نهاية النطاق مرتبطة بعمود معيّن. على سبيل المثال، بالنسبة إلى النطاقين A1:B10 أو B:B المرتبطين بأعمدة في نهاية النطاق، يعرض هذا الأسلوب true. أما بالنسبة إلى النطاقين 3:7 أو A1:5 المرتبطين بصفوف معيّنة فقط في نهاية النطاق، فيعرض هذا الأسلوب false.

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

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

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

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

الإرجاع

Boolean: true إذا كانت نهاية النطاق مرتبطة بعمود معيّن، false في ما عدا ذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isEndRowBounded()

تحدّد ما إذا كانت نهاية النطاق مرتبطة بصف معيّن. على سبيل المثال، بالنسبة إلى النطاقين A1:B10 أو 3:7 المرتبطين بالصفوف في نهاية النطاق، تعرض هذه الطريقة true. أما بالنسبة إلى النطاقين B:B أو A1:C المرتبطين بالأعمدة المحددة فقط في نهاية النطاق، فتعرض هذه الطريقة false.

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

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

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

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

الإرجاع

Booleantrue إذا كانت نهاية النطاق مرتبطة بصف معيّن، false في ما عدا ذلك.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isPartOfMerge()

تعرِض الدالة true إذا كانت الخلايا في النطاق الحالي تتداخل مع أي خلايا مدمجة.

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

const range = sheet.getRange('A1:B3');

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

الإرجاع

Boolean: تعرض true إذا كان النطاق يتداخل مع أي خلايا مدمجة، وإلا تعرض false.


isStartColumnBounded()

تحدّد ما إذا كانت بداية النطاق مرتبطة بعمود معيّن. على سبيل المثال، بالنسبة إلى النطاقين A1:B10 أو B:B، المرتبطَين بأعمدة في بداية النطاق، تعرض هذه الطريقة true، أما بالنسبة إلى النطاق 3:7، المرتبط بصف فقط في بداية النطاق، فتعرض هذه الطريقة false.

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

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

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

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

الإرجاع

Boolean: true إذا كانت بداية النطاق مرتبطة بعمود معيّن، false في ما عدا ذلك.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

isStartRowBounded()

تحدّد ما إذا كانت بداية النطاق مرتبطة بصف معيّن. على سبيل المثال، بالنسبة إلى النطاقين A1:B10 أو 3:7، المرتبطَين بالصفوف في بداية النطاق، تعرض هذه الطريقة true. أما بالنسبة إلى النطاق B:B، المرتبط بعمود معيّن فقط في بداية النطاق، فتعرض هذه الطريقة false.

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

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

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

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

الإرجاع

Booleantrue إذا كان بداية النطاق مرتبطًا بصف معيّن، false بخلاف ذلك.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

merge()

تدمج الخلايا في النطاق معًا في كتلة واحدة.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

mergeAcross()

لدمج الخلايا في النطاق على مستوى أعمدة النطاق

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

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

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

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

mergeVertically()

تدمج هذه السمة الخلايا في النطاق معًا.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

moveTo(target)

قصّ ولصق (التنسيق والقيم) من هذا النطاق إلى النطاق المستهدَف

// The code below moves the first 5 columns over to the 6th column
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A1:E').moveTo(sheet.getRange('F1'));

المعلمات

الاسمالنوعالوصف
targetRangeنطاق مستهدف لنسخ هذا النطاق إليه، ولا يهم سوى موضع الخلية في أعلى اليمين.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

offset(rowOffset, columnOffset)

تعرِض نطاقًا جديدًا تمّت إزاحته من هذا النطاق بعدد الصفوف والأعمدة المحدّد (الذي يمكن أن يكون سالبًا). النطاق الجديد هو بالحجم نفسه الذي كان عليه النطاق الأصلي.

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

const cell = sheet.getRange('A1');

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

المعلمات

الاسمالنوعالوصف
rowOffsetIntegerعدد الصفوف التي تلي الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الصفوف التي تسبق الخلية أعلى اليمين في النطاق.
columnOffsetIntegerعدد الأعمدة على يمين الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الأعمدة على يسار الخلية أعلى اليمين في النطاق.

الإرجاع

Range: هذا النطاق، للسلسلة.


offset(rowOffset, columnOffset, numRows)

تعرض هذه الدالة نطاقًا جديدًا مرتبطًا بالنطاق الحالي، وتتم إزاحة نقطة أعلى اليمين فيه عن النطاق الحالي بمقدار الصفوف والأعمدة المحدّدة، ويكون ارتفاعه بالخلايا هو الارتفاع المحدّد.

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

const cell = sheet.getRange('A1');

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

المعلمات

الاسمالنوعالوصف
rowOffsetIntegerعدد الصفوف التي تلي الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الصفوف التي تسبق الخلية أعلى اليمين في النطاق.
columnOffsetIntegerعدد الأعمدة على يمين الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الأعمدة على يسار الخلية أعلى اليمين في النطاق.
numRowsIntegerارتفاع النطاق الجديد بالصفوف

الإرجاع

Range: هذا النطاق، للسلسلة.


offset(rowOffset, columnOffset, numRows, numColumns)

تعرض هذه الدالة نطاقًا جديدًا مرتبطًا بالنطاق الحالي، وتكون نقطة الزاوية العلوية اليسرى منه مزاحة عن النطاق الحالي بمقدار الصفوف والأعمدة المحدّدة، ويكون ارتفاعه وعرضه محدّدَين بعدد الخلايا.

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

const cell = sheet.getRange('A1');

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

المعلمات

الاسمالنوعالوصف
rowOffsetIntegerعدد الصفوف التي تلي الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الصفوف التي تسبق الخلية أعلى اليمين في النطاق.
columnOffsetIntegerعدد الأعمدة على يمين الخلية أعلى اليمين في النطاق، وتمثّل القيم السالبة الأعمدة على يسار الخلية أعلى اليمين في النطاق.
numRowsIntegerارتفاع النطاق الجديد بالصفوف
numColumnsIntegerعرض النطاق الجديد بالأعمدة

الإرجاع

Range: هذا النطاق، للسلسلة.


protect()

تنشئ هذه الدالة عنصرًا يمكنه حماية النطاق من التعديل باستثناء المستخدمين الذين لديهم إذن بذلك. إلى أن يغيّر النص البرمجي قائمة المحرّرين للنطاق (من خلال استدعاء Protection.removeEditor(emailAddress) أو Protection.removeEditor(user) أو Protection.removeEditors(emailAddresses) أو Protection.addEditor(emailAddress) أو Protection.addEditor(user) أو Protection.addEditors(emailAddresses) أو ضبط قيمة جديدة لـ Protection.setDomainEdit(editable))، ستكون الأذونات مماثلة لأذونات جدول البيانات نفسه، ما يعني فعليًا أنّ النطاق سيظل غير محمي. إذا كان النطاق محميًا من قبل، ستنشئ هذه الطريقة نطاقًا محميًا جديدًا يتداخل مع النطاق الحالي. إذا كانت إحدى الخلايا محمية بنطاقات محمية متعددة وكان أيّ منها يمنع مستخدمًا معيّنًا من تعديل الخلية، لن يُسمح لهذا المستخدم بتعديل الخلية.

// Protect range A1:B10, then remove all other users from the list of editors.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

الإرجاع

Protection: عنصر يمثّل إعدادات الحماية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

randomize()

لترتيب الصفوف في النطاق المحدّد بشكل عشوائي.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Randomizes the range
range.randomize();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

removeCheckboxes()

تزيل هذه الدالة جميع مربّعات الاختيار من النطاق. يزيل التحقّق من صحة البيانات في كل خلية، بالإضافة إلى إزالة قيمتها إذا كانت الخلية تحتوي على القيمة المحدّدة أو غير المحدّدة.

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

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

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

const range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

removeDuplicates()

يزيل الصفوف ضمن هذا النطاق التي تحتوي على قيم مكرّرة من القيم في أي صف سابق. ويتم اعتبار الصفوف مكررةً إذا كانت تحتوي على قيم متطابقة، حتى وإن كانت بحالات أحرف أو تنسيقات أو صيغ مختلفة. تؤدي هذه الطريقة أيضًا إلى إزالة الصفوف المكرّرة المخفية عن العرض (على سبيل المثال، بسبب فلتر). لن تتم إزالة المحتوى خارج هذا النطاق.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove duplicate rows in the range.
range.removeDuplicates();

الإرجاع

Range: النطاق الناتج بعد إزالة التكرارات يتم تقليل حجم النطاق بمقدار صف واحد لكل صف تتم إزالته.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

removeDuplicates(columnsToCompare)

يزيل هذا الإجراء الصفوف ضمن هذا النطاق التي تحتوي على قيم مكرّرة في الأعمدة المحدّدة من أي صف سابق. ويتم اعتبار الصفوف مكررةً إذا كانت تحتوي على قيم متطابقة، حتى وإن كانت بحالات أحرف أو تنسيقات أو صيغ مختلفة. تزيل هذه الطريقة أيضًا الصفوف المكرّرة المخفية عن العرض (على سبيل المثال، بسبب فلتر). لن تتم إزالة المحتوى خارج هذا النطاق.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2, 4]);

المعلمات

الاسمالنوعالوصف
columnsToCompareInteger[]الأعمدة المطلوب تحليلها بحثًا عن القيم المكرّرة في حال عدم توفير أي أعمدة، سيتم تحليل جميع الأعمدة بحثًا عن القيم المكرّرة.

الإرجاع

Range: النطاق الناتج بعد إزالة التكرارات يتم تقليل حجم النطاق بمقدار صف واحد لكل صف تتم إزالته.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBackground(color)

تضبط هذه السمة لون الخلفية لجميع الخلايا في النطاق بتنسيق CSS (مثل '#ffffff' أو 'white').

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

المعلمات

الاسمالنوعالوصف
colorStringرمز لون بتنسيق CSS (مثل '#ffffff' أو 'white')، أو قيمة null لإعادة ضبط اللون

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBackgroundObject(color)

تضبط هذه السمة لون الخلفية لجميع الخلايا في النطاق.

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

const range = sheet.getRange('B2:D5');
range.setBackgroundObject(bgColor);

المعلمات

الاسمالنوعالوصف
colorColorلون الخلفية المطلوب ضبطه، وتؤدي القيمة null إلى إعادة ضبط لون الخلفية.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBackgroundObjects(color)

تضبط هذه السمة شبكة مستطيلة من ألوان الخلفية (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setBackgroundObjects(colors);

المعلمات

الاسمالنوعالوصف
colorColor[][]مصفوفة ثنائية الأبعاد من الألوان، وتعيد قيم null ضبط اللون.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBackgroundRGB(red, green, blue)

يضبط الخلفية على اللون المحدّد باستخدام قيم الأحمر والأخضر والأزرق (أعداد صحيحة بين 0 و255 ضِمنًا).

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

const cell = sheet.getRange('B2');

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

المعلمات

الاسمالنوعالوصف
redIntegerقيمة اللون الأحمر في ترميز RGB
greenIntegerقيمة اللون الأخضر في ترميز RGB
blueIntegerقيمة اللون الأزرق في ترميز RGB

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBackgrounds(color)

تضبط هذه السمة شبكة مستطيلة من ألوان الخلفية (يجب أن تتطابق مع أبعاد هذا النطاق). تكون الألوان بتنسيق CSS (مثل '#ffffff' أو 'white').

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

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

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

المعلمات

الاسمالنوعالوصف
colorString[][]مصفوفة ثنائية الأبعاد للألوان بتنسيق CSS (مثل '#ffffff' أو 'white')؛ تؤدي قيم null إلى إعادة ضبط اللون.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBorder(top, left, bottom, right, vertical, horizontal)

تضبط هذه السمة حدود العنصر. القيم الصالحة هي true (مفعَّل) وfalse (غير مفعَّل) وnull (بدون تغيير).

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

المعلمات

الاسمالنوعالوصف
topBooleantrue للحدود، false بلا حدود، null بدون تغيير
leftBooleantrue للحدود، false بلا حدود، null بدون تغيير
bottomBooleantrue للحدود، false بلا حدود، null بدون تغيير
rightBooleantrue للحدود، false بلا حدود، null بدون تغيير
verticalBooleantrue للحدود العمودية الداخلية، false لعدم وجود حدود، null لعدم إجراء أي تغيير
horizontalBooleantrue للحدود الأفقية الداخلية، false لعدم وجود حدود، null لعدم إجراء أي تغيير

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

تضبط هذه السمة حدود العنصر باستخدام اللون و/أو النمط. القيم الصالحة هي true (مفعَّل) وfalse (غير مفعَّل) وnull (بدون تغيير). بالنسبة إلى اللون، استخدِم "اللون" في ترميز CSS (مثل '#ffffff' أو 'white').

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

المعلمات

الاسمالنوعالوصف
topBooleantrue للحدود، false بلا حدود، null بدون تغيير
leftBooleantrue للحدود، false بلا حدود، null بدون تغيير
bottomBooleantrue للحدود، false بلا حدود، null بدون تغيير
rightBooleantrue للحدود، false بلا حدود، null بدون تغيير
verticalBooleantrue للحدود العمودية الداخلية، false لعدم وجود حدود، null لعدم إجراء أي تغيير
horizontalBooleantrue للحدود الأفقية الداخلية، false لعدم وجود حدود، null لعدم إجراء أي تغيير
colorStringلون بتنسيق CSS (مثل '#ffffff' أو 'white')، أو null للون التلقائي (أسود)
styleBorderStyleنمط الحدود، null للنمط التلقائي (متصل)

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setDataValidation(rule)

تضبط هذه السمة قاعدة واحدة للتحقّق من صحة البيانات لجميع الخلايا في النطاق.

// Set the data validation rule for cell A1 to require a value from B1:B10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

المعلمات

الاسمالنوعالوصف
ruleDataValidationقاعدة التحقّق من صحة البيانات التي تريد ضبطها، أو null لإزالة التحقّق من صحة البيانات

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setDataValidations(rules)

تضبط هذه السمة قواعد التحقّق من صحة البيانات لجميع الخلايا في النطاق. تأخذ هذه الطريقة صفيفًا ثنائي الأبعاد لعمليات التحقّق من صحة البيانات، ويتم فهرسته حسب الصف ثم حسب العمود. يجب أن تتطابق أبعاد الصفيفة مع أبعاد النطاق.

// Set the data validation rules for Sheet1!A1:B5 to require a value from
// Sheet2!A1:A10.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

المعلمات

الاسمالنوعالوصف
rulesDataValidation[][]مصفوفة ثنائية الأبعاد لقواعد التحقّق من صحة البيانات التي سيتم ضبطها، null قيم لإزالة التحقّق من صحة البيانات.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontColor(color)

تضبط هذه السمة لون الخط بتنسيق CSS (مثل '#ffffff' أو 'white').

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

const cell = sheet.getRange('B2');
cell.setFontColor('red');

المعلمات

الاسمالنوعالوصف
colorStringلون الخط بتنسيق CSS (مثل '#ffffff' أو 'white')، تؤدي القيمة null إلى إعادة ضبط اللون.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontColorObject(color)

تضبط هذه السمة لون الخط للنطاق المحدّد.

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

const cell = sheet.getRange('B2');
cell.setFontColor(color);

المعلمات

الاسمالنوعالوصف
colorColorلون الخط المطلوب ضبطه، وتؤدي القيمة null إلى إعادة ضبط اللون.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontColorObjects(colors)

تضبط هذه السمة شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

المعلمات

الاسمالنوعالوصف
colorsColor[][]صفيف ثنائي الأبعاد للألوان، وتؤدي القيم null إلى إعادة ضبط لون الخط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontColors(colors)

تضبط هذه السمة شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). يتم عرض الألوان بتنسيق CSS (مثل '#ffffff' أو 'white').

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

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

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

المعلمات

الاسمالنوعالوصف
colorsObject[][]مصفوفة ثنائية الأبعاد للألوان بتنسيق CSS (مثل '#ffffff' أو 'white')؛ تؤدي قيم null إلى إعادة ضبط اللون.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontFamilies(fontFamilies)

تضبط هذه السمة شبكة مستطيلة من مجموعات الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). تشمل أمثلة عائلات الخطوط "Arial" أو "Helvetica".

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

المعلمات

الاسمالنوعالوصف
fontFamiliesObject[][]مصفوفة ثنائية الأبعاد لمجموعات الخطوط، وتؤدي قيم null إلى إعادة ضبط مجموعة الخطوط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontFamily(fontFamily)

تضبط هذه السمة مجموعة الخطوط، مثل "Arial" أو "Helvetica".

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

المعلمات

الاسمالنوعالوصف
fontFamilyStringمجموعة الخطوط المطلوب ضبطها، تؤدي القيمة null إلى إعادة ضبط مجموعة الخطوط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontLine(fontLine)

تضبط هذه السمة نمط خط النص في النطاق المحدّد ('underline' أو 'line-through' أو 'none').

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

المعلمات

الاسمالنوعالوصف
fontLineStringنمط خط النص، إما 'underline' أو 'line-through' أو 'none'، وتؤدي القيمة null إلى إعادة ضبط نمط خط النص.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontLines(fontLines)

تضبط هذه السمة شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

المعلمات

الاسمالنوعالوصف
fontLinesObject[][]مصفوفة ثنائية الأبعاد لأنماط خطوط الخطوط ('underline' أو 'line-through' أو 'none')، وتؤدي قيم null إلى إعادة ضبط نمط خطوط الخطوط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontSize(size)

تضبط هذه السمة حجم الخط، ويكون الحجم هو حجم النقطة المطلوب استخدامها.

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

المعلمات

الاسمالنوعالوصف
sizeIntegerحجم الخط بالنقاط

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontSizes(sizes)

تضبط هذه السمة شبكة مستطيلة من أحجام الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). يتم قياس الأحجام بالنقاط.

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

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

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

المعلمات

الاسمالنوعالوصف
sizesObject[][]مصفوفة ثنائية الأبعاد للمقاسات.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontStyle(fontStyle)

ضبط نمط الخط للنطاق المحدّد ('italic' أو 'normal').

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

المعلمات

الاسمالنوعالوصف
fontStyleStringنمط الخط، إما 'italic' أو 'normal'، وتؤدي القيمة null إلى إعادة ضبط نمط الخط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontStyles(fontStyles)

تضبط هذه السمة شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

المعلمات

الاسمالنوعالوصف
fontStylesObject[][]مصفوفة ثنائية الأبعاد لأنماط الخطوط، إما 'italic' أو 'normal'، وتعيد قيم null ضبط نمط الخط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontWeight(fontWeight)

ضبط عرض الخط للنطاق المحدّد (عادي/غامق)

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

المعلمات

الاسمالنوعالوصف
fontWeightStringتمثّل هذه السمة كثافة الخط، إما 'bold' أو 'normal'، وتؤدي القيمة null إلى إعادة ضبط كثافة الخط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFontWeights(fontWeights)

تضبط هذه السمة شبكة مستطيلة من أوزان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). مثال على وزن الخط هو "غامق".

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

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

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

المعلمات

الاسمالنوعالوصف
fontWeightsObject[][]مصفوفة ثنائية الأبعاد لكثافات الخطوط، إما 'bold' أو 'normal'، وتؤدي قيم null إلى إعادة ضبط كثافة الخط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFormula(formula)

تعدّل هذه السمة الصيغة لهذا النطاق. يجب أن تكون الصيغة المقدَّمة بتنسيق A1.

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

المعلمات

الاسمالنوعالوصف
formulaStringسلسلة تمثّل الصيغة المطلوب ضبطها للخلية.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFormulaR1C1(formula)

تعدّل هذه السمة الصيغة لهذا النطاق. يجب أن تكون الصيغة المحدّدة بتنسيق R1C1.

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

const cell = sheet.getRange('B5');
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

المعلمات

الاسمالنوعالوصف
formulaStringصيغة سلسلة

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFormulas(formulas)

تضبط هذه السمة شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق). يجب أن تكون الصيغ المقدَّمة بتنسيق A1. تأخذ هذه الطريقة صفيفًا ثنائي الأبعاد من الصيغ، مفهرسًا حسب الصف، ثم حسب العمود. يجب أن تتوافق أبعاد الصفيفة مع أبعاد النطاق.

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

// This sets the formulas to be a row of sums, followed by a row of averages
// right below. The size of the two-dimensional array must match the size of the
// range.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

المعلمات

الاسمالنوعالوصف
formulasString[][]مصفوفة سلاسل ثنائية الأبعاد من الصيغ

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setFormulasR1C1(formulas)

تضبط هذه السمة شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق). يجب أن تكون الصيغ المحدّدة بتنسيق R1C1.

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

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

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

const cell = sheet.getRange('B5:D6');
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

المعلمات

الاسمالنوعالوصف
formulasString[][]صفيف ثنائي الأبعاد من الصيغ بتنسيق R1C1.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setHorizontalAlignment(alignment)

ضبط المحاذاة الأفقية (من اليسار إلى اليمين) للنطاق المحدّد (يسار/وسط/يمين)

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

المعلمات

الاسمالنوعالوصف
alignmentStringالمحاذاة، إما 'left' أو 'center' أو 'normal'، تؤدي القيمة null إلى إعادة ضبط المحاذاة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setHorizontalAlignments(alignments)

تضبط هذه السمة شبكة مستطيلة من المحاذاة الأفقية. اطّلِع على setHorizontalAlignment(alignment)

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

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

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

المعلمات

الاسمالنوعالوصف
alignmentsObject[][]مصفوفة ثنائية الأبعاد من عمليات المحاذاة، إما 'left' أو 'center' أو 'normal'، تؤدي القيمة null إلى إعادة ضبط المحاذاة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


setNote(note)

تضبط هذه السمة الملاحظة على القيمة المحدّدة.

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

المعلمات

الاسمالنوعالوصف
noteStringقيمة الملاحظة التي سيتم ضبطها للنطاق، وتؤدي القيمة null إلى إزالة الملاحظة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setNotes(notes)

تضبط هذه السمة شبكة مستطيلة من النوتات (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

المعلمات

الاسمالنوعالوصف
notesObject[][]مصفوفة ثنائية الأبعاد من الملاحظات، وتؤدي قيم null إلى إزالة الملاحظة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


setNumberFormat(numberFormat)

تضبط هذه السمة تنسيق الأرقام أو التواريخ على سلسلة التنسيق المحدّدة. يمكنك الاطّلاع على أنماط التنسيقات المقبولة في مستندات Sheets API.

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

const cell = sheet.getRange('B2');
// Always show 3 decimal points
cell.setNumberFormat('0.000');

المعلمات

الاسمالنوعالوصف
numberFormatStringسلسلة تنسيق الأرقام

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setNumberFormats(numberFormats)

تضبط هذه السمة شبكة مستطيلة من تنسيقات الأرقام أو التواريخ (يجب أن تتطابق مع أبعاد هذا النطاق). القيم هي سلاسل أنماط التنسيق كما هو موضّح في مستندات Sheets API.

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

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

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

المعلمات

الاسمالنوعالوصف
numberFormatsObject[][]هي عبارة عن مصفوفة ثنائية الأبعاد لتنسيقات الأرقام.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setRichTextValue(value)

تضبط هذه السمة قيمة النص المنسّق للخلايا في النطاق.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello"
// bolded.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const richText = SpreadsheetApp.newRichTextValue()
                     .setText('Hello world')
                     .setTextStyle(0, 5, bold)
                     .build();
range.setRichTextValue(richText);

المعلمات

الاسمالنوعالوصف
valueRichTextValueقيمة النص المنسّق المطلوبة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setRichTextValues(values)

تضبط هذه السمة شبكة مستطيلة من قيم "النص المنسّق".

// Sets the cells in range A1:A2 to have Rich Text values.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:A2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const richTextA1 = SpreadsheetApp.newRichTextValue()
                       .setText('This cell is bold')
                       .setTextStyle(bold)
                       .build();
const richTextA2 = SpreadsheetApp.newRichTextValue()
                       .setText('bold words, italic words')
                       .setTextStyle(0, 11, bold)
                       .setTextStyle(12, 24, italic)
                       .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

المعلمات

الاسمالنوعالوصف
valuesRichTextValue[][]قيم النص المنسّق المطلوبة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

يحدّد ما إذا كان يجب أن يعرض النطاق روابط تشعّبية أم لا.

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

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

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

المعلمات

الاسمالنوعالوصف
showHyperlinkBooleanتحديد ما إذا كان سيتم عرض الرابط التشعّبي أم لا

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextDirection(direction)

تضبط هذه السمة اتجاه النص للخلايا في النطاق. إذا كان الاتجاه المحدّد هو null، يتم استنتاج الاتجاه ثم ضبطه.

// Sets right-to-left text direction for the range.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

المعلمات

الاسمالنوعالوصف
directionTextDirectionتمثّل هذه السمة اتجاه النص المطلوب. إذا كانت القيمة null، يتم استنتاج الاتجاه قبل ضبطه.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextDirections(directions)

تضبط هذه السمة شبكة مستطيلة من اتجاهات النص. إذا كان الاتجاه المحدّد هو null، يتم استنتاج الاتجاه ثم ضبطه.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextDirections());

المعلمات

الاسمالنوعالوصف
directionsTextDirection[][]اتجاهات النص المطلوبة. إذا كان الاتجاه المحدّد هو null، يتم استنتاجه قبل الضبط.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextRotation(degrees)

تضبط هذه السمة إعدادات تدوير النص للخلايا في النطاق. يمثّل الإدخال الزاوية بين اتجاه النص العادي والاتجاه المطلوب. يشير إدخال القيمة صفر إلى أنّ النص مضبوط على الاتجاه العادي.

بالنسبة إلى اتجاه النص من اليسار إلى اليمين، تكون الزوايا الموجبة في اتجاه عكس عقارب الساعة، بينما تكون في اتجاه عقارب الساعة بالنسبة إلى اتجاه النص من اليمين إلى اليسار.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setTextRotation(45);

المعلمات

الاسمالنوعالوصف
degreesIntegerالزاوية المطلوبة بين الاتجاه العادي والاتجاه المطلوب بالنسبة إلى النص من اليسار إلى اليمين، تكون الزوايا الموجبة في اتجاه عكس عقارب الساعة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextRotation(rotation)

تضبط هذه السمة إعدادات تدوير النص للخلايا في النطاق.

// Sets all cell's in range B2:D4 to have the same text rotation settings as
// cell A1.
const sheet = SpreadsheetApp.getActiveSheet();

const rotation = sheet.getRange('A1').getTextRotation();

sheet.getRange('B2:D4').setTextRotation(rotation);

المعلمات

الاسمالنوعالوصف
rotationTextRotationإعدادات تدوير النص المطلوبة

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextRotations(rotations)

تضبط هذه السمة شبكة مستطيلة من عمليات تدوير النص.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextRotations());

المعلمات

الاسمالنوعالوصف
rotationsTextRotation[][]إعدادات تدوير النص المطلوبة

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextStyle(style)

تضبط هذه السمة نمط النص للخلايا في النطاق.

// Sets the cells in range C5:D6 to have underlined size 15 font.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('C5:D6');
const style =
    SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build();
range.setTextStyle(style);

المعلمات

الاسمالنوعالوصف
styleTextStyleنمط النص المطلوب

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setTextStyles(styles)

تضبط هذه السمة شبكة مستطيلة من أنماط النصوص.

// Sets text styles for cells in range A1:B2
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const otherStyle = SpreadsheetApp.newTextStyle()
                       .setBold(true)
                       .setUnderline(true)
                       .setItalic(true)
                       .setForegroundColor('#335522')
                       .setFontSize(44)
                       .build();
range.setTextStyles([
  [bold, otherStyle],
  [otherStyle, bold],
]);

المعلمات

الاسمالنوعالوصف
stylesTextStyle[][]أنماط النص المطلوبة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setValue(value)

تضبط هذه السمة قيمة النطاق. يمكن أن تكون القيمة رقمية أو سلسلة أو قيمة منطقية أو تاريخًا. إذا بدأت بالرمز '='، سيتم تفسيرها على أنّها صيغة.

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

const cell = sheet.getRange('B2');
cell.setValue(100);

المعلمات

الاسمالنوعالوصف
valueObjectقيمة النطاق

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setValues(values)

تضبط هذه السمة شبكة مستطيلة من القيم (يجب أن تتطابق مع أبعاد هذا النطاق). إذا بدأت قيمة بـ =، سيتم تفسيرها على أنّها صيغة.

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

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

const range = sheet.getRange('B2:D2');
range.setValues(values);

المعلمات

الاسمالنوعالوصف
valuesObject[][]مصفوفة ثنائية الأبعاد من القيم

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setVerticalAlignment(alignment)

اضبط المحاذاة العمودية (من الأعلى إلى الأسفل) للنطاق المحدّد (أعلى/وسط/أسفل).

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

المعلمات

الاسمالنوعالوصف
alignmentStringالمحاذاة، إما 'top' أو 'middle' أو 'bottom'، تؤدي القيمة null إلى إعادة ضبط المحاذاة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setVerticalAlignments(alignments)

تضبط هذه السمة شبكة مستطيلة من عمليات المحاذاة العمودية (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

المعلمات

الاسمالنوعالوصف
alignmentsObject[][]مصفوفة ثنائية الأبعاد من عمليات المحاذاة، إما 'top' أو 'middle' أو 'bottom'، تؤدي القيمة null إلى إعادة ضبط المحاذاة.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


setVerticalText(isVertical)

تضبط هذه السمة ما إذا كان سيتم ترتيب النص في الخلايا ضمن النطاق فوق بعضه أم لا. إذا كان النص مكدّسًا بشكل عمودي، سيتم تجاهل إعداد درجة تدوير النص.

// Sets all cell's in range B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

المعلمات

الاسمالنوعالوصف
isVerticalBooleanتحدّد ما إذا كان سيتم ترتيب النص فوق بعضه أم لا.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setWrap(isWrapEnabled)

اضبط التفاف الخلية للنطاق المحدّد.

يتم تغيير حجم الخلايا التي تم تفعيل ميزة الالتفاف فيها (الإعداد التلقائي) لعرض محتواها الكامل. تعرض الخلايا التي تم إيقاف ميزة &quot;الالتفاف&quot; فيها أكبر قدر ممكن من المحتوى في الخلية بدون تغيير حجمها أو الانتقال إلى أسطر متعددة.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

المعلمات

الاسمالنوعالوصف
isWrapEnabledBooleanتحديد ما إذا كان سيتم التفاف النص أم لا

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setWrapStrategies(strategies)

تضبط هذه السمة شبكة مستطيلة من استراتيجيات الالتفاف.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

المعلمات

الاسمالنوعالوصف
strategiesWrapStrategy[][]استراتيجيات الالتفاف المطلوبة

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setWrapStrategy(strategy)

تضبط هذه السمة استراتيجية التفاف النص للخلايا في النطاق.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

المعلمات

الاسمالنوعالوصف
strategyWrapStrategyاستراتيجية الالتفاف المطلوبة

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

setWraps(isWrapEnabled)

تضبط هذه السمة شبكة مستطيلة من سياسات التفاف النص (يجب أن تتطابق مع أبعاد هذا النطاق). يتم تغيير حجم الخلايا التي تم تفعيل ميزة الالتفاف فيها (الإعداد التلقائي) لعرض المحتوى الكامل. تعرض الخلايا التي تم إيقاف ميزة "الالتفاف" فيها أكبر قدر ممكن من المحتوى في الخلية بدون تغيير حجمها أو الانتقال إلى أسطر متعددة.

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

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

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

المعلمات

الاسمالنوعالوصف
isWrapEnabledObject[][]هي عبارة عن مصفوفة ثنائية الأبعاد من متغيرات الالتفاف التي تحدّد ما إذا كان سيتم التفاف النص في خلية أم لا.

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

انظر أيضًا


shiftColumnGroupDepth(delta)

تغيّر هذه السمة عمق تجميع الأعمدة للنطاق بالمقدار المحدّد.

ويؤدي ذلك إلى إنشاء مجموعات تتقاطع مع النطاق أو تعديلها أو حذفها. بالنسبة إلى التغييرات الإيجابية، يتم إنشاء المجموعات و/أو تعديلها، أما بالنسبة إلى التغييرات السلبية، فيتم إتلاف المجموعات و/أو تعديلها.

ولن يكون لذلك أي تأثير عند خفض عمق المجموعة إلى أقل من صفر أو أعلى من ثمانية.

إذا كانت قيمة column group control position هي BEFORE، سيحدث خطأ عند محاولة تغيير عمق الصف الأول.

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

المعلمات

الاسمالنوعالوصف
deltaIntegerمقدار تغيير عمق مجموعة الأعمدة لهذا النطاق.

الإرجاع

Range: هذا النطاق، للسلسلة.

الرميات

Error: عند محاولة تغيير عمق العمود الأول عندما يكون موضع عنصر التحكّم GroupControlTogglePosition.BEFORE

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

shiftRowGroupDepth(delta)

تغيّر هذه السمة عمق تجميع الصفوف للنطاق بالمقدار المحدّد.

ويؤدي ذلك إلى إنشاء مجموعات تتقاطع مع النطاق أو تعديلها أو حذفها. بالنسبة إلى التغييرات الإيجابية، يتم إنشاء المجموعات و/أو تعديلها، أما بالنسبة إلى التغييرات السلبية، فيتم إتلاف المجموعات و/أو تعديلها.

ولن يكون لذلك أي تأثير عند خفض عمق المجموعة إلى أقل من صفر أو أعلى من ثمانية.

إذا كانت قيمة row group control position هي BEFORE، سيحدث خطأ عند محاولة تغيير عمق الصف الأول.

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

المعلمات

الاسمالنوعالوصف
deltaIntegerمقدار تغيير عمق مجموعة الصفوف لهذا النطاق.

الإرجاع

Range: هذا النطاق، للسلسلة.

الرميات

Error: عند محاولة تغيير عمق الصف الأول عندما يكون موضع عنصر التحكّم GroupControlTogglePosition.BEFORE

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

sort(sortSpecObj)

لترتيب الخلايا في النطاق المحدّد حسب العمود والترتيب المحدّدَين.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([
  {column: 2, ascending: false},
  {column: 1, ascending: true},
]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more
// readable code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([
  {column: 2, ascending: true},
  {column: 1, ascending: true},
]);

المعلمات

الاسمالنوعالوصف
sortSpecObjObjectالأعمدة المطلوب الترتيب حسبها

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

splitTextToColumns()

تقسّم هذه الدالة عمودًا من النص إلى أعمدة متعددة استنادًا إلى محدد يتم رصده تلقائيًا.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

splitTextToColumns(delimiter)

تقسيم عمود من النص إلى عدة أعمدة باستخدام السلسلة المحدّدة كمحدّد مخصّص

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

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

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

المعلمات

الاسمالنوعالوصف
delimiterStringالمحدّد المخصّص الذي سيتم التقسيم عنده.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

splitTextToColumns(delimiter)

تقسّم هذه الدالة عمودًا من النص إلى أعمدة متعددة استنادًا إلى المحدد الذي تم تحديده.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

المعلمات

الاسمالنوعالوصف
delimiterTextToColumnsDelimiterالمُحدِّد المُسبَق الذي سيتم التقسيم استنادًا إليه.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

trimWhitespace()

تزيل هذه الدالة المسافات البيضاء (مثل المسافات أو علامات التبويب أو الأسطر الجديدة) في كل خلية ضمن هذا النطاق. تزيل هذه الدالة كل المسافات البيضاء من بداية ونهاية النص في كل خلية، وتختزل أي تسلسل فرعي من أحرف المسافات البيضاء المتبقية إلى مسافة واحدة.

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

range.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

uncheck()

تغيّر هذه الدالة حالة مربّعات الاختيار في النطاق إلى "غير محدّدة". وتتجاهل الخلايا في النطاق التي لا تحتوي حاليًا على القيمة المحدّدة أو غير المحدّدة التي تم ضبطها.

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

الإرجاع

Range: هذا النطاق، للسلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

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

الطُرق المتوقّفة