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.

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل


activateAsCurrentCell()

لضبط الخلية المحددة على أنها current cell.

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

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

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

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

addDeveloperMetadata(key)

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

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

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

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

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

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

المَعلمات

الاسمTypeالوصف
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());

المَعلمات

الاسمTypeالوصف
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());

المَعلمات

الاسمTypeالوصف
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());

المَعلمات

الاسمTypeالوصف
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());

المَعلمات

الاسمTypeالوصف
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());

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

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

استرجاع الكرة

Banding — النطاق الجديد

التفويض

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

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

autoFill(destination, series)

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

var sheet = SpreadsheetApp.getActiveSheet();

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

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

المَعلمات

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

التفويض

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

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

autoFillToNeighbor(series)

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

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

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

var sheet = SpreadsheetApp.getActiveSheet();

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

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

المَعلمات

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

التفويض

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

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

breakApart()

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

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

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

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

canEdit()

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

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

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

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

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

استرجاع الكرة

Boolean: true إذا كان المستخدم لديه إذن بتعديل كل خلية في النطاق، أو false بخلاف ذلك.

التفويض

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

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

check()

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clear()

يؤدي هذا الإجراء إلى محو نطاق المحتوى والتنسيقات.

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clear(options)

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

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

المَعلمات

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clearContent()

يؤدي هذا الإجراء إلى محو محتوى النطاق مع ترك التنسيق بدون تغيير.

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clearDataValidations()

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clearFormat()

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

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

clearNote()

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

collapseGroups()

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

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

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

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

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

var range = source.getRange("B2:D4");

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

المَعلمات

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

التفويض

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

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

يمكن أيضًا مراجعة


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

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

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

var range = source.getRange("B2:D4");

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

المَعلمات

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

التفويض

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

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

copyTo(destination)

تنسخ البيانات من نطاق من الخلايا إلى نطاق خلايا آخر. يتم نسخ كل من القيم والتنسيق.

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

المَعلمات

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

التفويض

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

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

copyTo(destination, copyPasteType, transposed)

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

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

المَعلمات

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

التفويض

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

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

copyTo(destination, options)

تنسخ البيانات من نطاق من الخلايا إلى نطاق خلايا آخر. بشكل افتراضي يتم نسخ كل من القيم والتنسيق، ولكن يمكن تجاوز ذلك باستخدام الوسيطات المتقدمة.

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

المَعلمات

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

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

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

التفويض

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

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

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

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

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

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

var range = source.getRange("B2:D4");

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

المَعلمات

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

التفويض

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

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

يمكن أيضًا مراجعة


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

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

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

var range = source.getRange("B2:D4");

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

المَعلمات

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

التفويض

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

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

createDataSourcePivotTable(dataSource)

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

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

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

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

createDataSourceTable(dataSource)

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

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

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

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

createDeveloperMetadataFinder()

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

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

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

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

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

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

استرجاع الكرة

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


createFilter()

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

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

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

استرجاع الكرة

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

التفويض

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

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

createPivotTable(sourceData)

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

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

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

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

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

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

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

createTextFinder(findText)

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

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

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

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

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

المَعلمات

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

استرجاع الكرة

TextFinderTextFinder للنطاق


deleteCells(shiftDimension)

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

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

المَعلمات

الاسمTypeالوصف
shiftDimensionDimensionالسمة التي يتم من خلالها نقل البيانات الحالية.

التفويض

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

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

expandGroups()

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

getA1Notation()

لعرض وصف سلسلة للنطاق، بترميز A1.

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

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

استرجاع الكرة

String — وصف السلسلة للنطاق في تدوين A1.

التفويض

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

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

getBackground()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getBackgroundObject()

لعرض لون الخلفية للخلية الموجودة في أعلى اليسار في النطاق.

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

استرجاع الكرة

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

التفويض

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

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

getBackgroundObjects()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getBackgrounds()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getBandings()

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getCell(row, column)

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

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

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

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

المَعلمات

الاسمTypeالوصف
rowIntegerصف الخلية المرتبط بالنطاق.
columnIntegerعمود الخلية المرتبط بالنطاق.

استرجاع الكرة

Range — نطاق يحتوي على خلية واحدة في الإحداثيات المحددة.

التفويض

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

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

getColumn()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDataRegion()

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

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

استرجاع الكرة

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

التفويض

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

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

getDataRegion(dimension)

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

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

المَعلمات

الاسمTypeالوصف
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[]: مصفوفة من DataSourceFormulas.

التفويض

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

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

getDataSourcePivotTables()

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDataSourceTables()

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDataSourceUrl()

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

Code.gs

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

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

piechart.html

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDataTable()

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

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

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

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

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

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

استرجاع الكرة

DataTable - البيانات كجدول بيانات.


getDataTable(firstRowIsHeader)

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

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

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

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

المَعلمات

الاسمTypeالوصف
firstRowIsHeaderBooleanما إذا كان سيتم التعامل مع الصف الأول على أنه عنوان.

استرجاع الكرة

DataTable — البيانات كجدول بيانات.

التفويض

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

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

getDataValidation()

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

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

استرجاع الكرة

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

التفويض

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

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

getDataValidations()

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDeveloperMetadata()

الحصول على البيانات الوصفية لمطوِّر البرامج المرتبطة بهذا النطاق

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDisplayValue()

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getDisplayValues()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getFilter()

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

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

استرجاع الكرة

Filter — الفلتر

التفويض

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

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

getFontColorObject()

