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\|null`	تعرض ورقة البيانات كـ `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`	تعرض هذه الدالة قائمة بالنطاقات النشطة في ورقة البيانات النشطة أو `null` إذا لم تكن هناك نطاقات نشطة.
`getBandings()`	`Banding[]`	تعرض هذه الدالة جميع النطاقات في ورقة البيانات هذه.
`getCharts()`	`EmbeddedChart[]`	تعرض هذه الدالة مصفوفة من الرسوم البيانية في ورقة البيانات هذه.
`getColumnGroup(columnIndex, groupDepth)`	`Group\|null`	تعرض مجموعة الأعمدة في الفهرس وعمق المجموعة المحدّدَين.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	تعرض هذه السمة `GroupControlTogglePosition` لجميع مجموعات الأعمدة في الورقة.
`getColumnGroupDepth(columnIndex)`	`Integer`	تعرض هذه الدالة مستوى عمق المجموعة للعمود في الفهرس المحدّد.
`getColumnWidth(columnPosition)`	`Integer`	تعرض هذه الدالة عرض العمود المحدّد بالبكسل.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	الحصول على جميع قواعد التنسيق الشرطي في ورقة البيانات هذه
`getCurrentCell()`	`Range\|null`	تعرِض هذه الدالة الخلية الحالية في الورقة النشطة أو `null` إذا لم تكن هناك خلية حالية.
`getDataRange()`	`Range`	تعرِض `Range` تتوافق مع السمات التي تتوفّر فيها البيانات.
`getDataSourceFormulas()`	`DataSourceFormula[]`	تعرض هذه الدالة جميع صيغ مصادر البيانات.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	تعرض هذه الدالة جميع الجداول المحورية لمصدر البيانات.
`getDataSourceTables()`	`DataSourceTable[]`	تعرض هذه الطريقة جميع جداول مصادر البيانات.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	الحصول على جميع بيانات المطوّر الوصفية المرتبطة بورقة البيانات هذه
`getDrawings()`	`Drawing[]`	تعرض هذه الدالة مصفوفة من الرسومات في الورقة.
`getFilter()`	`Filter\|null`	تعرِض هذه الدالة الفلتر في ورقة البيانات هذه، أو `null` إذا لم يكن هناك فلتر.
`getFormUrl()`	`String\|null`	تعرض هذه الدالة عنوان 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\|null`	تعرض هذه الدالة مجموعة الصفوف في الفهرس وعمق المجموعة المحدّدَين.
`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`	تعرض هذه الدالة لون علامة تبويب ورقة البيانات، أو `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`	تعرض هذه الدالة لون علامة تبويب ورقة البيانات، أو `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|null: ورقة مصدر بيانات

التفويض

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

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|null: قائمة النطاقات النشطة

التفويض

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

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|null: مجموعة الأعمدة في الفهرس وعمق عنصر التحكّم، أو يتم عرض استثناء إذا لم تكن المجموعة متوفّرة.

التفويض

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

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|null: الخلية الحالية

التفويض

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

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

// Lo gs the first data source formulain 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|null: الفلتر

التفويض

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

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|null: عنوان 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|null: مجموعة الصفوف في الفهرس والعمق المحدّدَين، أو تعرض استثناءً إذا لم تكن المجموعة متوفّرة.

التفويض

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

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: لون علامة تبويب ورقة البيانات، أو 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. الحد الأقصى لحجم الكائن الثنائي الكبير (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))، ستكون الأذونات مماثلة لأذونات جدول البيانات نفسه، ما يعني فعليًا أنّ الورقة ستظل غير محمية. إذا كانت ورقة البيانات محمية بالفعل، تعرض هذه الطريقة عنصرًا يمثّل إعدادات الحماية الحالية. قد تتضمّن ورقة محمية مناطق غير محمية.

// 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('user@example.com');

// 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|null: رمز اللون في ترميز 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

Class Sheet تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

الطُرق

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

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

activate()

الإرجاع

addDeveloperMetadata(key)

المَعلمات

الإرجاع

التفويض

addDeveloperMetadata(key, visibility)

المَعلمات

الإرجاع

التفويض

addDeveloperMetadata(key, value)

المَعلمات

الإرجاع

التفويض

addDeveloperMetadata(key, value, visibility)

المَعلمات

الإرجاع

التفويض

appendRow(rowContents)

المَعلمات

الإرجاع

التفويض

asDataSourceSheet()

الإرجاع

التفويض

autoResizeColumn(columnPosition)

المَعلمات

الإرجاع

التفويض

autoResizeColumns(startColumn, numColumns)

المَعلمات

الإرجاع

التفويض

autoResizeRows(startRow, numRows)

المَعلمات

الإرجاع

التفويض

clear()

الإرجاع

التفويض

clear(options)

المَعلمات

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

الإرجاع

التفويض

clearConditionalFormatRules()

التفويض

clearContents()

الإرجاع

التفويض

clearFormats()

الإرجاع

التفويض

clearNotes()

الإرجاع

التفويض

collapseAllColumnGroups()

الإرجاع

التفويض

collapseAllRowGroups()

الإرجاع

التفويض

copyTo(spreadsheet)

المَعلمات

الإرجاع

التفويض

createDeveloperMetadataFinder()

الإرجاع

createTextFinder(findText)

المَعلمات

الإرجاع

deleteColumn(columnPosition)

المَعلمات

الإرجاع

التفويض

deleteColumns(columnPosition, howMany)

Class Sheet

`activate()`

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`appendRow(rowContents)`

`asDataSourceSheet()`

`autoResizeColumn(columnPosition)`

`autoResizeColumns(startColumn, numColumns)`

`autoResizeRows(startRow, numRows)`

`clear()`

`clear(options)`

`clearConditionalFormatRules()`

`clearContents()`

`clearFormats()`

`clearNotes()`

`collapseAllColumnGroups()`

`collapseAllRowGroups()`

`copyTo(spreadsheet)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`expandAllColumnGroups()`

`expandAllRowGroups()`

`expandColumnGroupsUpToDepth(groupDepth)`

`expandRowGroupsUpToDepth(groupDepth)`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getBandings()`

`getCharts()`

`getColumnGroup(columnIndex, groupDepth)`

`getColumnGroupControlPosition()`

`getColumnGroupDepth(columnIndex)`

`getColumnWidth(columnPosition)`

`getConditionalFormatRules()`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`