Class Sheet

الجدول

الوصول إلى أوراق جداول البيانات وتعديلها تشمل العمليات الشائعة إعادة تسمية ورقة بيانات والوصول إلى ملف تعريف العناصر من ورقة البيانات.

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
activate()	Sheet	تفعيل هذه الورقة
addDeveloperMetadata(key)	Sheet	تُضيف البيانات الوصفية للمطوّر باستخدام المفتاح المحدّد إلى ورقة البيانات.
addDeveloperMetadata(key, visibility)	Sheet	تُضيف هذه الدالة البيانات الوصفية للمطوّر إلى ورقة البيانات باستخدام المفتاح ومستوى العرض المحدَّدَين.
addDeveloperMetadata(key, value)	Sheet	تُضيف هذه الدالة البيانات الوصفية للمطوّر باستخدام المفتاح والقيمة المحدّدَين إلى ورقة البيانات.
addDeveloperMetadata(key, value, visibility)	Sheet	تُضيف هذه الدالة البيانات الوصفية لمطوّر البرامج إلى ورقة البيانات باستخدام المفتاح والقيمة ومستوى العرض المحدّد.
appendRow(rowContents)	Sheet	إلحاق صف في أسفل منطقة البيانات الحالية في الورقة
asDataSourceSheet()	DataSourceSheet	تعرِض هذه الدالة الورقة كـ DataSourceSheet إذا كانت الورقة من النوع SheetType.DATASOURCE، أو null بخلاف ذلك.
autoResizeColumn(columnPosition)	Sheet	تضبط عرض العمود المحدّد ليلائم محتوياته.
autoResizeColumns(startColumn, numColumns)	Sheet	لضبط عرض كل الأعمدة بدءًا من موضع العمود المحدّد ليلائم محتوياتها
autoResizeRows(startRow, numRows)	Sheet	لضبط ارتفاع جميع الصفوف بدءًا من موضع الصف المحدّد ليلائم محتوياتها
clear()	Sheet	يؤدي هذا الخيار إلى محو محتوى ورقة البيانات ومعلومات التنسيق.
clear(options)	Sheet	تمحو ورقة البيانات المحتوى و/أو التنسيق، كما هو محدّد بالخيارات المتقدّمة المقدّمة.
clearConditionalFormatRules()	void	تزيل جميع قواعد التنسيق الشرطي من ورقة البيانات.
clearContents()	Sheet	تمحو ورقة البيانات محتوياتها مع الاحتفاظ بمعلومات التنسيق.
clearFormats()	Sheet	تمحو هذه العملية التنسيق من ورقة البيانات مع الحفاظ على المحتوى.
clearNotes()	Sheet	محو جميع الملاحظات من ورقة البيانات
collapseAllColumnGroups()	Sheet	تصغير كل مجموعات الأعمدة في الورقة
collapseAllRowGroups()	Sheet	تصغير كل مجموعات الصفوف في الورقة
copyTo(spreadsheet)	Sheet	نسخ الورقة إلى جدول بيانات معيّن، والذي يمكن أن يكون جدول البيانات نفسه المستخدَم كمصدر
createDeveloperMetadataFinder()	DeveloperMetadataFinder	تعرِض هذه الدالة DeveloperMetadataFinder للعثور على البيانات الوصفية للمطوّر في نطاق هذه الورقة.
createTextFinder(findText)	TextFinder	تُنشئ هذه الدالة أداة بحث عن النصوص في ورقة البيانات، والتي يمكنها البحث عن نص واستبداله في ورقة البيانات.
deleteColumn(columnPosition)	Sheet	تؤدي هذه الدالة إلى حذف العمود في موضع العمود المحدّد.
deleteColumns(columnPosition, howMany)	void	تحذف عددًا من الأعمدة بدءًا من موضع العمود المحدّد.
deleteRow(rowPosition)	Sheet	تؤدي هذه الدالة إلى حذف الصف في موضع الصف المحدّد.
deleteRows(rowPosition, howMany)	void	تحذف عددًا من الصفوف بدءًا من موضع الصف المحدّد.
expandAllColumnGroups()	Sheet	توسيع كل مجموعات الأعمدة في الورقة
expandAllRowGroups()	Sheet	توسيع جميع مجموعات الصفوف في الورقة
expandColumnGroupsUpToDepth(groupDepth)	Sheet	توسيع كل مجموعات الأعمدة إلى العمق المحدّد وتصغير كل المجموعات الأخرى
expandRowGroupsUpToDepth(groupDepth)	Sheet	توسيع كل مجموعات الصفوف إلى العمق المحدّد وتصغير كل المجموعات الأخرى
getActiveCell()	Range	عرض الخلية النشطة في ورقة البيانات هذه
getActiveRange()	Range	عرض النطاق المحدّد في الورقة النشطة، أو null إذا لم يكن هناك نطاق نشط
getActiveRangeList()	RangeList	عرض قائمة النطاقات النشطة في الورقة النشطة أو null إذا لم تكن هناك نطاقات نشطة
getBandings()	Banding[]	عرض جميع النطاقات في هذه الورقة
getCharts()	EmbeddedChart[]	تعرِض هذه الدالة مصفوفة من الرسوم البيانية في هذه الورقة.
getColumnGroup(columnIndex, groupDepth)	Group	لعرض مجموعة الأعمدة في المؤشر وعمق المجموعة المحدَّدَين
getColumnGroupControlPosition()	GroupControlTogglePosition	تُعرِض GroupControlTogglePosition لجميع مجموعات الأعمدة في ورقة البيانات.
getColumnGroupDepth(columnIndex)	Integer	لعرض عمق المجموعة للعمود في الفهرس المحدّد.
getColumnWidth(columnPosition)	Integer	تحصل على عرض العمود المحدّد بالبكسل.
getConditionalFormatRules()	ConditionalFormatRule[]	الحصول على جميع قواعد التنسيق الشرطي في هذه الورقة
getCurrentCell()	Range	تعرِض هذه الدالة الخلية الحالية في الورقة النشطة أو null إذا لم تكن هناك خلية حالية.
getDataRange()	Range	تعرِض Range مقابل السمات التي تتوفّر فيها البيانات.
getDataSourceFormulas()	DataSourceFormula[]	تحصل على جميع صِيَغ مصادر البيانات.
getDataSourcePivotTables()	DataSourcePivotTable[]	تحصل على جميع الجداول المحورية لمصدر البيانات.
getDataSourceTables()	DataSourceTable[]	تحصل على جميع جداول مصادر البيانات.
getDeveloperMetadata()	DeveloperMetadata[]	الحصول على جميع البيانات الوصفية للمطوّر المرتبطة بهذه الورقة
getDrawings()	Drawing[]	تعرِض هذه الدالة مصفوفة من الرسومات على الورقة.
getFilter()	Filter	تعرِض هذه السمة الفلتر في هذه الورقة، أو null إذا لم يكن هناك فلتر.
getFormUrl()	String	تعرِض هذه الدالة عنوان URL للنموذج الذي يُرسِل ردوده إلى ورقة البيانات هذه، أو null إذا لم تكن هذه الورقة مرتبطة بنموذج.
getFrozenColumns()	Integer	لعرض عدد الأعمدة المُجمَّدة.
getFrozenRows()	Integer	لعرض عدد الصفوف الثابتة.
getImages()	OverGridImage[]	عرض جميع الصور التي تتجاوز حدود الشبكة على الورقة
getIndex()	Integer	تحصل على موضع ورقة البيانات في جدول البيانات الرئيسي.
getLastColumn()	Integer	تعرِض هذه الدالة موضع آخر عمود يتضمّن محتوى.
getLastRow()	Integer	لعرض موضع آخر صف يحتوي على محتوى.
getMaxColumns()	Integer	لعرض العدد الحالي للأعمدة في ورقة البيانات، بغض النظر عن المحتوى.
getMaxRows()	Integer	تعرِض هذه الدالة العدد الحالي للصفوف في ورقة البيانات، بغض النظر عن المحتوى.
getName()	String	عرض اسم ورقة البيانات
getNamedRanges()	NamedRange[]	تحصل على جميع النطاقات المُعنوَنة في هذه الورقة.
getParent()	Spreadsheet	تعرِض هذه الدالة Spreadsheet التي تحتوي على هذا الجدول.
getPivotTables()	PivotTable[]	عرض جميع الجداول المحورية في هذه الورقة
getProtections(type)	Protection[]	تحصل على صفيف من العناصر التي تمثّل جميع النطاقات المحمية في جدول البيانات، أو صفيف يضم عنصرًا واحدًا يمثّل الحماية في جدول البيانات نفسه.
getRange(row, column)	Range	لعرض النطاق الذي يتضمّن الخلية في أعلى يمين الصفحة عند الإحداثيات المحدّدة.
getRange(row, column, numRows)	Range	لعرض النطاق الذي يتضمّن الخلية في أعلى يمين الإحداثيات المحدّدة، وبالعدد المحدّد من الصفوف.
getRange(row, column, numRows, numColumns)	Range	لعرض النطاق الذي يتضمّن الخلية في أعلى يمين الإحداثيات المحدّدة مع العدد المحدّد من الصفوف والأعمدة.
getRange(a1Notation)	Range	عرض النطاق على النحو المحدّد في ترميز A1 أو ترميز R1C1
getRangeList(a1Notations)	RangeList	تعرِض هذه الدالة مجموعة RangeList التي تمثّل النطاقات في ورقة البيانات نفسها المحدّدة بواسطة قائمة غير فارغة من علامات A1 أو علامات R1C1.
getRowGroup(rowIndex, groupDepth)	Group	تعرِض مجموعة الصفوف في المؤشر وعمق المجموعة المحدَّدَين.
getRowGroupControlPosition()	GroupControlTogglePosition	عرض GroupControlTogglePosition لجميع مجموعات الصفوف في الورقة
getRowGroupDepth(rowIndex)	Integer	لعرض عمق المجموعة للصف في الفهرس المحدّد.
getRowHeight(rowPosition)	Integer	تحصل على ارتفاع الصف المحدّد بالبكسل.
getSelection()	Selection	لعرض Selection الحالي في جدول البيانات.
getSheetId()	Integer	تعرِض هذه السمة رقم تعريف ورقة البيانات التي يمثّلها هذا العنصر.
getSheetName()	String	عرض اسم الورقة
getSheetValues(startRow, startColumn, numRows, numColumns)	Object[][]	لعرض شبكة مستطيلة من القيم لهذا النطاق بدءًا من الإحداثيات المحدّدة.
getSlicers()	Slicer[]	تعرِض هذه الدالة صفيفًا من أقسام الشرائح في ورقة البيانات.
getTabColorObject()	Color	تحصل على لون علامة التبويب الخاصة بالورقة، أو null إذا لم يكن لعلامة التبويب الخاصة بالورقة لون.
getType()	SheetType	لعرض نوع ورقة البيانات.
hasHiddenGridlines()	Boolean	تعرِض القيمة true إذا كانت خطوط الشبكة في الورقة مخفية، وتعرِض القيمة false بخلاف ذلك.
hideColumn(column)	void	لإخفاء العمود أو الأعمدة في النطاق المحدّد
hideColumns(columnIndex)	void	تخفي عمودًا واحدًا في الفهرس المحدَّد.
hideColumns(columnIndex, numColumns)	void	إخفاء عمود واحد أو أكثر متتاليين بدءًا من الفهرس المحدَّد
hideRow(row)	void	لإخفاء الصفوف في النطاق المحدّد
hideRows(rowIndex)	void	يخفي الصف في الفهرس المحدَّد.
hideRows(rowIndex, numRows)	void	إخفاء صف واحد أو أكثر متتاليَين بدءًا من الفهرس المحدَّد
hideSheet()	Sheet	يؤدي هذا الإجراء إلى إخفاء هذه الورقة.
insertChart(chart)	void	تُضيف رسمًا بيانيًا جديدًا إلى هذه الورقة.
insertColumnAfter(afterPosition)	Sheet	تُدخِل عمودًا بعد موضع العمود المحدَّد.
insertColumnBefore(beforePosition)	Sheet	تُستخدَم لإدراج عمود قبل موضع العمود المحدّد.
insertColumns(columnIndex)	void	تُستخدَم هذه الدالة لإدراج عمود فارغ في ورقة بيانات في الموقع المحدّد.
insertColumns(columnIndex, numColumns)	void	تُدرج هذه الدالة عمودًا فارغًا واحدًا أو أكثر متتاليًا في ورقة بيانات بدءًا من الموضع المحدّد.
insertColumnsAfter(afterPosition, howMany)	Sheet	تُدرج عددًا معيّنًا من الأعمدة بعد موضع العمود المحدّد.
insertColumnsBefore(beforePosition, howMany)	Sheet	تُدخِل عددًا من الأعمدة قبل موضع العمود المحدَّد.
insertImage(blobSource, column, row)	OverGridImage	لإدراج BlobSource كصورة في المستند في صف وعمود معيّنين
insertImage(blobSource, column, row, offsetX, offsetY)	OverGridImage	لإدراج BlobSource كصورة في المستند في صف وعمود معيّنين، مع إزاحة بكسل
insertImage(url, column, row)	OverGridImage	لإدراج صورة في المستند في صف وعمود محدّدَين
insertImage(url, column, row, offsetX, offsetY)	OverGridImage	لإدراج صورة في المستند في صف وعمود معيّنين، مع إزاحة بكسل
insertRowAfter(afterPosition)	Sheet	تُدرج صفًا بعد موضع الصف المحدَّد.
insertRowBefore(beforePosition)	Sheet	تُستخدَم لإدراج صف قبل موضع الصف المحدّد.
insertRows(rowIndex)	void	لإدراج صف فارغ في ورقة بيانات في الموضع المحدّد
insertRows(rowIndex, numRows)	void	تُدرج هذه الدالة صفًا فارغًا واحدًا أو أكثر متتاليًا في ورقة بيانات بدءًا من الموضع المحدّد.
insertRowsAfter(afterPosition, howMany)	Sheet	تُدرج عددًا من الصفوف بعد موضع الصف المحدَّد.
insertRowsBefore(beforePosition, howMany)	Sheet	تُستخدَم لإدراج عدد من الصفوف قبل موضع الصف المحدَّد.
insertSlicer(range, anchorRowPos, anchorColPos)	Slicer	تُضيف أداة تقسيم جديدة إلى هذه الورقة.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)	Slicer	تُضيف أداة تقسيم جديدة إلى هذه الورقة.
isColumnHiddenByUser(columnPosition)	Boolean	تعرِض هذه السمة ما إذا كان المستخدم قد أخفى العمود المحدّد.
isRightToLeft()	Boolean	تعرِض هذه الدالة القيمة true إذا كان تنسيق ورقة البيانات هذا من اليمين إلى اليسار.
isRowHiddenByFilter(rowPosition)	Boolean	تشير إلى ما إذا كان الصف المحدّد مخفيًا بواسطة فلتر (وليس عرض فلتر).
isRowHiddenByUser(rowPosition)	Boolean	تعرِض ما إذا كان المستخدم قد أخفى الصف المحدَّد.
isSheetHidden()	Boolean	تعرِض القيمة true إذا كانت الورقة مخفية حاليًا.
moveColumns(columnSpec, destinationIndex)	void	تنقل الأعمدة التي تم اختيارها حسب النطاق المحدّد إلى الموضع الذي يشير إليه الرمز destinationIndex.
moveRows(rowSpec, destinationIndex)	void	تنقل الصفوف التي تم اختيارها حسب النطاق المحدّد إلى الموضع الذي يشير إليه destinationIndex.
newChart()	EmbeddedChartBuilder	تعرِض هذه الدالة أداة إنشاء لإنشاء رسم بياني جديد لهذه الورقة.
protect()	Protection	لإنشاء عنصر يمكنه حماية ورقة البيانات من التعديل إلا من قِبل المستخدمين الذين لديهم الإذن
removeChart(chart)	void	تزيل الرسم البياني من ورقة البيانات الرئيسية.
setActiveRange(range)	Range	تُستخدَم لضبط النطاق المحدّد على أنّه active range في ورقة البيانات النشطة، مع تحديد الخلية في أعلى يمين النطاق على أنّها current cell.
setActiveRangeList(rangeList)	RangeList	تُستخدَم هذه الدالة لضبط قائمة النطاقات المحدّدة على أنّها active ranges في الورقة النشطة.
setActiveSelection(range)	Range	تُستخدَم لضبط منطقة الاختيار النشطة في هذه الورقة.
setActiveSelection(a1Notation)	Range	تُستخدَم لضبط الاختيار النشط، كما هو محدّد في ترميز A1 أو ترميز R1C1.
setColumnGroupControlPosition(position)	Sheet	تُستخدَم لضبط موضع زر التبديل الخاص بعنصر التحكّم في مجموعة الأعمدة على ورقة البيانات.
setColumnWidth(columnPosition, width)	Sheet	لضبط عرض العمود المحدّد بالبكسل
setColumnWidths(startColumn, numColumns, width)	Sheet	لضبط عرض الأعمدة المحدّدة بالبكسل
setConditionalFormatRules(rules)	void	لاستبدال جميع قواعد التنسيق الشرطي الحالية في الورقة بقواعد الإدخال
setCurrentCell(cell)	Range	لضبط الخلية المحدّدة على أنّها current cell.
setFrozenColumns(columns)	void	تجميد العدد المحدّد من الأعمدة
setFrozenRows(rows)	void	تجميد العدد المحدّد من الصفوف
setHiddenGridlines(hideGridlines)	Sheet	إخفاء خطوط الشبكة في الورقة أو إظهارها
setName(name)	Sheet	لضبط اسم ورقة البيانات
setRightToLeft(rightToLeft)	Sheet	لضبط تنسيق الورقة من اليمين إلى اليسار أو إلغاء ضبطه
setRowGroupControlPosition(position)	Sheet	تُستخدَم لضبط موضع زرّ التبديل الخاص بعنصر التحكّم في مجموعة الصفوف على ورقة البيانات.
setRowHeight(rowPosition, height)	Sheet	لضبط ارتفاع الصف المحدّد بالبكسل
setRowHeights(startRow, numRows, height)	Sheet	لضبط ارتفاع الصفوف المحدّدة بالبكسل.
setRowHeightsForced(startRow, numRows, height)	Sheet	لضبط ارتفاع الصفوف المحدّدة بالبكسل.
setTabColor(color)	Sheet	لضبط لون علامة تبويب ورقة البيانات
setTabColorObject(color)	Sheet	لضبط لون علامة تبويب ورقة البيانات
showColumns(columnIndex)	void	تُزيل إخفاء العمود في الفهرس المحدَّد.
showColumns(columnIndex, numColumns)	void	إزالة إخفاء عمود واحد أو أكثر متتاليين بدءًا من الفهرس المحدَّد
showRows(rowIndex)	void	تُزيل إخفاء الصف في الفهرس المحدَّد.
showRows(rowIndex, numRows)	void	إزالة إخفاء صف واحد أو أكثر متتاليَين بدءًا من الفهرس المحدَّد
showSheet()	Sheet	يجعل الورقة مرئية.
sort(columnPosition)	Sheet	لترتيب ورقة بيانات حسب العمود تصاعديًا
sort(columnPosition, ascending)	Sheet	يرتِّب ورقة بيانات حسب العمود.
unhideColumn(column)	void	تُزيل إخفاء العمود في النطاق المحدَّد.
unhideRow(row)	void	لإزالة إخفاء الصف في النطاق المحدّد
updateChart(chart)	void	تعديل الرسم البياني في هذه الورقة

