Class Sheet

جدول بيانات

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

الطُرق

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

الوثائق التفصيلية

activate()

لتفعيل هذه الورقة. لا يغير الورقة نفسها، فقط مفهوم الأصل للورقة النشطة.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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());

المَعلمات

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

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

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

المَعلمات

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

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

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

المَعلمات

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

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

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

المَعلمات

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

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

appendRow(rowContents)

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

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

المَعلمات

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

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

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

التفويض

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

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

asDataSourceSheet()

يتم عرض ورقة البيانات على شكل DataSourceSheet إذا كانت الورقة من النوع SheetType.DATASOURCE أو null.

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

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

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

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

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

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

التفويض

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

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

autoResizeColumn(columnPosition)

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

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود المحدّد المطلوب تغيير حجمه.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

autoResizeColumns(startColumn, numColumns)

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

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

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

المَعلمات

الاسمالنوعالوصف
startColumnIntegerعمود البداية المطلوب تغيير حجمه تلقائيًا.
numColumnsIntegerعدد الأعمدة المطلوب تغيير حجمها تلقائيًا.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

autoResizeRows(startRow, numRows)

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

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

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

المَعلمات

الاسمالنوعالوصف
startRowIntegerصف البداية المطلوب تغيير حجمه تلقائيًا.
numRowsIntegerعدد الصفوف المطلوب تغيير حجمها تلقائيًا.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

clear()

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

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

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

Sheet — الورقة التي تم محوها

التفويض

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

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

clear(options)

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

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

المَعلمات

الاسمالنوعالوصف
optionsObjectخريطة JavaScript تحتوي على خيارات متقدمة، مدرَجة أدناه.

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

الاسمالنوعالوصف
contentsOnlyBooleanما إذا كان سيتم محو المحتوى.
formatOnlyBooleanما إذا كان سيتم محو التنسيق.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

clearConditionalFormatRules()

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

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

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

collapseAllColumnGroups()

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

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

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

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

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

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

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

المَعلمات

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

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

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)

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

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

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

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

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

المَعلمات

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

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

TextFinder - TextFinder للورقة.


deleteColumn(columnPosition)

لحذف العمود عند موضع العمود المعني.

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود، بدءًا من 1 للعمود الأول.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

deleteColumns(columnPosition, howMany)

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

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود الأول المطلوب حذفه.
howManyIntegerعدد الأعمدة المطلوب حذفها.

التفويض

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

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

deleteRow(rowPosition)

لحذف الصف في موضع الصف المعني.

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

deleteRows(rowPosition, howMany)

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

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

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف الأول المطلوب حذفه.
howManyIntegerعدد الصفوف المطلوب حذفها.

التفويض

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

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

expandAllColumnGroups()

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

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

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

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

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

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

المَعلمات

الاسمالنوعالوصف
groupDepthIntegerعمق المجموعة المطلوب توسيع مجموعات الأعمدة إليه.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

expandRowGroupsUpToDepth(groupDepth)

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

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

المَعلمات

الاسمالنوعالوصف
groupDepthIntegerعمق المجموعة المطلوب توسيع مجموعات الصفوف وفقًا له.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

getActiveCell()

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

ملاحظة: من الأفضل استخدام السمة getCurrentCell() التي تعرض الخلية المميّزة الحالية.

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

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

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

التفويض

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

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

getActiveRange()

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

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

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

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

Range — النطاق النشط

التفويض

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

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

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


getActiveRangeList()

عرض قائمة النطاقات النشطة في الورقة النشطة أو عرض null في حال عدم توفّر نطاقات نشطة.

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

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

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

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

التفويض

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

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

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


getBandings()

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

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

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

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

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

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

تعرض مجموعة الأعمدة بالفهرس وعمق المجموعة المحدَّدين.

var 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.
var columnGroup = sheet.getColumnGroup(2, 1);

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس العمود الخاص بتبديل عنصر التحكّم في المجموعة أو فهرس داخل المجموعة.
groupDepthIntegerعمق المجموعة.

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

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

