Class Sheet

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

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

الإرجاع

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME');  // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

تضيف هذه الدالة بيانات وصفية للمطوّر مع المفتاح ومستوى الظهور المحدّدَين إلى ورقة البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata(     'NAME',     SpreadsheetApp.DeveloperMetadataVisibility.PROJECT, );  // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for // the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH');  // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

تضيف هذه الدالة بيانات وصفية للمطوّر تتضمّن المفتاح والقيمة ومستوى الظهور المحدّدين إلى ورقة البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and // sets the visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata(     'COMPANY',     'TECH',     SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT, );  // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet();  // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  sheet.getRange('a1').setValue(     'Whenever it is a damp, drizzly November in my soul...');  // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);

المعلمات

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

المعلمات

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

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

التفويض

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

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

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

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

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

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

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const source = SpreadsheetApp.getActiveSpreadsheet(); const sheet = source.getSheets()[0];  const destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);

المعلمات

الإرجاع

Sheet: ورقة جديدة، للسلسلة

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS');  // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder();  // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

الإرجاع

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // Creates  a text finder. const textFinder = sheet.createTextFinder('dog');  // Returns the first occurrence of 'dog' in the sheet. const firstOccurrence = textFinder.findNext();  // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

المعلمات

الإرجاع

TextFinder: TextFinder للورقة.

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

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

المعلمات

التفويض

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

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

يحذف هذا الإجراء الصف في موضع الصف المحدّد.

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

المعلمات

الإرجاع

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

التفويض

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

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

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

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

المعلمات

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All row groups on the sheet are expanded. sheet.expandAllRowGroups();

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);

المعلمات

الإرجاع

Sheet: هذه الورقة، للسلسلة

التفويض

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

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا

• setActiveRange(range)

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا

• setActiveRangeList(rangeList)

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets the banding info for the sheet. const bandings = sheet.getBandings();  // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) {   console.log(banding.getSecondRowColor()); }

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const charts = sheet.getCharts();  for (const i in charts) {   const chart = charts[i];   // Do something with the chart }

الإرجاع

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

التفويض

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // GroupControlTogglePosition.AFTER if the column grouping control toggle is // shown after the group. const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

الإرجاع

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

التفويض

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

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // 1 if there is a group over columns 1 through 3 const groupDepth = sheet.getColumnGroupDepth(1);

المعلمات

الإرجاع

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

التفويض

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

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

تعرض هذه الدالة عرض العمود المحدّد بالبكسل.

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // Columns start at 1 Logger.log(sheet.getColumnWidth(1));

المعلمات

الإرجاع

Integer: تمثّل عرض العمود بالبكسل.

التفويض

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

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

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

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

الإرجاع

‫ConditionalFormatRule[]: مصفوفة تتضمّن جميع القواعد في ورقة البيانات

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // This represents ALL the data const range = sheet.getDataRange(); const values = range.getValues();  // This logs the spreadsheet in CSV format with a trailing comma for (let i = 0; i < values.length; i++) {   let row = '';   for (let j = 0; j < values[i].length; j++) {     if (values[i][j]) {       row = row + values[i][j];     }     row = `${row},`;   }   Logger.log(row); }

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet by its ID. If you created your script from within a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456');  // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets an array of the data source formulas on Sheet1. // To get an array of data source formulas for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceFormulas = sheet.getDataSourceFormulas();  // Logs the first data source formula in the array. console.log(dataSourceFormulas[0].getFormula());

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456');  // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets an array of the data source pivot tables on Sheet1. // To get an array of data source pivot tables for the entire // spreadsheet, replace 'sheet' with 'ss'. const dataSourcePivotTables = sheet.getDataSourcePivotTables();  // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456');  // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets an array of data source tables on Sheet1. // To get an array of data source tables for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceTables = sheet.getDataSourceTables();  // Logs the last completed data execution time on the first data source table. console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS');  // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata();  // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) {   console.log(developerMetaData.getKey()); }

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings();  // Logs the number of drawings present on the sheet. console.log(allDrawings.length);

الإرجاع

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

التفويض

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

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

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

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

الإرجاع

Filter: الفلتر

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

تعرض هذه السمة عدد الأعمدة المجمّدة.

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

الإرجاع

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

التفويض

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

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

تعرض هذه السمة عدد الصفوف المجمّدة.

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

الإرجاع

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

التفويض

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

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

تعرِض هذه الدالة جميع الصور التي تقع خارج الشبكة في ورقة الجدول.

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets spreadsheet, you can use // SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets the over-the-grid images from Sheet1. // To get the over-the-grid images from the entire spreadsheet, use // ss.getImages() instead. const images = sheet.getImages();  // For each image, logs the anchor cell in A1 notation. for (const image of images) {   console.log(image.getAnchorCell().getA1Notation()); }