الطرق المتوقّفة

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
getSheetProtection()	PageProtection	عرض مثيل PageProtection يصف أذونات الورقة الحالية
getTabColor()	String	تحصل على لون علامة التبويب الخاصة بالورقة، أو null إذا لم يكن لعلامة التبويب الخاصة بالورقة لون.
setSheetProtection(permissions)	void	تُستخدَم لضبط أذونات ورقة البيانات الحالية.

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

activate()

تفعيل هذه الورقة لا يؤدي ذلك إلى تغيير الورقة نفسها، بل يغيّر فقط مفهوم الورقة النشط للعنصر الرئيسي.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.activate();

الإرجاع

Sheet: ورقة البيانات النشطة حديثًا.

---

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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

المعلَمات

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

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

• 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

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

المعلَمات

الاسم	النوع	الوصف
key	String	مفتاح البيانات الوصفية الجديدة للمطوّر
visibility	DeveloperMetadataVisibility	مستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

• 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for
// the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

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

المعلَمات

الاسم	النوع	الوصف
key	String	مفتاح البيانات الوصفية الجديدة للمطوّر
value	String	قيمة البيانات الوصفية الجديدة لمطوّر البرامج

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

• 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and
// sets the visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
    'COMPANY',
    'TECH',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

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

المعلَمات

