Class Slicer

برش دهنده

یک slicer را نشان می‌دهد که برای فیلتر کردن محدوده‌ها، نمودارها و جداول محوری به صورت غیر مشارکتی استفاده می‌شود. این کلاس شامل متدهایی برای دسترسی و تغییر slicerهای موجود است. برای ایجاد یک slicer جدید، از Sheet.insertSlicer(range, anchorRowPos, anchorColPos) استفاده کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
get Background Color Object() Color |null Color پس‌زمینه‌ی برش‌دهنده را برمی‌گرداند.
get Column Position() Integer|null موقعیت ستون (نسبت به محدوده داده‌های برش‌دهنده) که فیلتر در برش‌دهنده روی آن اعمال می‌شود را برمی‌گرداند، یا اگر موقعیت ستون تنظیم نشده باشد، null برمی‌گرداند.
get Container Info() Container Info اطلاعاتی در مورد محل قرارگیری برش‌دهنده در صفحه دریافت می‌کند.
get Filter Criteria() Filter Criteria |null معیارهای فیلتر برش‌دهنده را برمی‌گرداند، یا اگر معیارهای فیلتر تنظیم نشده باشند null برمی‌گرداند.
get Range() Range محدوده داده‌هایی را که برش‌دهنده روی آنها اعمال می‌شود، دریافت می‌کند.
get Title() String عنوان برش‌دهنده را برمی‌گرداند.
get Title Horizontal Alignment() String تراز افقی عنوان را برمی‌گرداند.
get Title Text Style() Text Style سبک متن عنوان برش‌دهنده را برمی‌گرداند.
is Applied To Pivot Tables() Boolean برمی‌گرداند که آیا برش‌دهنده‌ی داده شده روی جداول محوری اعمال شده است یا خیر.
remove() void برش‌دهنده را حذف می‌کند.
set Apply To Pivot Tables(applyToPivotTables) Slicer تعیین می‌کند که آیا برش‌دهنده‌ی داده شده باید روی جداول محوری در برگه‌ی کار اعمال شود یا خیر.
set Background Color(color) Slicer رنگ پس‌زمینه‌ی برش‌دهنده را تنظیم می‌کند.
set Background Color Object(color) Slicer Color پس‌زمینه‌ی برش‌دهنده را تنظیم می‌کند.
set Column Filter Criteria(columnPosition, filterCriteria) Slicer شاخص ستون و معیارهای فیلترینگ برش‌دهنده را تنظیم می‌کند.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) Slicer موقعیتی را که برش‌دهنده روی برگه ظاهر می‌شود، تنظیم می‌کند.
set Range(rangeApi) Slicer محدوده داده‌هایی را که برش‌دهنده روی آنها اعمال می‌شود، تنظیم می‌کند.
set Title(title) Slicer عنوان برش‌دهنده را تنظیم می‌کند.
set Title Horizontal Alignment(horizontalAlignment) Slicer تراز افقی عنوان را در برش‌دهنده تنظیم می‌کند.
set Title Text Style(textStyle) Slicer سبک متن برش‌دهنده را تنظیم می‌کند.

مستندات دقیق

get Background Color Object()

Color پس‌زمینه‌ی برش‌دهنده را برمی‌گرداند.

بازگشت

Color |null — رنگ پس‌زمینه‌ی این برش‌دهنده. اگر رنگی تنظیم نشود، null را برمی‌گرداند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Column Position()

موقعیت ستون (نسبت به محدوده داده‌های برش‌دهنده) که فیلتر در برش‌دهنده روی آن اعمال می‌شود را برمی‌گرداند، یا اگر موقعیت ستون تنظیم نشده باشد، null برمی‌گرداند. این باید موقعیت ستون با اندیس ۱ باشد، مشابه filter.

بازگشت

Integer|null — موقعیت ستون این برش‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Container Info()

اطلاعاتی در مورد محل قرارگیری برش‌دهنده در صفحه دریافت می‌کند.

بازگشت

Container Info - شیء حاوی موقعیت کانتینر برش‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Filter Criteria()

معیارهای فیلتر برش‌دهنده را برمی‌گرداند، یا اگر معیارهای فیلتر تنظیم نشده باشند null برمی‌گرداند.

بازگشت

Filter Criteria |null — معیارهای فیلتر این برش‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Range()

محدوده داده‌هایی را که برش‌دهنده روی آنها اعمال می‌شود، دریافت می‌کند.

بازگشت

Range — محدوده برش دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Title()

عنوان برش‌دهنده را برمی‌گرداند.

بازگشت

String - این برش‌دهنده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Title Horizontal Alignment()

تراز افقی عنوان را برمی‌گرداند.

بازگشت

String — تراز افقی عنوان این برش‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Title Text Style()

سبک متن عنوان برش‌دهنده را برمی‌گرداند.

بازگشت

Text Style — سبک متن عنوان این برش‌دهنده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

is Applied To Pivot Tables()

برمی‌گرداند که آیا برش‌دهنده‌ی داده شده روی جداول محوری اعمال شده است یا خیر.

بازگشت

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

set Apply To Pivot Tables(applyToPivotTables)

تعیین می‌کند که آیا برش‌دهنده‌ی داده شده باید روی جداول محوری در برگه‌ی کار اعمال شود یا خیر.

پارامترها

نام نوع توضیحات
apply To Pivot Tables Boolean مشخص می‌کند که آیا این برش‌دهنده باید روی جداول محوری اعمال شود یا خیر.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Background Color(color)

رنگ پس‌زمینه‌ی برش‌دهنده را تنظیم می‌کند. مقدار null رنگ پس‌زمینه را به حالت اولیه برمی‌گرداند.

پارامترها

نام نوع توضیحات
color String رنگ پس‌زمینه جدید این برش‌دهنده در نمادگذاری CSS (مانند '#ffffff').

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Background Color Object(color)

Color پس‌زمینه‌ی برش‌دهنده را تنظیم می‌کند. مقدار null رنگ پس‌زمینه را به حالت اولیه برمی‌گرداند.

پارامترها

نام نوع توضیحات
color Color رنگ پس‌زمینه جدید این برش‌دهنده.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Column Filter Criteria(columnPosition, filterCriteria)

شاخص ستون و معیارهای فیلترینگ برش‌دهنده را تنظیم می‌کند. مقدار null فیلتر برش‌دهنده را بازنشانی می‌کند.

پارامترها

نام نوع توضیحات
column Position Integer موقعیت ستون جدید این برش‌دهنده.
filter Criteria Filter Criteria معیارهای فیلتر جدید این دستگاه برش.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Position(anchorRowPos, anchorColPos, offsetX, offsetY)

موقعیت مکانی که برش‌دهنده روی صفحه ظاهر می‌شود را تعیین می‌کند. شاخص‌های موقعیت ردیف و ستون لنگر، ۱-ایندکس هستند.

پارامترها

نام نوع توضیحات
anchor Row Pos Integer قسمت بالایی برش‌دهنده در این ردیف محکم شده است.
anchor Col Pos Integer قسمت بالایی برش‌دهنده در این ستون محکم شده است.
offsetX Integer فاصله افقی از گوشه سلول بر حسب پیکسل.
offsetY Integer فاصله عمودی از گوشه سلول بر حسب پیکسل.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Range(rangeApi)

محدوده داده‌هایی را که برش‌دهنده روی آنها اعمال می‌شود، تنظیم می‌کند.

پارامترها

نام نوع توضیحات
range Api Range سری جدید این دستگاه برش.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Title(title)

عنوان برش‌دهنده را تنظیم می‌کند. یک عنوان خالی، عنوان را به مقدار پیش‌فرض بازنشانی می‌کند.

پارامترها

نام نوع توضیحات
title String عنوان جدید این اسلایسر.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Title Horizontal Alignment(horizontalAlignment)

تراز افقی عنوان را در برش‌دهنده تنظیم می‌کند. مقدار null تراز را به حالت اولیه برمی‌گرداند.

پارامترها

نام نوع توضیحات
horizontal Alignment String تراز افقی جدید عنوان این برش‌دهنده.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Title Text Style(textStyle)

سبک متن برش‌دهنده را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
text Style Text Style سبک متن جدید عنوان برش‌دهنده.

بازگشت

Slicer — این برش‌دهنده، برای زنجیر کردن.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

متدهای منسوخ شده