Class Spreadsheet

جدول بيانات

الوصول إلى ملفات "جداول بيانات Google" وتعديلها وتتم إضافة أوراق بيانات جديدة وإضافة متعاونين.

الطُرق

الطريقةنوع الإرجاعوصف قصير
addDeveloperMetadata(key)Spreadsheetتتم إضافة بيانات وصفية لمطوّر البرامج باستخدام المفتاح المحدد إلى جدول بيانات المستوى الأعلى.
addDeveloperMetadata(key, visibility)Spreadsheetلإضافة بيانات وصفية لمطوّر البرامج باستخدام المفتاح المحدد ومستوى الرؤية إلى جدول البيانات.
addDeveloperMetadata(key, value)Spreadsheetلإضافة بيانات وصفية لمطوّر البرامج بالمفتاح المحدّد والقيمة إلى جدول البيانات
addDeveloperMetadata(key, value, visibility)Spreadsheetتتم إضافة بيانات وصفية لمطوّر البرامج باستخدام المفتاح والقيمة وإمكانية الوصول إلى جدول البيانات.
addEditor(emailAddress)Spreadsheetلإضافة المستخدم المحدد إلى قائمة محرري Spreadsheet.
addEditor(user)Spreadsheetلإضافة المستخدم المحدد إلى قائمة محرري Spreadsheet.
addEditors(emailAddresses)Spreadsheetلإضافة مصفوفة محددة من المستخدمين إلى قائمة المحرِّرين في Spreadsheet.
addMenu(name, subMenus)voidلإنشاء قائمة جديدة في واجهة مستخدم جدول البيانات
addViewer(emailAddress)Spreadsheetلإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet.
addViewer(user)Spreadsheetلإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet.
addViewers(emailAddresses)Spreadsheetلإضافة الصفيف المحدد من المستخدمين إلى قائمة مشاهدي Spreadsheet.
appendRow(rowContents)Sheetلإلحاق صف إلى أسفل منطقة البيانات الحالية في ورقة البيانات
autoResizeColumn(columnPosition)Sheetلضبط عرض العمود المحدّد ليلائم محتواه.
copy(name)Spreadsheetيؤدّي هذا الإجراء إلى نسخ جدول البيانات وعرض الجدول الجديد.
createDeveloperMetadataFinder()DeveloperMetadataFinderتعرض DeveloperMetadataFinder للبحث عن البيانات الوصفية لمطوّر البرامج ضمن نطاق جدول البيانات هذا.
createTextFinder(findText)TextFinderتنشئ هذه الأداة باحثًا نصيًا لجدول البيانات، والذي يمكن استخدامه للعثور على نص ضمن جدول البيانات واستبداله.
deleteActiveSheet()Sheetحذف ورقة البيانات النشطة حاليًا
deleteColumn(columnPosition)Sheetحذف العمود في موضع العمود المعني
deleteColumns(columnPosition, howMany)voidحذف عدد الأعمدة التي تبدأ في موضع الأعمدة المحدّد
deleteRow(rowPosition)Sheetحذف الصف في موضع الصف المحدد
deleteRows(rowPosition, howMany)voidحذف عدد من الصفوف بدءًا من موضع الصف المحدّد.
deleteSheet(sheet)voidحذف ورقة البيانات المحددة
duplicateActiveSheet()Sheetتكرار الورقة النشطة وجعلها الورقة النشطة.
getActiveCell()Rangeلعرض الخلية النشطة في ورقة البيانات هذه.
getActiveRange()Rangeيعرض النطاق المحدد في الورقة النشطة أو null إذا لم يكن هناك نطاق نشط.
getActiveRangeList()RangeListيعرض قائمة النطاقات النشطة في ورقة البيانات النشطة أو null في حال عدم توفّر نطاقات نشطة.
getActiveSheet()Sheetللحصول على الورقة النشطة في جدول بيانات
getAs(contentType)Blobعرض البيانات داخل هذا الكائن ككائنات الثنائية الثنائية (blob) التي تم تحويلها إلى نوع المحتوى المحدَّد
getBandings()Banding[]تعرض جميع الهوامش في جدول البيانات هذا.
getBlob()Blobاعرض البيانات داخل هذا الكائن ككائنات ثنائية (blob).
getColumnWidth(columnPosition)Integerللحصول على العرض بالبكسل للعمود المحدّد.
getCurrentCell()Rangeلعرض الخلية الحالية في ورقة البيانات النشطة أو null إذا لم تكن هناك خلية حالية.
getDataRange()Rangeتعرِض Range المقابلة للأبعاد التي تتوفّر بها البيانات.
getDataSourceFormulas()DataSourceFormula[]تحصل على جميع صيغ مصدر البيانات.
getDataSourcePivotTables()DataSourcePivotTable[]الحصول على جميع الجداول المحورية لمصدر البيانات
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]للحصول على الجداول الزمنية لإعادة تحميل جدول البيانات هذا
getDataSourceSheets()DataSourceSheet[]عرض جميع أوراق مصدر البيانات في جدول البيانات
getDataSourceTables()DataSourceTable[]الحصول على جميع جداول مصادر البيانات
getDataSources()DataSource[]عرض جميع مصادر البيانات في جدول البيانات.
getDeveloperMetadata()DeveloperMetadata[]يمكنك الحصول على البيانات الوصفية لمطوّر البرامج المرتبطة بجدول بيانات المستوى الأعلى.
getEditors()User[]الحصول على قائمة المحرِّرين لـ Spreadsheet
getFormUrl()Stringتعرض عنوان URL للنموذج الذي يرسل ردوده على جدول البيانات هذا، أو null في حال كان جدول البيانات هذا لا يحتوي على نموذج مرتبط.
getFrozenColumns()Integerلعرض عدد الأعمدة المجمّدة.
getFrozenRows()Integerلعرض عدد الصفوف المجمّدة.
getId()Stringتحصل على معرِّف فريد لجدول البيانات هذا.
getImages()OverGridImage[]لعرض جميع الصور المعروضة على الشبكة في ورقة البيانات.
getIterativeCalculationConvergenceThreshold()Numberتعرض قيمة الحد الأدنى المستخدمة أثناء العملية الحسابية المتكررة.
getLastColumn()Integerلعرض موضع العمود الأخير الذي يتضمن محتوى.
getLastRow()Integerلعرض موضع الصف الأخير الذي يتضمن محتوى.
getMaxIterativeCalculationCycles()Integerتعرض الحد الأقصى لعدد التكرارات المطلوب استخدامها أثناء الحساب المكرر.
getName()Stringالحصول على اسم المستند
getNamedRanges()NamedRange[]يحصل على جميع النطاقات المُعنوَنة في جدول البيانات هذا.
getNumSheets()Integerلعرض عدد الأوراق في جدول البيانات هذا.
getOwner()Userيعرض مالك المستند أو null لمستند في مساحة تخزين سحابي مشتركة.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]لعرض قائمة المظاهر المحددة مسبقًا.
getProtections(type)Protection[]للحصول على صفيف من العناصر التي تمثل جميع النطاقات أو جداول البيانات المحمية في جدول البيانات.
getRange(a1Notation)Rangeتعرض النطاق المحدد في تدوين A1 أو تدوين R1C1.
getRangeByName(name)Rangeتعرض نطاقًا مُعنوَنًا أو null في حال عدم العثور على نطاق بالاسم الذي تم إدخاله.
getRangeList(a1Notations)RangeListتعرض المجموعة RangeList التي تمثل النطاقات في ورقة البيانات نفسها المحدّدة من خلال قائمة غير فارغة من علامات A1 أو علامات R1C1.
getRecalculationInterval()RecalculationIntervalلعرض الفاصل الزمني للعمليات في جدول البيانات هذا.
getRowHeight(rowPosition)Integerللحصول على الارتفاع بالبكسل للصف المحدّد.
getSelection()Selectionلعرض Selection الحالية في جدول البيانات.
getSheetByName(name)Sheetتعرض ورقة بيانات بالاسم الذي تم إدخاله.
getSheetId()Integerتعرض رقم تعريف الورقة التي يمثّلها هذا العنصر.
getSheetName()Stringيعرض اسم الورقة.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]تعرض شبكة القيم المستطيلة لهذا النطاق بدءًا من الإحداثيات المحددة.
getSheets()Sheet[]الحصول على جميع جداول البيانات في جدول البيانات هذا
getSpreadsheetLocale()Stringتحصل على لغة جدول البيانات.
getSpreadsheetTheme()SpreadsheetThemeلعرض المظهر الحالي لجدول البيانات، أو null في حال عدم تطبيق أي مظهر.
getSpreadsheetTimeZone()Stringللحصول على المنطقة الزمنية لجدول البيانات.
getUrl()Stringلعرض عنوان URL لجدول البيانات المحدد.
getViewers()User[]الحصول على قائمة المشاهدين والمعلقين لجهاز Spreadsheet هذا.
hideColumn(column)voidإخفاء العمود أو الأعمدة في النطاق المحدّد
hideRow(row)voidإخفاء الصفوف في النطاق المحدّد
insertColumnAfter(afterPosition)Sheetإدراج عمود بعد موضع العمود المحدّد.
insertColumnBefore(beforePosition)Sheetإدخال عمود قبل موضع العمود المحدد.
insertColumnsAfter(afterPosition, howMany)Sheetإدراج عدد من الأعمدة بعد موضع العمود المحدد.
insertColumnsBefore(beforePosition, howMany)Sheetإدراج عدد من الأعمدة قبل موضع العمود المحدد.
insertDataSourceSheet(spec)DataSourceSheetإدراج DataSourceSheet جديد في جدول البيانات وبدء تنفيذ البيانات.
insertImage(blobSource, column, row)OverGridImageإدراج Spreadsheet كصورة في المستند في صف وعمود معيّن.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageيتم إدراج Spreadsheet كصورة في المستند في صف وعمود معيّن، مع إزاحة بكسل.
insertImage(url, column, row)OverGridImageإدراج صورة في المستند في صف وعمود محدد.
insertImage(url, column, row, offsetX, offsetY)OverGridImageإدراج صورة في المستند في صف وعمود محدد، مع إزاحة بكسل.
insertRowAfter(afterPosition)Sheetإدراج صف بعد موضع الصف المحدّد.
insertRowBefore(beforePosition)Sheetإدخال صف قبل موضع الصف المحدّد.
insertRowsAfter(afterPosition, howMany)Sheetإدراج عدد من الصفوف بعد موضع الصف المحدّد.
insertRowsBefore(beforePosition, howMany)Sheetإدراج عدد من الصفوف قبل موضع الصف المحدد.
insertSheet()Sheetإدراج ورقة جديدة في جدول البيانات باستخدام اسم ورقة بيانات تلقائي.
insertSheet(sheetIndex)Sheetإدراج ورقة جديدة في جدول البيانات في الفهرس المحدد.
insertSheet(sheetIndex, options)Sheetإدراج ورقة جديدة في جدول البيانات في الفهرس المحدد واستخدام الوسيطات المتقدمة الاختيارية.
insertSheet(options)Sheetإدراج ورقة جديدة في جدول البيانات باستخدام اسم ورقة تلقائية ووسيطات متقدمة اختيارية.
insertSheet(sheetName)Sheetإدراج ورقة جديدة في جدول البيانات بالاسم الذي تم إدخاله.
insertSheet(sheetName, sheetIndex)Sheetإدخال ورقة جديدة في جدول البيانات بالاسم الذي تم إدخاله في الفهرس المحدد.
insertSheet(sheetName, sheetIndex, options)Sheetيتم إدراج ورقة بيانات جديدة في جدول البيانات باستخدام الاسم الوارد في الفهرس المحدّد واستخدام الوسيطات المتقدّمة الاختيارية.
insertSheet(sheetName, options)Sheetإدخال ورقة جديدة في جدول البيانات بالاسم الذي تم استخدامه به واستخدام الوسيطات المتقدّمة الاختيارية.
insertSheetWithDataSourceTable(spec)Sheetيتم إدراج ورقة بيانات جديدة في جدول البيانات، ويتم إنشاء DataSourceTable باستخدام ورقة البيانات التي تتضمن مواصفات مصادر البيانات المحدّدة، ثم بدء تنفيذ البيانات.
isColumnHiddenByUser(columnPosition)Booleanيعرض ما إذا كان العمود الذي يظهر مخفيًا بواسطة المستخدم.
isIterativeCalculationEnabled()Booleanلعرض ما إذا كانت العملية الحسابية المتكررة مفعَّلة في جدول البيانات هذا.
isRowHiddenByFilter(rowPosition)Booleanلعرض ما إذا كان الصف المحدّد مخفيًا باستخدام فلتر (وليس عرض فلتر).
isRowHiddenByUser(rowPosition)Booleanيعرض ما إذا كان الصف المحدّد مخفيًا بواسطة المستخدم.
moveActiveSheet(pos)voidنقل ورقة البيانات النشطة إلى الموضع المحدّد في قائمة أوراق البيانات
moveChartToObjectSheet(chart)Sheetينشئ جدول بيانات SheetType.OBJECT جديدًا وينقل الرسم البياني المقدَّم إليه.
refreshAllDataSources()voidيُعيد تحميل كل مصادر البيانات المتوافقة وعناصر مصدر البيانات المرتبطة، مع تخطي عناصر مصدر البيانات غير الصالحة.
removeEditor(emailAddress)Spreadsheetيزيل المستخدم المحدد من قائمة أدوات تحرير Spreadsheet.
removeEditor(user)Spreadsheetيزيل المستخدم المحدد من قائمة أدوات تحرير Spreadsheet.
removeMenu(name)voidإزالة قائمة تمت إضافتها من قِبل addMenu(name, subMenus)
removeNamedRange(name)voidحذف نطاق مُعنوَن بالاسم الذي تم إدخاله
removeViewer(emailAddress)Spreadsheetإزالة مستخدم معيّن من قائمة المشاهدين والمعلقين في Spreadsheet
removeViewer(user)Spreadsheetإزالة مستخدم معيّن من قائمة المشاهدين والمعلقين في Spreadsheet
rename(newName)voidإعادة تسمية المستند.
renameActiveSheet(newName)voidإعادة تسمية الورقة النشطة الحالية إلى الاسم الجديد المعيّن.
resetSpreadsheetTheme()SpreadsheetThemeتتم إزالة المظهر المُطبَّق وضبط المظهر التلقائي في جدول البيانات.
setActiveRange(range)Rangeلضبط النطاق المحدّد على أنه active range في ورقة البيانات النشطة، مع أعلى خلية إلى يمين النطاق في النطاق current cell.
setActiveRangeList(rangeList)RangeListلضبط قائمة النطاقات المحدّدة على أنها active ranges في ورقة البيانات النشطة.
setActiveSelection(range)Rangeلضبط منطقة الاختيار النشطة لهذه الورقة.
setActiveSelection(a1Notation)Rangeلضبط الاختيار النشط، كما هو محدد في تدوين A1 أو تدوين R1C1.
setActiveSheet(sheet)Sheetلضبط ورقة البيانات المحددة لتكون الورقة النشطة في جدول البيانات.
setActiveSheet(sheet, restoreSelection)Sheetلضبط ورقة البيانات المحددة بحيث تكون ورقة البيانات النشطة في جدول البيانات، مع خيار استعادة أحدث اختيار ضمن ورقة البيانات هذه.
setColumnWidth(columnPosition, width)Sheetلضبط عرض العمود المحدّد بالبكسل.
setCurrentCell(cell)Rangeلضبط الخلية المحدّدة على أنها current cell.
setFrozenColumns(columns)voidيعمل على تجميد العدد المحدّد من الأعمدة.
setFrozenRows(rows)voidيؤدي هذا الخيار إلى تجميد العدد المحدّد من الصفوف.
setIterativeCalculationConvergenceThreshold(minThreshold)Spreadsheetتضبط الحد الأدنى لقيمة العملية الحسابية المتكررة.
setIterativeCalculationEnabled(isEnabled)Spreadsheetتحدِّد ما إذا كانت الاحتساب المكرر مفعَّلة في جدول البيانات هذا.
setMaxIterativeCalculationCycles(maxIterations)Spreadsheetتحدد الحد الأقصى لعدد تكرارات العملية الحسابية التي يجب إجراؤها أثناء الاحتساب المكرر.
setNamedRange(name, range)voidتحدد نطاقًا.
setRecalculationInterval(recalculationInterval)Spreadsheetتضبط هذه السياسة عدد مرات إعادة احتساب جدول البيانات هذا.
setRowHeight(rowPosition, height)Sheetلضبط ارتفاع الصف للصف المحدّد بالبكسل.
setSpreadsheetLocale(locale)voidلضبط لغة جدول البيانات.
setSpreadsheetTheme(theme)SpreadsheetThemeضبط مظهر في جدول البيانات
setSpreadsheetTimeZone(timezone)voidلضبط المنطقة الزمنية لجدول البيانات.
show(userInterface)voidتعرِض مكوّن واجهة مستخدم مخصّصًا في مربّع حوار يتمحور حول إطار عرض المتصفح للمستخدم.
sort(columnPosition)Sheetيتم ترتيب جدول بيانات تصاعدي حسب العمود.
sort(columnPosition, ascending)Sheetلترتيب ورقة حسب العمود.
toast(msg)voidتعرِض نافذة منبثقة في أسفل يسار جدول البيانات بالرسالة المعنيّة.
toast(msg, title)voidتعرِض نافذة منبثقة في أسفل يسار جدول البيانات بالرسالة وعنوانه المحدّدين.
toast(msg, title, timeoutSeconds)voidتعرِض نافذة منبثقة في أسفل يسار جدول البيانات بالعنوان والرسالة المحدّدَين، وتظل مرئية لفترة زمنية معيّنة.
unhideColumn(column)voidيظهر العمود في النطاق المحدّد.
unhideRow(row)voidيظهر الصف في النطاق المحدّد.
updateMenu(name, subMenus)voidيتم تعديل القائمة التي تمت إضافتها بواسطة addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidانتظِر حتى تكتمل جميع عمليات التنفيذ الحالية في جدول البيانات، على أن تنتهي المهلة بعد عدد الثواني المُقدَّم.

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

