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