Class DataSourceFormula

فرمول منبع داده

دسترسی و تغییر فرمول‌های منبع داده موجود. برای ایجاد یک فرمول منبع داده جدید، از Range.setFormula(formula) استفاده کنید.

فقط از این کلاس با داده‌هایی استفاده کنید که به پایگاه داده BigQuery متصل هستند.

روش‌ها

روش نوع بازگشتی شرح مختصر
cancel Data Refresh() Data Source Formula اگر در حال حاضر این شیء در حال اجرا باشد، به‌روزرسانی داده‌های مرتبط با آن را لغو می‌کند.
force Refresh Data() Data Source Formula داده‌های این شیء را صرف نظر از وضعیت فعلی آن، به‌روزرسانی می‌کند.
get Anchor Cell() Range Range برمی‌گرداند که نشان‌دهنده‌ی سلولی است که این فرمول منبع داده در آن قرار دارد.
get Data Source() Data Source منبع داده‌ای که شیء به آن لینک شده است را دریافت می‌کند.
get Display Value() String مقدار نمایش فرمول منبع داده را برمی‌گرداند.
get Formula() String فرمول مربوط به این فرمول منبع داده را برمی‌گرداند.
get Status() Data Execution Status وضعیت اجرای داده‌ی شیء را دریافت می‌کند.
refresh Data() Data Source Formula داده‌های شیء را به‌روزرسانی می‌کند.
set Formula(formula) Data Source Formula فرمول را به‌روزرسانی می‌کند.
wait For Completion(timeoutInSeconds) Data Execution Status منتظر می‌ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه‌های ارائه شده، زمان‌بندی خاتمه می‌یابد.

مستندات دقیق

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)

فرمول را به‌روزرسانی می‌کند.

پارامترها

نام نوع توضیحات
formula String فرمول جدید.

بازگشت

DataSourceFormula — فرمول منبع داده، برای زنجیره‌سازی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

waitForCompletion(timeoutInSeconds)

منتظر می‌ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه‌های مشخص شده، زمان‌بندی خاتمه می‌یابد. اگر اجرا هنگام اتمام زمان‌بندی کامل نشود، استثنا ایجاد می‌کند، اما اجرای داده‌ها را لغو نمی‌کند.

پارامترها

نام نوع توضیحات
timeout In Seconds Integer زمان انتظار برای اجرای داده، بر حسب ثانیه. حداکثر ۳۰۰ ثانیه است.

بازگشت

DataExecutionStatus — وضعیت اجرای داده‌ها.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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