المَعلمات

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

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

المَعلمات

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

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

المَعلمات

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

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

المَعلمات

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

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

addEditor(emailAddress)

لإضافة المستخدم المحدد إلى قائمة محرري Spreadsheet. إذا كان المستخدم مدرجًا في قائمة المشاهدين، ستنقل هذه الطريقة المستخدم إلى قائمة المشاهدين.

المَعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إضافته.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

addEditor(user)

لإضافة المستخدم المحدد إلى قائمة محرري Spreadsheet. إذا كان المستخدم مدرجًا في قائمة المشاهدين، ستنقل هذه الطريقة المستخدم إلى قائمة المشاهدين.

المَعلمات

الاسمالنوعالوصف
userUserتمثيل المستخدم المراد إضافته.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

addEditors(emailAddresses)

لإضافة مصفوفة محددة من المستخدمين إلى قائمة المحرِّرين في Spreadsheet. وإذا كان أيٌّ من المستخدمين مُدرَجًا في قائمة المشاهدين، ستنقلهم هذه الطريقة خارج قائمة المشاهدين.

المَعلمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتها.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

addMenu(name, subMenus)

لإنشاء قائمة جديدة في واجهة مستخدم جدول البيانات

يشغّل كل إدخال في القائمة دالة يحددها المستخدم. تريد عادةً استدعاء هذه الدالة من خلال الدالة onOpen() بحيث يتم إنشاء القائمة تلقائيًا عند تحميل جدول البيانات.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة التي سيتم إنشاؤها.
subMenusObject[]مصفوفة من خرائط JavaScript تتضمن المَعلمتَين name وfunctionName . يمكنك استخدام وظائف من المكتبات المضمّنة، مثل Library.libFunction1.

