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|null عرض ستون مشخص شده را برمی‌گرداند.
get Data Source() Data Source منبع داده‌ای که شیء به آن لینک شده است را دریافت می‌کند.
get Filters() Data Source Sheet Filter[] تمام فیلترهای اعمال شده روی برگه منبع داده را برمی‌گرداند.
get Sheet Values(columnName) Object[] تمام مقادیر مربوط به برگه منبع داده را برای نام ستون ارائه شده برمی‌گرداند.
get Sheet Values(columnName, startRow, numRows) Object[] تمام مقادیر مربوط به برگه منبع داده را برای نام ستون ارائه شده از ردیف شروع ارائه شده (مبتنی بر ۱) و تا 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 — عرض ستون، یا 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)

تمام مقادیر مربوط به برگه منبع داده را برای نام ستون ارائه شده از ردیف شروع ارائه شده (مبتنی بر ۱) و تا 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 زمان انتظار برای اجرای داده، بر حسب ثانیه. حداکثر ۳۰۰ ثانیه است.

بازگشت

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

مجوز

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

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