لعرض لون خط الخلية في أعلى الجانب الأيسر من النطاق.

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

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

استرجاع الكرة

Color: لون خط الخلية العلوية على اليسار في النطاق

التفويض

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

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

getFontColorObjects()

تعرض ألوان خط الخلايا في النطاق.

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

var results = range.getFontColorObjects();

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

استرجاع الكرة

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

التفويض

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

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

getFontFamilies()

تعرض عائلات الخطوط للخلايا في النطاق.

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

var results = range.getFontFamilies();

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

استرجاع الكرة

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

التفويض

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

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

getFontFamily()

لعرض مجموعة الخطوط للخلية في أعلى الجانب الأيسر من النطاق.

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

Logger.log(range.getFontFamily());

استرجاع الكرة

String — مجموعة الخطوط في الخلية

التفويض

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

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

getFontLine()

للحصول على نمط خط الخلية في أعلى الجانب الأيمن من النطاق ('underline' أو 'line-through' أو 'none').

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

Logger.log(range.getFontLine());

استرجاع الكرة

String — سطر الخط

التفويض

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

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

getFontLines()

الحصول على نمط الخط للخلايا في النطاق ('underline'، أو 'line-through'، أو 'none').

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

var results = range.getFontLines();

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

استرجاع الكرة

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

التفويض

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

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

getFontSize()

لعرض حجم الخط بحجم النقطة في الخلية في أعلى الجانب الأيسر من النطاق.

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

Logger.log(range.getFontSize());

استرجاع الكرة

Integer — حجم الخط في حجم النقطة

التفويض

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

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

getFontSizes()

تعرض أحجام الخط للخلايا في النطاق.

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

var results = range.getFontSizes();

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

استرجاع الكرة

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

التفويض

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

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

getFontStyle()

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

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

Logger.log(range.getFontStyle());

استرجاع الكرة

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

التفويض

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

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

getFontStyles()

تعرض أنماط الخط للخلايا في النطاق.

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

var results = range.getFontStyles();

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

استرجاع الكرة

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

التفويض

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

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

getFontWeight()

لعرض عرض الخط (عادي/غامق) للخلية في الزاوية العلوية اليسرى من النطاق.

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

Logger.log(range.getFontWeight());

استرجاع الكرة

String — عرض خط النص في الخلية

التفويض

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

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

getFontWeights()

لعرض قيم وزن الخطوط للخلايا في النطاق.

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

var results = range.getFontWeights();

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

استرجاع الكرة

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

التفويض

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

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

getFormula()

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getFormulaR1C1()

لعرض الصيغة (تدوين R1C1) لخلية معينة، أو عرض null في حال عدم وجودها.

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

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

استرجاع الكرة

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

التفويض

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

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

getFormulas()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getFormulasR1C1()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getGridId()

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

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

Logger.log(range.getGridId());

استرجاع الكرة

Integer — رقم تعريف الشبكة لورقة البيانات الرئيسية

التفويض

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

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

getHeight()

لعرض ارتفاع النطاق.

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

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

استرجاع الكرة

Integer — ارتفاع النطاق.

التفويض

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

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

getHorizontalAlignment()

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

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

Logger.log(range.getHorizontalAlignment());

استرجاع الكرة

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

التفويض

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

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

getHorizontalAlignments()

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

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

var results = range.getHorizontalAlignments();

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

استرجاع الكرة

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

التفويض

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

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

getLastColumn()

تعرض موضع عمود النهاية.

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

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

استرجاع الكرة

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

التفويض

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

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

getLastRow()

لعرض موضع صف النهاية.

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

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

استرجاع الكرة

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

التفويض

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

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

getMergedRanges()

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

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

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

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

استرجاع الكرة

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


getNextDataCell(direction)

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

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

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

getNote()

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

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

Logger.log(range.getNote());

استرجاع الكرة

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

التفويض

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

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

getNotes()

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

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

var results = range.getNotes();

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

استرجاع الكرة

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

التفويض

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

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

getNumColumns()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getNumRows()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getNumberFormat()

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

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

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

استرجاع الكرة

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

التفويض

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

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

getNumberFormats()

تعرض تنسيقات الرقم أو التاريخ للخلايا في النطاق. يتم توضيح أنماط التنسيق المعروض في وثائق واجهة برمجة تطبيقات جداول بيانات Google.

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

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

استرجاع الكرة

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

التفويض

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

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

getRichTextValue()

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

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

استرجاع الكرة

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

التفويض

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

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

getRichTextValues()

لعرض قيم النص المنسَّق للخلايا في النطاق.

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

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

استرجاع الكرة

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

التفويض

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

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

getRow()

تعرض موضع الصف لهذا النطاق. يتطابق مع getRowIndex().

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

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

استرجاع الكرة

Integer - موضع صف النطاق

التفويض

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

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

getRowIndex()

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

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

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

استرجاع الكرة

Integer - موضع صف النطاق

التفويض

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

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

يمكن أيضًا مراجعة


getSheet()

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getTextDirection()

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

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

استرجاع الكرة

TextDirection — اتجاه النص للخلية أعلى اليسار في النطاق.

التفويض

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

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

getTextDirections()

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

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

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

استرجاع الكرة

TextDirection[][] — مصفوفة ثنائية الأبعاد لاتجاهات النص.

التفويض

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

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

getTextRotation()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getTextRotations()

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

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

var results = range.getTextRotations();

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

استرجاع الكرة

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

التفويض

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

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

getTextStyle()