التفويض

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

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

addViewer(emailAddress)

لإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet. إذا كان المستخدم مدرَجًا في قائمة المحرِّرين، لن يكون لهذه الطريقة أي تأثير.

المَعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إضافته.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

addViewer(user)

لإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet. إذا كان المستخدم مدرَجًا في قائمة المحرِّرين، لن يكون لهذه الطريقة أي تأثير.

المَعلمات

الاسمالنوعالوصف
userUserتمثيل المستخدم المراد إضافته.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

addViewers(emailAddresses)

لإضافة الصفيف المحدد من المستخدمين إلى قائمة مشاهدي Spreadsheet. إذا كان أي من المستخدمين مُدرجًا في قائمة المحرّرين، لن يكون لهذه الطريقة أي تأثير.

المَعلمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتها.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

  • 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

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

copy(name)

يؤدّي هذا الإجراء إلى نسخ جدول البيانات وعرض الجدول الجديد.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

المَعلمات

الاسمالنوعالوصف
nameStringاسم النسخة.

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

رحلة العودة

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


createTextFinder(findText)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

// Returns the first occurrence of 'dog' in the spreadsheet.
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النص المطلوب البحث عنه.

رحلة العودة

TextFinderTextFinder في جدول البيانات.


deleteActiveSheet()

