Class DataSourceChart

DataSourceChart

גישה לתרשים קיים של מקור נתונים ושינוי שלו.

יש להשתמש במחלקה הזו רק עם נתונים שמחוברים למסד נתונים.

שיטות

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

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

פרמטרים

שםסוגתיאור
timeoutInSecondsIntegerזמן ההמתנה לביצוע נתונים, בשניות. הערך המקסימלי הוא 300 שניות.

החזרות

DataExecutionStatus – סטטוס ביצוע הנתונים.

אישור

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

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