لعرض نمط النص للخلية العلوية اليسرى من النطاق.

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

استرجاع الكرة

TextStyle - نمط النص للخلية العلوية اليمنى في النطاق.

التفويض

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

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

getTextStyles()

لعرض أنماط النص للخلايا في النطاق.

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

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

استرجاع الكرة

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

التفويض

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

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

getValue()

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getValues()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getVerticalAlignment()

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

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

Logger.log(range.getVerticalAlignment());

استرجاع الكرة

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

التفويض

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

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

getVerticalAlignments()

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

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

var results = range.getVerticalAlignments();

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

استرجاع الكرة

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

التفويض

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

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

getWidth()

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

getWrap()

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

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

Logger.log(range.getWrap());

استرجاع الكرة

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

التفويض

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

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

getWrapStrategies()

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

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

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

استرجاع الكرة

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

التفويض

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

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

getWrapStrategy()

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

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

استرجاع الكرة

WrapStrategy — استراتيجية التفاف النص للخلية العلوية اليسرى في النطاق.

التفويض

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

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

getWraps()

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

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

var results = range.getVerticalAlignments();

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

استرجاع الكرة

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

التفويض

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

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

insertCells(shiftDimension)

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

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

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

المَعلمات

الاسمTypeالوصف
shiftDimensionDimensionالسمة التي يتم من خلالها نقل البيانات الحالية.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

insertCheckboxes()

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

insertCheckboxes(checkedValue)

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

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

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

المَعلمات

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

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

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

المَعلمات

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

isBlank()

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

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

Logger.log(range.isBlank());

استرجاع الكرة

Boolean - true إذا كان النطاق فارغًا، وبخلاف ذلك false.

التفويض

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

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

isChecked()

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

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

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

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

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

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

استرجاع الكرة

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

التفويض

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

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

isEndColumnBounded()

لتحديد ما إذا كانت نهاية النطاق مرتبطة بعمود معين أم لا. على سبيل المثال، بالنسبة إلى النطاقَين A1:B10 أو B:B المرتبطَين بأعمدة في نهاية النطاق، تعرِض هذه الطريقة true. أما بالنسبة إلى النطاقات 3:7 أو A1:5، التي ترتبط فقط بصفوف معيّنة في نهاية النطاق، تعرِض هذه الطريقة false.

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

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

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

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

استرجاع الكرة

Boolean - true إذا كانت نهاية النطاق مرتبطة بعمود معيّن، وإلا تكون false.

التفويض

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

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

isEndRowBounded()

لتحديد ما إذا كانت نهاية النطاق مرتبطة بصف معين. على سبيل المثال، بالنسبة إلى النطاقَين A1:B10 أو 3:7 المرتبطَين بالصفوف في نهاية النطاق، تعرض هذه الطريقة true. أما بالنسبة إلى النطاقات B:B أو A1:C، التي ترتبط فقط بأعمدة معيّنة في نهاية النطاق، تعرِض هذه الطريقة false.

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

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

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

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

استرجاع الكرة

Boolean - true إذا كانت نهاية النطاق مرتبطة بصف معيّن، وإلا false.

التفويض

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

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

isPartOfMerge()

تعرض true إذا كانت الخلايا في النطاق الحالي تتداخل مع أي خلايا مدمَجة.

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

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

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

استرجاع الكرة

Booleantrue إذا كان النطاق يتداخل مع أي خلايا مدمَجة، أو يعرض false بخلاف ذلك.


isStartColumnBounded()

تحدد ما إذا كانت بداية النطاق مرتبطة بعمود معين. على سبيل المثال، بالنسبة إلى النطاقَين A1:B10 أو B:B المرتبطَين بأعمدة في بداية النطاق، تعرِض هذه الطريقة true، أمّا بالنسبة إلى النطاق 3:7، الذي يرتبط فقط بصف في بداية النطاق، تعرِض هذه الطريقة false.

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

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

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

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

استرجاع الكرة

Boolean - true إذا كانت بداية النطاق مرتبطة بعمود معيّن، وإلا تكون false.

التفويض

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

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

isStartRowBounded()

تحدد ما إذا كانت بداية النطاق مرتبطة بصف معين. على سبيل المثال، بالنسبة إلى النطاقين A1:B10 أو 3:7 المرتبطين بالصفوف في بداية النطاق، تعرض هذه الطريقة true. وبالنسبة إلى النطاق B:B الذي يرتبط فقط بعمود معين في بداية النطاق، تعرض هذه الطريقة false.

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

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

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

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

استرجاع الكرة

Boolean - true إذا كانت بداية النطاق مرتبطة بصف معين، وإلا false.

التفويض

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

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

merge()

يدمج الخلايا الموجودة في النطاق معًا في كتلة واحدة.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

mergeAcross()

ادمج الخلايا في النطاق عبر أعمدة النطاق.

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

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

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

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

mergeVertically()

يدمج الخلايا الموجودة في النطاق معًا.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

moveTo(target)

قص ولصق (كل من التنسيق والقيم) من هذا النطاق إلى النطاق المستهدف.

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

المَعلمات

الاسمTypeالوصف
targetRangeنطاق مستهدَف لنسخ هذا النطاق إليه، ويكون موضع الخلية في أعلى يسار الصفحة ملائمًا.

التفويض

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

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

offset(rowOffset, columnOffset)

تعرض نطاقًا جديدًا تتم إزاحته عن هذا النطاق بعدد الصفوف والأعمدة المعطاة (الذي يمكن أن يكون سالبًا). النطاق الجديد له نفس حجم النطاق الأصلي.

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

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

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