التفويض

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

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

getColumnGroupControlPosition()

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

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

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

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

GroupControlTogglePosition - true إذا تم عرض زر إيقاف/تفعيل عنصر التحكّم في تجميع الأعمدة بعد المجموعة في ورقة البيانات هذه وfalse في الحالات الأخرى.

التفويض

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

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

getColumnGroupDepth(columnIndex)

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

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

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

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

المَعلمات

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

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

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

التفويض

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

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

getColumnWidth(columnPosition)

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

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

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود المطلوب فحصه.

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

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

التفويض

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

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

getConditionalFormatRules()

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

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

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

ConditionalFormatRule[]: مصفوفة من كل القواعد في ورقة البيانات.

التفويض

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

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

getCurrentCell()

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

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

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

Range — الخلية الحالية

التفويض

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

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

getDataRange()

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

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

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

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

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

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

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

التفويض

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

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

getDataSourceFormulas()

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

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

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

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

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

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

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

التفويض

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

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

getDataSourcePivotTables()

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

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

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

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

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

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

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

التفويض

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

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

getDataSourceTables()

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

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

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

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

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

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

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

التفويض

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

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

getDeveloperMetadata()

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

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

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

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

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

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

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

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

التفويض

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

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

getDrawings()

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

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

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

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

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

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

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

التفويض

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

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

getFilter()

يتم عرض الفلتر في ورقة البيانات هذه أو null في حال عدم توفّر فلتر.

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

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

Filter — الفلتر

التفويض

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

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

getFormUrl()

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

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

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

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

التفويض

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

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

getFrozenColumns()

تعرض عدد الأعمدة المجمدة.

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

تعرض عدد الصفوف المجمدة.

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var 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()

تعرض موضع آخر عمود يتضمن محتوى.

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

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

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

Integer - العمود الأخير في ورقة البيانات الذي يحتوي على المحتوى

التفويض

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

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

getLastRow()

لعرض موضع الصف الأخير الذي يتضمن محتوى.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

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

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

التفويض

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

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

getName()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
var 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 التي تحتوي على هذه الورقة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

المَعلمات

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

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

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

التفويض

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

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

getRange(row, column)

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

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

المَعلمات

الاسمالنوعالوصف
rowIntegerفهرس صف الخلية المراد عرضها، تبدأ فهرسة الصفوف بالرقم 1.
columnIntegerفهرس العمود للخلية المراد عرضها، تبدأ فهرسة الأعمدة بالرقم 1.

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

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

التفويض

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

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

getRange(row, column, numRows)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowIntegerفهرس صف البداية للنطاق، وتبدأ فهرسة الصفوف بالرقم 1.
columnIntegerفهرس الأعمدة للنطاق، وتبدأ فهرسة الأعمدة بالرقم 1.
numRowsIntegerعدد الصفوف المطلوب عرضها.

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

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

التفويض

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

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

getRange(row, column, numRows, numColumns)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowIntegerفهرس صف البداية للنطاق، وتبدأ فهرسة الصفوف بالرقم 1.
columnIntegerفهرس عمود البداية للنطاق، وتبدأ فهرسة الأعمدة بالرقم 1.
numRowsIntegerعدد الصفوف المطلوب عرضها.
numColumnsIntegerعدد الأعمدة المطلوب عرضها.

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

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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

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

المَعلمات

الاسمالنوعالوصف
a1NotationStringالنطاق المراد عرضه، كما هو محدد في تدوين 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.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

المَعلمات

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

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

RangeList - قائمة النطاقات في الموقع الجغرافي المعيّن

التفويض

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

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

getRowGroup(rowIndex, groupDepth)

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

var 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.
var rowGroup = sheet.getRowGroup(2, 1);

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس صف مفتاح تبديل عنصر التحكّم في المجموعة أو فهرس داخل المجموعة.
groupDepthIntegerعمق المجموعة.

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

Group: مجموعة الصفوف في فهرس التحكّم والعمق، أو تعرض استثناء إذا لم تكن المجموعة متوفّرة.

