Class DataSourceFormula

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().

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

חזרה

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

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

חזרה

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

אישור

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

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

setFormula(formula)

עדכון הנוסחה.

פרמטרים

שםסוגתיאור
formulaStringהנוסחה החדשה.

חזרה

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

אישור

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

  • 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