المَعلمات

الاسمTypeالوصف
rowOffsetIntegerعدد الصفوف لأسفل من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الصفوف لأعلى من الخلية العلوية اليسرى للنطاق.
columnOffsetIntegerعدد الأعمدة مباشرةً من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الأعمدة المتبقية من الخلية العلوية اليسرى في النطاق.

استرجاع الكرة

Range: هذا النطاق للسلاسل


offset(rowOffset, columnOffset, numRows)

لعرض نطاق جديد مرتبط بالنطاق الحالي، حيث تتم إزاحة نقطتين العلويتين من النطاق الحالي عن طريق الصفوف والأعمدة المحددة، وبارتفاع معين في الخلايا.

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

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

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

المَعلمات

الاسمTypeالوصف
rowOffsetIntegerعدد الصفوف لأسفل من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الصفوف لأعلى من الخلية العلوية اليسرى للنطاق.
columnOffsetIntegerعدد الأعمدة مباشرةً من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الأعمدة المتبقية من الخلية العلوية اليسرى في النطاق.
numRowsIntegerالارتفاع في صفوف النطاق الجديد.

استرجاع الكرة

Range: هذا النطاق للسلاسل


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

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

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

المَعلمات

الاسمTypeالوصف
rowOffsetIntegerعدد الصفوف لأسفل من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الصفوف لأعلى من الخلية العلوية اليسرى للنطاق.
columnOffsetIntegerعدد الأعمدة مباشرةً من الخلية العلوية اليسرى في النطاق، وتمثل القيم السالبة الأعمدة المتبقية من الخلية العلوية اليسرى في النطاق.
numRowsIntegerالارتفاع في صفوف النطاق الجديد.
numColumnsIntegerالعرض في أعمدة النطاق الجديد.

استرجاع الكرة

Range: هذا النطاق للسلاسل


protect()

تنشئ كائنًا يمكنه حماية النطاق من التعديل إلا من قِبل المستخدمين الذين لديهم الإذن. إلى أن يغيّر النص البرمجي قائمة المحرّرين للنطاق (من خلال طلب Protection.removeEditor(emailAddress) أو Protection.removeEditor(user) أو Protection.removeEditors(emailAddresses) أو Protection.addEditor(emailAddress) أو Protection.addEditor(user) أو Protection.addEditors(emailAddresses) أو ضبط قيمة جديدة للسمة Protection.setDomainEdit(editable))، تتطابق الأذونات مع أذونات جدول البيانات نفسه، ما يعني أنّ النطاق سيظل غير محمي. إذا كان النطاق محميًا بالفعل، فإن هذه الطريقة تنشئ نطاقًا محميًا جديدًا يتداخل مع النطاق الحالي. إذا كانت إحدى الخلايا محمية بعدة نطاقات محمية وكان أي منها يمنع مستخدمًا معينًا من تحرير الخلية، فلن يُسمح لهذا المستخدم بتحرير الخلية.

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

استرجاع الكرة

Protection: عنصر يمثّل إعدادات الحماية.

التفويض

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

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

randomize()

ترتيب الصفوف عشوائيًا في نطاق معين.

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

// Randomizes the range
range.randomize();

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

removeCheckboxes()

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

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

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

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

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

removeDuplicates()

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

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

// Remove duplicate rows in the range.
range.removeDuplicates();

استرجاع الكرة

Range — النطاق الناتج بعد إزالة التكرارات ويتم تقليل حجم النطاق بمقدار صف لكل صف تمت إزالته.

التفويض

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

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

removeDuplicates(columnsToCompare)

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

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

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

المَعلمات

الاسمTypeالوصف
columnsToCompareInteger[]الأعمدة المطلوب تحليلها بحثًا عن القيم المكرّرة. وفي حال عدم توفير أي أعمدة، يتم تحليل جميع الأعمدة بحثًا عن أي تكرارات.

استرجاع الكرة

Range — النطاق الناتج بعد إزالة التكرارات ويتم تقليل حجم النطاق بمقدار صف لكل صف تمت إزالته.

التفويض

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

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

setBackground(color)

لضبط لون الخلفية لجميع الخلايا في النطاق في ترميز CSS (مثل '#ffffff' أو 'white').

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

var range = sheet.getRange("B2:D5");
range.setBackground("red");

المَعلمات

الاسمTypeالوصف
colorStringرمز لون في طريقة ترميز CSS (مثل '#ffffff' أو 'white')، المطلوب من خلال قيمة null إعادة ضبط اللون.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBackgroundObject(color)

لضبط لون الخلفية لجميع الخلايا في النطاق

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

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

المَعلمات

الاسمTypeالوصف
colorColorلون الخلفية المطلوب ضبطه: ستُعيد قيمة null ضبط لون الخلفية.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBackgroundObjects(color)

