Class DataSourceFormula

صيغةمصدرالبيانات

الوصول إلى صِيَغ مصادر البيانات الحالية وتعديلها لإنشاء صيغة مصدر بيانات جديدة، استخدِم Range.setFormula(formula).

لا تستخدِم هذه الفئة إلا مع البيانات المرتبطة بقاعدة بيانات BigQuery.

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
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