לגשת לטבלת צירים של מקור נתונים ולשנות אותה. כדי ליצור טבלת צירים חדשה של מקור נתונים, משתמשים בפונקציה Range.createDataSourcePivotTable(dataSource)
.
יש להשתמש במחלקה הזו רק עם נתונים שמקושרים למסד נתונים.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addColumnGroup(columnName) | PivotGroup | הוספה של קבוצה חדשה של עמודות צירים על סמך העמודה שצוינה במקור הנתונים. |
addFilter(columnName, filterCriteria) | PivotFilter | הוספה של מסנן חדש המבוסס על העמודה שצוינה במקור הנתונים עם הקריטריונים שצוינו. |
addPivotValue(columnName, summarizeFunction) | PivotValue | הוספת ערך ציר חדש על סמך העמודה שצוינה במקור הנתונים עם פונקציית הסיכום שצוינה. |
addRowGroup(columnName) | PivotGroup | הוספה של קבוצה חדשה של שורות צירים על סמך העמודה שצוינה במקור הנתונים. |
asPivotTable() | PivotTable | מחזירה את טבלת הצירים של מקור הנתונים כאובייקט רגיל של טבלת צירים. |
forceRefreshData() | DataSourcePivotTable | רענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי. |
getDataSource() | DataSource | הפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר. |
getStatus() | DataExecutionStatus | קבלת סטטוס הביצוע של הנתונים של האובייקט. |
refreshData() | DataSourcePivotTable | רענון של נתוני האובייקט. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | ממתין לסיום ההפעלה הנוכחית, ומסתיים לאחר מספר השניות שצוין. |
תיעוד מפורט
addColumnGroup(columnName)
הוספה של קבוצה חדשה של עמודות צירים על סמך העמודה שצוינה במקור הנתונים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
columnName | String | שם העמודה של מקור הנתונים שעליו מבוססת קבוצת הצירים. |
החזרות
PivotGroup
- קבוצת הצירים החדשה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
הוספה של מסנן חדש המבוסס על העמודה שצוינה במקור הנתונים עם הקריטריונים שצוינו.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
columnName | String | שם העמודה של מקור הנתונים שעליו מבוסס המסנן. |
filterCriteria | FilterCriteria | הקריטריונים שהמסנן משתמש בהם. |
החזרות
PivotFilter
– המסנן החדש.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addPivotValue(columnName, summarizeFunction)
הוספת ערך ציר חדש על סמך העמודה שצוינה במקור הנתונים עם פונקציית הסיכום שצוינה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
columnName | String | שם העמודה ב-data לחברה שעליה מבוסס הערך בטבלת הציר. |
summarizeFunction | PivotTableSummarizeFunction | פונקציית הסיכום שבה משתמש ערך הציר. |
החזרות
PivotValue
- הערך החדש בטבלת הציר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addRowGroup(columnName)
הוספה של קבוצה חדשה של שורות צירים על סמך העמודה שצוינה במקור הנתונים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
columnName | String | שם העמודה של מקור הנתונים שעליו מבוססת קבוצת הצירים. |
החזרות
PivotGroup
- קבוצת הצירים החדשה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asPivotTable()
מחזירה את טבלת הצירים של מקור הנתונים כאובייקט רגיל של טבלת צירים.
החזרות
PivotTable
- טבלת הצירים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
רענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי. לפרטים נוספים,
אפשר לקרוא את refreshData()
.
מציג חריגה אם סוג מקור הנתונים לא מופעל. שימוש בשיטות SpreadsheetApp#enable...Execution()
כדי לאפשר הפעלת נתונים לסוג ספציפי של מקור נתונים.
החזרות
DataSourcePivotTable
- אובייקט הנתונים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
הפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר.
החזרות
DataSource
– מקור הנתונים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
קבלת סטטוס הביצוע של הנתונים של האובייקט.
החזרות
DataExecutionStatus
– סטטוס הביצוע של הנתונים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
רענון של נתוני האובייקט.
הפונקציה מחריגה חריגות אם היא נמצאת כרגע במצב error
. יש להשתמש באפשרות DataSource#updateSpec()
כדי לעדכן את המפרט. השיטה הזו מועדפת על פני forceRefreshData()
כדי למנוע עריכות לא צפויות במקור הנתונים.
מציג חריגה אם סוג מקור הנתונים לא מופעל. שימוש בשיטות SpreadsheetApp#enable...Execution()
כדי לאפשר הפעלת נתונים לסוג ספציפי של מקור נתונים.
החזרות
DataSourcePivotTable
- אובייקט הנתונים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
ממתין לסיום ההפעלה הנוכחית, ומסתיים לאחר מספר השניות שצוין. הפונקציה מוסיפה חריגות אם הביצוע לא הושלם בזמן שהזמן הקצוב לתפוגה הסתיים, אבל לא מבטל את הפעלת הנתונים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
timeoutInSeconds | Integer | זמן ההמתנה לביצוע נתונים, בשניות. המקסימום הוא 300 שניות. |
החזרות
DataExecutionStatus
– סטטוס הביצוע של הנתונים.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets