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

انظر أيضًا