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 — كائن البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

forceRefreshData()

يعيد تحميل بيانات هذا الكائن بغض النظر عن الحالة الحالية. راجِع refreshData() لمزيد من التفاصيل. إذا أردت إلغاء عملية إعادة تحميل قيد التشغيل حاليًا لهذا الكائن، راجِع cancelDataRefresh().

يظهر استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طُرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

الإرجاع

DataSourceFormula — كائن البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

getAnchorCell()

يعرِض Range الذي يمثّل الخلية التي تم تثبيت صيغة مصدر البيانات هذه فيها.

الإرجاع

Range — الخلية الأساسية

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

getDataSource()

يحصل على مصدر البيانات المرتبط بالكائن.

الإرجاع

DataSource — مصدر البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

getDisplayValue()

يعرِض القيمة المعروضة لصيغة مصدر البيانات.

الإرجاع

String — القيمة المعروضة

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

getFormula()

يعرِض صيغة مصدر البيانات هذه.

الإرجاع

String — الصيغة

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

getStatus()

يحصل على حالة تنفيذ البيانات للكائن.

الإرجاع

DataExecutionStatus — حالة تنفيذ البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

refreshData()

يعيد تحميل بيانات الكائن.

يظهر استثناء إذا كانت الحالة الحالية error. استخدِم DataSource#updateSpec() لتعديل المواصفات. يُفضَّل استخدام هذه الطريقة على forceRefreshData() لمنع إجراء تعديلات غير متوقّعة على مصدر البيانات.

يظهر استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طُرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

الإرجاع

DataSourceFormula — كائن البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

setFormula(formula)

يعدِّل الصيغة.

المَعلمات

الاسمالنوعالوصف
formulaStringالصيغة الجديدة

الإرجاع

DataSourceFormula — صيغة مصدر البيانات، للربط

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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

waitForCompletion(timeoutInSeconds)

ينتظر إلى أن تكتمل عملية التنفيذ الحالية، وتنتهي المهلة بعد عدد الثواني المقدَّم. يظهر استثناء إذا لم تكتمل عملية التنفيذ عند انتهاء المهلة، ولكن لا يتم إلغاء تنفيذ البيانات.

المَعلمات

الاسمالنوعالوصف
timeoutInSecondsIntegerالوقت الذي يجب انتظاره لتنفيذ البيانات، بالثواني الحدّ الأقصى هو 300 ثانية.

الإرجاع

DataExecutionStatus — حالة تنفيذ البيانات

التفويض

تتطلّب البرامج النصية التي تستخدِم هذه الطريقة الحصول على تفويض بنطاق واحد أو أكثر من النطاقات التالية: scopes

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