Class Slicer

أداة التقطيع

يمثّل هذا النوع فلتر نطاق بيانات، ويُستخدم لفلترة النطاقات والرسوم البيانية والجداول المحورية بطريقة غير تعاونية. تحتوي هذه الفئة على طرق للوصول إلى أدوات التقطيع الحالية وتعديلها. لإنشاء مقسّم جديد، استخدِم Sheet.insertSlicer(range, anchorRowPos, anchorColPos).

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
getBackgroundColorObject()Color|nullإرجاع الخلفية Color من أداة التقطيع
getColumnPosition()Integer|nullتعرض هذه السمة موضع العمود (بالنسبة إلى نطاق بيانات أداة التقطيع) الذي يتم تطبيق الفلتر عليه في أداة التقطيع، أو null إذا لم يتم ضبط موضع العمود.
getContainerInfo()ContainerInfoتعرض هذه الدالة معلومات حول موضع أداة التقطيع في ورقة البيانات.
getFilterCriteria()FilterCriteria|nullتعرض هذه الدالة معايير الفلتر الخاصة بأداة التقطيع، أو null إذا لم يتم ضبط معايير الفلتر.
getRange()Rangeتعرض هذه الدالة نطاق البيانات الذي يتم تطبيق فلتر نطاق البيانات عليه.
getTitle()Stringتعرض هذه السمة عنوان أداة التقطيع.
getTitleHorizontalAlignment()Stringتعرض هذه السمة المحاذاة الأفقية للعنوان.
getTitleTextStyle()TextStyleتعرض هذه الدالة نمط النص لعنوان أداة التقطيع.
isAppliedToPivotTables()Booleanتعرِض هذه الدالة ما إذا كان يتم تطبيق أداة التقطيع المحدّدة على الجداول المحورية.
remove()voidيحذف مقسّم البيانات.
setApplyToPivotTables(applyToPivotTables)Slicerتضبط هذه السمة ما إذا كان يجب تطبيق فلتر نطاق البيانات المحدّد على الجداول المحورية في ورقة العمل.
setBackgroundColor(color)Slicerتضبط هذه السمة لون خلفية أداة التقطيع.
setBackgroundColorObject(color)Slicerتضبط هذه السمة خلفية أداة التقطيع.Color
setColumnFilterCriteria(columnPosition, filterCriteria)Slicerتضبط هذه السمة فهرس العمود ومعايير الفلترة الخاصة بأداة التقطيع.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)Slicerتضبط هذه السمة موضع أداة التقطيع على ورقة البيانات.
setRange(rangeApi)Slicerتضبط هذه السمة النطاق الزمني الذي يتم تطبيق أداة التقطيع عليه.
setTitle(title)Slicerتضبط هذه السمة عنوان أداة التقطيع.
setTitleHorizontalAlignment(horizontalAlignment)Slicerتضبط هذه السمة المحاذاة الأفقية للعنوان في أداة التقطيع.
setTitleTextStyle(textStyle)Slicerتضبط هذه السمة نمط النص الخاص بأداة التقطيع.

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

getBackgroundColorObject()

إرجاع الخلفية Color من أداة التقطيع

الإرجاع

Color|null: لون خلفية أداة التقطيع هذه. تعرِض null إذا لم يتم ضبط أي لون.

التفويض

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

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

getColumnPosition()

تعرض هذه السمة موضع العمود (بالنسبة إلى نطاق بيانات أداة التقطيع) الذي يتم تطبيق الفلتر عليه في أداة التقطيع، أو null إذا لم يتم ضبط موضع العمود. يجب أن يكون هذا الرقم هو موضع العمود المستند إلى الفهرس 1، على غرار الفلتر.

الإرجاع

Integer|null: موضع العمود الخاص بأداة التقطيع هذه

التفويض

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

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

getContainerInfo()

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

الإرجاع

‫ContainerInfo: عنصر يحتوي على موضع حاوية أداة التقطيع.

التفويض

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

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

getFilterCriteria()

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

الإرجاع

FilterCriteria|null: معايير الفلتر الخاصة بأداة التقطيع هذه.

التفويض

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

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

getRange()

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

الإرجاع

Range: نطاق أداة التقطيع

التفويض

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

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

getTitle()

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

الإرجاع

String: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

getTitleHorizontalAlignment()

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

الإرجاع

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

التفويض

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

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

getTitleTextStyle()

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

الإرجاع

TextStyle — نمط نص عنوان أداة التقطيع هذه.

التفويض

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

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

isAppliedToPivotTables()

تعرِض هذه الدالة ما إذا كان يتم تطبيق أداة التقطيع المحدّدة على الجداول المحورية.

الإرجاع

‫Boolean: true إذا تم تطبيق أداة التقطيع هذه على الجداول المحورية، وإلا false.

التفويض

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

  • 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

setApplyToPivotTables(applyToPivotTables)

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

المعلمات

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

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setBackgroundColor(color)

تضبط هذه السمة لون خلفية أداة التقطيع. تعمل القيمة null على إعادة ضبط لون الخلفية.

المعلمات

الاسمالنوعالوصف
colorStringلون الخلفية الجديد لأداة التقطيع هذه بتنسيق CSS (مثل ‎#ffffff).

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setBackgroundColorObject(color)

تضبط هذه السمة خلفية أداة التقطيع.Color تعيد القيمة null ضبط لون الخلفية.

المعلمات

الاسمالنوعالوصف
colorColorلون الخلفية الجديد لأداة التقطيع هذه.

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setColumnFilterCriteria(columnPosition, filterCriteria)

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

المعلمات

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

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

تضبط هذه السمة موضع أداة التقطيع على ورقة البيانات. فهارس موضع الصف والعمود الأساسيَّين مفهرسة بدءًا من 1.

المعلمات

الاسمالنوعالوصف
anchorRowPosIntegerيتم تثبيت الجانب العلوي من أداة التقطيع في هذا الصف.
anchorColPosIntegerيتم تثبيت الجانب العلوي من أداة التقطيع في هذا العمود.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setRange(rangeApi)

تضبط هذه السمة النطاق الزمني الذي يتم تطبيق أداة التقطيع عليه.

المعلمات

الاسمالنوعالوصف
rangeApiRangeالنطاق الجديد لأداة التقطيع هذه.

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setTitle(title)

تضبط هذه السمة عنوان أداة التقطيع. يؤدي العنوان الفارغ إلى إعادة ضبط العنوان على القيمة التلقائية.

المعلمات

الاسمالنوعالوصف
titleStringالعنوان الجديد لأداة التقطيع هذه.

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setTitleHorizontalAlignment(horizontalAlignment)

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

المعلمات

الاسمالنوعالوصف
horizontalAlignmentStringالمحاذاة الأفقية الجديدة لعنوان أداة التقطيع هذه.

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

setTitleTextStyle(textStyle)

تضبط هذه السمة نمط النص الخاص بأداة التقطيع.

المعلمات

الاسمالنوعالوصف
textStyleTextStyleنمط النص الجديد لعنوان أداة التقطيع.

الإرجاع

Slicer: أداة التقطيع هذه مخصّصة للربط.

التفويض

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

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

الطُرق المتوقّفة