حذف ورقة البيانات النشطة حاليًا

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

رحلة العودة

Sheet - الورقة النشطة الجديدة

التفويض

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

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

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

deleteSheet(sheet)

حذف ورقة البيانات المحددة

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

المَعلمات

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

التفويض

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

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

duplicateActiveSheet()

تكرار الورقة النشطة وجعلها الورقة النشطة.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

رحلة العودة

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

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


getActiveSheet()

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

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

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

رحلة العودة

Sheet - ورقة البيانات النشطة في جدول البيانات.


getAs(contentType)

عرض البيانات داخل هذا الكائن ككائنات الثنائية الثنائية (blob) التي تم تحويلها إلى نوع المحتوى المحدَّد تضيف هذه الطريقة الامتداد المناسب إلى اسم الملف، على سبيل المثال، "myfile.pdf". ومع ذلك، يفترض أنّ الجزء المُضاف بعد اسم الملف والذي يلي آخر فترة (إن وُجد) هو امتداد حالي يجب استبداله. وبالتالي، يصبح "ShoppingList.12.25.2014" "ShoppingList.12.25.pdf".

لعرض الحصص اليومية للإحالات الناجحة، راجِع حصص خدمات Google. قد تخضع نطاقات Google Workspace التي تم إنشاؤها حديثًا إلى عروض أسعار أكثر صرامة.