التفويض

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

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

getRowGroupControlPosition()

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

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

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

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

GroupControlTogglePosition - true إذا تم عرض زر إيقاف/تفعيل عنصر التحكّم في تجميع الصفوف بعد المجموعة في ورقة البيانات هذه وfalse في أي وقت آخر.

التفويض

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

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

getRowGroupDepth(rowIndex)

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

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

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

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

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف.

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

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

التفويض

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

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

getRowHeight(rowPosition)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerتمثّل هذه السمة موضع الصف المطلوب فحصه.

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

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

التفويض

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

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

getSelection()

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

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

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

Logger.log(sheet.getSheetId());

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

Integer - رقم تعريف للورقة الفريد في جدول البيانات

التفويض

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

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

getSheetName()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 المقدمة كموضع الصف أو العمود الحصول على آخر صف أو عمود يحتوي على بيانات في الورقة.

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

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

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

المَعلمات

الاسمالنوعالوصف
startRowIntegerتمثّل هذه السمة موضع صف البداية.
startColumnIntegerتمثّل هذه السمة موضع عمود البداية.
numRowsIntegerعدد الصفوف المطلوب عرض قيم لها.
numColumnsIntegerعدد الأعمدة المطلوب عرض قيم لها.

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

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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

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

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

التفويض

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

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

getType()

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

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

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

يخفي العمود أو الأعمدة في النطاق المحدد.

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

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

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

المَعلمات

الاسمالنوعالوصف
columnRangeنطاق العمود المطلوب إخفاءه

التفويض

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

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

hideColumns(columnIndex)

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

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

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

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

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس العمود المطلوب إخفاءه.

التفويض

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

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

hideColumns(columnIndex, numColumns)

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

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

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس البداية للأعمدة المطلوب إخفاءها.
numColumnsIntegerعدد الأعمدة المراد إخفاؤها.

التفويض

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

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

hideRow(row)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowRangeنطاق الصفوف المراد إخفاؤه.

التفويض

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

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

hideRows(rowIndex)

لإخفاء الصف في الفهرس المحدد.

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

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف المطلوب إخفاءه.

التفويض

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

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

hideRows(rowIndex, numRows)

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

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

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس البداية للصفوف المراد إخفاءها.
numRowsIntegerعدد الصفوف المراد إخفاؤها.

التفويض

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

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

hideSheet()

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

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

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

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

التفويض

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

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

insertChart(chart)

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

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var 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);

المَعلمات

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

التفويض

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

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

insertColumnAfter(afterPosition)

يدرج عمودًا بعد موضع العمود المحدد.

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertColumnBefore(beforePosition)

إدراج عمود قبل موضع العمود المحدد

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertColumns(columnIndex)

يدرج عمودًا فارغًا في ورقة في الموقع المحدد.

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

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس يشير إلى مكان إدراج عمود.

التفويض

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

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

insertColumns(columnIndex, numColumns)

لإدراج عمود واحد أو أكثر من الأعمدة الفارغة المتتالية في ورقة بدءًا من الموقع المحدد.

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

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس يشير إلى مكان إدراج عمود.
numColumnsIntegerعدد الأعمدة المطلوب إدراجها.

التفويض

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

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

insertColumnsAfter(afterPosition, howMany)

لإدراج عدد معين من الأعمدة بعد موضع العمود المحدد.

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertColumnsBefore(beforePosition, howMany)

لإدراج عدد من الأعمدة قبل موضع العمود المحدد.

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertImage(blobSource, column, row)

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

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

المَعلمات

الاسمالنوعالوصف
blobSourceBlobSourceالكائن الثنائي الكبير (blob) الذي يحتوي على محتوى الصورة ونوع MIME واسم (اختياري).
columnIntegerتمثّل هذه السمة موضع العمود.
rowIntegerتمثّل هذه السمة موضع الصف.

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

OverGridImage — الصورة المدرجة

التفويض

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

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

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

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

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

المَعلمات

