Class Slicer

כלי סינון

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
getBackgroundColorObject()	Color	החזרת Color הרקע של כלי הסינון.
getColumnPosition()	Integer	הפונקציה מחזירה את מיקום העמודה (ביחס לטווח הנתונים של כלי הסינון) שבו המסנן מופעל בכלי הסינון, או null אם מיקום העמודה לא מוגדר.
getContainerInfo()	ContainerInfo	קבלת מידע על המיקום של כלי הסינון בגיליון.
getFilterCriteria()	FilterCriteria	מחזירה את קריטריוני הסינון של כלי הסינון, או 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	הגדרת סגנון הטקסט בכלי הסינון.

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

שיטה	סוג הערך שמוחזר	תיאור קצר
getBackgroundColor()	String	פונקציה זו מחזירה את צבע הרקע של כלי הסינון בסימון CSS (למשל ' # # ').

תיעוד מפורט

getBackgroundColorObject()

החזרת Color הרקע של כלי הסינון.

החזרות

Color – צבע הרקע של כלי הסינון הזה. הפונקציה מחזירה את הערך null אם לא הוגדר צבע.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

getColumnPosition()

הפונקציה מחזירה את מיקום העמודה (ביחס לטווח הנתונים של כלי הסינון) שבו המסנן מופעל בכלי הסינון, או null אם מיקום העמודה לא מוגדר. המיקום של העמודה באינדקס צריך להיות דומה למיקום המסנן.

החזרות

Integer – מיקום העמודה בכלי הסינון הזה.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• 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 – קריטריוני הסינון של כלי הסינון הזה.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• 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)

קובעת אם יש להחיל את כלי הסינון הנתון על טבלאות צירים בגיליון העבודה.

פרמטרים

שם	תיאור	התיאור
applyToPivotTables	Boolean	קובעת אם כלי הסינון הזה יחול על טבלאות צירים.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setBackgroundColor(color)

הגדרת צבע הרקע של כלי הסינון. ערך של null מאפס את צבע הרקע.

פרמטרים

שם	תיאור	התיאור
color	String	צבע הרקע החדש של כלי הסינון הזה בסימון CSS (למשל '#f').

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setBackgroundColorObject(color)

הגדרת הרקע Color של כלי הסינון. הערך של null מאפס את צבע הרקע.

פרמטרים

שם	תיאור	התיאור
color	Color	צבע הרקע החדש של כלי הסינון הזה.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setColumnFilterCriteria(columnPosition, filterCriteria)

המדיניות מגדירה את אינדקס העמודות ואת הקריטריונים לסינון בכלי הסינון. הערך null מאפס את המסנן של כלי הסינון.

פרמטרים

שם	תיאור	התיאור
columnPosition	Integer	מיקום העמודה החדש בכלי סינון זה.
filterCriteria	FilterCriteria	קריטריוני הסינון החדשים בכלי הסינון הזה.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

קובעת את המיקום שבו מופיע כלי הסינון בגיליון. האינדקסים של שורת העוגן ומיקום העמודה מופיעים באינדקס 1.

פרמטרים

שם	תיאור	התיאור
anchorRowPos	Integer	הצד העליון של כלי הסינון מעוגן בשורה הזו.
anchorColPos	Integer	הצד העליון של כלי הסינון מעוגן בעמודה הזו.
offsetX	Integer	ההיסט האופקי מפינת התא בפיקסלים.
offsetY	Integer	ההיסט האנכי מפינת התא בפיקסלים.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setRange(rangeApi)

מגדירה את טווח הנתונים שבו מופעל כלי הסינון.

פרמטרים

שם	תיאור	התיאור
rangeApi	Range	הטווח החדש של כלי הסינון הזה.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setTitle(title)

מגדיר את השם של כלי הסינון. כותרת ריקה מאפסת את הכותרת לערך ברירת המחדל.

פרמטרים

שם	תיאור	התיאור
title	String	השם החדש של כלי הסינון הזה.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setTitleHorizontalAlignment(horizontalAlignment)

הגדרת היישור האופקי של הכותרת בכלי הסינון. הערך של null מאפס את היישור.

פרמטרים

שם	תיאור	התיאור
horizontalAlignment	String	היישור האופקי החדש של השם של כלי הסינון הזה.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

---

setTitleTextStyle(textStyle)

הגדרת סגנון הטקסט בכלי הסינון.

פרמטרים

שם	תיאור	התיאור
textStyle	TextStyle	סגנון הטקסט החדש של כותרת כלי הסינון.

החזרות

Slicer – כלי הסינון הזה לשרשורים.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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

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

getBackgroundColor()

הוצא משימוש. הוחלף על ידי getBackgroundColorObject()

פונקציה זו מחזירה את צבע הרקע של כלי הסינון בסימון CSS (למשל ' # # ').

החזרות

String – צבע הרקע של כלי הסינון הזה. הפונקציה מחזירה את הערך null אם לא הוגדר צבע.

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

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