المَعلمات

الاسمالنوعالوصف
contentTypeStringنوع MIME المطلوب التحويل إليه في معظم الكائنات الثنائية الكبيرة، يُعدّ 'application/pdf' الخيار الوحيد الصالح. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يكون أي من 'image/bmp' أو 'image/gif' أو 'image/jpeg' أو 'image/png' صالحًا أيضًا.

رحلة العودة

Blob: البيانات الثنائية الفائقة الحجم


getBandings()

تعرض جميع الهوامش في جدول البيانات هذا.

رحلة العودة

Banding[] — الهوامش في جدول البيانات هذا

التفويض

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

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

getBlob()

اعرض البيانات داخل هذا الكائن ككائنات ثنائية (blob).

رحلة العودة

Blob: البيانات الثنائية الفائقة الحجم


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

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.getLastالصفوف()).

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

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

رحلة العودة

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

التفويض

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

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

getDataSourcePivotTables()

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

رحلة العودة

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

التفويض

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

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

getDataSourceRefreshSchedules()

للحصول على الجداول الزمنية لإعادة تحميل جدول البيانات هذا

رحلة العودة

DataSourceRefreshSchedule[] — الجداول الزمنية لإعادة تحميل جدول البيانات هذا

التفويض

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

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

getDataSourceSheets()

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

رحلة العودة

DataSourceSheet[]: مصفوفة من أوراق بيانات المصدر.

التفويض

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

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

getDataSourceTables()

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

رحلة العودة

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

التفويض

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

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

getDataSources()

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

رحلة العودة

DataSource[]: مصفوفة من جميع مصادر البيانات.

التفويض

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

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

getDeveloperMetadata()

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

رحلة العودة

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

التفويض

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

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

getEditors()

الحصول على قائمة المحرِّرين لـ Spreadsheet

رحلة العودة

User[]: مصفوفة من المستخدمين الذين لديهم إذن تعديل.

التفويض

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

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

getFormUrl()

تعرض عنوان URL للنموذج الذي يرسل ردوده على جدول البيانات هذا، أو null في حال كان جدول البيانات هذا لا يحتوي على نموذج مرتبط. إذا أرسلت نماذج متعددة استجابات إلى جدول البيانات هذا، لن يكون عنوان URL للنموذج المعروض محددًا. بدلاً من ذلك، يمكن استرداد ارتباطات عناوين 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

getId()

تحصل على معرِّف فريد لجدول البيانات هذا. ويمكن استخراج معرّف جدول البيانات من عنوان URL. على سبيل المثال، رقم تعريف جدول البيانات في عنوان URL https://docs.google.com/schemas/d/abc1234567/edit#gid=0 هو "abc1234567".

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