الاسم	النوع	الوصف
key	String	مفتاح البيانات الوصفية الجديدة للمطوّر
value	String	قيمة البيانات الوصفية الجديدة لمطوّر البرامج
visibility	DeveloperMetadataVisibility	مستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

appendRow(rowContents)

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

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

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(['a man', 'a plan', 'panama']);

المعلَمات

الاسم	النوع	الوصف
rowContents	Object[]	صفيف من القيم لإدراجه بعد الصف الأخير في ورقة البيانات

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق.

التفويض

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

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

---

asDataSourceSheet()

تعرِض هذه الدالة الورقة كـ DataSourceSheet إذا كانت الورقة من النوع SheetType.DATASOURCE، أو null بخلاف ذلك.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

الإرجاع

DataSourceSheet: ورقة مصدر بيانات.

التفويض

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

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

---

autoResizeColumn(columnPosition)

تضبط عرض العمود المحدّد ليلائم محتوياته.

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

sheet.getRange('a1').setValue(
    'Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود المحدّد الذي تريد تغيير حجمه

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

autoResizeColumns(startColumn, numColumns)

لضبط عرض كل الأعمدة بدءًا من موضع العمود المحدّد ليلائم محتوياتها

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

المعلَمات

الاسم	النوع	الوصف
startColumn	Integer	العمود الأول الذي سيتم تغيير حجمه تلقائيًا
numColumns	Integer	عدد الأعمدة المطلوب تغيير حجمها تلقائيًا

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

autoResizeRows(startRow, numRows)

لضبط ارتفاع جميع الصفوف بدءًا من موضع الصف المحدّد ليلائم محتوياتها

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

المعلَمات

الاسم	النوع	الوصف
startRow	Integer	الصف الأول الذي سيتم تغيير حجمه تلقائيًا.
numRows	Integer	عدد الصفوف المطلوب تغيير حجمها تلقائيًا.

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

clear()

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clear();

الإرجاع

Sheet: الورقة التي تمّ محو بياناتها

التفويض

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

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

---

clear(options)

تمحو ورقة البيانات المحتوى و/أو التنسيق، كما هو محدّد بالخيارات المتقدّمة المقدّمة.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.clear({formatOnly: true, contentsOnly: true});

المعلَمات

الاسم	النوع	الوصف
options	Object	خريطة JavaScript تحتوي على خيارات متقدّمة، وهي مذكورة أدناه.

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

الاسم	النوع	الوصف
contentsOnly	Boolean	ما إذا كان سيتم محو المحتوى
formatOnly	Boolean	يمكنك اختيار ما إذا كنت تريد محو التنسيق.

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

clearConditionalFormatRules()

تزيل جميع قواعد التنسيق الشرطي من ورقة البيانات. يعادل هذا استدعاء setConditionalFormatRules(rules) باستخدام صفيف فارغ كمدخل.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

التفويض

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

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

---

clearContents()

تمحو ورقة البيانات محتوياتها مع الاحتفاظ بمعلومات التنسيق.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearContents();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

clearFormats()

تمحو هذه العملية التنسيق من ورقة البيانات مع الحفاظ على المحتوى.

يشير التنسيق إلى كيفية تنسيق البيانات على النحو المسموح به من خلال الخيارات ضمن قائمة "التنسيق" (مثل غامق ومائل وتنسيق مشروط) وليس عرض الخلايا أو ارتفاعها.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearFormats();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

clearNotes()

محو جميع الملاحظات من ورقة البيانات

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

collapseAllColumnGroups()

تصغير كل مجموعات الأعمدة في الورقة

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

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

collapseAllRowGroups()

تصغير كل مجموعات الصفوف في الورقة

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

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

copyTo(spreadsheet)

نسخ الورقة إلى جدول بيانات معيّن، والذي يمكن أن يكون جدول البيانات نفسه المستخدَم كمصدر يُطلق على الورقة المنسوخة اسم "نسخة من [الاسم الأصلي]".

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

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

المعلَمات

الاسم	النوع	الوصف
spreadsheet	Spreadsheet	جدول البيانات الذي سيتم نسخ ورقة البيانات هذه إليه، والذي يمكن أن يكون جدول البيانات نفسه الذي يتضمّن المصدر

الإرجاع

Sheet: الورقة الجديدة لإنشاء سلاسل.

التفويض

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

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

---

createDeveloperMetadataFinder()

تعرِض هذه الدالة DeveloperMetadataFinder للعثور على البيانات الوصفية للمطوّر في نطاق هذه الورقة. تكون البيانات الوصفية ضمن نطاق ورقة بيانات معيّنة إذا كانت مرتبطة بالورقة نفسها أو مرتبطة بصف أو عمود أو نطاق في تلك الورقة.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

الإرجاع

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

---

createTextFinder(findText)

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

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

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

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

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

المعلَمات

الاسم	النوع	الوصف
findText	String	النص المطلوب البحث عنه

الإرجاع

TextFinder: TextFinder للورقة

---

deleteColumn(columnPosition)

تؤدي هذه الدالة إلى حذف العمود في موضع العمود المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود، بدءًا من 1 للعمود الأول

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

deleteColumns(columnPosition, howMany)

تحذف عددًا من الأعمدة بدءًا من موضع العمود المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع أول عمود تريد حذفه.
howMany	Integer	عدد الأعمدة المطلوب حذفها.

التفويض

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

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

---

deleteRow(rowPosition)

تؤدي هذه الدالة إلى حذف الصف في موضع الصف المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف، بدءًا من 1 للصف الأول

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

deleteRows(rowPosition, howMany)

تحذف عددًا من الصفوف بدءًا من موضع الصف المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الأول المطلوب حذفه.
howMany	Integer	عدد الصفوف المطلوب حذفها.

التفويض

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

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

---

expandAllColumnGroups()

توسيع كل مجموعات الأعمدة في الورقة تتطلّب هذه الطريقة مجموعة أعمدة واحدة على الأقل.

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

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

expandAllRowGroups()

توسيع جميع مجموعات الصفوف في الورقة تتطلّب هذه الطريقة مجموعة صفوف واحدة على الأقل.

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

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

expandColumnGroupsUpToDepth(groupDepth)

توسيع كل مجموعات الأعمدة إلى العمق المحدّد وتصغير كل المجموعات الأخرى

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

المعلَمات

الاسم	النوع	الوصف
groupDepth	Integer	عمق المجموعة الذي يتم توسيع مجموعات الأعمدة إليه.

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

expandRowGroupsUpToDepth(groupDepth)

توسيع كل مجموعات الصفوف إلى العمق المحدّد وتصغير كل المجموعات الأخرى

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

المعلَمات

الاسم	النوع	الوصف
groupDepth	Integer	عمق المجموعة الذي يتم توسيع مجموعات الصفوف إليه.

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

getActiveCell()

عرض الخلية النشطة في ورقة البيانات هذه

ملاحظة: يُفضَّل استخدام getCurrentCell()، الذي يعرض الخلية التي تم تمييزها حاليًا.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

الإرجاع

Range: الخلية النشطة الحالية

التفويض

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

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

---

getActiveRange()

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

الإرجاع

Range: النطاق النشط

التفويض

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

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

انظر أيضًا

• setActiveRange(range)

---

getActiveRangeList()

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

إذا تم اختيار نطاق واحد، سيعمل هذا النطاق كطلب getActiveRange().

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

الإرجاع

RangeList - قائمة النطاقات النشطة

التفويض

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

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

انظر أيضًا

• setActiveRangeList(rangeList)

---

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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

الإرجاع

Banding[]: جميع النطاقات في هذه الورقة

التفويض

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

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

---

getCharts()

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

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

for (const i in charts) {
  const chart = charts[i];
  // Do something with the chart
}

الإرجاع

EmbeddedChart[]: صفيف من الرسوم البيانية

التفويض

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

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

---

getColumnGroup(columnIndex, groupDepth)

لعرض مجموعة الأعمدة في المؤشر وعمق المجموعة المحدَّدَين

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
const columnGroup = sheet.getColumnGroup(2, 1);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	مؤشر العمود لتبديل عنصر التحكّم في المجموعة أو مؤشر داخل المجموعة
groupDepth	Integer	عمق المجموعة.

الإرجاع

Group: مجموعة الأعمدة في مؤشر التحكّم وعمقه، أو تُلقي استثناءً إذا كانت المجموعة غير متوفّرة.

التفويض

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

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

---

getColumnGroupControlPosition()

تُعرِض GroupControlTogglePosition لجميع مجموعات الأعمدة في ورقة البيانات.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

الإرجاع

GroupControlTogglePosition — true إذا كان زر التحكّم في تجميع الأعمدة معروضًا بعد المجموعة في جدول البيانات هذا، وfalse في غير ذلك

التفويض

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

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

---

getColumnGroupDepth(columnIndex)

لعرض عمق المجموعة للعمود في الفهرس المحدّد.

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

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

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	فهرس العمود.

الإرجاع

Integer: عمق المجموعة للعمود في المؤشر المحدّد

التفويض

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

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

---

getColumnWidth(columnPosition)

تحصل على عرض العمود المحدّد بالبكسل.

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

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود الذي تريد فحصه.

الإرجاع

Integer - عرض العمود بالبكسل

التفويض

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

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

---

getConditionalFormatRules()

الحصول على جميع قواعد التنسيق الشرطي في هذه الورقة

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const rule = rules[i];
  Logger.log(rule);
}

