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 منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

cancel Data Refresh()

اگر در حال حاضر در حال اجرا باشد، به‌روزرسانی داده مرتبط با این شی را لغو می‌کند.

این مثال نحوه لغو بازخوانی فرمول را نشان می دهد.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Formula - شی داده.

مجوز

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

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

force Refresh Data()

داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند. برای جزئیات بیشتر به refresh Data() مراجعه کنید. اگر می‌خواهید یک به‌روزرسانی فعلی این شی را لغو کنید، cancel Data Refresh() مراجعه کنید.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Formula - شی داده.

مجوز

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

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

get Anchor Cell()

Range نشان می دهد که نشان دهنده سلولی است که این فرمول منبع داده لنگر است.

بازگشت

Range - سلول لنگر.

مجوز

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

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

get Data Source()

منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.

بازگشت

Data Source - منبع داده.

مجوز

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

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

get Display Value()

مقدار نمایش فرمول منبع داده را برمی گرداند.

بازگشت

String - مقدار نمایشگر.

مجوز

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

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

get Formula()

فرمول این فرمول منبع داده را برمی گرداند.

بازگشت

String - فرمول.

مجوز

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

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

get Status()

وضعیت اجرای داده شی را دریافت می کند.

بازگشت

Data Execution Status - وضعیت اجرای داده ها.

مجوز

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

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

refresh Data()

داده های شی را تازه می کند.

اگر در حال حاضر در حالت error باشد، یک استثنا می‌اندازد. از Data Source#updateSpec() برای به روز رسانی مشخصات استفاده کنید. برای جلوگیری از ویرایش‌های غیرمنتظره در منبع داده، این روش بر force Refresh Data() ترجیح داده می‌شود.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

بازگشت

Data Source Formula - شی داده.

مجوز

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

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

set Formula(formula)

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

پارامترها

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

بازگشت

Data Source Formula - فرمول منبع داده، برای زنجیره سازی.

مجوز

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

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

wait For Completion(timeoutInSeconds)

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

پارامترها

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

بازگشت

Data Execution Status - وضعیت اجرای داده ها.

مجوز

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

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