رحلة العودة

String: المعرّف الفريد (أو المفتاح) لجدول البيانات.


getImages()

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

رحلة العودة

OverGridImage[] : مصفوفة من الصور المعروضة على الشبكة

التفويض

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

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

getIterativeCalculationConvergenceThreshold()

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

رحلة العودة

Number — الحد الأدنى للتقارب

التفويض

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

  • 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

getMaxIterativeCalculationCycles()

تعرض الحد الأقصى لعدد التكرارات المطلوب استخدامها أثناء الحساب المكرر.

رحلة العودة

Integer — الحد الأقصى لعدد تكرارات العملية الحسابية.

التفويض

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

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

getName()

الحصول على اسم المستند

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.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.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

رحلة العودة

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

التفويض

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

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

getNumSheets()

لعرض عدد الأوراق في جدول البيانات هذا.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

رحلة العودة

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


getOwner()

يعرض مالك المستند أو null لمستند في مساحة تخزين سحابي مشتركة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

رحلة العودة

User: مالك المستند أو null إذا كان المستند في مساحة تخزين سحابي مشتركة.

التفويض

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

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

getPredefinedSpreadsheetThemes()

لعرض قائمة المظاهر المحددة مسبقًا.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

رحلة العودة

SpreadsheetTheme[] — قائمة بالمظاهر المحددة مسبقًا.