الإرجاع

ConditionalFormatRule[]: صفيف لجميع القواعد في الورقة

التفويض

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

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

---

getCurrentCell()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
const currentCell = sheet.getCurrentCell();

الإرجاع

Range: الخلية الحالية

التفويض

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

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

---

getDataRange()

تعرِض Range مقابل السمات التي تتوفّر فيها البيانات.

وهذا المكافئ وظيفيًا لإنشاء نطاق محدود بـ A1 و (Sheet.getLastColumn(), Sheet.getLastRow()).

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

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

الإرجاع

Range - نطاق يتألف من جميع البيانات في جدول البيانات

التفويض

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

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

---

getDataSourceFormulas()

تحصل على جميع صِيَغ مصادر البيانات.

// Opens the spreadsheet by its ID. If you created your script from within 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 an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

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

الإرجاع

DataSourceFormula[]: قائمة بصيغ مصادر البيانات

التفويض

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

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

---

getDataSourcePivotTables()

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

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

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

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.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 an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

الإرجاع

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

التفويض

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

• 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

الإرجاع

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

التفويض

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

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

---

getDrawings()

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

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

// Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

الإرجاع

Drawing[]: قائمة الرسومات في هذه الورقة

التفويض

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

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

---

getFilter()

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

// Gets the filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();

الإرجاع

Filter: الفلتر

التفويض

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

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

---

getFormUrl()

تعرِض هذه الدالة عنوان URL للنموذج الذي يُرسِل ردوده إلى ورقة البيانات هذه، أو null إذا لم تكن هذه الورقة مرتبطة بنموذج. يُعرِض استثناءً إذا لم يكن لدى المستخدم إذن بتعديل جدول البيانات.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

الإرجاع

String: عنوان URL للنموذج الذي يضع ردوده في هذه الورقة، أو null إذا لم تكن هذه الورقة مرتبطة بنموذج

التفويض

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

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

---

getFrozenColumns()

لعرض عدد الأعمدة المُجمَّدة.

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

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

الإرجاع

Integer: عدد الأعمدة المجمّدة

التفويض

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

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

---

getFrozenRows()

لعرض عدد الصفوف الثابتة.

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

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

الإرجاع

Integer: عدد الصفوف المجمّدة

التفويض

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

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

---

getImages()

عرض جميع الصور التي تتجاوز حدود الشبكة على الورقة

// Opens the spreadsheet file 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 over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

الإرجاع

‫OverGridImage[]: صفيف من الصور التي تظهر على سطح الشبكة

التفويض

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

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

---

getIndex()

تحصل على موضع ورقة البيانات في جدول البيانات الرئيسي. تبدأ من 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

الإرجاع

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

التفويض

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

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

---

getLastColumn()

تعرِض هذه الدالة موضع آخر عمود يتضمّن محتوى.

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

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

الإرجاع

Integer: العمود الأخير في جدول البيانات الذي يحتوي على محتوى

التفويض

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

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

---

getLastRow()

لعرض موضع آخر صف يحتوي على محتوى.

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

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

الإرجاع

Integer: الصف الأخير من جدول البيانات الذي يحتوي على محتوى

التفويض

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

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

---

getMaxColumns()

لعرض العدد الحالي للأعمدة في ورقة البيانات، بغض النظر عن المحتوى.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxColumns());

الإرجاع

‫Integer: الحد الأقصى لعرض الورقة

التفويض

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

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

---

