Class PivotGroup

PivotGroup

الوصول إلى مجموعات تقسيم الجداول المحورية وتعديلها

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
addManualGroupingRule(groupName, groupMembers)PivotGroupتضيف هذه السمة قاعدة تجميع يدوي لهذه المجموعة المحورية.
areLabelsRepeated()Booleanتعرض هذه السمة ما إذا كانت التصنيفات معروضة بشكل متكرّر.
clearGroupingRule()PivotGroupيزيل أي قواعد تجميع من مجموعة المحور هذه.
clearSort()PivotGroupيزيل أي ترتيب تم تطبيقه على هذه المجموعة.
getDateTimeGroupingRule()DateTimeGroupingRule|nullتعرض هذه الدالة قاعدة تجميع التاريخ والوقت في المجموعة المحورية، أو القيمة null إذا لم يتم ضبط قاعدة تجميع التاريخ والوقت.
getDimension()Dimensionتعرِض هذه السمة ما إذا كانت هذه مجموعة صفوف أو أعمدة.
getGroupLimit()PivotGroupLimit|nullتعرض هذه السمة الحد الأقصى للمجموعة المحورية.
getIndex()Integerتعرِض هذه السمة فهرس مجموعة المحاور في ترتيب المجموعة الحالي.
getPivotTable()PivotTableتعرِض هذه السمة PivotTable التي ينتمي إليها هذا التجميع.
getSourceDataColumn()Integerتعرض هذه الدالة عدد أعمدة بيانات المصدر التي تلخّصها هذه المجموعة.
getSourceDataSourceColumn()DataSourceColumn|nullتعرض هذه السمة عمود مصدر البيانات الذي تعمل عليه مجموعة الجدول المحوري.
hideRepeatedLabels()PivotGroupيخفي التصنيفات المكرّرة لهذه المجموعة.
isSortAscending()Booleanتعرض الدالة true إذا كان الترتيب تصاعديًا، وتعرض false إذا كان الترتيب تنازليًا.
moveToIndex(index)PivotGroupتنقل هذه المجموعة إلى الموضع المحدّد في القائمة الحالية لمجموعات الصفوف أو الأعمدة.
remove()voidتزيل هذه المجموعة المحورية من الجدول.
removeManualGroupingRule(groupName)PivotGroupتزيل هذه الطريقة قاعدة التجميع اليدوي التي تحمل groupName المحدّد.
resetDisplayName()PivotGroupتعيد هذه السمة ضبط اسم العرض لهذه المجموعة في الجدول المحوري إلى قيمته التلقائية.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupتضبط هذه السمة قاعدة تجميع التاريخ والوقت في المجموعة المحورية.
setDisplayName(name)PivotGroupتضبط هذه السمة اسم العرض لهذه المجموعة في الجدول المحوري.
setGroupLimit(countLimit)PivotGroupتضبط هذه السمة الحد الأقصى للمجموعة المحورية.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupتضبط هذه السمة قاعدة تجميع مدرّج تكراري لهذه المجموعة المحورية.
showRepeatedLabels()PivotGroupعندما يكون هناك أكثر من تجميع واحد للصفوف أو الأعمدة، تعرض هذه الطريقة تصنيف هذا التجميع لكل إدخال من التجميع اللاحق.
showTotals(showTotals)PivotGroupتحدّد ما إذا كان سيتم عرض القيم الإجمالية لمجموعة المحاور هذه في الجدول.
sortAscending()PivotGroupيضبط ترتيب الفرز على تصاعدي.
sortBy(value, oppositeGroupValues)PivotGroupترتّب هذه المجموعة حسب PivotValue المحدّد للقيم من oppositeGroupValues.
sortDescending()PivotGroupيضبط ترتيب الفرز على الترتيب التنازلي.
totalsAreShown()Booleanتعرض هذه السمة ما إذا كان يتم حاليًا عرض إجمالي القيم لمجموعة المحور هذه.

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

addManualGroupingRule(groupName, groupMembers)

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

المَعلمات

الاسمالنوعالوصف
groupNameStringاسم قاعدة التجميع هذه.
groupMembersObject[]القيم التي يتم تضمينها في قاعدة التجميع هذه.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

areLabelsRepeated()

تعرض هذه السمة ما إذا كانت التصنيفات معروضة بشكل متكرّر.

الإرجاع

Boolean: true إذا تم تكرار التصنيفات، وإلا تعرض false.

التفويض

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

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

clearGroupingRule()

يزيل أي قواعد تجميع من مجموعة المحور هذه.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

clearSort()

يزيل أي ترتيب تم تطبيقه على هذه المجموعة.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

getDateTimeGroupingRule()

تعرض هذه الدالة قاعدة تجميع التاريخ والوقت في المجموعة المحورية، أو القيمة null إذا لم يتم ضبط قاعدة تجميع التاريخ والوقت.

الإرجاع

DateTimeGroupingRule|null: قاعدة تجميع التاريخ والوقت.

التفويض

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

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

getDimension()

تعرِض هذه السمة ما إذا كانت هذه مجموعة صفوف أو أعمدة.

الإرجاع

‫Dimension: السمة التي تمثّل نوع هذه المجموعة

التفويض

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

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

getGroupLimit()

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

الإرجاع

‫PivotGroupLimit|null: الحد الأقصى للمجموعة المحورية

التفويض

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

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

getIndex()

تعرِض هذه السمة فهرس مجموعة المحاور في ترتيب المجموعة الحالي.

الإرجاع

‫Integer: فهرس المجموعة المحورية

التفويض

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

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

getPivotTable()

تعرِض هذه السمة PivotTable التي ينتمي إليها هذا التجميع.

الإرجاع

PivotTable: الجدول المحوري الذي تنتمي إليه هذه المجموعة

التفويض

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

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

getSourceDataColumn()

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

الإرجاع

Integer: رقم عمود البيانات المصدر

التفويض

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

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

getSourceDataSourceColumn()

تعرض هذه السمة عمود مصدر البيانات الذي تعمل عليه مجموعة الجدول المحوري. تعرِض الدالة null إذا لم يكن الجدول المحوري {DataSourcePivotTableApi}.

الإرجاع

DataSourceColumn|null: عمود مصدر البيانات الذي تعمل عليه المجموعة المحورية.

التفويض

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

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

hideRepeatedLabels()

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

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

isSortAscending()

تعرض الدالة true إذا كان الترتيب تصاعديًا، وتعرض false إذا كان الترتيب تنازليًا.

الإرجاع

‫Boolean — true إذا كان ترتيب الفرز تصاعديًا

التفويض

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

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

moveToIndex(index)

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

المَعلمات

الاسمالنوعالوصف
indexIntegerالفهرس الذي سيتم نقل هذه المجموعة إليه.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

remove()

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

التفويض

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

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

removeManualGroupingRule(groupName)

تزيل هذه الطريقة قاعدة التجميع اليدوي التي تحمل groupName المحدّد.

المَعلمات

الاسمالنوعالوصف
groupNameStringاسم قاعدة التجميع التي سيتمّ إزالتها.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

resetDisplayName()

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

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

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

لإزالة القاعدة، استخدِم clearGroupingRule().

المَعلمات

الاسمالنوعالوصف
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeنوع القاعدة المطلوب ضبطها.

الإرجاع

PivotGroup: مجموعة المحور، للسلسلة.

التفويض

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

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

setDisplayName(name)

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

المَعلمات

الاسمالنوعالوصف
nameStringالاسم المعروض المطلوب ضبطه.

الإرجاع

‫PivotGroup: مجموعة المحور للتسلسل

التفويض

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

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

setGroupLimit(countLimit)

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

المَعلمات

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

الإرجاع

‫PivotGroup: مجموعة المحور للتسلسل

التفويض

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

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

تضبط هذه السمة قاعدة تجميع مدرّج تكراري لهذه المجموعة المحورية. تعمل قاعدة المدرّج التكراري على تنظيم القيم في عمود بيانات مصدر في حِزم ذات حجم ثابت. يتم وضع جميع القيم من minValue إلى maxValue في مجموعات بحجم interval. يتم وضع جميع القيم الأقل من minValue في مجموعة واحدة، وكذلك جميع القيم الأكبر من maxValue.

المَعلمات

الاسمالنوعالوصف
minValueIntegerالحد الأدنى لقيمة العناصر التي سيتم وضعها في حِزم. يتم دمج القيم الأقل من هذا الحد في مجموعة واحدة.
maxValueIntegerالحدّ الأقصى لقيمة العناصر التي سيتم وضعها في مجموعات يتم دمج القيم الأكبر من هذا الحد في مجموعة واحدة.
intervalSizeInteger

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

showRepeatedLabels()

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

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

showTotals(showTotals)

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

المَعلمات

الاسمالنوعالوصف
showTotalsBooleanتحديد ما إذا كان سيتم عرض الإجماليات أم لا

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

sortAscending()

يضبط ترتيب الفرز على تصاعدي.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

sortBy(value, oppositeGroupValues)

ترتّب هذه المجموعة حسب PivotValue المحدّد للقيم من oppositeGroupValues. 

// Sorts the item group by the "SUM of Quantity" pivot value for the specified
// salespersons.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

المَعلمات

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

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

sortDescending()

يضبط ترتيب الفرز على الترتيب التنازلي.

الإرجاع

PivotGroup: مجموعة المحاور الخاصة بالتسلسل

التفويض

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

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

totalsAreShown()

تعرض هذه السمة ما إذا كان يتم حاليًا عرض إجمالي القيم لمجموعة المحور هذه.

الإرجاع

‫Boolean: true إذا تم عرض القيم الإجمالية لمجموعة المحور هذه، وإلا تعرض false.

التفويض

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

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