לגשת לתרשים קיים של מקור נתונים ולשנות אותו.
יש להשתמש בכיתה הזו רק עם נתונים שמקושרים למסד נתונים.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
cancelDataRefresh() | DataSourceChart | ביטול של רענון הנתונים המשויך לאובייקט הזה, אם הוא פועל כרגע. |
forceRefreshData() | DataSourceChart | רענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי. |
getDataSource() | DataSource | הפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר. |
getStatus() | DataExecutionStatus | הפונקציה מקבלת את סטטוס ביצוע הנתונים של האובייקט. |
refreshData() | DataSourceChart | רענון של נתוני האובייקט. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | בהמתנה לסיום הביצוע הנוכחי, הזמן הקצוב יסתיים אחרי מספר השניות שצוין. |
מסמכי תיעוד מפורטים
cancelDataRefresh()
ביטול של רענון הנתונים המשויך לאובייקט הזה, אם הוא פועל כרגע.
בדוגמה הזו תוכלו לראות איך לבטל רענון של נוסחאות.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
מחריגה חריג אם הסוג של מקור הנתונים לא מופעל. כדי להפעיל נתונים במקור נתונים ספציפי, צריך להשתמש בשיטות
SpreadsheetApp#enable...Execution()
מהסוג הזה.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
רענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי. הצגת refreshData()
ל-
פרטים נוספים. אם רוצים לבטל את הרענון של האובייקט הזה כרגע, צריך לעיין במאמר cancelDataRefresh()
.
מחריגה חריג אם הסוג של מקור הנתונים לא מופעל. כדי להפעיל נתונים במקור נתונים ספציפי, צריך להשתמש בשיטות SpreadsheetApp#enable...Execution()
מהסוג הזה.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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()
מהסוג הזה.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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