getMaxRows()

تعرِض هذه الدالة العدد الحالي للصفوف في ورقة البيانات، بغض النظر عن المحتوى.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxRows());

الإرجاع

Integer: الحد الأقصى لارتفاع الورقة

التفويض

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

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

---

getName()

عرض اسم ورقة البيانات

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

الإرجاع

String: اسم ورقة البيانات

التفويض

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

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

---

getNamedRanges()

تحصل على جميع النطاقات المُعنوَنة في هذه الورقة.

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

الإرجاع

NamedRange[]: صفيف لجميع النطاقات المُعنوَنة في الورقة

التفويض

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

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

---

getParent()

تعرِض هذه الدالة Spreadsheet التي تحتوي على هذا الجدول.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const parent = sheet.getParent();

الإرجاع

Spreadsheet: جدول البيانات الرئيسي

التفويض

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

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

---

getPivotTables()

عرض جميع الجداول المحورية في هذه الورقة

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

الإرجاع

PivotTable[]: الجداول المحورية في هذه الورقة

التفويض

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

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

---

getProtections(type)

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

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

المعلَمات

الاسم	النوع	الوصف
type	ProtectionType	نوع المنطقة المحمية، إما SpreadsheetApp.ProtectionType.RANGE أو SpreadsheetApp.ProtectionType.SHEET.

الإرجاع

Protection[]: مصفوفة من العناصر التي تمثّل جميع النطاقات المحمية في ورقة البيانات، أو مصفوفة من عنصر واحد تمثّل الحماية في ورقة البيانات نفسها.

التفويض

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

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

---

getRange(row, column)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
const range = sheet.getRange(1, 1);
const values = range.getValues();
Logger.log(values[0][0]);

المعلَمات

الاسم	النوع	الوصف
row	Integer	فهرس الصف للخلية المطلوب عرضها، يبدأ ترقيم الصفوف بالرقم 1.
column	Integer	فهرس عمود الخلية المطلوب عرضها، تبدأ فهرسة الأعمدة بالرقم 1.

الإرجاع

Range: نطاق يحتوي على هذه الخلية فقط

التفويض

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

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

---

getRange(row, column, numRows)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

المعلَمات

الاسم	النوع	الوصف
row	Integer	فهرس الصف الأول من النطاق، يبدأ ترقيم الصفوف بالرقم 1.
column	Integer	فهرس عمود النطاق، يبدأ ترقيم الأعمدة بالرقم 1.
numRows	Integer	عدد الصفوف المطلوب عرضها.

الإرجاع

Range: نطاق يحتوي على عمود واحد من البيانات بعدد الصفوف المحدّد.

التفويض

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

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

---

getRange(row, column, numRows, numColumns)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

المعلَمات

الاسم	النوع	الوصف
row	Integer	فهرس الصف الأول من النطاق، يبدأ ترقيم الصفوف بالرقم 1.
column	Integer	فهرس العمود الأول من النطاق، يبدأ ترقيم الأعمدة بالرقم 1.
numRows	Integer	عدد الصفوف المطلوب عرضها.
numColumns	Integer	عدد الأعمدة المطلوب عرضها.

الإرجاع

Range: نطاق يتوافق مع المنطقة المحدّدة

التفويض

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

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

---

getRange(a1Notation)

عرض النطاق على النحو المحدّد في ترميز A1 أو ترميز R1C1

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

المعلَمات

الاسم	النوع	الوصف
a1Notation	String	النطاق المطلوب عرضه، كما هو محدّد في ترميز A1 أو ترميز R1C1.

الإرجاع

Range: النطاق في الموقع المحدّد

التفويض

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

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

---

getRangeList(a1Notations)

تعرِض هذه الدالة مجموعة RangeList التي تمثّل النطاقات في ورقة البيانات نفسها المحدّدة بواسطة قائمة غير فارغة من علامات A1 أو علامات R1C1.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

المعلَمات

الاسم	النوع	الوصف
a1Notations	String[]	قائمة النطاقات المطلوب عرضها، كما هو محدّد في ترميز A1 أو ترميز R1C1.

الإرجاع

RangeList: قائمة النطاقات في الموقع المحدّد

التفويض

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

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

---

getRowGroup(rowIndex, groupDepth)

تعرِض مجموعة الصفوف في المؤشر وعمق المجموعة المحدَّدَين.

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
const rowGroup = sheet.getRowGroup(2, 1);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	مؤشر الصف لزرّ التبديل الخاص بعنصر التحكّم في المجموعة أو مؤشر داخل المجموعة
groupDepth	Integer	عمق المجموعة.

الإرجاع

Group - مجموعة الصفوف في مؤشر التحكّم وعمقه، أو تُلقي استثناءً إذا كانت المجموعة غير متوفّرة.

التفويض

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

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

---

getRowGroupControlPosition()

عرض GroupControlTogglePosition لجميع مجموعات الصفوف في الورقة

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

الإرجاع

GroupControlTogglePosition — true إذا كان زرّ التحكّم في تجميع الصفوف معروضًا بعد المجموعة في هذه الورقة وfalse في غير ذلك

التفويض

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

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

---

getRowGroupDepth(rowIndex)

لعرض عمق المجموعة للصف في الفهرس المحدّد.

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

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

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	فهرس الصف

الإرجاع

Integer: عمق المجموعة للصف في المؤشر المحدّد.

التفويض

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

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

---

getRowHeight(rowPosition)

تحصل على ارتفاع الصف المحدّد بالبكسل.

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

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الذي يجب فحصه.

الإرجاع

Integer - ارتفاع الصف بالبكسل

التفويض

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

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

---

getSelection()

لعرض Selection الحالي في جدول البيانات.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const currentCell = selection.getCurrentCell();

الإرجاع

Selection: العنصر المحدّد حاليًا

التفويض

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

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

---

getSheetId()

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

هذا هو معرّف الورقة الفريد لجدول البيانات. المعرّف هو عدد صحيح متزايد بشكلٍ منتظم يتمّ تعيينه في وقت إنشاء ورقة البيانات، وهو مستقلّ عن موضع ورقة البيانات. يكون هذا الإجراء مفيداً مع طرق مثل Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) التي تأخذ مَعلمة gridId بدلاً من مثيل Sheet.

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

Logger.log(sheet.getSheetId());

الإرجاع

Integer: معرّف لصفحة البيانات فريد لجدول البيانات

التفويض

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

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

---

getSheetName()

عرض اسم الورقة

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

Logger.log(sheet.getSheetName());

الإرجاع

String: اسم جدول البيانات

التفويض

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

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

---

getSheetValues(startRow, startColumn, numRows, numColumns)

لعرض شبكة مستطيلة من القيم لهذا النطاق بدءًا من الإحداثيات المحدّدة. إنّ القيمة -1 المُعطاة كموضع الصف أو العمود تُعادل الحصول على الصف أو العمود الأكثر تأخُّرًا الذي يحتوي على بيانات في الورقة.

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

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

المعلَمات

الاسم	النوع	الوصف
startRow	Integer	موضع الصف الأول.
startColumn	Integer	موضع العمود الأول.
numRows	Integer	عدد الصفوف المطلوب عرض قيم لها.
numColumns	Integer	عدد الأعمدة المطلوب عرض قيم لها.

الإرجاع

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

التفويض

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

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

---

getSlicers()

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

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

الإرجاع

Slicer[]: قائمة الأقسام في ورقة البيانات هذه

التفويض

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

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

---

getTabColorObject()

تحصل على لون علامة التبويب الخاصة بالورقة، أو null إذا لم يكن لعلامة التبويب الخاصة بالورقة لون.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = first.getTabColorObject();

الإرجاع

Color: لون علامة التبويب الخاصة بالورقة، أو null إذا لم يكن لعلامة التبويب لون

التفويض

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

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

---

getType()

لعرض نوع ورقة البيانات.

النوع التلقائي للورقة هو SheetType.GRID. إذا كانت الورقة تحتوي على كائن واحد مضمّن مثل EmbeddedChart، تكون الورقة من النوع SheetType.OBJECT.

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

الإرجاع

‫SheetType: نوع الورقة

التفويض

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

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

---

hasHiddenGridlines()

تعرِض القيمة true إذا كانت خطوط الشبكة في الورقة مخفية، وتعرِض القيمة 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the
// console.
console.log(sheet.hasHiddenGridlines());

الإرجاع

Boolean: true إذا كانت خطوط الشبكة مخفية، false بخلاف ذلك

التفويض

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

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

---

hideColumn(column)

لإخفاء العمود أو الأعمدة في النطاق المحدّد

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

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

المعلَمات

الاسم	النوع	الوصف
column	Range	نطاق الأعمدة المطلوب إخفاؤه.

التفويض

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

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

---

hideColumns(columnIndex)

تخفي عمودًا واحدًا في الفهرس المحدَّد. استخدِم الفهرس 1 لهذه الطريقة.

لإخفاء أكثر من عمود واحد باستخدام فهرس، استخدِم hideColumns(columnIndex, numColumns).

لإخفاء أكثر من عمود واحد باستخدام نطاق، استخدِم hideColumn().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	فهرس العمود المطلوب إخفاؤه.

التفويض

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

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

---

hideColumns(columnIndex, numColumns)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	فهرس بداية الأعمدة المطلوب إخفاؤها.
numColumns	Integer	عدد الأعمدة المطلوب إخفاؤها

التفويض

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

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

---

hideRow(row)

لإخفاء الصفوف في النطاق المحدّد

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

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

المعلَمات

الاسم	النوع	الوصف
row	Range	نطاق الصفوف المطلوب إخفاؤه

التفويض

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

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

---

hideRows(rowIndex)

يخفي الصف في الفهرس المحدَّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	فهرس الصف المطلوب إخفاؤه.

التفويض

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

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

---

hideRows(rowIndex, numRows)

إخفاء صف واحد أو أكثر متتاليَين بدءًا من الفهرس المحدَّد

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	فهرس بداية الصفوف المطلوب إخفاؤها.
numRows	Integer	عدد الصفوف المطلوب إخفاؤها.

التفويض

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

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

---

hideSheet()

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

const sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

الإرجاع

Sheet: الورقة الحالية

التفويض

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

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

---

insertChart(chart)

تُضيف رسمًا بيانيًا جديدًا إلى هذه الورقة.

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(sheet.getRange('A1:B4'))
                  .setPosition(5, 5, 0, 0)
                  .setOption('title', 'Dynamic Chart')
                  .build();
sheet.insertChart(chart);

المعلَمات

الاسم	النوع	الوصف
chart	EmbeddedChart	الرسم البياني المطلوب إدراجه.

التفويض

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

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

---

insertColumnAfter(afterPosition)

تُدخِل عمودًا بعد موضع العمود المحدَّد.

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

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

المعلَمات

الاسم	النوع	الوصف
afterPosition	Integer	العمود الذي يجب إضافة العمود الجديد بعده

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertColumnBefore(beforePosition)

تُستخدَم لإدراج عمود قبل موضع العمود المحدّد.

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

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

المعلَمات

الاسم	النوع	الوصف
beforePosition	Integer	العمود الذي يجب إضافة العمود الجديد قبله

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertColumns(columnIndex)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	الفهرس الذي يشير إلى مكان إدراج عمود

التفويض

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

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

---

insertColumns(columnIndex, numColumns)

تُدرج هذه الدالة عمودًا فارغًا واحدًا أو أكثر متتاليًا في ورقة بيانات بدءًا من الموضع المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	الفهرس الذي يشير إلى مكان إدراج عمود
numColumns	Integer	عدد الأعمدة المطلوب إدراجها.

التفويض

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

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

---

insertColumnsAfter(afterPosition, howMany)

تُدرج عددًا معيّنًا من الأعمدة بعد موضع العمود المحدّد.

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

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

المعلَمات

الاسم	النوع	الوصف
afterPosition	Integer	العمود الذي يجب إضافة العمود الجديد بعده
howMany	Integer	عدد الأعمدة المطلوب إدراجها.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertColumnsBefore(beforePosition, howMany)

تُدخِل عددًا من الأعمدة قبل موضع العمود المحدَّد.

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

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

المعلَمات

الاسم	النوع	الوصف
beforePosition	Integer	العمود الذي يجب إضافة العمود الجديد قبله
howMany	Integer	عدد الأعمدة المطلوب إدراجها.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertImage(blobSource, column, row)

لإدراج BlobSource كصورة في المستند في صف وعمود معيّنين يتم استرداد حجم الصورة من محتوى العنصر المصغّر. الحد الأقصى لحجم الكائن الثنائي الكبير (blob) المسموح به هو 2 ميغابايت.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

المعلَمات

الاسم	النوع	الوصف
blobSource	BlobSource	عنصر تخزين البيانات الثنائية الكبيرة الذي يحتوي على محتوى الصورة ونوع MIME والاسم (اختياري)
column	Integer	موضع العمود
row	Integer	موضع الصف

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertImage(blobSource, column, row, offsetX, offsetY)

لإدراج BlobSource كصورة في المستند في صف وعمود معيّنين، مع إزاحة بكسل يتم استرداد حجم الصورة من محتوى العنصر المصغّر. الحد الأقصى لحجم الكائن الثنائي الكبير (blob) المسموح به هو 2 ميغابايت.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

المعلَمات

الاسم	النوع	الوصف
blobSource	BlobSource	عنصر تخزين البيانات الثنائية الكبيرة الذي يحتوي على محتوى الصورة ونوع MIME والاسم (اختياري)
column	Integer	موضع العمود
row	Integer	موضع الصف
offsetX	Integer	القيمة الأفقية للعنصر من زاوية الخلية بالبكسل
offsetY	Integer	القيمة العمودية للخلية من زاوية الخلية بالبكسل

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertImage(url, column, row)

لإدراج صورة في المستند في صف وعمود محدّدَين

يجب أن يكون عنوان URL المقدَّم متاحًا للجميع.

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

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

المعلَمات

الاسم	النوع	الوصف
url	String	عنوان URL للصورة
column	Integer	موضع عمود الشبكة.
row	Integer	موضع صف الشبكة

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertImage(url, column, row, offsetX, offsetY)

لإدراج صورة في المستند في صف وعمود معيّنين، مع إزاحة بكسل

يجب أن يكون عنوان URL المقدَّم متاحًا للجميع.

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

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

المعلَمات

الاسم	النوع	الوصف
url	String	عنوان URL للصورة
column	Integer	موضع العمود
row	Integer	موضع الصف
offsetX	Integer	القيمة الأفقية للعنصر من زاوية الخلية بالبكسل
offsetY	Integer	القيمة العمودية للخلية من زاوية الخلية بالبكسل

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertRowAfter(afterPosition)

تُدرج صفًا بعد موضع الصف المحدَّد.

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

// This inserts a row after the first row position
sheet.insertRowAfter(1);

المعلَمات

الاسم	النوع	الوصف
afterPosition	Integer	الصف الذي يجب إضافة الصف الجديد بعده

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertRowBefore(beforePosition)

تُستخدَم لإدراج صف قبل موضع الصف المحدّد.

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

// This inserts a row before the first row position
sheet.insertRowBefore(1);

المعلَمات

الاسم	النوع	الوصف
beforePosition	Integer	الصف الذي يجب إضافة الصف الجديد قبله

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertRows(rowIndex)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	المؤشر الذي يشير إلى مكان إدراج صف

التفويض

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

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

---

insertRows(rowIndex, numRows)

تُدرج هذه الدالة صفًا فارغًا واحدًا أو أكثر متتاليًا في ورقة بيانات بدءًا من الموضع المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	المؤشر الذي يشير إلى مكان إدراج صف
numRows	Integer	عدد الصفوف المطلوب إدراجها.

التفويض

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

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

---

insertRowsAfter(afterPosition, howMany)

تُدرج عددًا من الصفوف بعد موضع الصف المحدَّد.

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

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

المعلَمات

الاسم	النوع	الوصف
afterPosition	Integer	الصف الذي يجب إضافة الصفوف الجديدة بعده
howMany	Integer	عدد الصفوف المطلوب إدراجها.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertRowsBefore(beforePosition, howMany)

تُستخدَم لإدراج عدد من الصفوف قبل موضع الصف المحدَّد.

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

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

المعلَمات

الاسم	النوع	الوصف
beforePosition	Integer	الصف الذي يجب إضافة الصفوف الجديدة قبله
howMany	Integer	عدد الصفوف المطلوب إدراجها.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

insertSlicer(range, anchorRowPos, anchorColPos)

تُضيف أداة تقسيم جديدة إلى هذه الورقة.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

المعلَمات

الاسم	النوع	الوصف
range	Range	النطاق الذي يتم إنشاء أداة فلترة نطاق البيانات عليه
anchorRowPos	Integer	يتم تثبيت الجانب العلوي من أداة التقسيم في هذا الصف.
anchorColPos	Integer	يتم تثبيت الجانب العلوي من أداة التقسيم في هذا العمود.

