Class Slicer

כלי סינון

מייצג כלי סינון, שמשמש לסינון טווחים, תרשימים וטבלאות צירים באופן לא שיתופי. הקטגוריה הזו מכילה שיטות לגישה לפרוסות קיימות ולשינוי שלהן. כדי ליצור כלי פריסה חדש, משתמשים ב-Sheet.insertSlicer(range, anchorRowPos, anchorColPos).

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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

שיטות שהוצאו משימוש