تُستخدم هذه السياسة في ضبط شبكة مستطيلة من ألوان الخلفية (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

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

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

المَعلمات

الاسمTypeالوصف
colorColor[][]مصفوفة ألوان ثنائية الأبعاد؛ تُعيد قيم null ضبط اللون.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBackgroundRGB(red, green, blue)

لضبط الخلفية على اللون المعيّن باستخدام قيم نموذج أحمر أخضر أزرق (الأعداد الصحيحة بين 0 و255 ضمنًا).

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

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

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

المَعلمات

الاسمTypeالوصف
redIntegerالقيمة الحمراء في تدوين نموذج أحمر أخضر أزرق.
greenIntegerالقيمة الخضراء في تدوين نموذج أحمر أخضر أزرق.
blueIntegerالقيمة الزرقاء في ترميز نموذج أحمر أخضر أزرق.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBackgrounds(color)

تُستخدم هذه السياسة في ضبط شبكة مستطيلة من ألوان الخلفية (يجب أن تتطابق مع أبعاد هذا النطاق). وتكون الألوان بترميز CSS (مثل '#ffffff' أو 'white').

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

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

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

المَعلمات

الاسمTypeالوصف
colorString[][]مصفوفة ألوان ثنائية الأبعاد في ترميز CSS (مثل '#ffffff' أو 'white')؛ تؤدي قيم null إلى إعادة ضبط اللون.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBorder(top, left, bottom, right, vertical, horizontal)

تُستخدَم لضبط سمة الحدود. القيم الصالحة هي true (تفعيل) وfalse (إيقاف) وnull (بدون تغيير).

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

المَعلمات

الاسمTypeالوصف
topBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
leftBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
bottomBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
rightBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
verticalBooleantrue للحدود العمودية الداخلية وfalse بلا حدود وnull بدون تغيير.
horizontalBooleantrue للحدود الأفقية الداخلية وfalse بلا حدود وnull بدون تغيير.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

لضبط خاصية الحد مع اللون و/أو النمط. القيم الصالحة هي true (تفعيل) وfalse (إيقاف) وnull (بدون تغيير). بالنسبة إلى اللون، استخدِم اللون في ترميز CSS (مثل '#ffffff' أو 'white').

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

المَعلمات

الاسمTypeالوصف
topBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
leftBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
bottomBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
rightBooleantrue للحدود، وfalse بلا تغيير، وnull بلا تغيير.
verticalBooleantrue للحدود العمودية الداخلية وfalse بلا حدود وnull بدون تغيير.
horizontalBooleantrue للحدود الأفقية الداخلية وfalse بلا حدود وnull بدون تغيير.
colorStringلون في ترميز CSS (مثل '#ffffff' أو 'white')، وnull للون التلقائي (أسود).
styleBorderStyleنمط للحدود، وnull للنمط التلقائي (متصل).

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setDataValidation(rule)

لضبط قاعدة واحدة للتحقق من صحة البيانات لجميع الخلايا في النطاق.

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

المَعلمات

الاسمTypeالوصف
ruleDataValidationقاعدة التحقّق من صحة البيانات المطلوب ضبطها أو null لإزالة التحقّق من صحة البيانات.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setDataValidations(rules)

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

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

المَعلمات

الاسمTypeالوصف
rulesDataValidation[][]يشير ذلك المصطلح إلى مصفوفة ثنائية الأبعاد لقواعد التحقّق من صحة البيانات المطلوب ضبطها. وتؤدي قيم null إلى إزالة إجراءات التحقّق من صحة البيانات.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontColor(color)

لضبط لون الخط في ترميز CSS (مثل '#ffffff' أو 'white').

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

var cell = sheet.getRange("B2");
cell.setFontColor("red");

المَعلمات

الاسمTypeالوصف
colorStringلون الخط في ترميز CSS (مثل '#ffffff' أو 'white')، أمّا قيمة null، فتُعيد ضبط اللون.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontColorObject(color)

لضبط لون الخط للنطاق المحدد.

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

var cell = sheet.getRange("B2");
cell.setFontColor(color);

المَعلمات

الاسمTypeالوصف
colorColorلون الخط المطلوب ضبطه، وتتم إعادة ضبط اللون باستخدام قيمة null.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontColorObjects(colors)

تعيين شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

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

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

المَعلمات

الاسمTypeالوصف
colorsColor[][]مصفوفة ألوان ثنائية الأبعاد؛ تعيد قيم null ضبط لون الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontColors(colors)

تعيين شبكة مستطيلة من ألوان الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). ويتم استخدام الألوان بترميز CSS (مثل '#ffffff' أو 'white').

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

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

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

المَعلمات

الاسمTypeالوصف
colorsObject[][]مصفوفة ألوان ثنائية الأبعاد في ترميز CSS (مثل '#ffffff' أو 'white')؛ تؤدي قيم null إلى إعادة ضبط اللون.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontFamilies(fontFamilies)

تحدِّد شبكة مستطيلة من مجموعات الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). ومن أمثلة عائلات الخطوط " Arial" أو "Helvetica".

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

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

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

المَعلمات

الاسمTypeالوصف
fontFamiliesObject[][]مصفوفة ثنائية الأبعاد من مجموعات الخطوط: تعيد قيم null ضبط مجموعة الخطوط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontFamily(fontFamily)

لتعيين مجموعة الخطوط، مثل "Arial" أو "Helvetica".

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

المَعلمات

الاسمTypeالوصف
fontFamilyStringمجموعة الخطوط المطلوب ضبطها، وتؤدي القيمة null إلى إعادة ضبط مجموعة الخطوط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontLine(fontLine)

لضبط نمط سطر الخط للنطاق المحدد ('underline'، أو 'line-through'، أو 'none').

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

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

المَعلمات

الاسمTypeالوصف
fontLineStringنمط سطر الخط، إما 'underline' أو 'line-through' أو 'none'، ويؤدي استخدام القيمة null إلى إعادة ضبط نمط سطر الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontLines(fontLines)

لضبط شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

المَعلمات