الإرجاع

Slicer: فلتر النطاق الذي تم إدراجه حديثًا.

التفويض

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

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

---

insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)

تُضيف أداة تقسيم جديدة إلى هذه الورقة.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

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

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

المعلَمات

الاسم	النوع	الوصف
range	Range	النطاق الذي يتم إنشاء أداة فلترة نطاق البيانات عليه
anchorRowPos	Integer	يتم تثبيت الجانب العلوي من أداة التقسيم في هذا الصف.
anchorColPos	Integer	يتم تثبيت الجانب العلوي من أداة التقسيم في هذا العمود.
offsetX	Integer	القيمة الأفقية للعنصر من زاوية الخلية بالبكسل
offsetY	Integer	القيمة العمودية للخلية من زاوية الخلية بالبكسل

الإرجاع

Slicer: فلتر النطاق الذي تم إدراجه حديثًا.

التفويض

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

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

---

isColumnHiddenByUser(columnPosition)

تعرِض هذه السمة ما إذا كان المستخدم قد أخفى العمود المحدّد.

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

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود الذي تريد فحصه.

الإرجاع

Boolean: true إذا كان العمود مخفيًا، false بخلاف ذلك

التفويض

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

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

---

isRightToLeft()

تعرِض هذه الدالة القيمة true إذا كان تنسيق ورقة البيانات هذا من اليمين إلى اليسار. تعرِض هذه الدالة القيمة 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to
// the console.
console.log(sheet.isRightToLeft());

الإرجاع

Boolean: true إذا كان الاتجاه من اليمين إلى اليسار، وfalse في حال كان الاتجاه من اليسار إلى اليمين

التفويض

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

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

---

isRowHiddenByFilter(rowPosition)

تشير إلى ما إذا كان الصف المحدّد مخفيًا بواسطة فلتر (وليس عرض فلتر).

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الذي يجب فحصه.

الإرجاع

Boolean: true إذا كان الصف مخفيًا، false بخلاف ذلك

التفويض

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

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

---

isRowHiddenByUser(rowPosition)

تعرِض ما إذا كان المستخدم قد أخفى الصف المحدَّد.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الذي يجب فحصه.

الإرجاع

Boolean: true إذا كان الصف مخفيًا، false بخلاف ذلك

التفويض

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

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

---

isSheetHidden()

تعرِض القيمة true إذا كانت الورقة مخفية حاليًا.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

الإرجاع

Boolean: true إذا كانت الورقة مخفية، false في الحالات الأخرى

التفويض

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

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

---

moveColumns(columnSpec, destinationIndex)

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

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

المعلَمات

الاسم	النوع	الوصف
columnSpec	Range	نطاق يشمل الأعمدة التي يجب نقلها
destinationIndex	Integer	الفهرس الذي يجب نقل الأعمدة إليه. يُرجى العِلم أنّ هذا الفهرس يستند إلى الإحداثيات قبل نقل الأعمدة. يتمّ نقل البيانات الحالية لليسار لتوفير مساحة للأعمدة التي تمّ نقلها، بينما تتمّ إزالة أعمدة المصدر من الشبكة. وبالتالي، قد تنتهي البيانات في فهرس مختلف عن الفهرس المحدّد في الأصل.

التفويض

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

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

---

moveRows(rowSpec, destinationIndex)

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

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

المعلَمات

الاسم	النوع	الوصف
rowSpec	Range	نطاق يشمل الصفوف التي يجب نقلها
destinationIndex	Integer	الفهرس الذي يجب نقل الصفوف إليه. يُرجى العِلم أنّ هذا الفهرس يستند إلى الإحداثيات قبل نقل الصفوف. يتمّ نقل البيانات الحالية للأسفل لإفساح المجال للصفوف التي تمّ نقلها، بينما تتمّ إزالة صفوف المصدر من الشبكة. وبالتالي، قد تنتهي البيانات في فهرس مختلف عن الفهرس المحدّد في الأصل.

التفويض

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

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

---

newChart()

تعرِض هذه الدالة أداة إنشاء لإنشاء رسم بياني جديد لهذه الورقة.

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

الإرجاع

EmbeddedChartBuilder - أداة إنشاء لإنشاء رسم بياني جديد

---

protect()

لإنشاء عنصر يمكنه حماية ورقة البيانات من التعديل إلا من قِبل المستخدمين الذين لديهم الإذن إلى أن يغيّر النص البرمجي قائمة المحرِّرين للجدول (من خلال استدعاء Protection.removeEditor(emailAddress) أو Protection.removeEditor(user) أو Protection.removeEditors(emailAddresses) أو Protection.addEditor(emailAddress) أو Protection.addEditor(user) أو Protection.addEditors(emailAddresses) أو ضبط قيمة جديدة لـ Protection.setDomainEdit(editable))، تتطابق الأذونات مع أذونات جدول بيانات Google نفسه، ما يعني أنّ الجدول يظل غير محمي. إذا كانت الورقة ملتصقة بالحماية، تُعرِض هذه الطريقة عنصرًا يمثّل إعدادات الحماية الحالية. قد تتضمّن ورقة البيانات المحمية مناطق غير محمية.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

الإرجاع

‫Protection: عنصر يمثّل إعدادات الحماية

التفويض

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

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

---

removeChart(chart)

تزيل الرسم البياني من ورقة البيانات الرئيسية.

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

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

المعلَمات

الاسم	النوع	الوصف
chart	EmbeddedChart	الرسم البياني المطلوب إزالته

التفويض

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

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

---

setActiveRange(range)

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

المعلَمات

الاسم	النوع	الوصف
range	Range	النطاق الذي سيتم ضبطه على أنّه النطاق النشط

الإرجاع

Range: النطاق النشط حديثًا

التفويض

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

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

---

setActiveRangeList(rangeList)

تُستخدَم هذه الدالة لضبط قائمة النطاقات المحدّدة على أنّها active ranges في الورقة النشطة. يتم ضبط النطاق الأخير في القائمة على active range.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

المعلَمات

الاسم	النوع	الوصف
rangeList	RangeList	قائمة النطاقات التي سيتم اختيارها

الإرجاع

RangeList: قائمة النطاقات التي تم اختيارها حديثًا

التفويض

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

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

---

setActiveSelection(range)

تُستخدَم لضبط منطقة الاختيار النشطة في هذه الورقة.

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

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

المعلَمات

الاسم	النوع	الوصف
range	Range	النطاق الذي سيتم ضبطه على أنّه الاختيار النشط.

الإرجاع

Range: النطاق النشط حديثًا

التفويض

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

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

---

setActiveSelection(a1Notation)

تُستخدَم لضبط الاختيار النشط، كما هو محدّد في ترميز A1 أو ترميز R1C1.

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

sheet.setActiveSelection('A1:D4');

المعلَمات

الاسم	النوع	الوصف
a1Notation	String	النطاق الذي سيتم ضبطه على أنّه نشط، كما هو محدّد في ترميز A1 أو ترميز R1C1.

الإرجاع

Range: النطاق النشط حديثًا

التفويض

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

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

---

setColumnGroupControlPosition(position)

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

المعلَمات

الاسم	النوع	الوصف
position	GroupControlTogglePosition	موضع تبديل عنصر التحكّم في مجموعة الأعمدة

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setColumnWidth(columnPosition, width)

لضبط عرض العمود المحدّد بالبكسل

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود المحدّد المطلوب ضبطه.
width	Integer	العرض بالبكسل المطلوب ضبطه

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

setColumnWidths(startColumn, numColumns, width)

لضبط عرض الأعمدة المحدّدة بالبكسل

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

المعلَمات

الاسم	النوع	الوصف
startColumn	Integer	موضع العمود الأول الذي سيتم تغييره
numColumns	Integer	عدد الأعمدة المطلوب تغييرها.
width	Integer	العرض بالبكسل المطلوب ضبطه

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setConditionalFormatRules(rules)

لاستبدال جميع قواعد التنسيق الشرطي الحالية في الورقة بقواعد الإدخال يتم تقييم القواعد بترتيب إدخالها.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

المعلَمات

الاسم	النوع	الوصف
rules	ConditionalFormatRule[]	قواعد التنسيق الشرطي الجديدة

التفويض

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

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

---

setCurrentCell(cell)

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

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

المعلَمات