الاسمالنوعالوصف
blobSourceBlobSourceالكائن الثنائي الكبير (blob) الذي يحتوي على محتوى الصورة ونوع MIME واسم (اختياري).
columnIntegerتمثّل هذه السمة موضع العمود.
rowIntegerتمثّل هذه السمة موضع الصف.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل.
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل.

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

OverGridImage — الصورة المدرجة

التفويض

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

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

insertImage(url, column, row)

يدرج صورة في المستند في صف وعمود معينين.

يجب أن يتمكّن الجميع من الوصول إلى عنوان URL المقدَّم.

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

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

المَعلمات

الاسمالنوعالوصف
urlStringعنوان URL للصورة
columnIntegerموضع عمود الشبكة.
rowIntegerموضع صف الشبكة.

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

OverGridImage — الصورة المدرجة

التفويض

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

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

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

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

يجب أن يتمكّن الجميع من الوصول إلى عنوان URL المقدَّم.

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

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

المَعلمات

الاسمالنوعالوصف
urlStringعنوان URL للصورة
columnIntegerتمثّل هذه السمة موضع العمود.
rowIntegerتمثّل هذه السمة موضع الصف.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل.
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل.

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

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

التفويض

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

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

insertRowAfter(afterPosition)

يدرج صفًا بعد موضع الصف المعني.

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertRowBefore(beforePosition)

لإدراج صف قبل موضع الصف المحدد.

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

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

المَعلمات

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

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertRows(rowIndex)

يدرج صفًا فارغًا في ورقة في الموقع المحدد.

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

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس يشير إلى مكان إدراج الصف.

التفويض

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

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

insertRows(rowIndex, numRows)

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

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

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس يشير إلى مكان إدراج الصف.
numRowsIntegerعدد الصفوف المراد إدراجها.

التفويض

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

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

insertRowsAfter(afterPosition, howMany)

لإدراج عدد من الصفوف بعد موضع الصف المحدّد.

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

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

المَعلمات

الاسمالنوعالوصف
afterPositionIntegerالصف الذي يجب إضافة الصفوف الجديدة بعده.
howManyIntegerعدد الصفوف المراد إدراجها.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

insertRowsBefore(beforePosition, howMany)

لإدراج عدد من الصفوف قبل موضع الصف المحدد.

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

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

المَعلمات

الاسمالنوعالوصف
beforePositionIntegerالصف الذي يجب إضافة الصفوف الجديدة قبله.
howManyIntegerعدد الصفوف المراد إدراجها.

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

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

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق الذي يتم إنشاء فلتر نطاق بيانات من خلاله
anchorRowPosIntegerتم تثبيت الجانب العلوي من فلتر نطاق البيانات في هذا الصف.
anchorColPosIntegerتم تثبيت الجانب العلوي من فلتر نطاق البيانات في هذا العمود.

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

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

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق الذي يتم إنشاء فلتر نطاق بيانات من خلاله
anchorRowPosIntegerتم تثبيت الجانب العلوي من فلتر نطاق البيانات في هذا الصف.
anchorColPosIntegerتم تثبيت الجانب العلوي من فلتر نطاق البيانات في هذا العمود.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل.
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل.

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

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

التفويض

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

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

isColumnHiddenByUser(columnPosition)

تعرض ما إذا كان العمود المعيّن مخفيًا من قِبل المستخدم.

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

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود المطلوب فحصه.

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

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)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerتمثّل هذه السمة موضع الصف المطلوب فحصه.

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

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

التفويض

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

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

isRowHiddenByUser(rowPosition)

تعرض ما إذا كان الصف المحدّد مخفيًا من قِبل المستخدم.

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

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

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerتمثّل هذه السمة موضع الصف المطلوب فحصه.

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

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

التفويض

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

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

isSheetHidden()

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

var 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.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

المَعلمات

