Class Group

المجموعة

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

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

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
collapse()Groupتصغير هذه المجموعة
expand()Groupلتوسيع هذه المجموعة
getControlIndex()Integerعرض مؤشر تبديل عناصر التحكّم في هذه المجموعة
getDepth()Integerلعرض عمق هذه المجموعة.
getRange()Rangeتعرِض هذه الدالة النطاق الذي تتوفّر فيه هذه المجموعة.
isCollapsed()Booleanتعرِض true إذا كانت هذه المجموعة مصغّرة.
remove()voidتزيل هذه المجموعة من ورقة البيانات، ما يؤدي إلى تقليل عمق المجموعة في range بمقدار واحد.

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

collapse()

تصغير هذه المجموعة 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Collapses this group.
group.collapse();

الإرجاع

Group - هذه المجموعة، لإنشاء سلاسل

التفويض

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

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

expand()

لتوسيع هذه المجموعة 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Expands this group.
group.expand();

الإرجاع

Group - هذه المجموعة، لإنشاء سلاسل

التفويض

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

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

getControlIndex()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 4
const controlIndex = group.getControlIndex();

الإرجاع

Integer - مؤشر تبديل التحكّم في هذه المجموعة

التفويض

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

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

getDepth()

لعرض عمق هذه المجموعة. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
const depth = group.getDepth();

الإرجاع

Integer - عمق هذه المجموعة

التفويض

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

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

getRange()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(1, 1);

// Returns the range 2:3 if the group is over rows 2:3
range = group.getRange();

الإرجاع

Range: النطاق الذي تتوفّر فيه المجموعة

التفويض

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

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

isCollapsed()

تعرِض true إذا كانت هذه المجموعة مصغّرة. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
const isCollapsed = group.isCollapsed();

الإرجاع

Boolean: true إذا كانت هذه المجموعة مصغّرة، وfalse بخلاف ذلك

التفويض

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

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

remove()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Removes this group
range = group.remove();

التفويض

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

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

انظر أيضًا