Class DataSourceSheet

DataSourceSheet

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

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

مواد و روش ها

روش نوع برگشت توضیح مختصر
addFilter(columnName, filterCriteria) DataSourceSheet یک فیلتر اعمال شده به برگه منبع داده اضافه می کند.
asSheet() Sheet برگه منبع داده را به عنوان یک شی برگ معمولی برمی گرداند.
autoResizeColumn(columnName) DataSourceSheet اندازه خودکار عرض ستون مشخص شده را تغییر می دهد.
autoResizeColumns(columnNames) DataSourceSheet اندازه خودکار عرض ستون های مشخص شده را تغییر می دهد.
forceRefreshData() DataSourceSheet داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getColumnWidth(columnName) Integer عرض ستون مشخص شده را برمی گرداند.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getFilters() DataSourceSheetFilter[] تمام فیلترهای اعمال شده به برگه منبع داده را برمی گرداند.
getSheetValues(columnName) Object[] تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده برمی گرداند.
getSheetValues(columnName, startRow, numRows) Object[] همه مقادیر برگه منبع داده را برای نام ستون ارائه شده از سطر شروع ارائه شده (بر اساس-1) و تا numRows ارائه شده برمی گرداند.
getSortSpecs() SortSpec[] تمام مشخصات مرتب سازی را در برگه منبع داده دریافت می کند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
refreshData() DataSourceSheet داده های شی را تازه می کند.
removeFilters(columnName) DataSourceSheet تمام فیلترهای اعمال شده در ستون برگه منبع داده را حذف می کند.
removeSortSpec(columnName) DataSourceSheet مشخصات مرتب‌سازی در یک ستون در برگه منبع داده را حذف می‌کند.
setColumnWidth(columnName, width) DataSourceSheet عرض ستون مشخص شده را تنظیم می کند.
setColumnWidths(columnNames, width) DataSourceSheet عرض ستون های مشخص شده را تنظیم می کند.
setSortSpec(columnName, ascending) DataSourceSheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
setSortSpec(columnName, sortOrder) DataSourceSheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

addFilter(columnName, filterCriteria)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستونی که این فیلتر روی آن اعمال می شود.
filterCriteria FilterCriteria معیارهای فیلتر برای اعمال

برگشت

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

مجوز

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

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

asSheet()

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

برگشت

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

مجوز

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

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

autoResizeColumn(columnName)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستون

برگشت

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

مجوز

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

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

autoResizeColumns(columnNames)

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

مولفه های

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

برگشت

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

مجوز

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

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

forceRefreshData()

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

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

برگشت

DataSourceSheet - شی داده.

مجوز

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

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

getColumnWidth(columnName)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستون

برگشت

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

مجوز

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

  • 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

getFilters()

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

برگشت

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

مجوز

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

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

getSheetValues(columnName)

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

مولفه های

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

برگشت

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

مجوز

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

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

getSheetValues(columnName, startRow, numRows)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستون منبع داده برای واکشی مقادیر.
startRow Integer موقعیت ردیف برای شروع واکشی مقادیر از.
numRows Integer تعداد ردیف هایی که باید واکشی شوند.

برگشت

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

مجوز

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

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

getSortSpecs()

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

برگشت

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

مجوز

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

  • 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() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

برگشت

DataSourceSheet - شی داده.

مجوز

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

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

removeFilters(columnName)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستونی برای حذف فیلترها.

برگشت

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

مجوز

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

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

removeSortSpec(columnName)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستون.

برگشت

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

مجوز

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

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

setColumnWidth(columnName, width)

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

مولفه های

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

برگشت

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

مجوز

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

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

setColumnWidths(columnNames, width)

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

مولفه های

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

برگشت

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

مجوز

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

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

setSortSpec(columnName, ascending)

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

مولفه های

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

برگشت

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

مجوز

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

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

setSortSpec(columnName, sortOrder)

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

مولفه های

نام تایپ کنید شرح
columnName String نام ستونی که باید مرتب شود.
sortOrder SortOrder ترتیب مرتب سازی

برگشت

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

مجوز

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

  • 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