דף זה תורגם על ידי Cloud Translation API.

Class DataSourceFormula

גישה לנוסחאות קיימות של מקורות נתונים ושינוי שלהן. כדי ליצור נוסחה חדשה של מקור נתונים, צריך להשתמש בפונקציה Range.setFormula(formula).

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`cancelDataRefresh()`	`DataSourceFormula`	מבטל את רענון הנתונים המשויך לאובייקט הזה אם הוא פועל עכשיו.
`forceRefreshData()`	`DataSourceFormula`	רענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי.
`getAnchorCell()`	`Range`	הפונקציה מחזירה את הערך `Range` שמייצג את התא שבו מעוגנת הנוסחה של מקור הנתונים.
`getDataSource()`	`DataSource`	מקבלת את מקור הנתונים שאליו האובייקט מקושר.
`getDisplayValue()`	`String`	מחזירה את ערך התצוגה של הנוסחה של מקור הנתונים.
`getFormula()`	`String`	מחזירה את הנוסחה לנוסחה של מקור הנתונים.
`getStatus()`	`DataExecutionStatus`	מקבל את סטטוס ביצוע הנתונים של האובייקט.
`refreshData()`	`DataSourceFormula`	רענון של נתוני האובייקט.
`setFormula(formula)`	`DataSourceFormula`	המערכת מעדכנת את הנוסחה.
`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() כדי לאפשר ביצוע נתונים לסוג ספציפי של מקור נתונים.

החזרות

DataSourceFormula – אובייקט הנתונים.

אישור

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

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

`forceRefreshData()`

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

החזרות

DataSourceFormula – אובייקט הנתונים.

אישור

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

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

`getAnchorCell()`

הפונקציה מחזירה את הערך Range שמייצג את התא שבו מעוגנת הנוסחה של מקור הנתונים.

החזרות

Range – תא העוגן.

אישור

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

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

`getDisplayValue()`

מחזירה את ערך התצוגה של הנוסחה של מקור הנתונים.

החזרות

String – הערך לתצוגה.

אישור

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

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

`getFormula()`

מחזירה את הנוסחה לנוסחה של מקור הנתונים.

החזרות

String - הנוסחה.

אישור

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

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() כדי למנוע עריכות לא צפויות במקור הנתונים.

החזרות

DataSourceFormula – אובייקט הנתונים.

אישור

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

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

`setFormula(formula)`

המערכת מעדכנת את הנוסחה.

פרמטרים

שם	סוג	תיאור
`formula`	`String`	הנוסחה החדשה.

החזרות

DataSourceFormula – הנוסחה של מקור הנתונים לשרשור.

אישור

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

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