Class DataSourceSheet

برگه منبع داده

به برگه منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید. برای ایجاد یک صفحه منبع داده جدید، از Spreadsheet.insertDataSourceSheet(spec) استفاده کنید.

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

روش ها

روش نوع برگشت شرح مختصر
add Filter(columnName, filterCriteria) Data Source Sheet یک فیلتر اعمال شده به برگه منبع داده اضافه می کند.
as Sheet() Sheet برگه منبع داده را به عنوان یک شی برگ معمولی برمی گرداند.
auto Resize Column(columnName) Data Source Sheet اندازه خودکار عرض ستون مشخص شده را تغییر می دهد.
auto Resize Columns(columnNames) Data Source Sheet اندازه خودکار عرض ستون های مشخص شده را تغییر می دهد.
cancel Data Refresh() Data Source Sheet اگر در حال حاضر در حال اجرا باشد، به‌روزرسانی داده مرتبط با این شی را لغو می‌کند.
force Refresh Data() Data Source Sheet داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
get Column Width(columnName) Integer عرض ستون مشخص شده را برمی گرداند.
get Data Source() Data Source منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
get Filters() Data Source Sheet Filter[] تمام فیلترهای اعمال شده به برگه منبع داده را برمی گرداند.
get Sheet Values(columnName) Object[] تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده برمی گرداند.
get Sheet Values(columnName, startRow, numRows) Object[] تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده از سطر شروع ارائه شده (بر اساس-1) و تا num Rows ارائه شده برمی گرداند.
get Sort Specs() Sort Spec[] تمام مشخصات مرتب سازی را در برگه منبع داده دریافت می کند.
get Status() Data Execution Status وضعیت اجرای داده شی را دریافت می کند.
refresh Data() Data Source Sheet داده های شی را تازه می کند.
remove Filters(columnName) Data Source Sheet تمام فیلترهای اعمال شده در ستون برگه منبع داده را حذف می کند.
remove Sort Spec(columnName) Data Source Sheet مشخصات مرتب‌سازی در یک ستون در برگه منبع داده را حذف می‌کند.
set Column Width(columnName, width) Data Source Sheet عرض ستون مشخص شده را تنظیم می کند.
set Column Widths(columnNames, width) Data Source Sheet عرض ستون های مشخص شده را تنظیم می کند.
set Sort Spec(columnName, ascending) Data Source Sheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
set Sort Spec(columnName, sortOrder) Data Source Sheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
wait For Completion(timeoutInSeconds) Data Execution Status منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

add Filter(columnName, filterCriteria)

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

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستونی که این فیلتر روی آن اعمال می شود.
filter Criteria Filter Criteria معیارهای فیلتر برای اعمال

بازگشت

Data Source Sheet - برگه منبع داده، برای زنجیره روش.

مجوز

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

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

as Sheet()

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

بازگشت

Sheet - ورق معمولی.

مجوز

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

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

auto Resize Column(columnName)

اندازه خودکار عرض ستون مشخص شده را تغییر می دهد.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون

بازگشت

Data Source Sheet - این برگه منبع داده، برای زنجیره‌بندی.

مجوز

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

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

auto Resize Columns(columnNames)

اندازه خودکار عرض ستون های مشخص شده را تغییر می دهد.

پارامترها

نام تایپ کنید توضیحات
column Names String[] لیست نام ستون ها برای به روز رسانی.

بازگشت

Data Source Sheet - این برگه منبع داده، برای زنجیره‌بندی.

مجوز

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

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

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 Sheet - شی داده.

مجوز

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

  • 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 Sheet - شی داده.

مجوز

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

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

get Column Width(columnName)

عرض ستون مشخص شده را برمی گرداند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون

بازگشت

Integer - عرض ستون، یا اگر ستون از عرض پیش‌فرض استفاده کند، null .

مجوز

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

  • 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 Filters()

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

بازگشت

Data Source Sheet Filter[] - آرایه ای از تمام فیلترهای اعمال شده در صفحه منبع داده.

مجوز

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

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

get Sheet Values(columnName)

تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده برمی گرداند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون منبع داده برای واکشی مقادیر.

بازگشت

Object[] - یک آرایه یک بعدی از مقادیر.

مجوز

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

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

get Sheet Values(columnName, startRow, numRows)

تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده از سطر شروع ارائه شده (بر اساس-1) و تا num Rows ارائه شده برمی گرداند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون منبع داده برای واکشی مقادیر.
start Row Integer موقعیت ردیف برای شروع واکشی مقادیر از.
num Rows Integer تعداد ردیف هایی که باید واکشی شوند.

بازگشت

Object[] - یک آرایه یک بعدی از مقادیر.

مجوز

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

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

get Sort Specs()

تمام مشخصات مرتب سازی را در برگه منبع داده دریافت می کند.

بازگشت

Sort Spec[] - لیستی از مشخصات مرتب سازی.

مجوز

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

  • 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 Sheet - شی داده.

مجوز

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

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

remove Filters(columnName)

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

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستونی برای حذف فیلترها.

بازگشت

Data Source Sheet - برگه منبع داده، برای زنجیره روش.

مجوز

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

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

remove Sort Spec(columnName)

مشخصات مرتب‌سازی در یک ستون در برگه منبع داده را حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون.

بازگشت

Data Source Sheet - برگه منبع داده، برای زنجیر کردن.

مجوز

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

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

set Column Width(columnName, width)

عرض ستون مشخص شده را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستون
width Integer عرض جدید برای ستون.

بازگشت

Data Source Sheet - این برگه منبع داده، برای زنجیره‌بندی.

مجوز

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

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

set Column Widths(columnNames, width)

عرض ستون های مشخص شده را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
column Names String[] لیست نام ستون ها برای به روز رسانی.
width Integer عرض جدید برای ستون ها.

بازگشت

Data Source Sheet - این برگه منبع داده، برای زنجیره‌بندی.

مجوز

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

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

set Sort Spec(columnName, ascending)

مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستونی که باید مرتب شود.
ascending Boolean اگر true ، ستون را به ترتیب صعودی مرتب کنید. اگر false ، ستون را به ترتیب نزولی مرتب کنید.

بازگشت

Data Source Sheet - برگه منبع داده، برای زنجیر کردن.

مجوز

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

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

set Sort Spec(columnName, sortOrder)

مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
column Name String نام ستونی که باید مرتب شود.
sort Order Sort Order ترتیب مرتب سازی

بازگشت

Data Source Sheet - برگه منبع داده، برای زنجیر کردن.

مجوز

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

  • 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