الإرجاع

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

التفويض

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

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

تعرض هذه الدالة موضع الورقة في جدول البيانات الرئيسي. تبدأ القيمة بـ 1.

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

الإرجاع

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

التفويض

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

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

تعرِض موضع العمود الأخير الذي يتضمّن محتوًى.

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

الإرجاع

Integer: هو آخر عمود في ورقة البيانات يحتوي على محتوى.

التفويض

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

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

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

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

الإرجاع

Integer: يشير إلى آخر صف في ورقة البيانات يحتوي على محتوى.

التفويض

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

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

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

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

الإرجاع

‫Integer: الحد الأقصى لعرض ورقة البيانات.

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables();  // Logs the pivot tables to the console. for (const pivotTable of pivotTables) {   console.log(pivotTable.getSourceDataRange().getValues()); }

الإرجاع

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

التفويض

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

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is // returned. const range = sheet.getRange(1, 1, 3); const values = range.getValues();  // Prints 3 values from the first column, starting from row 1. for (const row in values) {   for (const col in values[row]) {     Logger.log(values[row][col]);   } }

المعلمات

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange(1, 1, 3, 3); const values = range.getValues();  // Print values from a 3x3 box. for (const row in values) {   for (const col in values[row]) {     Logger.log(values[row][col]);   } }

المعلمات

الإرجاع

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

التفويض

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

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

تعرض هذه الدالة النطاق كما هو محدّد في ترميز A1 أو ترميز R1C1.

// Get a range A1:D4 on sheet titled "Invoices" const ss = SpreadsheetApp.getActiveSpreadsheet(); const range = ss.getRange('Invoices!A1:D4');  // Get cell A1 on the first sheet const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1');

المعلمات

الإرجاع

‫Range: النطاق في الموقع الجغرافي المحدّد

التفويض

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

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

المعلمات

الإرجاع

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

التفويض

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown // after the group. const rowGroupControlPosition = sheet.getRowGroupControlPosition();

الإرجاع

‫GroupControlTogglePosition — true إذا كان مفتاح التبديل الخاص بعنصر التحكّم في تجميع الصفوف يظهر بعد المجموعة في ورقة البيانات هذه، وfalse في الحالات الأخرى.

التفويض

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

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

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];  // 1 if there is a group over rows 1 through 3 const groupDepth = sheet.getRowGroupDepth(1);

المعلمات

الإرجاع

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

التفويض

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

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

تعرض هذه الدالة ارتفاع الصف المحدّد بالبكسل.

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // Rows start at 1 Logger.log(sheet.getRowHeight(1));

المعلمات

الإرجاع

Integer: تمثّل ارتفاع الصف بالبكسل.

التفويض

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

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

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

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

الإرجاع

‫Selection: التحديد الحالي

التفويض

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

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

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

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

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

الإرجاع

استبدِل Integer بمعرّف الورقة الفريد في جدول البيانات.

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // The two samples below produce the same output let values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values);  const range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);

المعلمات

الإرجاع

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

التفويض

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

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

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

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers();  // Logs the slicer titles to the console. for (const slicer of slicers) {   console.log(slicer.getTitle()); }

الإرجاع

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

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

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

الإرجاع

SheetType: نوع الورقة

التفويض

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

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

تعرِض هذه الدالة true إذا كانت خطوط الشبكة في ورقة الجداول مخفية، وإلا تعرِض false. تكون خطوط الشبكة مرئية تلقائيًا.

// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl(     'https://docs.google.com/spreadsheets/d/abc123456/edit', );  // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1');  // Checks if the spreadsheet has hidden gridelines and logs the result to the // console. console.log(sheet.hasHiddenGridlines());

الإرجاع

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

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // This hides the first column let range = sheet.getRange('A1'); sheet.hideColumn(range);  // This hides the first 3 columns range = sheet.getRange('A:C'); sheet.hideColumn(range);

المعلمات

التفويض

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

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

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

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

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

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

المعلمات

التفويض

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

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

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

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

المعلمات

التفويض

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

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // This hides the first row const range = sheet.getRange('A1'); sheet.hideRow(range);

المعلمات

التفويض

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

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

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

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

المعلمات

التفويض

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

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

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

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

المعلمات

التفويض

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

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

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

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

الإرجاع

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

التفويض

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

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

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

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

المعلمات

التفويض

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

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

تُدرج هذه الدالة عمودًا بعد موضع العمود المحدّد.

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  // This inserts a column after the first column position sheet.insertColumnAfter(1);