الاسم	النوع	الوصف
cell	Range	الخلية التي سيتم ضبطها على أنّها الخلية الحالية.

الإرجاع

Range: الخلية الحالية التي تم ضبطها حديثًا

التفويض

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

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

---

setFrozenColumns(columns)

تجميد العدد المحدّد من الأعمدة إذا كان صفرًا، لن يتم تجميد أي أعمدة.

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

// Freezes the first column
sheet.setFrozenColumns(1);

المعلَمات

الاسم	النوع	الوصف
columns	Integer	عدد الأعمدة المطلوب تجميدها

التفويض

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

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

---

setFrozenRows(rows)

تجميد العدد المحدّد من الصفوف إذا كان صفرًا، لن يتم تجميد أي صفوف.

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

// Freezes the first row
sheet.setFrozenRows(1);

المعلَمات

الاسم	النوع	الوصف
rows	Integer	عدد الصفوف المطلوب تجميدها.

التفويض

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

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

---

setHiddenGridlines(hideGridlines)

إخفاء خطوط الشبكة في الورقة أو إظهارها

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

المعلَمات

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

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setName(name)

لضبط اسم ورقة البيانات

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

المعلَمات

الاسم	النوع	الوصف
name	String	الاسم الجديد للورقة

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setRightToLeft(rightToLeft)

لضبط تنسيق الورقة من اليمين إلى اليسار أو إلغاء ضبطه

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

المعلَمات

الاسم	النوع	الوصف
rightToLeft	Boolean	إذا كان الخيار true، يتم ضبط تنسيق ورقة البيانات على "من اليمين إلى اليسار"، مع وضع الخلية A1 في أعلى يسار الصفحة. إذا كان الخيار false، يتم ضبط تنسيق الورقة على الإعداد التلقائي من اليسار إلى اليمين، مع الخلية A1 في أعلى يمين الصفحة.

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setRowGroupControlPosition(position)

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

المعلَمات

الاسم	النوع	الوصف
position	GroupControlTogglePosition	موضع زرّ التبديل لعنصر التحكّم في مجموعة الصفوف

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setRowHeight(rowPosition, height)

لضبط ارتفاع الصف المحدّد بالبكسل تكبر الصفوف تلقائيًا لتتلاءم مع محتوى الخلايا. إذا أردت ضبط ارتفاع الصفوف على قيمة محدّدة، استخدِم setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

المعلَمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الذي تريد تغييره
height	Integer	الارتفاع بالبكسل المطلوب ضبطه

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق.

التفويض

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

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

---

setRowHeights(startRow, numRows, height)

لضبط ارتفاع الصفوف المحدّدة بالبكسل. تكبر الصفوف تلقائيًا لتتلاءم مع محتوى الخلايا. إذا أردت فرض ارتفاع محدّد للصفوف، استخدِم setRowHeightsForced(startRow, numRows, height).

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

المعلَمات

الاسم	النوع	الوصف
startRow	Integer	موضع الصف الأول الذي سيتم تغييره
numRows	Integer	عدد الصفوف المطلوب تغييرها.
height	Integer	الارتفاع بالبكسل المطلوب ضبطه

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setRowHeightsForced(startRow, numRows, height)

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

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

المعلَمات

الاسم	النوع	الوصف
startRow	Integer	موضع الصف الأول الذي سيتم تغييره
numRows	Integer	عدد الصفوف المطلوب تغييرها.
height	Integer	الارتفاع بالبكسل المطلوب ضبطه

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setTabColor(color)

لضبط لون علامة تبويب ورقة البيانات

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

المعلَمات

الاسم	النوع	الوصف
color	String	رمز لون بترميز CSS (مثل '#ffffff' أو 'white')، أو null لإعادة ضبط لون علامة التبويب

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

setTabColorObject(color)

لضبط لون علامة تبويب ورقة البيانات

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

المعلَمات

الاسم	النوع	الوصف
color	Color	لون علامة تبويب ورقة البيانات المطلوب ضبطه

الإرجاع

Sheet — هذه الورقة، لإنشاء سلاسل.

التفويض

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

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

---

showColumns(columnIndex)

تُزيل إخفاء العمود في الفهرس المحدَّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	فهرس العمود المطلوب إظهاره.

التفويض

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

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

---

showColumns(columnIndex, numColumns)

إزالة إخفاء عمود واحد أو أكثر متتاليين بدءًا من الفهرس المحدَّد

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

المعلَمات

الاسم	النوع	الوصف
columnIndex	Integer	فهرس البداية للأعمدة المطلوب إلغاء إخفائها.
numColumns	Integer	عدد الأعمدة المطلوب إظهارها

التفويض

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

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

---

showRows(rowIndex)

تُزيل إخفاء الصف في الفهرس المحدَّد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	فهرس الصف المطلوب إظهاره.

التفويض

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

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

---

showRows(rowIndex, numRows)

إزالة إخفاء صف واحد أو أكثر متتاليَين بدءًا من الفهرس المحدَّد

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

المعلَمات

الاسم	النوع	الوصف
rowIndex	Integer	فهرس بداية الصفوف المطلوب إظهارها
numRows	Integer	عدد الصفوف المطلوب إظهارها

التفويض

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

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

---

showSheet()

يجعل الورقة مرئية. لا يكون له أي تأثير إذا كانت الورقة مرئية.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

الإرجاع

Sheet: الورقة الحالية

التفويض

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

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

---

sort(columnPosition)

لترتيب ورقة بيانات حسب العمود تصاعديًا

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	العمود الذي يتم الترتيب حسبه.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

sort(columnPosition, ascending)

يرتِّب ورقة بيانات حسب العمود. تأخذ مَعلمة لتحديد الترتيب التصاعدي أو التنازلي.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

المعلَمات

الاسم	النوع	الوصف
columnPosition	Integer	العمود الذي يتم الترتيب حسبه.
ascending	Boolean	true للترتيبات التصاعدية، false للترتيبات التنازلية.

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

---

unhideColumn(column)

تُزيل إخفاء العمود في النطاق المحدَّد.

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

المعلَمات

الاسم	النوع	الوصف
column	Range	النطاق المطلوب إظهاره، إذا كان مخفيًا.

التفويض

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

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

---

unhideRow(row)

لإزالة إخفاء الصف في النطاق المحدّد

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

المعلَمات

الاسم	النوع	الوصف
row	Range	النطاق المطلوب إظهاره، إذا كان مخفيًا.

التفويض

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

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

---

updateChart(chart)

تعديل الرسم البياني في هذه الورقة

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

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

المعلَمات

الاسم	النوع	الوصف
chart	EmbeddedChart	الرسم البياني المطلوب تعديله

التفويض

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

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

الطرق المتوقّفة

getSheetProtection()

تمّ إيقاف هذا العمود نهائيًا. بالنسبة إلى جداول البيانات التي تم إنشاؤها في الإصدار الأحدث من "جداول بيانات Google"، استخدِم getProtections(type)، الذي يعرض فئة Protection الأكثر فعالية. على الرغم من أنّ هذه الطريقة متوقّفة نهائيًا، إلا أنّها لا تزال متاحة لأجل توافقها مع الإصدار القديم من "جداول بيانات Google"

عرض مثيل PageProtection يصف أذونات الورقة الحالية

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

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('[e-mail]');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

الإرجاع

PageProtection: عنصر يصف أذونات الوصول إلى ورقة البيانات

التفويض

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

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

---

getTabColor()

تمّ إيقاف هذا العمود نهائيًا. تم استبداله بـ getTabColorObject()

تحصل على لون علامة التبويب الخاصة بالورقة، أو null إذا لم يكن لعلامة التبويب الخاصة بالورقة لون.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

الإرجاع

String: رمز اللون بترميز CSS (مثل '#ffffff')

التفويض

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

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

---

setSheetProtection(permissions)

تمّ إيقاف هذا العمود نهائيًا. بالنسبة إلى جداول البيانات التي تم إنشاؤها في الإصدار الأحدث من "جداول بيانات Google"، استخدِم protect()، الذي يعرض فئة Protection الأكثر فعالية. على الرغم من أنّ هذه الطريقة متوقّفة نهائيًا، إلا أنّها لا تزال متاحة للتوافق مع الإصدار القديم من "جداول بيانات Google".

تُستخدَم لضبط أذونات ورقة البيانات الحالية.

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

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

المعلَمات

الاسم	النوع	الوصف
permissions	PageProtection	عنصر أذونات الوصول المطلوب ضبطه في هذه الورقة

التفويض

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

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