الاسمTypeالوصف
fontLinesObject[][]مصفوفة ثنائية الأبعاد لأنماط خطوط الخطوط ('underline' أو 'line-through' أو 'none')؛ تؤدي قيم null إلى إعادة ضبط نمط خط الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontSize(size)

لضبط حجم الخط، مع تحديد الحجم لحجم النقطة المطلوب استخدامه.

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

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

المَعلمات

الاسمTypeالوصف
sizeIntegerحجم خط بحجم النقطة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontSizes(sizes)

تحدّد شبكة مستطيلة من أحجام الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). الأحجام بالنقاط.

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

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

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

المَعلمات

الاسمTypeالوصف
sizesObject[][]يشير ذلك المصطلح إلى مصفوفة ثنائية الأبعاد من الأحجام.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontStyle(fontStyle)

ضبط نمط الخط للنطاق المحدد ('italic' أو 'normal').

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

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

المَعلمات

الاسمTypeالوصف
fontStyleStringنمط الخط، إما 'italic' أو 'normal'، وتؤدّي القيمة null إلى إعادة ضبط نمط الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontStyles(fontStyles)

تعيين شبكة مستطيلة من أنماط الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

المَعلمات

الاسمTypeالوصف
fontStylesObject[][]مصفوفة ثنائية الأبعاد لأنماط الخطوط، إما 'italic' أو 'normal'، وتعيد قيم null ضبط نمط الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontWeight(fontWeight)

ضبط عرض الخط للنطاق المعيّن (عادي/غامق).

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

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

المَعلمات

الاسمTypeالوصف
fontWeightStringعرض الخط، إما 'bold' أو 'normal'، والقيمة null هي إعادة ضبط سماكة الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFontWeights(fontWeights)

لتعيين شبكة مستطيلة من سُمك الخطوط (يجب أن تتطابق مع أبعاد هذا النطاق). مثال على سُمك الخط "bold".

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

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

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

المَعلمات

الاسمTypeالوصف
fontWeightsObject[][]مصفوفة ثنائية الأبعاد لقياسات الخطوط، إما 'bold' أو 'normal'، وتؤدي قيم null إلى إعادة ضبط عرض الخط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFormula(formula)

لتعديل الصيغة لهذا النطاق يجب أن تكون الصيغة المحددة بترميز A1.

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

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

المَعلمات

الاسمTypeالوصف
formulaStringسلسلة تمثل الصيغة المراد تعيينها للخلية.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFormulaR1C1(formula)

لتعديل الصيغة لهذا النطاق يجب أن تكون الصيغة المقدمة بصيغة R1C1.

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

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

المَعلمات

الاسمTypeالوصف
formulaStringصيغة سلسلة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFormulas(formulas)

لضبط شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق). يجب أن تكون المعادلات المحددة بتدوين A1. تستخدم هذه الطريقة صفيفًا ثنائي الأبعاد من المعادلات، تتم فهرستها حسب الصف ثم حسب العمود. يجب أن تتوافق أبعاد الصفيفة مع أبعاد النطاق.

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

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

المَعلمات

الاسمTypeالوصف
formulasString[][]يشير ذلك المصطلح إلى مصفوفة سلسلة ثنائية الأبعاد من الصيغ.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setFormulasR1C1(formulas)

لضبط شبكة مستطيلة من الصيغ (يجب أن تتطابق مع أبعاد هذا النطاق). يجب أن تكون المعادلات المحددة في تدوين R1C1.

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

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

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

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

المَعلمات

الاسمTypeالوصف
formulasString[][]مصفوفة ثنائية الأبعاد من الصيغ بتنسيق R1C1.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setHorizontalAlignment(alignment)

قم بتعيين المحاذاة الأفقية (من اليسار إلى اليمين) للنطاق المحدد (اليسار/الوسط/اليمين).

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

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

المَعلمات

الاسمTypeالوصف
alignmentStringتمت إعادة ضبط المحاذاة، إما 'left' أو 'center' أو 'normal'، كما أنّ القيمة null تؤدي إلى إعادة ضبط المحاذاة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setHorizontalAlignments(alignments)

لضبط شبكة مستطيلة من المحاذاة الأفقية. يمكنك الاطّلاع على setHorizontalAlignment(alignment).

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

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

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

المَعلمات

الاسمTypeالوصف
alignmentsObject[][]مصفوفة ثنائية الأبعاد من المحاذاة، إما 'left' أو 'center' أو 'normal'، وتعيد القيمة null ضبط المحاذاة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

يمكن أيضًا مراجعة


setNote(note)

لضبط الملاحظة على القيمة المقدَّمة

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

المَعلمات

الاسمTypeالوصف
noteStringقيمة الملاحظة المطلوب ضبطها للنطاق، تزيل قيمة null الملاحظة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setNotes(notes)

تحدّد شبكة مستطيلة من الملاحظات (يجب أن تتطابق مع أبعاد هذا النطاق).

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

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

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

المَعلمات

الاسمTypeالوصف
notesObject[][]مصفوفة ثنائية الأبعاد من الملاحظات؛ وتزيل قيم null الملاحظة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

يمكن أيضًا مراجعة


setNumberFormat(numberFormat)

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

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

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

المَعلمات

الاسمTypeالوصف
numberFormatStringسلسلة تنسيق رقم

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

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

setNumberFormats(numberFormats)

