این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class DataSourceChart

به نمودار منبع داده موجود دسترسی داشته باشید و آن را تغییر دهید.

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

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`cancelDataRefresh()`	`DataSourceChart`	اگر در حال حاضر در حال اجرا باشد، به‌روزرسانی داده مرتبط با این شی را لغو می‌کند.
`forceRefreshData()`	`DataSourceChart`	داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
`getDataSource()`	`DataSource`	منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
`getStatus()`	`DataExecutionStatus`	وضعیت اجرای داده شی را دریافت می کند.
`refreshData()`	`DataSourceChart`	داده های شی را تازه می کند.
`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() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

برگشت

DataSourceChart - شی داده.

مجوز

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

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

`forceRefreshData()`

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

برگشت

DataSourceChart - شی داده.

مجوز

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

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

`getStatus()`

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

برگشت

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

مجوز

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

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

`refreshData()`

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

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

برگشت

DataSourceChart - شی داده.

مجوز

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

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

`waitForCompletion(timeoutInSeconds)`

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

مولفه های

نام	تایپ کنید	شرح
`timeoutInSeconds`	`Integer`	زمان انتظار برای اجرای داده ها، در ثانیه. حداکثر 300 ثانیه است.

برگشت

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

مجوز

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

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