الاسمالنوعالوصف
columnSpecRangeنطاق يمتد على الأعمدة التي يجب نقلها.
destinationIndexIntegerالفهرس الذي يجب نقل الأعمدة إليه. يعتمد هذا الفهرس على الإحداثيات قبل نقل الأعمدة. يتم نقل البيانات الحالية إلى اليمين لتوفير مساحة للأعمدة المنقولة أثناء إزالة أعمدة المصدر من الشبكة. وبالتالي، قد ينتهي الأمر بالبيانات في فهرس مختلف عن الفهرس المحدد في الأصل.

التفويض

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

  • 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.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

المَعلمات

الاسمالنوعالوصف
rowSpecRangeنطاق يمتد عبر الصفوف التي يجب نقلها.
destinationIndexIntegerالفهرس الذي يجب نقل الصفوف إليه. يعتمد هذا الفهرس على الإحداثيات قبل نقل الصفوف. يتم نقل البيانات الحالية للأسفل لتوفير مساحة للصفوف المنقولة أثناء إزالة الصفوف المصدر من الشبكة. وبالتالي، قد ينتهي الأمر بإدراج البيانات في فهرس مختلف عن الفهرس الذي تم تحديده في الأصل.

التفويض

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

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

newChart()

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

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

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

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

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

التفويض

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

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

removeChart(chart)

إزالة المخطط من الورقة الرئيسية.

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

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

المَعلمات

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

التفويض

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

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

setActiveRange(range)

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

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

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

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق المراد ضبطه كنطاق نشط.

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

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

التفويض

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

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

setActiveRangeList(rangeList)

لضبط قائمة النطاقات المحددة مثل active ranges في الورقة النشطة. تم ضبط النطاق الأخير في القائمة على active range.

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

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

المَعلمات

الاسمالنوعالوصف
rangeListRangeListقائمة النطاقات المطلوب اختيارها.

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

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

التفويض

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

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

setActiveSelection(range)

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

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

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

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق المراد ضبطه على أنه اختيار نشط.

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

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

التفويض

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

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

setActiveSelection(a1Notation)

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

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

sheet.setActiveSelection("A1:D4");

المَعلمات

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

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

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

التفويض

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

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

setColumnGroupControlPosition(position)

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

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

المَعلمات

الاسمالنوعالوصف
positionGroupControlTogglePositionموضع زر إيقاف/تفعيل عنصر التحكّم في مجموعة الأعمدة.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

setColumnWidth(columnPosition, width)

لتعيين عرض العمود المحدد بالبكسل.

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

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

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود المحدّد المطلوب ضبطه.
widthIntegerالعرض بالبكسل المطلوب ضبطه.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

setColumnWidths(startColumn, numColumns, width)

لتعيين عرض الأعمدة المحددة بالبكسل.

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

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

المَعلمات

الاسمالنوعالوصف
startColumnIntegerموضع عمود البداية المطلوب تغييره.
numColumnsIntegerعدد الأعمدة المطلوب تغييرها.
widthIntegerالعرض بالبكسل المطلوب ضبطه.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

setConditionalFormatRules(rules)

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

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

المَعلمات

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

التفويض

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

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

setCurrentCell(cell)

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

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

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

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

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

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

المَعلمات

الاسمالنوعالوصف
cellRangeالخلية المراد تعيينها كخلية حالية.

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

Range — الخلية الحالية التي تم إعدادها حديثًا

التفويض

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

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

setFrozenColumns(columns)

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

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

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

المَعلمات

الاسمالنوعالوصف
columnsIntegerعدد الأعمدة المراد تجميدها.

التفويض

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

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

setFrozenRows(rows)

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

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

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

المَعلمات

الاسمالنوعالوصف
rowsIntegerعدد الصفوف لتجميدها.

التفويض

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

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

المَعلمات

الاسمالنوعالوصف
hideGridlinesBooleanفي حال استخدام 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

المَعلمات

الاسمالنوعالوصف
nameStringالاسم الجديد للورقة.

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

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

المَعلمات

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

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

setRowGroupControlPosition(position)

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

المَعلمات

الاسمالنوعالوصف
positionGroupControlTogglePositionموضع زر إيقاف/تفعيل عنصر التحكّم في مجموعة الصفوف.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