التفويض

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

  • 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 ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (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(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

getRangeByName(name)

تعرض نطاقًا مُعنوَنًا أو null في حال عدم العثور على نطاق بالاسم الذي تم إدخاله. إذا كانت أوراق بيانات متعددة في جدول البيانات تستخدم اسم النطاق نفسه، حدِّد اسم الورقة بدون علامات اقتباس إضافية، على سبيل المثال getRangeByName('TaxRates') أو getRangeByName('Sheet Name!TaxRates') وليس getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم النطاق الذي تريد الحصول عليه.

رحلة العودة

Range: نطاق الخلايا الذي يحمل الاسم نفسه.


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

getRecalculationInterval()

لعرض الفاصل الزمني للعمليات في جدول البيانات هذا.

رحلة العودة

RecalculationInterval — الفاصل الزمني للعمليات في جدول البيانات هذا.

التفويض

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

  • 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

getSheetByName(name)

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

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

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

المَعلمات

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

رحلة العودة

Sheet: جدول البيانات بالاسم الذي تم إدخاله.


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

getSheets()

الحصول على جميع جداول البيانات في جدول البيانات هذا

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

رحلة العودة

Sheet[]: مصفوفة من كل جداول البيانات في جدول البيانات.


getSpreadsheetLocale()

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

رحلة العودة

String: لغة جدول البيانات

التفويض

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

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

getSpreadsheetTheme()

لعرض المظهر الحالي لجدول البيانات، أو null في حال عدم تطبيق أي مظهر.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

رحلة العودة

SpreadsheetTheme : المظهر الحالي المُطبَّق

التفويض

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

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

getSpreadsheetTimeZone()

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

رحلة العودة

String: المنطقة الزمنية المحدّدة بالتنسيق "طويلة" (على سبيل المثال، "America/New_York"، كما هو موضّح في Joda.org).

التفويض

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

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

getUrl()

لعرض عنوان URL لجدول البيانات المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

رحلة العودة

String — عنوان URL لجدول البيانات المحدد.

التفويض

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

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

getViewers()

الحصول على قائمة المشاهدين والمعلقين لجهاز Spreadsheet هذا.

رحلة العودة

User[]: مصفوفة من المستخدمين الذين لديهم إذن للعرض أو التعليق.

التفويض

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

  • 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

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

المَعلمات

الاسمالنوعالوصف
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

insertDataSourceSheet(spec)

إدراج DataSourceSheet جديد في جدول البيانات وبدء تنفيذ البيانات. ونتيجةً لذلك، يؤدي هذا الإجراء أيضًا إلى جعل ورقة البيانات الجديدة هي الورقة النشطة.

طرح استثناء إذا لم يتم تفعيل نوع مصدر البيانات استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات محدّد.

المَعلمات

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

رحلة العودة

DataSourceSheet - ورقة بيانات مصدر البيانات الجديدة.

التفويض

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

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

insertImage(blobSource, column, row)

إدراج Spreadsheet كصورة في المستند في صف وعمود معيّن. يتم استرداد حجم الصورة من محتوى الكائن الثنائي الكبير (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)

يتم إدراج Spreadsheet كصورة في المستند في صف وعمود معيّن، مع إزاحة بكسل. يتم استرداد حجم الصورة من محتوى الكائن الثنائي الكبير (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, 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

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

insertSheet()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetIndex)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

المَعلمات

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetIndex, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetIndexIntegerفهرس ورقة البيانات التي تم إنشاؤها حديثًا. لإدراج ورقة باعتبارها الورقة الأولى في جدول البيانات، اضبطها على القيمة 0.
optionsObjectوسيطات JavaScript المتقدمة اختيارية.

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

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

المَعلمات

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

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

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetName)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

المَعلمات

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetName, sheetIndex)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم ورقة البيانات الجديدة.
sheetIndexIntegerفهرس ورقة البيانات التي تم إنشاؤها حديثًا. لإدراج ورقة باعتبارها الورقة الأولى في جدول البيانات، اضبطها على القيمة 0.

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetName, sheetIndex, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم ورقة البيانات الجديدة.
sheetIndexIntegerفهرس الورقة المُدرجة حديثًا. لإدراج ورقة باعتبارها الورقة الأولى في جدول بيانات، اضبطها على القيمة 0.
optionsObjectوسيطات JavaScript المتقدمة اختيارية.

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

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheet(sheetName, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم ورقة البيانات الجديدة.
optionsObjectوسيطات JavaScript المتقدمة اختيارية.

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

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

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

insertSheetWithDataSourceTable(spec)

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

طرح استثناء إذا لم يتم تفعيل نوع مصدر البيانات استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات محدّد.

المَعلمات

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

رحلة العودة

Sheet — الورقة الجديدة

التفويض

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

  • 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

isIterativeCalculationEnabled()

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

رحلة العودة

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موضع الصف المراد فحصه.

رحلة العودة

Booleantrue إذا كان الصف مخفيًا، أو 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موضع الصف المراد فحصه.

رحلة العودة

Booleantrue إذا كان الصف مخفيًا، أو false في حال عدم ظهوره.

التفويض

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

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

moveActiveSheet(pos)

نقل ورقة البيانات النشطة إلى الموضع المحدّد في قائمة أوراق البيانات طرح استثناء إذا كان الموضع سالبًا أو أكبر من عدد أوراق البيانات

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

المَعلمات

الاسمالنوعالوصف
posIntegerموضع فهرس واحد لنقل الورقة النشطة إلى قائمة من الأوراق.

التفويض

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

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

moveChartToObjectSheet(chart)

ينشئ جدول بيانات SheetType.OBJECT جديدًا وينقل الرسم البياني المقدَّم إليه. إذا كان الرسم البياني من قبل في ورقة البيانات الخاصة به، سيتم عرض ورقة البيانات هذه بدون إنشاء رسم بياني جديد.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

المَعلمات

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

رحلة العودة

Sheet: جدول البيانات الذي يظهر فيه الرسم البياني

التفويض

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

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

refreshAllDataSources()

يُعيد تحميل كل مصادر البيانات المتوافقة وعناصر مصدر البيانات المرتبطة، مع تخطي عناصر مصدر البيانات غير الصالحة.

استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

التفويض

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

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

removeEditor(emailAddress)

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المَعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

removeEditor(user)

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المَعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم المطلوب إزالته

رحلة العودة

Spreadsheet: هذا Spreadsheet، لسلسلة الكتب.

التفويض

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

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

removeMenu(name)

إزالة قائمة تمت إضافتها من قِبل addMenu(name, subMenus) يجب أن تكون للوسيطة name القيمة نفسها للمكالمة المقابلة لـ addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة المطلوب إزالتها

التفويض

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

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

removeNamedRange(name)

حذف نطاق مُعنوَن بالاسم الذي تم إدخاله ويتم طرح استثناء إذا لم يتم العثور على نطاق بالاسم الذي تم إدخاله في جدول البيانات.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

المَعلمات

الاسمالنوعالوصف
nameStringاسم النطاق.

التفويض

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

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

removeViewer(emailAddress)

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرِّرين.

المَعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

رحلة العودة

Spreadsheet: هذا Spreadsheet لسلسلة الكتب.

التفويض

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

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

removeViewer(user)

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرِّرين.

المَعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم المطلوب إزالته

رحلة العودة

Spreadsheet: هذا Spreadsheet لسلسلة الكتب.

التفويض

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

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

rename(newName)

إعادة تسمية المستند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

المَعلمات

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

التفويض

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

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

renameActiveSheet(newName)

إعادة تسمية الورقة النشطة الحالية إلى الاسم الجديد المعيّن.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

المَعلمات

الاسمالنوعالوصف
newNameStringالاسم الجديد للورقة النشطة الحالية.

التفويض

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

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

resetSpreadsheetTheme()

تتم إزالة المظهر المُطبَّق وضبط المظهر التلقائي في جدول البيانات.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

رحلة العودة

SpreadsheetTheme: المظهر التلقائي.

التفويض

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

  • 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

setActiveSheet(sheet)

لضبط ورقة البيانات المحددة لتكون الورقة النشطة في جدول البيانات. تعرض واجهة مستخدم "جداول بيانات Google" الورقة المُختارة ما لم تكن ورقة البيانات تنتمي إلى جدول بيانات مختلف.

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

المَعلمات

الاسمالنوعالوصف
sheetSheetورقة البيانات التي يتم ضبطها كورقة بيانات نشطة

رحلة العودة

Sheet — الورقة النشطة

التفويض

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

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

setActiveSheet(sheet, restoreSelection)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

المَعلمات

الاسمالنوعالوصف
sheetSheetالورقة النشطة الجديدة
restoreSelectionBooleanفي المرة الـ true، يتم اختيار أحدث مجموعة من جداول البيانات النشطة الجديدة مرة أخرى، عندما تصبح ورقة البيانات الجديدة نشطة. وفي حال أصبح false نشطًا، ستصبح ورقة البيانات الجديدة نشطة بدون تغيير النسخة الحالية.

رحلة العودة

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

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

المَعلمات

الاسمالنوعالوصف
minThresholdNumberالحد الأدنى للتقارب (يجب ألا يكون سالبًا).

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

setIterativeCalculationEnabled(isEnabled)

تحدِّد ما إذا كانت الاحتساب المكرر مفعَّلة في جدول البيانات هذا. إذا لم يتم ضبط الحد الأقصى لعدد دورات احتساب القيم والحد الأدنى للتقارب قبل تفعيل الحساب، تكون القيمة التلقائية 50 و0.05 على التوالي. وفي حال ضبط أيٍّ منهما في وقت سابق، يحتفظان بقيمهما السابقة.

المَعلمات

الاسمالنوعالوصف
isEnabledBooleantrue إذا كان يجب تفعيل العملية الحسابية المكرّرة، false بخلاف ذلك

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

setMaxIterativeCalculationCycles(maxIterations)

تحدد الحد الأقصى لعدد تكرارات العملية الحسابية التي يجب إجراؤها أثناء الاحتساب المكرر. ويجب أن تتراوح هذه القيمة بين 1 و10,000 (شاملة)، ويتم ضبطها تلقائيًا على 50.

المَعلمات

الاسمالنوعالوصف
maxIterationsIntegerالحد الأقصى لعدد تكرارات العملية الحسابية (بين 1 و10,000).

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

setNamedRange(name, range)

تحدد نطاقًا.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

المَعلمات

الاسمالنوعالوصف
nameStringالاسم الذي يجب تحديد النطاق له.
rangeRangeمواصفات النطاق.

التفويض

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

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

setRecalculationInterval(recalculationInterval)

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

المَعلمات

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

رحلة العودة

Spreadsheet: جدول البيانات هذا للسلسلة.

التفويض

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

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

setRowHeight(rowPosition, height)

لضبط ارتفاع الصف للصف المحدّد بالبكسل. يتم توسيع الصفوف تلقائيًا لتناسب محتوى الخلية. إذا كنت تريد فرض ارتفاع الصفوف على ارتفاع معيّن، يمكنك استخدام Sheet.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

setSpreadsheetLocale(locale)

لضبط لغة جدول البيانات.

المَعلمات

الاسمالنوعالوصف
localeStringرمز اللغة المطلوب استخدامه (على سبيل المثال، "en" أو "fr" أو "en_US").

التفويض

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

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

setSpreadsheetTheme(theme)

ضبط مظهر في جدول البيانات

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

المَعلمات

الاسمالنوعالوصف
themeSpreadsheetThemeالمظهر المراد تطبيقه.

رحلة العودة

SpreadsheetTheme : المظهر الحالي الجديد.

التفويض

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

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

setSpreadsheetTimeZone(timezone)

لضبط المنطقة الزمنية لجدول البيانات.

المَعلمات

الاسمالنوعالوصف
timezoneStringالمنطقة الزمنية المحدّدة بالتنسيق "طويلة" (مثل "America/New_York")، كما هو مدرَج في Joda.org).

