Class DataSourceFormula

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