setRowHeight(rowPosition, height)

لضبط ارتفاع صف الصف المحدّد بالبكسل. يزداد عدد الصفوف تلقائيًا لاحتواء محتوى الخلية. إذا كنت تريد فرض ضبط الصفوف على ارتفاع محدّد، استخدِم السمة setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف المطلوب تغييره.
heightIntegerالارتفاع بالبكسل المطلوب ضبطه.

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

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

التفويض

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

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

setRowHeights(startRow, numRows, height)

لتعيين ارتفاع الصفوف المحددة بالبكسل. يزداد عدد الصفوف تلقائيًا لاحتواء محتوى الخلية. إذا كنت تريد فرض ضبط الصفوف على ارتفاع محدّد، استخدِم السمة setRowHeightsForced(startRow, numRows, height).

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

المَعلمات

الاسمالنوعالوصف
startRowIntegerموضع صف البداية المطلوب تغييره.
numRowsIntegerعدد الصفوف المطلوب تغييرها.
heightIntegerالارتفاع بالبكسل المطلوب ضبطه.

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

setRowHeightsForced(startRow, numRows, height)

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

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

المَعلمات

الاسمالنوعالوصف
startRowIntegerموضع صف البداية المطلوب تغييره.
numRowsIntegerعدد الصفوف المطلوب تغييرها.
heightIntegerالارتفاع بالبكسل المطلوب ضبطه.

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

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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

المَعلمات

الاسمالنوعالوصف
colorStringرمز لون في شكل 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

المَعلمات

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

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

Sheet: هذه الورقة مخصَّصة للسلاسل

التفويض

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

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

showColumns(columnIndex)

إظهار العمود في الفهرس المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس العمود المطلوب إظهاره.

التفويض

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

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

showColumns(columnIndex, numColumns)

يؤدي إلى إظهار عمود واحد أو أكثر من الأعمدة المتتالية بدءًا من الفهرس المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

المَعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس البدء للأعمدة المطلوب إظهارها.
numColumnsIntegerعدد الأعمدة المطلوب إظهارها.

التفويض

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

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

showRows(rowIndex)

إظهار الصف في الفهرس المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف المطلوب إظهاره

التفويض

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

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

showRows(rowIndex, numRows)

يؤدي إلى إظهار صف واحد أو أكثر من الصفوف المتتالية بدءًا من الفهرس المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

المَعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس البداية للصفوف المطلوب إظهارها.
numRowsIntegerعدد الصفوف المطلوب إظهارها.

التفويض

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

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

showSheet()

يجعل الورقة مرئية. لن يكون لها أي تأثير إذا كانت الورقة مرئية من قبل.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

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

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

التفويض

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

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

sort(columnPosition)

لترتيب الورقة حسب العمود تصاعديًا.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerالعمود المطلوب الترتيب حسبه.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

sort(columnPosition, ascending)

لترتيب الورقة حسب العمود. يستخدم مَعلمة لتحديد ترتيب تصاعدي أو تنازلي.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerالعمود المطلوب الترتيب حسبه.
ascendingBooleantrue للترتيب التصاعدي وfalse للترتيب التنازلي.

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

Sheet: الورقة مفيدة لتسلسل الطرق.

التفويض

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

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

unhideColumn(column)

يؤدي إلى إظهار العمود في النطاق المحدد.

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

المَعلمات

الاسمالنوعالوصف
columnRangeالنطاق المطلوب إظهاره، إذا كان مخفيًا

التفويض

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

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

unhideRow(row)

إظهار الصف في النطاق المحدد

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

المَعلمات

الاسمالنوعالوصف
rowRangeالنطاق المطلوب إظهاره، إذا كان مخفيًا

التفويض

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

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

updateChart(chart)

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

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

المَعلمات

الاسمالنوعالوصف
chartEmbeddedChartالرسم البياني المطلوب تعديله

التفويض

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

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

الطرق المتوقّفة نهائيًا