التفويض

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

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

show(userInterface)

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

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

يعرض مقتطف الرمز التالي تطبيق HtmlService بسيطًا في مربّع حوار بعنوان وارتفاع وعرض محدّدَين:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

المَعلمات

الاسمالنوعالوصف
userInterfaceObjectHtmlOutput.

التفويض

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

  • https://www.googleapis.com/auth/script.container.ui

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

toast(msg)

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

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.

التفويض

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

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

toast(msg, title)

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

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.
titleStringتمثّل هذه السمة العنوان الاختياري لتحميص الخبز.

التفويض

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

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

toast(msg, title, timeoutSeconds)

تعرِض نافذة منبثقة في أسفل يسار جدول البيانات بالعنوان والرسالة المحدّدَين، وتظل مرئية لفترة زمنية معيّنة.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.
titleStringتمثّل هذه السمة العنوان الاختياري لتحميص الخبز.
timeoutSecondsNumberالمهلة الزمنية بالثواني، إذا كانت قيمة الخبز المحمّصة هي null تلقائيًا، وفي حال كانت القيمة سالبة، تظل الخبز المحمّص إلى أن يتم إغلاقها.

التفويض

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

  • 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

updateMenu(name, subMenus)

يتم تعديل القائمة التي تمت إضافتها بواسطة addMenu(name, subMenus). يعمل تمامًا مثل addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة المراد تعديلها
subMenusObject[]مصفوفة من خرائط JavaScript تتضمن المَعلمتَين name وfunctionName . يمكنك استخدام وظائف من المكتبات المضمّنة، مثل Library.libFunction1.

التفويض

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

المَعلمات

الاسمالنوعالوصف
timeoutInSecondsIntegerوقت الانتظار بالثواني لعمليات تنفيذ البيانات. الحد الأقصى هو 300 ثانية.

التفويض

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

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

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