تحدِّد شبكة مستطيلة من تنسيقات الأرقام أو التواريخ (يجب أن تتطابق مع أبعاد هذا النطاق). والقيم هي سلاسل أنماط بتنسيق كما هو موضح في وثائق واجهة برمجة تطبيقات جداول البيانات.

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

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

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

المَعلمات

الاسمTypeالوصف
numberFormatsObject[][]يشير ذلك المصطلح إلى مصفوفة ثنائية الأبعاد لتنسيقات الأرقام.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValue(value)

لضبط قيمة النص المنسَّق للخلايا في النطاق.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

المَعلمات

الاسمTypeالوصف
valueRichTextValueقيمة النص المنسَّق المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValues(values)

لضبط شبكة مستطيلة من قيم النصوص المنسّقة.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

المَعلمات

الاسمTypeالوصف
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);

المَعلمات

الاسمTypeالوصف
showHyperlinkBooleanما إذا كان سيتم عرض الرابط التشعّبي أم لا.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirection(direction)

لضبط اتجاه النص للخلايا في النطاق. إذا كان الاتجاه المحدد هو null، يتم استنتاج الاتجاه ثم تعيينه.

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

المَعلمات

الاسمTypeالوصف
directionTextDirectionاتجاه النص المطلوب، في حال تم استنتاج null الاتجاه قبل الضبط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirections(directions)

لتعيين شبكة مستطيلة باتجاهات النص. إذا كان الاتجاه المحدد هو null، يتم استنتاج الاتجاه ثم تعيينه.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

المَعلمات

الاسمTypeالوصف
directionsTextDirection[][]اتجاهات النص المطلوبة، وإذا كان الاتجاه المحدّد هو null، سيتم استنتاجه قبل الضبط.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(degrees)

لضبط إعدادات تدوير النص للخلايا في النطاق. يتجاوب الإدخال مع الزاوية بين الاتجاه القياسي للنص والاتجاه المطلوب. يشير إدخال صفر إلى أنه تم تعيين النص على الاتجاه القياسي.

بالنسبة لاتجاه النص من اليسار إلى اليمين، تكون الزوايا الموجبة في اتجاه عكس اتجاه عقارب الساعة، بينما تكون بالنسبة إلى اليمين إلى اليسار في اتجاه عقارب الساعة.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

المَعلمات

الاسمTypeالوصف
degreesIntegerالزاوية المطلوبة بين الاتجاه القياسي والاتجاه المطلوب. بالنسبة للنص من اليسار إلى اليمين، تكون الزوايا الموجبة في اتجاه عكس اتجاه عقارب الساعة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(rotation)

لضبط إعدادات تدوير النص للخلايا في النطاق.

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

المَعلمات

الاسمTypeالوصف
rotationTextRotationإعدادات تدوير النص المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotations(rotations)

لتعيين شبكة مستطيلة من دوران النص.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

المَعلمات

الاسمTypeالوصف
rotationsTextRotation[][]إعدادات تدوير النص المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyle(style)

لضبط نمط النص للخلايا في النطاق.

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

المَعلمات

الاسمTypeالوصف
styleTextStyleنمط النص المطلوب.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyles(styles)

لضبط شبكة مستطيلة من أنماط النص.

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

المَعلمات

الاسمTypeالوصف
stylesTextStyle[][]أنماط النص المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

تحدِّد قيمة النطاق. يمكن أن تكون القيمة رقمية أو سلسلة أو منطقية أو تاريخ. إذا بدأت بـ '='، سيتم تفسيرها على أنها معادلة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setValue(100);

المَعلمات

الاسمTypeالوصف
valueObjectقيمة النطاق.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValues(values)

تحدِّد شبكة مستطيلة من القيم (يجب أن تتطابق مع أبعاد هذا النطاق). إذا كانت القيمة تبدأ بـ =، سيتم تفسيرها على أنها صيغة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

المَعلمات

الاسمTypeالوصف
valuesObject[][]يشير ذلك المصطلح إلى مصفوفة قيم ثنائية الأبعاد.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignment(alignment)

اضبط المحاذاة العمودية (من أعلى إلى أسفل) للنطاق المحدَّد (أعلى/متوسط/أسفل).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

المَعلمات

الاسمTypeالوصف
alignmentStringتمت إعادة ضبط المحاذاة، إما 'top' أو 'middle' أو 'bottom'، كما أنّ القيمة null تؤدي إلى إعادة ضبط المحاذاة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignments(alignments)

لضبط شبكة مستطيلة من المحاذاة العمودية (يجب أن تتطابق مع أبعاد هذا النطاق).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

المَعلمات

الاسمTypeالوصف
alignmentsObject[][]مصفوفة ثنائية الأبعاد من المحاذاة، إما 'top' أو 'middle' أو 'bottom'، وتعيد القيمة null ضبط المحاذاة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

يمكن أيضًا مراجعة


setVerticalText(isVertical)

لتعيين ما إذا كان سيتم تكديس النص للخلايا في النطاق أم لا. إذا كان النص مكدسًا رأسيًا، يتم تجاهل إعداد تدوير النص بالدرجة.

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

المَعلمات

الاسمTypeالوصف
isVerticalBooleanتحديد ما إذا كان سيتم تكديس النص أم لا.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrap(isWrapEnabled)

اضبط التفاف الخلية للنطاق المحدد.

يتم تغيير حجم الخلايا التي تم تفعيل التفافها (الخيار التلقائي) لعرض المحتوى بالكامل. يتم عرض الخلايا التي تم إيقاف التفافها بأكبر قدر ممكن في الخلية دون تغيير حجمها أو تشغيلها على أسطر متعددة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setWrap(true);

المَعلمات

الاسمTypeالوصف
isWrapEnabledBooleanتحديد ما إذا كان سيتم التفاف النص أم لا.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategies(strategies)

تعيين شبكة مستطيلة من استراتيجيات الالتفاف.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

المَعلمات

الاسمTypeالوصف
strategiesWrapStrategy[][]استراتيجيات الالتفاف المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategy(strategy)

تحدِّد استراتيجية التفاف النص للخلايا في النطاق.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

المَعلمات

الاسمTypeالوصف
strategyWrapStrategyاستراتيجية الالتفاف المطلوبة.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWraps(isWrapEnabled)

تحدِّد شبكة مستطيلة تتضمّن سياسات التفاف الكلمات (يجب أن تتطابق مع أبعاد هذا النطاق). يتغير حجم الخلايا التي تم تمكين الالتفاف فيها (الافتراضي) لعرض محتواها الكامل. يتم عرض الخلايا التي تم إيقاف الالتفاف بها أكبر قدر ممكن في الخلية دون تغيير حجمها أو تشغيلها على أسطر متعددة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

المَعلمات

الاسمTypeالوصف
isWrapEnabledObject[][]يشير ذلك المصطلح إلى مصفوفة ثنائية الأبعاد من متغيّرات الالتفاف التي تحدّد ما إذا كان سيتم لف النص في خلية أم لا.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

يمكن أيضًا مراجعة


shiftColumnGroupDepth(delta)

تغيّر عمق تجميع الأعمدة للنطاق بمقدار المقدار المحدد.

هذا له تأثير إنشاء أو تعديل أو حذف المجموعات التي تتقاطع مع النطاق. بالنسبة إلى مجموعات دلتا الموجبة، يتم إنشاء المجموعات و/أو تعديلها؛ وبالنسبة إلى مجموعات دلتا السالبة، يتم تدمير المجموعات و/أو تعديلها.

هذا ليس له أي تأثير عند خفض عمق المجموعة إلى أقل من صفر أو فوق ثمانية.

وإذا كانت قيمة column group control position هي BEFORE، سيؤدي ذلك إلى ظهور خطأ عند محاولة تغيير عمق الصف الأول.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

المَعلمات

الاسمTypeالوصف
deltaIntegerالمقدار الذي سيتم من خلاله تغيير عمق مجموعة الأعمدة لهذا النطاق.

استرجاع الكرة

Range: هذا النطاق للسلاسل

الرميات

Error: عند محاولة تغيير عمق العمود الأول عندما يكون موضع التحكّم GroupControlTogglePosition.BEFORE

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

shiftRowGroupDepth(delta)

تغيّر عمق تجميع الصفوف للنطاق حسب المقدار المحدد.

هذا له تأثير إنشاء أو تعديل أو حذف المجموعات التي تتقاطع مع النطاق. بالنسبة إلى مجموعات دلتا الموجبة، يتم إنشاء المجموعات و/أو تعديلها؛ وبالنسبة إلى مجموعات دلتا السالبة، يتم تدمير المجموعات و/أو تعديلها.

هذا ليس له أي تأثير عند خفض عمق المجموعة إلى أقل من صفر أو فوق ثمانية.

إذا كانت قيمة row group control position هي BEFORE، سيؤدي ذلك إلى عرض خطأ عند محاولة تغيير عمق الصف الأول.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

المَعلمات

الاسمTypeالوصف
deltaIntegerالمقدار الذي سيتم من خلاله تغيير عمق مجموعة الصفوف لهذا النطاق.

استرجاع الكرة

Range: هذا النطاق للسلاسل

الرميات

Error: عند محاولة تغيير عمق الصف الأول عندما يكون موضع التحكّم GroupControlTogglePosition.BEFORE

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(sortSpecObj)

تفرز الخلايا في النطاق المحدد حسب العمود والترتيب المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

المَعلمات

الاسمTypeالوصف
sortSpecObjObjectالأعمدة المطلوب الترتيب على أساسها.

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns()

لتقسيم عمود من النص إلى أعمدة متعددة بناءً على محدد يتم اكتشافه تلقائيًا.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

لتقسيم عمود من النص إلى أعمدة متعددة باستخدام السلسلة المحددة كمحدد مخصص.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

المَعلمات

الاسمTypeالوصف
delimiterStringالمحدِّد المخصّص للتقسيم بناءً عليه.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

لتقسيم عمود من النص إلى أعمدة متعددة بناءً على المحدد المحدد.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

المَعلمات

الاسمTypeالوصف
delimiterTextToColumnsDelimiterالمُحدِّد المُعد مسبقًا للتقسيم بناءً عليه.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

trimWhitespace()

اقتطاع المسافة البيضاء (مثل المسافات أو علامات التبويب أو الأسطر الجديدة) في كل خلية في هذا النطاق تزيل كل المسافات البيضاء من بداية نص كل خلية ونهايتها، وتقلل أي تسلسل فرعي من أحرف المسافة البيضاء المتبقية إلى مسافة واحدة.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

uncheck()

تغيير حالة مربعات الاختيار في النطاق إلى "غير محدد". ويتجاهل الخلايا في النطاق الذي لا يحتوي حاليًا على القيمة المحددة أو غير المحددة التي تم إعدادها.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

استرجاع الكرة

Range: هذا النطاق للسلاسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

الطرق المتوقّفة نهائيًا