دسترسی و تغییر صفحات گسترده. عملیات رایج شامل تغییر نام یک صفحه و دسترسی به اشیاء محدوده از صفحه است.
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
activate() | Sheet | این برگه را فعال میکند. |
add Developer Metadata(key) | Sheet | متادیتای توسعهدهنده را با کلید مشخصشده به برگه اضافه میکند. |
add Developer Metadata(key, visibility) | Sheet | فرادادههای توسعهدهنده را با کلید و قابلیت مشاهدهی مشخصشده به برگه اضافه میکند. |
add Developer Metadata(key, value) | Sheet | متادیتای توسعهدهنده را با کلید و مقدار مشخصشده به برگه اضافه میکند. |
add Developer Metadata(key, value, visibility) | Sheet | متادیتای توسعهدهنده را با کلید، مقدار و قابلیت مشاهدهی مشخصشده به برگه اضافه میکند. |
append Row(rowContents) | Sheet | یک ردیف به پایین ناحیه داده فعلی در برگه اضافه میکند. |
as Data Source Sheet() | Data Source Sheet |null | اگر برگه از نوع Sheet Type.DATASOURCE باشد، آن را به عنوان یک Data Source Sheet برمیگرداند، و در غیر این صورت null برمیگرداند. |
auto Resize Column(columnPosition) | Sheet | عرض ستون داده شده را متناسب با محتوای آن تنظیم میکند. |
auto Resize Columns(startColumn, numColumns) | Sheet | عرض تمام ستونها را از موقعیت ستون داده شده شروع میکند تا با محتوای آنها متناسب باشد. |
auto Resize Rows(startRow, numRows) | Sheet | ارتفاع تمام ردیفها را از موقعیت ردیف داده شده شروع میکند تا با محتوای آنها متناسب باشد. |
clear() | Sheet | محتوای برگه و اطلاعات قالببندی را پاک میکند. |
clear(options) | Sheet | محتویات و/یا قالب برگه را، همانطور که با گزینههای پیشرفته داده شده مشخص شده است، پاک میکند. |
clear Conditional Format Rules() | void | تمام قوانین قالببندی شرطی را از برگه حذف میکند. |
clear Contents() | Sheet | محتویات برگه را پاک میکند، در حالی که اطلاعات قالببندی را حفظ میکند. |
clear Formats() | Sheet | قالببندی برگه را پاک میکند، در حالی که محتویات را حفظ میکند. |
clear Notes() | Sheet | برگه را از تمام یادداشتها پاک میکند. |
collapse All Column Groups() | Sheet | تمام گروههای ستون روی برگه را جمع میکند. |
collapse All Row Groups() | Sheet | تمام گروههای ردیف روی برگه را جمع میکند. |
copy To(spreadsheet) | Sheet | برگه را در یک صفحه گسترده (spreadsheet) مشخص کپی میکند، که میتواند همان صفحه گسترده منبع باشد. |
create Developer Metadata Finder() | Developer Metadata Finder | یک Developer Metadata Finder برای یافتن فراداده توسعهدهنده در محدوده این برگه برمیگرداند. |
create Text Finder(findText) | Text Finder | یک یابنده متن برای برگه ایجاد میکند که میتواند متن درون برگه را پیدا و جایگزین کند. |
delete Column(columnPosition) | Sheet | ستون را در موقعیت ستون داده شده حذف میکند. |
delete Columns(columnPosition, howMany) | void | تعدادی ستون را که از موقعیت ستون داده شده شروع میشوند، حذف میکند. |
delete Row(rowPosition) | Sheet | ردیف را در موقعیت ردیف داده شده حذف میکند. |
delete Rows(rowPosition, howMany) | void | تعدادی از ردیفها را از موقعیت ردیف داده شده حذف میکند. |
expand All Column Groups() | Sheet | تمام گروههای ستون روی برگه را گسترش میدهد. |
expand All Row Groups() | Sheet | تمام گروههای ردیف را در صفحه گسترش میدهد. |
expand Column Groups Up To Depth(groupDepth) | Sheet | تمام گروههای ستون را تا عمق داده شده گسترش میدهد و بقیه را جمع میکند. |
expand Row Groups Up To Depth(groupDepth) | Sheet | تمام گروههای ردیف را تا عمق داده شده گسترش میدهد و بقیه را جمع میکند. |
get Active Cell() | Range | سلول فعال در این برگه را برمیگرداند. |
get Active Range() | Range | محدوده انتخاب شده در برگه فعال را برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null برمیگرداند. |
get Active Range List() | Range List |null | لیست محدودههای فعال در برگه فعال را برمیگرداند یا اگر هیچ محدوده فعالی وجود نداشته باشد null برمیگرداند. |
get Bandings() | Banding[] | تمام نوارهای موجود در این برگه را برمیگرداند. |
get Charts() | Embedded Chart[] | آرایهای از نمودارها را در این برگه برمیگرداند. |
get Column Group(columnIndex, groupDepth) | Group |null | گروه ستون را در اندیس و عمق گروه داده شده برمیگرداند. |
get Column Group Control Position() | Group Control Toggle Position | Group Control Toggle Position برای همه گروههای ستون روی برگه برمیگرداند. |
get Column Group Depth(columnIndex) | Integer | عمق گروه ستون را در اندیس داده شده برمیگرداند. |
get Column Width(columnPosition) | Integer | عرض ستون داده شده را بر حسب پیکسل برمیگرداند. |
get Conditional Format Rules() | Conditional Format Rule[] | تمام قوانین قالببندی شرطی را در این برگه دریافت کنید. |
get Current Cell() | Range |null | سلول فعلی را در برگه فعال برمیگرداند یا اگر سلول فعلی وجود نداشته باشد null برمیگرداند. |
get Data Range() | Range | Range مطابق با ابعادی که دادهها در آن وجود دارند را برمیگرداند. |
get Data Source Formulas() | Data Source Formula[] | تمام فرمولهای منبع داده را دریافت میکند. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | تمام جداول محوری منبع داده را دریافت میکند. |
get Data Source Tables() | Data Source Table[] | تمام جداول منبع داده را دریافت میکند. |
get Developer Metadata() | Developer Metadata[] | تمام فرادادههای توسعهدهنده مرتبط با این برگه را دریافت کنید. |
get Drawings() | Drawing[] | آرایهای از نقاشیهای روی صفحه را برمیگرداند. |
get Filter() | Filter |null | فیلتر موجود در این برگه را برمیگرداند، یا اگر فیلتری وجود نداشته باشد null برمیگرداند. |
get Form Url() | String|null | آدرس اینترنتی فرمی را که پاسخهایش را به این برگه ارسال میکند، برمیگرداند، یا اگر این برگه هیچ فرم مرتبطی نداشته باشد، null برمیگرداند. |
get Frozen Columns() | Integer | تعداد ستونهای فریز شده را برمیگرداند. |
get Frozen Rows() | Integer | تعداد ردیفهای فریز شده را برمیگرداند. |
get Images() | Over Grid Image[] | تمام تصاویر روی شبکه (over-the-grid) روی برگه را برمیگرداند. |
get Index() | Integer | موقعیت برگه را در صفحه گسترده والدش دریافت میکند. |
get Last Column() | Integer | موقعیت آخرین ستونی که محتوا دارد را برمیگرداند. |
get Last Row() | Integer | موقعیت آخرین ردیفی که محتوا دارد را برمیگرداند. |
get Max Columns() | Integer | تعداد فعلی ستونهای موجود در برگه را صرف نظر از محتوا، برمیگرداند. |
get Max Rows() | Integer | تعداد ردیفهای فعلی در برگه را صرف نظر از محتوا، برمیگرداند. |
get Name() | String | نام برگه را برمیگرداند. |
get Named Ranges() | Named Range[] | تمام محدودههای نامگذاری شده در این برگه را دریافت میکند. |
get Parent() | Spreadsheet | Spreadsheet که شامل این برگه است را برمیگرداند. |
get Pivot Tables() | Pivot Table[] | تمام جداول محوری موجود در این برگه را برمیگرداند. |
get Protections(type) | Protection[] | آرایهای از اشیاء را که نشاندهندهی تمام محدودههای محافظتشده در برگه هستند، یا یک آرایهی تکعنصری که نشاندهندهی محافظت روی خود برگه است، دریافت میکند. |
get Range(row, column) | Range | محدودهای را که سلول بالا سمت چپ در مختصات داده شده قرار دارد، برمیگرداند. |
get Range(row, column, numRows) | Range | محدودهای را با سلول بالا سمت چپ در مختصات داده شده و با تعداد ردیفهای داده شده برمیگرداند. |
get Range(row, column, numRows, numColumns) | Range | محدودهای را که سلول بالا سمت چپ در مختصات داده شده با تعداد ردیفها و ستونهای داده شده قرار دارد، برمیگرداند. |
get Range(a1Notation) | Range | محدودهای را که در نمادگذاری A1 یا نمادگذاری R1C1 مشخص شده است، برمیگرداند. |
get Range List(a1Notations) | Range List | مجموعه Range List را برمیگرداند که نشاندهنده محدودههای موجود در همان برگه است که توسط یک لیست غیر خالی از نمادهای A1 یا نمادهای R1C1 مشخص شدهاند. |
get Row Group(rowIndex, groupDepth) | Group |null | گروه ردیف را در اندیس و عمق گروه داده شده برمیگرداند. |
get Row Group Control Position() | Group Control Toggle Position | Group Control Toggle Position برای همه گروههای ردیف روی برگه برمیگرداند. |
get Row Group Depth(rowIndex) | Integer | عمق گروه ردیف را در اندیس داده شده برمیگرداند. |
get Row Height(rowPosition) | Integer | ارتفاع ردیف داده شده را بر حسب پیکسل برمیگرداند. |
get Selection() | Selection | Selection فعلی را در صفحه گسترده برمیگرداند. |
get Sheet Id() | Integer | شناسهی برگهای که توسط این شیء نمایش داده میشود را برمیگرداند. |
get Sheet Name() | String | نام برگه را برمیگرداند. |
get Sheet Values(startRow, startColumn, numRows, numColumns) | Object[][] | شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع میشود، برمیگرداند. |
get Slicers() | Slicer[] | آرایهای از برشدهندههای (slicer) روی برگه را برمیگرداند. |
get Tab Color Object() | Color |null | رنگ زبانه برگه را برمیگرداند، یا اگر زبانه برگه رنگی نداشته باشد null برمیگرداند. |
get Type() | Sheet Type | نوع برگه را برمیگرداند. |
has Hidden Gridlines() | Boolean | اگر خطوط شبکهای صفحه پنهان باشند، مقدار true و در غیر این صورت false را برمیگرداند. |
hide Column(column) | void | ستون یا ستونهای موجود در محدوده داده شده را پنهان میکند. |
hide Columns(columnIndex) | void | یک ستون را در اندیس داده شده پنهان میکند. |
hide Columns(columnIndex, numColumns) | void | یک یا چند ستون متوالی را که از اندیس داده شده شروع میشوند، پنهان میکند. |
hide Row(row) | void | ردیفهای موجود در محدوده داده شده را پنهان میکند. |
hide Rows(rowIndex) | void | ردیف را در اندیس داده شده پنهان میکند. |
hide Rows(rowIndex, numRows) | void | یک یا چند ردیف متوالی را که از اندیس داده شده شروع میشوند، پنهان میکند. |
hide Sheet() | Sheet | این برگه را پنهان میکند. |
insert Chart(chart) | void | یک نمودار جدید به این برگه اضافه میکند. |
insert Column After(afterPosition) | Sheet | یک ستون را بعد از موقعیت ستون داده شده درج میکند. |
insert Column Before(beforePosition) | Sheet | یک ستون را قبل از موقعیت ستون داده شده درج میکند. |
insert Columns(columnIndex) | void | یک ستون خالی را در محل مشخص شده در یک برگه درج میکند. |
insert Columns(columnIndex, numColumns) | void | یک یا چند ستون خالی متوالی را در یک برگه با شروع از محل مشخص شده درج میکند. |
insert Columns After(afterPosition, howMany) | Sheet | تعداد مشخصی ستون را بعد از موقعیت ستون داده شده درج میکند. |
insert Columns Before(beforePosition, howMany) | Sheet | تعدادی ستون را قبل از موقعیت ستون داده شده درج میکند. |
insert Image(blobSource, column, row) | Over Grid Image | یک Blob Source به عنوان تصویر در سند در یک ردیف و ستون مشخص درج میکند. |
insert Image(blobSource, column, row, offsetX, offsetY) | Over Grid Image | یک Blob Source را به عنوان تصویر در سند، در یک سطر و ستون مشخص، با یک فاصله پیکسلی درج میکند. |
insert Image(url, column, row) | Over Grid Image | یک تصویر را در سند در یک ردیف و ستون مشخص درج میکند. |
insert Image(url, column, row, offsetX, offsetY) | Over Grid Image | تصویری را در سند، در یک سطر و ستون مشخص، با یک فاصله پیکسلی درج میکند. |
insert Row After(afterPosition) | Sheet | یک ردیف بعد از موقعیت ردیف داده شده درج میکند. |
insert Row Before(beforePosition) | Sheet | یک ردیف قبل از موقعیت ردیف داده شده درج میکند. |
insert Rows(rowIndex) | void | یک ردیف خالی را در محل مشخص شده در یک برگه درج میکند. |
insert Rows(rowIndex, numRows) | void | یک یا چند ردیف خالی متوالی را در یک برگه با شروع از محل مشخص شده درج میکند. |
insert Rows After(afterPosition, howMany) | Sheet | تعدادی ردیف را بعد از موقعیت ردیف داده شده درج میکند. |
insert Rows Before(beforePosition, howMany) | Sheet | تعدادی ردیف را قبل از موقعیت ردیف داده شده درج میکند. |
insert Slicer(range, anchorRowPos, anchorColPos) | Slicer | یک برشدهنده جدید به این برگه اضافه میکند. |
insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | یک برشدهنده جدید به این برگه اضافه میکند. |
is Column Hidden By User(columnPosition) | Boolean | مشخص میکند که آیا ستون داده شده توسط کاربر پنهان شده است یا خیر. |
is Right To Left() | Boolean | اگر طرحبندی این برگه از راست به چپ باشد، true را برمیگرداند. |
is Row Hidden By Filter(rowPosition) | Boolean | برمیگرداند که آیا ردیف داده شده توسط یک فیلتر (نه یک نمای فیلتر) پنهان شده است یا خیر. |
is Row Hidden By User(rowPosition) | Boolean | برمیگرداند که آیا ردیف داده شده توسط کاربر پنهان شده است یا خیر. |
is Sheet Hidden() | Boolean | اگر برگه در حال حاضر پنهان باشد، true را برمیگرداند. |
move Columns(columnSpec, destinationIndex) | void | ستونهای انتخاب شده توسط محدوده داده شده را به موقعیتی که توسط destination Index مشخص شده است، منتقل میکند. |
move Rows(rowSpec, destinationIndex) | void | ردیفهای انتخاب شده توسط محدوده داده شده را به موقعیتی که توسط destination Index نشان داده شده است، منتقل میکند. |
new Chart() | Embedded Chart Builder | یک سازنده را برمیگرداند تا نمودار جدیدی برای این برگه ایجاد کند. |
protect() | Protection | یک شیء ایجاد میکند که میتواند از ویرایش برگه به جز توسط کاربرانی که مجوز دارند، جلوگیری کند. |
remove Chart(chart) | void | یک نمودار را از برگه والد حذف میکند. |
set Active Range(range) | Range | محدوده مشخص شده را به عنوان active range در برگه فعال، با سلول بالا سمت چپ در محدوده به عنوان current cell تنظیم میکند. |
set Active Range List(rangeList) | Range List | لیست مشخص شده از محدودهها را به عنوان active ranges در برگه فعال تنظیم میکند. |
set Active Selection(range) | Range | ناحیه انتخاب فعال را برای این برگه تنظیم میکند. |
set Active Selection(a1Notation) | Range | انتخاب فعال را مطابق با نمادگذاری A1 یا نمادگذاری R1C1 تعیین میکند. |
set Column Group Control Position(position) | Sheet | موقعیت دکمه کنترل گروه ستون را روی برگه تنظیم میکند. |
set Column Width(columnPosition, width) | Sheet | عرض ستون داده شده را بر حسب پیکسل تنظیم میکند. |
set Column Widths(startColumn, numColumns, width) | Sheet | عرض ستونهای داده شده را بر حسب پیکسل تنظیم میکند. |
set Conditional Format Rules(rules) | void | تمام قوانین قالببندی شرطی موجود در برگه را با قوانین ورودی جایگزین میکند. |
set Current Cell(cell) | Range | سلول مشخص شده را به عنوان current cell تنظیم میکند. |
set Frozen Columns(columns) | void | تعداد ستونهای داده شده را ثابت نگه میدارد. |
set Frozen Rows(rows) | void | تعداد ردیفهای داده شده را ثابت نگه میدارد. |
set Hidden Gridlines(hideGridlines) | Sheet | خطوط شبکهای صفحه را پنهان یا آشکار میکند. |
set Name(name) | Sheet | نام برگه را تنظیم میکند. |
set Right To Left(rightToLeft) | Sheet | طرحبندی برگه را به راست به چپ تنظیم یا از حالت تنظیم خارج میکند. |
set Row Group Control Position(position) | Sheet | موقعیت دکمه کنترل گروه ردیف را روی برگه تنظیم میکند. |
set Row Height(rowPosition, height) | Sheet | ارتفاع ردیف داده شده را بر حسب پیکسل تنظیم میکند. |
set Row Heights(startRow, numRows, height) | Sheet | ارتفاع سطرهای داده شده را بر حسب پیکسل تنظیم میکند. |
set Row Heights Forced(startRow, numRows, height) | Sheet | ارتفاع سطرهای داده شده را بر حسب پیکسل تنظیم میکند. |
set Tab Color(color) | Sheet | رنگ تب برگه را تنظیم میکند. |
set Tab Color Object(color) | Sheet | رنگ تب برگه را تنظیم میکند. |
show Columns(columnIndex) | void | ستون را در اندیس داده شده، از حالت مخفی خارج میکند. |
show Columns(columnIndex, numColumns) | void | یک یا چند ستون متوالی را که از اندیس داده شده شروع میشوند، آشکار میکند. |
show Rows(rowIndex) | void | سطر را در اندیس داده شده، از حالت مخفی خارج میکند. |
show Rows(rowIndex, numRows) | void | یک یا چند ردیف متوالی را که از اندیس داده شده شروع میشوند، آشکار میکند. |
show Sheet() | Sheet | باعث میشود برگه قابل مشاهده باشد. |
sort(columnPosition) | Sheet | یک برگه را بر اساس ستون، به صورت صعودی مرتب میکند. |
sort(columnPosition, ascending) | Sheet | یک برگه را بر اساس ستون مرتب میکند. |
unhide Column(column) | void | ستون را در محدوده داده شده از حالت مخفی خارج میکند. |
unhide Row(row) | void | ردیف را در محدوده داده شده از حالت مخفی خارج میکند. |
update Chart(chart) | void | نمودار این برگه را بهروزرسانی میکند. |
مستندات دقیق
activate()
این برگه را فعال میکند. خود برگه را تغییر نمیدهد، فقط مفهوم برگه فعال را که والد تعیین کرده است، تغییر میدهد.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.activate();
بازگشت
Sheet — برگهای که به تازگی فعال شده است.
add Developer Metadata(key)
متادیتای توسعهدهنده را با کلید مشخصشده به برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME'); // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
key | String | کلید فراداده جدید توسعهدهنده. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
add Developer Metadata(key, visibility)
فرادادههای توسعهدهنده را با کلید و قابلیت مشاهدهی مشخصشده به برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata( 'NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
key | String | کلید فراداده جدید توسعهدهنده. |
visibility | Developer Metadata Visibility | قابلیت مشاهدهی ابردادهی جدید توسعهدهنده. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
add Developer Metadata(key, value)
متادیتای توسعهدهنده را با کلید و مقدار مشخصشده به برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for // the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH'); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
key | String | کلید فراداده جدید توسعهدهنده. |
value | String | مقدار برای ابرداده توسعهدهنده جدید. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
add Developer Metadata(key, value, visibility)
متادیتای توسعهدهنده را با کلید، مقدار و قابلیت مشاهدهی مشخصشده به برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and // sets the visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata( 'COMPANY', 'TECH', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
key | String | کلید فراداده جدید توسعهدهنده. |
value | String | مقدار برای ابرداده توسعهدهنده جدید. |
visibility | Developer Metadata Visibility | قابلیت مشاهدهی ابردادهی جدید توسعهدهنده. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
append Row(rowContents)
یک ردیف به پایین ناحیه داده فعلی در برگه اضافه میکند. اگر محتوای یک سلول با = شروع شود، به عنوان یک فرمول تفسیر میشود.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Appends a new row with 3 columns to the bottom of the current // data region in the sheet containing the values in the array. sheet.appendRow(['a man', 'a plan', 'panama']);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Contents | Object[] | آرایهای از مقادیر که باید بعد از آخرین ردیف در برگه درج شود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
as Data Source Sheet()
اگر برگه از نوع Sheet Type.DATASOURCE باشد، آن را به عنوان یک Data Source Sheet برمیگرداند، و در غیر این صورت null برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
بازگشت
Data Source Sheet |null — یک برگه منبع داده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
auto Resize Column(columnPosition)
عرض ستون داده شده را متناسب با محتوای آن تنظیم میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue( 'Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | موقعیت ستون داده شده برای تغییر اندازه. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
auto Resize Columns(startColumn, numColumns)
عرض تمام ستونها را از موقعیت ستون داده شده شروع میکند تا با محتوای آنها متناسب باشد.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Column | Integer | ستون شروع برای تغییر اندازه خودکار. |
num Columns | Integer | تعداد ستونهایی که به صورت خودکار تغییر اندازه میدهند. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
auto Resize Rows(startRow, numRows)
ارتفاع تمام ردیفها را از موقعیت ردیف داده شده شروع میکند تا با محتوای آنها متناسب باشد.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Row | Integer | ردیف شروع برای تغییر اندازه خودکار. |
num Rows | Integer | تعداد ردیفهایی که به صورت خودکار تغییر اندازه میدهند. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear()
محتوای برگه و اطلاعات قالببندی را پاک میکند.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clear();
بازگشت
Sheet — برگه پاکشده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear(options)
محتویات و/یا قالب برگه را، همانطور که با گزینههای پیشرفته داده شده مشخص شده است، پاک میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.clear({formatOnly: true, contentsOnly: true});
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
options | Object | یک نقشه جاوا اسکریپت حاوی گزینههای پیشرفته، که در زیر فهرست شدهاند. |
پارامترهای پیشرفته
| نام | نوع | توضیحات |
|---|---|---|
contents Only | Boolean | اینکه آیا محتوا پاک شود یا خیر. |
format Only | Boolean | آیا قالب را پاک کنیم یا نه. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear Conditional Format Rules()
تمام قوانین قالببندی شرطی را از برگه حذف میکند. معادل فراخوانی set Conditional Format Rules(rules) با یک آرایه خالی به عنوان ورودی است.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear Contents()
محتویات برگه را پاک میکند، در حالی که اطلاعات قالببندی را حفظ میکند.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearContents();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear Formats()
قالببندی برگه را پاک میکند، در حالی که محتویات را حفظ میکند.
قالببندی به نحوه قالببندی دادهها طبق گزینههای مجاز در منوی «قالببندی» (مثلاً: پررنگ، کج، قالببندی شرطی) اشاره دارد و نه عرض یا ارتفاع سلولها.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearFormats();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
clear Notes()
برگه را از تمام یادداشتها پاک میکند.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearNotes();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
collapse All Column Groups()
تمام گروههای ستون روی برگه را جمع میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
collapse All Row Groups()
تمام گروههای ردیف روی برگه را جمع میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
copy To(spreadsheet)
برگه را در یک صفحه گسترده (spreadsheet) مشخص کپی میکند، که میتواند همان صفحه گسترده منبع باشد. برگه کپی شده "کپی از [نام اصلی]" نامگذاری میشود.
const source = SpreadsheetApp.getActiveSpreadsheet(); const sheet = source.getSheets()[0]; const destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
spreadsheet | Spreadsheet | صفحهگستردهای که قرار است این برگه در آن کپی شود، که میتواند همان صفحهگستردهای باشد که منبع در آن قرار دارد. |
بازگشت
Sheet — برگه جدید، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
create Developer Metadata Finder()
یک Developer Metadata Finder برای یافتن فراداده توسعهدهنده در محدوده این برگه برمیگرداند. فراداده در صورتی در محدوده یک برگه خاص است که یا با خود برگه مرتبط باشد، یا با یک ردیف، ستون یا محدوده در آن برگه مرتبط باشد.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder(); // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());
بازگشت
Developer Metadata Finder — یابندهی فرادادهی توسعهدهنده برای جستجوی فراداده در محدودهی این برگه.
create Text Finder(findText)
یک یابنده متن برای برگه ایجاد میکند که میتواند متن درون برگه را پیدا و جایگزین کند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. const textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. const firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
find Text | String | متنی که باید جستجو شود. |
بازگشت
Text Finder — Text Finder برای برگه.
delete Column(columnPosition)
ستون را در موقعیت ستون داده شده حذف میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | موقعیت ستون، که از عدد ۱ برای ستون اول شروع میشود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
delete Columns(columnPosition, howMany)
تعدادی ستون را که از موقعیت ستون داده شده شروع میشوند، حذف میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | موقعیت اولین ستونی که قرار است حذف شود. |
how Many | Integer | تعداد ستونهایی که باید حذف شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
delete Row(rowPosition)
ردیف را در موقعیت ردیف داده شده حذف میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | موقعیت ردیف، که از ۱ برای ردیف اول شروع میشود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
delete Rows(rowPosition, howMany)
تعدادی از ردیفها را از موقعیت ردیف داده شده حذف میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | موقعیت اولین ردیفی که باید حذف شود. |
how Many | Integer | تعداد ردیفهایی که باید حذف شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
expand All Column Groups()
تمام گروههای ستونی روی برگه را گسترش میدهد. این روش حداقل به یک گروه ستون نیاز دارد.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
expand All Row Groups()
تمام گروههای ردیف را در صفحه گسترش میدهد. این روش حداقل به یک گروه ردیف نیاز دارد.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
expand Column Groups Up To Depth(groupDepth)
تمام گروههای ستون را تا عمق داده شده گسترش میدهد و بقیه را جمع میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
group Depth | Integer | عمق گروهی که گروههای ستونی تا آن گسترش مییابند. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
expand Row Groups Up To Depth(groupDepth)
تمام گروههای ردیف را تا عمق داده شده گسترش میدهد و بقیه را جمع میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
group Depth | Integer | عمق گروهی که گروههای ردیف تا آن گسترش مییابند. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Cell()
سلول فعال در این برگه را برمیگرداند.
نکته: بهتر است از get Current Cell() استفاده کنید که سلول هایلایت شده فعلی را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Returns the active cell const cell = sheet.getActiveCell();
بازگشت
Range — سلول فعال فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Range()
محدوده انتخاب شده در برگه فعال را برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null برمیگرداند. اگر چندین محدوده انتخاب شده باشند، این روش فقط آخرین محدوده انتخاب شده را برمیگرداند.
اصطلاح «محدوده فعال» به محدودهای اشاره دارد که کاربر در برگه فعال انتخاب کرده است، اما در یک تابع سفارشی به سلولی اشاره دارد که به طور فعال دوباره محاسبه میشود.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const activeRange = sheet.getActiveRange();
بازگشت
Range — محدوده فعال.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
همچنین ببینید
get Active Range List()
لیست محدودههای فعال در برگه فعال را برمیگرداند یا اگر هیچ محدوده فعالی وجود نداشته باشد null برمیگرداند.
اگر یک محدوده انتخاب شده باشد، این تابع مانند فراخوانی تابع get Active Range() عمل میکند.
const sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. const activeRangeList = sheet.getActiveRangeList();
بازگشت
Range List |null — فهرست محدودههای فعال.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
همچنین ببینید
get Bandings()
تمام نوارهای موجود در این برگه را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the banding info for the sheet. const bandings = sheet.getBandings(); // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) { console.log(banding.getSecondRowColor()); }
بازگشت
Banding[] — تمام banding های موجود در این برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Charts()
آرایهای از نمودارها را در این برگه برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const charts = sheet.getCharts(); for (const i in charts) { const chart = charts[i]; // Do something with the chart }
بازگشت
Embedded Chart[] — آرایهای از نمودارها.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Column Group(columnIndex, groupDepth)
گروه ستون را در اندیس و عمق گروه داده شده برمیگرداند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. const columnGroup = sheet.getColumnGroup(2, 1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | شاخص ستونِ دکمهی کنترل گروه یا شاخصی درون گروه. |
group Depth | Integer | عمق گروه. |
بازگشت
Group |null — گروه ستون در اندیس و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد میکند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Column Group Control Position()
Group Control Toggle Position برای همه گروههای ستون روی برگه برمیگرداند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is // shown after the group. const columnGroupControlPosition = sheet.getColumnGroupControlPosition();
بازگشت
Group Control Toggle Position - اگر دکمه کنترل گروهبندی ستون بعد از گروهبندی در این برگه نمایش داده شود، true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Column Group Depth(columnIndex)
عمق گروه ستون را در اندیس داده شده برمیگرداند.
عمق گروه نشان میدهد که چند گروه با ستون همپوشانی دارند. این میتواند بین صفر تا هشت باشد.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 const groupDepth = sheet.getColumnGroupDepth(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | شاخص ستون. |
بازگشت
Integer - عمق گروه ستون در اندیس داده شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Column Width(columnPosition)
عرض ستون داده شده را بر حسب پیکسل برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | موقعیت ستون مورد بررسی. |
بازگشت
Integer - عرض ستون بر حسب پیکسل.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Conditional Format Rules()
تمام قوانین قالببندی شرطی را در این برگه دریافت کنید.
// Logs the conditional format rules in a sheet. const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (let i = 0; i < rules.length; i++) { const rule = rules[i]; Logger.log(rule); }
بازگشت
Conditional Format Rule[] — آرایهای از تمام قواعد موجود در برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Current Cell()
سلول فعلی در برگه فعال را برمیگرداند یا اگر سلول فعلی وجود نداشته باشد، null برمیگرداند. سلول فعلی سلولی است که در رابط کاربری Google Sheets فوکوس دارد و با یک حاشیه تیره برجسته شده است. هرگز بیش از یک سلول فعلی وجود ندارد. وقتی کاربر یک یا چند محدوده سلولی را انتخاب میکند، یکی از سلولهای موجود در انتخاب، سلول فعلی است.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. const currentCell = sheet.getCurrentCell();
بازگشت
Range |null — سلول فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Data Range()
Range مطابق با ابعادی که دادهها در آن وجود دارند را برمیگرداند.
این از نظر عملکردی معادل ایجاد یک محدوده محدود شده توسط A1 و (Sheet.getLastColumn(), Sheet.getLastRow()) است.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This represents ALL the data const range = sheet.getDataRange(); const values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (let i = 0; i < values.length; i++) { let row = ''; for (let j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = `${row},`; } Logger.log(row); }
بازگشت
Range - محدودهای شامل تمام دادههای موجود در صفحه گسترده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Data Source Formulas()
تمام فرمولهای منبع داده را دریافت میکند.
// Opens the spreadsheet by its ID. If you created your script from within a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source formulas on Sheet1. // To get an array of data source formulas for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceFormulas = sheet.getDataSourceFormulas(); // Logs the first data source formula in the array. console.log(dataSourceFormulas[0].getFormula());
بازگشت
Data Source Formula[] — فهرستی از فرمولهای منبع داده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Data Source Pivot Tables()
تمام جداول محوری منبع داده را دریافت میکند.
// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source pivot tables on Sheet1. // To get an array of data source pivot tables for the entire // spreadsheet, replace 'sheet' with 'ss'. const dataSourcePivotTables = sheet.getDataSourcePivotTables(); // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());
بازگشت
Data Source Pivot Table[] — فهرستی از جداول محوری منبع داده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Data Source Tables()
تمام جداول منبع داده را دریافت میکند.
// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of data source tables on Sheet1. // To get an array of data source tables for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceTables = sheet.getDataSourceTables(); // Logs the last completed data execution time on the first data source table. console.log(dataSourceTables[0].getStatus().getLastExecutionTime());
بازگشت
Data Source Table[] — فهرستی از جداول منبع داده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Developer Metadata()
تمام فرادادههای توسعهدهنده مرتبط با این برگه را دریافت کنید.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata(); // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) { console.log(developerMetaData.getKey()); }
بازگشت
Developer Metadata[] — فراداده توسعهدهنده مرتبط با این برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Drawings()
آرایهای از نقاشیهای روی صفحه را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings(); // Logs the number of drawings present on the sheet. console.log(allDrawings.length);
بازگشت
Drawing[] — فهرست نقشههای موجود در این برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Filter()
فیلتر موجود در این برگه را برمیگرداند، یا اگر فیلتری وجود نداشته باشد null برمیگرداند.
// Gets the filter on the active sheet. const ss = SpreadsheetApp.getActiveSheet(); const filter = ss.getFilter();
بازگشت
Filter |null — فیلتر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Form Url()
آدرس اینترنتی (URL) فرمی را که پاسخهایش را به این برگه ارسال میکند، برمیگرداند، یا اگر این برگه هیچ فرم مرتبطی نداشته باشد، null برمیگرداند. اگر کاربر اجازه ویرایش صفحه گسترده را نداشته باشد، یک استثنا ایجاد میکند.
const sheet = SpreadsheetApp.getActiveSheet(); const url = sheet.getFormUrl();
بازگشت
String|null — آدرس اینترنتی فرمی که پاسخهایش را در این برگه قرار میدهد، یا null اگر این برگه فرم مرتبطی نداشته باشد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Frozen Columns()
تعداد ستونهای فریز شده را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());
بازگشت
Integer - تعداد ستونهای فریز شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Frozen Rows()
تعداد ردیفهای فریز شده را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());
بازگشت
Integer - تعداد ردیفهای فریز شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Images()
تمام تصاویر روی شبکه (over-the-grid) روی برگه را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets spreadsheet, you can use // SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the over-the-grid images from Sheet1. // To get the over-the-grid images from the entire spreadsheet, use // ss.getImages() instead. const images = sheet.getImages(); // For each image, logs the anchor cell in A1 notation. for (const image of images) { console.log(image.getAnchorCell().getA1Notation()); }
بازگشت
Over Grid Image[] — آرایهای از تصاویر روی شبکه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Index()
موقعیت برگه را در صفحه گسترده والدش دریافت میکند. از ۱ شروع میشود.
const ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 const sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
بازگشت
Integer - موقعیت برگه در صفحه گسترده والدش.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Last Column()
موقعیت آخرین ستونی که محتوا دارد را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet const lastRow = sheet.getLastRow(); const lastColumn = sheet.getLastColumn(); const lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
بازگشت
Integer - آخرین ستون برگه که شامل محتوا است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Last Row()
موقعیت آخرین ردیفی که محتوا دارد را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet const lastRow = sheet.getLastRow(); const lastColumn = sheet.getLastColumn(); const lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
بازگشت
Integer - آخرین ردیف برگه که شامل محتوا است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Max Columns()
تعداد فعلی ستونهای موجود در برگه را صرف نظر از محتوا، برمیگرداند.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxColumns());
بازگشت
Integer - حداکثر عرض ورق.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Max Rows()
تعداد ردیفهای فعلی در برگه را صرف نظر از محتوا، برمیگرداند.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxRows());
بازگشت
Integer - حداکثر ارتفاع ورق.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Name()
نام برگه را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
بازگشت
String — نام برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Named Ranges()
تمام محدودههای نامگذاری شده در این برگه را دریافت میکند.
// The code below logs the name of the first named range. const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
بازگشت
Named Range[] — آرایهای از تمام محدودههای نامگذاری شده در برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Parent()
Spreadsheet که شامل این برگه است را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // parent is identical to ss const parent = sheet.getParent();
بازگشت
Spreadsheet — صفحه گسترده والد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Pivot Tables()
تمام جداول محوری موجود در این برگه را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables(); // Logs the pivot tables to the console. for (const pivotTable of pivotTables) { console.log(pivotTable.getSourceDataRange().getValues()); }
بازگشت
Pivot Table[] — جداول محوری در این برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Protections(type)
آرایهای از اشیاء را که نشاندهندهی تمام محدودههای محافظتشده در برگه هستند، یا یک آرایهی تکعنصری که نشاندهندهی محافظت روی خود برگه است، دریافت میکند.
// Remove all range protections in the spreadsheet that the user has permission // to edit. const sheet = SpreadsheetApp.getActiveSheet(); const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (let i = 0; i < protections.length; i++) { const protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to // edit it. const sheet = SpreadsheetApp.getActiveSheet(); const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection?.canEdit()) { protection.remove(); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
type | Protection Type | نوع منطقه حفاظتشده، یا Spreadsheet App.ProtectionType.RANGE یا Spreadsheet App.ProtectionType.SHEET . |
بازگشت
Protection[] — آرایهای از اشیاء که نشاندهندهی تمام محدودههای محافظتشده در صفحه هستند، یا یک آرایهی تکعنصری که نشاندهندهی محافظت روی خود صفحه است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Range(row, column)
محدودهای را که سلول بالا سمت چپ در مختصات داده شده قرار دارد، برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. const range = sheet.getRange(1, 1); const values = range.getValues(); Logger.log(values[0][0]);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row | Integer | اندیس ردیف سلولی که قرار است برگردانده شود؛ اندیسگذاری ردیف با ۱ شروع میشود. |
column | Integer | اندیس ستون سلولی که قرار است برگردانده شود؛ اندیسگذاری ستون با ۱ شروع میشود. |
بازگشت
Range - محدودهای که فقط شامل این سلول باشد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Range(row, column, numRows)
محدودهای را با سلول بالا سمت چپ در مختصات داده شده و با تعداد ردیفهای داده شده برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is // returned. const range = sheet.getRange(1, 1, 3); const values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (const row in values) { for (const col in values[row]) { Logger.log(values[row][col]); } }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row | Integer | اندیس ردیف شروع محدوده؛ اندیسگذاری ردیف با ۱ شروع میشود. |
column | Integer | اندیس ستون محدوده؛ اندیسگذاری ستون با ۱ شروع میشود. |
num Rows | Integer | تعداد ردیفهایی که باید برگردانده شوند. |
بازگشت
Range - محدودهای شامل یک ستون از دادهها با تعداد ردیفهای مشخص شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Range(row, column, numRows, numColumns)
محدودهای را که سلول بالا سمت چپ در مختصات داده شده با تعداد ردیفها و ستونهای داده شده قرار دارد، برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange(1, 1, 3, 3); const values = range.getValues(); // Print values from a 3x3 box. for (const row in values) { for (const col in values[row]) { Logger.log(values[row][col]); } }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row | Integer | اندیس ردیف شروع محدوده؛ اندیسگذاری ردیف با ۱ شروع میشود. |
column | Integer | اندیس ستون شروع محدوده؛ اندیسگذاری ستون با ۱ شروع میشود. |
num Rows | Integer | تعداد ردیفهایی که باید برگردانده شوند. |
num Columns | Integer | تعداد ستونهایی که باید برگردانده شوند. |
بازگشت
Range — محدودهای مربوط به ناحیه مشخص شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Range(a1Notation)
محدودهای را که در نمادگذاری A1 یا نمادگذاری R1C1 مشخص شده است، برمیگرداند.
// Get a range A1:D4 on sheet titled "Invoices" const ss = SpreadsheetApp.getActiveSpreadsheet(); const range = ss.getRange('Invoices!A1:D4'); // Get cell A1 on the first sheet const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
a1Notation | String | محدودهای که باید برگردانده شود، همانطور که در نمادگذاری A1 یا نمادگذاری R1C1 مشخص شده است. |
بازگشت
Range — محدوده در محل تعیین شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Range List(a1Notations)
مجموعه Range List را برمیگرداند که نشاندهنده محدودههای موجود در همان برگه است که توسط یک لیست غیر خالی از نمادهای A1 یا نمادهای R1C1 مشخص شدهاند.
// Get a list of ranges A1:D4, F1:H4. const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
a1Notations | String[] | فهرست محدودههایی که باید برگردانده شوند، همانطور که در نمادگذاری A1 یا نمادگذاری R1C1 مشخص شده است. |
بازگشت
Range List — فهرست محدوده در محل تعیین شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Row Group(rowIndex, groupDepth)
گروه ردیف را در اندیس و عمق گروه داده شده برمیگرداند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. const rowGroup = sheet.getRowGroup(2, 1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | شاخص ردیفِ دکمهی کنترل گروه یا شاخصی درون گروه. |
group Depth | Integer | عمق گروه. |
بازگشت
Group |null — گروه ردیف در اندیس و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد میکند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Row Group Control Position()
Group Control Toggle Position برای همه گروههای ردیف روی برگه برمیگرداند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown // after the group. const rowGroupControlPosition = sheet.getRowGroupControlPosition();
بازگشت
Group Control Toggle Position - اگر دکمه کنترل گروهبندی ردیفها بعد از گروهبندی در این برگه نمایش داده شود، true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Row Group Depth(rowIndex)
عمق گروه ردیف را در اندیس داده شده برمیگرداند.
عمق گروه نشان میدهد که چند گروه با ردیف همپوشانی دارند. این میتواند بین صفر تا هشت باشد.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 const groupDepth = sheet.getRowGroupDepth(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | شاخص ردیف. |
بازگشت
Integer - عمق گروه ردیف در اندیس داده شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Row Height(rowPosition)
ارتفاع ردیف داده شده را بر حسب پیکسل برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | موقعیت ردیفی که باید بررسی شود. |
بازگشت
Integer - ارتفاع ردیف بر حسب پیکسل.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Selection()
Selection فعلی را در صفحه گسترده برمیگرداند.
const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); const currentCell = selection.getCurrentCell();
بازگشت
Selection — انتخاب فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Sheet Id()
شناسهی برگهای که توسط این شیء نمایش داده میشود را برمیگرداند.
این یک شناسه برای برگه است که مختص صفحه گسترده است. شناسه یک عدد صحیح یکنواخت افزایشی است که در زمان ایجاد برگه اختصاص داده میشود و مستقل از موقعیت برگه است. این در رابطه با روشهایی مانند Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) که یک پارامتر grid Id به جای یک نمونه Sheet میگیرند، مفید است.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
بازگشت
Integer - شناسهای برای برگه که مختص صفحه گسترده است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Sheet Name()
نام برگه را برمیگرداند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
بازگشت
String — نام برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Sheet Values(startRow, startColumn, numRows, numColumns)
شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع میشود، برمیگرداند. مقدار -1 که به عنوان موقعیت ردیف یا ستون داده میشود، معادل دریافت آخرین ردیف یا ستونی است که در برگه داده دارد.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The two samples below produce the same output let values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); const range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Row | Integer | موقعیت ردیف شروع. |
start Column | Integer | موقعیت ستون شروع. |
num Rows | Integer | تعداد ردیفهایی که باید مقادیرشان را برگردانیم. |
num Columns | Integer | تعداد ستونهایی که باید مقادیرشان برگردانده شود. |
بازگشت
Object[][] — یک آرایه دو بعدی از مقادیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Slicers()
آرایهای از برشدهندههای (slicer) روی برگه را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers(); // Logs the slicer titles to the console. for (const slicer of slicers) { console.log(slicer.getTitle()); }
بازگشت
Slicer[] — فهرست Slicerهای موجود در این برگه.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Tab Color Object()
رنگ زبانه برگه را برمیگرداند، یا اگر زبانه برگه رنگی نداشته باشد null برمیگرداند.
// This example assumes there is a sheet named "Sheet1" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('Sheet1'); const color = first.getTabColorObject();
بازگشت
Color |null — رنگ زبانه برگه، یا اگر زبانه برگه رنگی نداشته باشد، null .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Type()
نوع برگه را برمیگرداند.
نوع پیشفرض برگه Sheet Type.GRID است. برگهای که شامل یک شیء جاسازیشده مانند یک Embedded Chart باشد، یک برگه Sheet Type.OBJECT است.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
بازگشت
Sheet Type - نوع ورق.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
has Hidden Gridlines()
اگر خطوط شبکهای صفحه پنهان باشند، مقدار true و در غیر این صورت false را برمیگرداند. خطوط شبکهای به طور پیشفرض قابل مشاهده هستند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if the spreadsheet has hidden gridelines and logs the result to the // console. console.log(sheet.hasHiddenGridlines());
بازگشت
Boolean - اگر خطوط شبکه پنهان باشند، true و در غیر این صورت false برمیگرداند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Column(column)
ستون یا ستونهای موجود در محدوده داده شده را پنهان میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange('A1'); sheet.hideColumn(range); // This hides the first 3 columns range = sheet.getRange('A:C'); sheet.hideColumn(range);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column | Range | محدوده ستونی که قرار است پنهان شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Columns(columnIndex)
یک ستون را در اندیس داده شده پنهان میکند. برای این روش از ۱-ایندکس استفاده کنید.
برای مخفی کردن بیش از یک ستون با استفاده از یک اندیس، از hide Columns(columnIndex, numColumns) استفاده کنید.
برای پنهان کردن بیش از یک ستون با استفاده از یک محدوده، از hide Column() استفاده کنید.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | اندیس ستونی که قرار است پنهان شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Columns(columnIndex, numColumns)
یک یا چند ستون متوالی را که از اندیس داده شده شروع میشوند، پنهان میکند. برای این روش از ۱-ایندکس استفاده کنید.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | اندیس شروع ستونهایی که قرار است پنهان شوند. |
num Columns | Integer | تعداد ستونهایی که باید پنهان شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Row(row)
ردیفهای موجود در محدوده داده شده را پنهان میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This hides the first row const range = sheet.getRange('A1'); sheet.hideRow(range);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row | Range | محدودهی ردیفهایی که قرار است پنهان شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Rows(rowIndex)
ردیف را در اندیس داده شده پنهان میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | اندیس سطری که قرار است پنهان شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Rows(rowIndex, numRows)
یک یا چند ردیف متوالی را که از اندیس داده شده شروع میشوند، پنهان میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | اندیس شروع ردیفهایی که قرار است پنهان شوند. |
num Rows | Integer | تعداد ردیفهایی که باید پنهان شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
hide Sheet()
این برگه را پنهان میکند. اگر برگه از قبل پنهان شده باشد، هیچ تاثیری ندارد. اگر این متد روی تنها برگه قابل مشاهده فراخوانی شود، یک استثنا ایجاد میکند.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
بازگشت
Sheet — برگه فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Chart(chart)
یک نمودار جدید به این برگه اضافه میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B4')) .setPosition(5, 5, 0, 0) .setOption('title', 'Dynamic Chart') .build(); sheet.insertChart(chart);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
chart | Embedded Chart | نموداری که باید درج شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Column After(afterPosition)
یک ستون را بعد از موقعیت ستون داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
after Position | Integer | ستونی که ستون جدید باید بعد از آن اضافه شود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Column Before(beforePosition)
یک ستون را قبل از موقعیت ستون داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
before Position | Integer | ستونی که ستون جدید باید قبل از آن اضافه شود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Columns(columnIndex)
یک ستون خالی را در محل مشخص شده در یک برگه درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | اندیسی که نشان میدهد یک ستون کجا درج شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Columns(columnIndex, numColumns)
یک یا چند ستون خالی متوالی را در یک برگه با شروع از محل مشخص شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | اندیسی که نشان میدهد یک ستون کجا درج شود. |
num Columns | Integer | تعداد ستونهایی که باید درج شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Columns After(afterPosition, howMany)
تعداد مشخصی ستون را بعد از موقعیت ستون داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Inserts two columns after the first column on the first sheet of the // spreadsheet. sheet.insertColumnsAfter(1, 2);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
after Position | Integer | ستونی که ستون جدید باید بعد از آن اضافه شود. |
how Many | Integer | تعداد ستونهایی که باید درج شوند. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Columns Before(beforePosition, howMany)
تعدادی ستون را قبل از موقعیت ستون داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
before Position | Integer | ستونی که ستون جدید باید قبل از آن اضافه شود. |
how Many | Integer | تعداد ستونهایی که باید درج شوند. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Image(blobSource, column, row)
یک Blob Source به عنوان تصویر در سند در یک ردیف و ستون مشخص درج میکند. اندازه تصویر از محتویات blob بازیابی میشود. حداکثر اندازه blob پشتیبانی شده ۲ مگابایت است.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const binaryData = []; // TODO(developer): Replace with your binary data. const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
blob Source | Blob Source | حبابی که شامل محتوای تصویر، نوع MIME و (اختیاری) نام آن است. |
column | Integer | موقعیت ستون. |
row | Integer | موقعیت ردیف. |
بازگشت
Over Grid Image - تصویر درج شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Image(blobSource, column, row, offsetX, offsetY)
یک Blob Source به عنوان تصویر در سند در یک سطر و ستون مشخص، با یک فاصله پیکسلی، درج میکند. اندازه تصویر از محتویات blob بازیابی میشود. حداکثر اندازه blob پشتیبانی شده ۲ مگابایت است.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const binaryData = []; // TODO(developer): Replace with your binary data. const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
blob Source | Blob Source | حبابی که شامل محتوای تصویر، نوع MIME و (اختیاری) نام آن است. |
column | Integer | موقعیت ستون. |
row | Integer | موقعیت ردیف. |
offsetX | Integer | فاصله افقی از گوشه سلول بر حسب پیکسل. |
offsetY | Integer | فاصله عمودی از گوشه سلول بر حسب پیکسل. |
بازگشت
Over Grid Image - تصویر درج شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Image(url, column, row)
یک تصویر را در سند در یک ردیف و ستون مشخص درج میکند.
آدرس اینترنتی ارائه شده باید برای عموم قابل دسترسی باشد.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
url | String | آدرس اینترنتی (URL) تصویر. |
column | Integer | موقعیت ستون شبکه. |
row | Integer | موقعیت ردیف شبکه. |
بازگشت
Over Grid Image - تصویر درج شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Image(url, column, row, offsetX, offsetY)
تصویری را در سند، در یک سطر و ستون مشخص، با یک فاصله پیکسلی درج میکند.
آدرس اینترنتی ارائه شده باید برای عموم قابل دسترسی باشد.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage( 'https://www.google.com/images/srpr/logo3w.png', 1, 1, 10, 10, );
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
url | String | آدرس اینترنتی (URL) تصویر. |
column | Integer | موقعیت ستون. |
row | Integer | موقعیت ردیف. |
offsetX | Integer | فاصله افقی از گوشه سلول بر حسب پیکسل. |
offsetY | Integer | فاصله عمودی از گوشه سلول بر حسب پیکسل. |
بازگشت
Over Grid Image - تصویر درج شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Row After(afterPosition)
یک ردیف بعد از موقعیت ردیف داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
after Position | Integer | ردیفی که ردیف جدید باید بعد از آن اضافه شود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Row Before(beforePosition)
یک ردیف قبل از موقعیت ردیف داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
before Position | Integer | ردیفی که ردیف جدید باید قبل از آن اضافه شود. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Rows(rowIndex)
یک ردیف خالی را در محل مشخص شده در یک برگه درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | اندیسی که نشان میدهد یک ردیف کجا درج شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Rows(rowIndex, numRows)
یک یا چند ردیف خالی متوالی را در یک برگه با شروع از محل مشخص شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | اندیسی که نشان میدهد یک ردیف کجا درج شود. |
num Rows | Integer | تعداد ردیفهایی که باید درج شوند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Rows After(afterPosition, howMany)
تعدادی ردیف را بعد از موقعیت ردیف داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
after Position | Integer | ردیفی که ردیفهای جدید باید بعد از آن اضافه شوند. |
how Many | Integer | تعداد ردیفهایی که باید درج شوند. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Rows Before(beforePosition, howMany)
تعدادی ردیف را قبل از موقعیت ردیف داده شده درج میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
before Position | Integer | ردیفی که ردیفهای جدید باید قبل از آن اضافه شوند. |
how Many | Integer | تعداد ردیفهایی که باید درج شوند. |
بازگشت
Sheet — برگه، برای زنجیرهسازی متدها مفید است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Slicer(range, anchorRowPos, anchorColPos)
یک برشدهنده جدید به این برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range of the sheet. const range = sheet.getRange('A1:D10'); // Inserts the slicer with a random range into the sheet. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10); // Logs the insert slicer result to the console. console.log(insertSlicers);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range | Range | محدودهای که slicer روی آن ایجاد میشود. |
anchor Row Pos | Integer | قسمت بالایی برشدهنده در این ردیف محکم شده است. |
anchor Col Pos | Integer | قسمت بالایی برشدهنده در این ستون محکم شده است. |
بازگشت
Slicer - برشدهندهای که تازه وارد شده است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
یک برشدهنده جدید به این برگه اضافه میکند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range. const range = sheet.getRange('A1:D10'); // Inserts a slicer using the random range function. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0); // Logs the insert slicer result to the console. console.log(insertSlicers);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range | Range | محدودهای که slicer روی آن ایجاد میشود. |
anchor Row Pos | Integer | قسمت بالایی برشدهنده در این ردیف محکم شده است. |
anchor Col Pos | Integer | قسمت بالایی برشدهنده در این ستون محکم شده است. |
offsetX | Integer | فاصله افقی از گوشه سلول بر حسب پیکسل. |
offsetY | Integer | فاصله عمودی از گوشه سلول بر حسب پیکسل. |
بازگشت
Slicer - برشدهندهای که تازه وارد شده است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is Column Hidden By User(columnPosition)
مشخص میکند که آیا ستون داده شده توسط کاربر پنهان شده است یا خیر.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | موقعیت ستون مورد بررسی. |
بازگشت
Boolean - اگر ستون پنهان باشد، true و در غیر این صورت false برمیگرداند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is Right To Left()
اگر طرحبندی این برگه از راست به چپ باشد، مقدار true و اگر برگه از طرحبندی پیشفرض چپ به راست استفاده کند، مقدار false را برمیگرداند.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if a spreadsheet is ordered from right to left and logs the result to // the console. console.log(sheet.isRightToLeft());
بازگشت
Boolean - اگر از راست به چپ باشد true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is Row Hidden By Filter(rowPosition)
برمیگرداند که آیا ردیف داده شده توسط یک فیلتر (نه یک نمای فیلتر) پنهان شده است یا خیر.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | موقعیت ردیفی که باید بررسی شود. |
بازگشت
Boolean - اگر ردیف پنهان باشد، true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is Row Hidden By User(rowPosition)
برمیگرداند که آیا ردیف داده شده توسط کاربر پنهان شده است یا خیر.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | موقعیت ردیفی که باید بررسی شود. |
بازگشت
Boolean - اگر ردیف پنهان باشد، true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
is Sheet Hidden()
اگر برگه در حال حاضر پنهان باشد، true را برمیگرداند.
const sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
بازگشت
Boolean - اگر برگه پنهان باشد، true و در غیر این صورت false .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
move Columns(columnSpec, destinationIndex)
ستونهای انتخابشده توسط محدودهی دادهشده را به موقعیتی که توسط destination Index نشان داده شده است، منتقل میکند. لازم نیست خودِ column Spec دقیقاً نشاندهندهی کل یک ستون یا گروهی از ستونها برای جابجایی باشد - تمام ستونهایی را که محدوده در بر میگیرد، انتخاب میکند.
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. const sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. const columnSpec = sheet.getRange('A1:B1'); sheet.moveColumns(columnSpec, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Spec | Range | محدودهای که ستونهایی را که باید جابجا شوند، در بر میگیرد. |
destination Index | Integer | اندیسی که ستونها باید به آن منتقل شوند. توجه داشته باشید که این اندیس بر اساس مختصات قبل از جابجایی ستونها تعیین میشود. دادههای موجود به سمت راست منتقل میشوند تا فضای کافی برای ستونهای منتقل شده ایجاد شود، در حالی که ستونهای منبع از شبکه حذف میشوند. بنابراین، دادهها ممکن است در اندیسی متفاوت از آنچه در ابتدا مشخص شده بود، قرار گیرند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
move Rows(rowSpec, destinationIndex)
ردیفهای انتخابشده توسط محدودهی دادهشده را به موقعیتی که توسط destination Index نشان داده شده است، منتقل میکند. لازم نیست خودِ row Spec دقیقاً نشاندهندهی یک ردیف کامل یا گروهی از ردیفها برای جابجایی باشد - تمام ردیفهایی را که محدوده در بر میگیرد، انتخاب میکند.
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. const sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. const rowSpec = sheet.getRange('A1:A2'); sheet.moveRows(rowSpec, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Spec | Range | محدودهای که ردیفهایی را که باید جابجا شوند، در بر میگیرد. |
destination Index | Integer | اندیسی که ردیفها باید به آن منتقل شوند. توجه داشته باشید که این اندیس بر اساس مختصات قبل از جابجایی ردیفها تعیین میشود. دادههای موجود به پایین منتقل میشوند تا فضای کافی برای ردیفهای منتقل شده ایجاد شود، در حالی که ردیفهای منبع از شبکه حذف میشوند. بنابراین، دادهها ممکن است در اندیسی متفاوت از آنچه در ابتدا مشخص شده بود، قرار گیرند. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
new Chart()
یک سازنده را برمیگرداند تا نمودار جدیدی برای این برگه ایجاد کند.
این مثال نحوه ایجاد یک نمودار جدید را نشان میدهد:
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:B8'); const chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
بازگشت
Embedded Chart Builder - سازندهای برای ایجاد نمودار جدید.
protect()
شیءای ایجاد میکند که میتواند از ویرایش برگه به جز توسط کاربرانی که مجوز دارند، محافظت کند. تا زمانی که اسکریپت واقعاً لیست ویرایشگرهای برگه را تغییر ندهد (با فراخوانی Protection.removeEditor(emailAddress) ، Protection.removeEditor(user) ، Protection.removeEditors(emailAddresses) ، Protection.addEditor(emailAddress) ، Protection.addEditor(user) ، Protection.addEditors(emailAddresses) ، یا تنظیم مقدار جدیدی برای Protection.setDomainEdit(editable) )، مجوزها منعکسکنندهی مجوزهای خود صفحه گسترده هستند، که در واقع به این معنی است که برگه بدون محافظت باقی میماند. اگر برگه از قبل محافظت شده باشد، این متد شیءای را برمیگرداند که نشاندهندهی تنظیمات حفاظتی موجود آن است. یک برگه محافظت شده ممکن است شامل نواحی محافظت نشده باشد.
// Protect the active sheet, then remove all other users from the list of // editors. const sheet = SpreadsheetApp.getActiveSheet(); const protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if // the user's edit permission comes from a group, the script throws an exception // upon removing the group. const me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
بازگشت
Protection — شیءای که تنظیمات حفاظت را نشان میدهد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
remove Chart(chart)
یک نمودار را از برگه والد حذف میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet const charts = sheet.getCharts(); for (const i in charts) { sheet.removeChart(charts[i]); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
chart | Embedded Chart | نموداری که باید حذف شود. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Active Range(range)
محدوده مشخص شده را به عنوان active range در برگه فعال، با سلول بالا سمت چپ در محدوده به عنوان current cell تنظیم میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); const selection = sheet.getSelection(); // Current cell: A1 const currentCell = selection.getCurrentCell(); // Active Range: A1:D4 const activeRange = selection.getActiveRange();
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range | Range | محدودهای که به عنوان محدوده فعال تنظیم میشود. |
بازگشت
Range — محدوده تازه فعال شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Active Range List(rangeList)
لیست مشخص شده از محدودهها را به عنوان active ranges در برگه فعال تنظیم میکند. آخرین محدوده در لیست به عنوان active range تنظیم میشود.
const sheet = SpreadsheetApp.getActiveSheet(); const rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); const selection = sheet.getSelection(); // Current cell: B2 const currentCell = selection.getCurrentCell(); // Active range: B2:C4 const activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] const activeRangeList = selection.getActiveRangeList();
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range List | Range List | لیست محدودههایی که باید انتخاب شوند. |
بازگشت
Range List — فهرست محدودههای انتخابشدهی جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Active Selection(range)
ناحیه انتخاب فعال را برای این برگه تنظیم میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D4'); sheet.setActiveSelection(range);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range | Range | محدودهای که قرار است به عنوان انتخاب فعال تعیین شود. |
بازگشت
Range — محدوده تازه فعال شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Active Selection(a1Notation)
انتخاب فعال را مطابق با نمادگذاری A1 یا نمادگذاری R1C1 تعیین میکند.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.setActiveSelection('A1:D4');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
a1Notation | String | محدودهای که باید به عنوان فعال تنظیم شود، همانطور که در نمادگذاری A1 یا نمادگذاری R1C1 مشخص شده است. |
بازگشت
Range — محدوده تازه فعال شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Column Group Control Position(position)
موقعیت دکمه کنترل گروه ستون را روی برگه تنظیم میکند.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
position | Group Control Toggle Position | موقعیت دکمهی کنترل گروه ستونها. |
بازگشت
Sheet — این برگه، برای زنجیر کردن.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Column Width(columnPosition, width)
Sets the width of the given column in pixels.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | The position of the given column to set. |
width | Integer | The width in pixels to set it to. |
بازگشت
Sheet — The sheet, useful for method chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Column Widths(startColumn, numColumns, width)
Sets the width of the given columns in pixels.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Column | Integer | The starting column position to change. |
num Columns | Integer | The number of columns to change. |
width | Integer | The width in pixels to set it to. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Conditional Format Rules(rules)
Replaces all currently existing conditional format rules in the sheet with the input rules. Rules are evaluated in their input order.
// Remove one of the existing conditional format rules. const sheet = SpreadsheetApp.getActiveSheet(); const rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
rules | Conditional Format Rule[] | The new conditional format rules. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Current Cell(cell)
Sets the specified cell as the current cell .
If the specified cell is present in an already selected range, then that range becomes the active range with the cell as the current cell.
If the specified cell is not present in any selected range, then any existing selection is removed and the cell becomes the current cell and the active range.
Note: The specified Range must consist of one cell, otherwise it throws an exception.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); const selection = sheet.getSelection(); // Current cell: B5 const currentCell = selection.getCurrentCell();
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
cell | Range | The cell to set as the current cell. |
بازگشت
Range — The newly set current cell.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Frozen Columns(columns)
Freezes the given number of columns. If zero, no columns are frozen.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
columns | Integer | The number of columns to freeze. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Frozen Rows(rows)
Freezes the given number of rows. If zero, no rows are frozen.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
rows | Integer | The number of rows to freeze. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Hidden Gridlines(hideGridlines)
Hides or reveals the sheet gridlines.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Hides the gridlines in the sheet. sheet.setHiddenGridlines(true);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
hide Gridlines | Boolean | If true , hide gridlines in this sheet; otherwise show the gridlines. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Name(name)
Sets the sheet name.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.setName('not first anymore');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | The new name for the sheet. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Right To Left(rightToLeft)
Sets or unsets the sheet layout to right-to-left.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the sheet layout, so that the sheet is ordered from right to left. sheet.setRightToLeft(true);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
right To Left | Boolean | If true , the sheet layout is set to right-to-left, with cell A1 at the top right corner. If false , the sheet layout is set to the default left-to-right, with cell A1 at the top left. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Row Group Control Position(position)
Sets the position of the row group control toggle on the sheet.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
position | Group Control Toggle Position | The position of the row group control toggle. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Row Height(rowPosition, height)
Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use set Row Heights Forced(startRow, numRows, height) .
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first row to a height of 200 pixels sheet.setRowHeight(1, 200);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Position | Integer | The row position to change. |
height | Integer | The height in pixels to set it to. |
بازگشت
Sheet — The sheet, useful for method chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Row Heights(startRow, numRows, height)
Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use set Row Heights Forced(startRow, numRows, height) .
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Row | Integer | The starting row position to change. |
num Rows | Integer | The number of rows to change. |
height | Integer | The height in pixels to set it to. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Row Heights Forced(startRow, numRows, height)
Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use set Row Heights Forced , rows are forced to the specified height even if the cell contents are taller than the row height.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
start Row | Integer | The starting row position to change. |
num Rows | Integer | The number of rows to change. |
height | Integer | The height in pixels to set it to. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Tab Color(color)
Sets the sheet tab color.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.setTabColor('ff0000'); // Set the color to red. first.setTabColor(null); // Unset the color.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
color | String | A color code in CSS notation (like '#ffffff' or 'white' ), or null to reset the tab color. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Tab Color Object(color)
Sets the sheet tab color.
// This example assumes there is a sheet named "Sheet1" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('Sheet1'); const color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
color | Color | The sheet tab color to set. |
بازگشت
Sheet — This sheet, for chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
show Columns(columnIndex)
Unhides the column at the given index.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | The index of the column to unhide. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
show Columns(columnIndex, numColumns)
Unhides one or more consecutive columns starting at the given index.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Index | Integer | The starting index of the columns to unhide. |
num Columns | Integer | The number of columns to unhide. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
show Rows(rowIndex)
Unhides the row at the given index.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | The index of the row to unhide. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
show Rows(rowIndex, numRows)
Unhides one or more consecutive rows starting at the given index.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row Index | Integer | The starting index of the rows to unhide. |
num Rows | Integer | The number of rows to unhide. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
show Sheet()
Makes the sheet visible. Has no effect if the sheet is already visible.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
بازگشت
Sheet — The current sheet.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition)
Sorts a sheet by column, ascending.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | The column to sort by. |
بازگشت
Sheet — The sheet, useful for method chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition, ascending)
Sorts a sheet by column. Takes a parameter to specify ascending or descending.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column Position | Integer | The column to sort by. |
ascending | Boolean | true for ascending sorts, false for descending. |
بازگشت
Sheet — The sheet, useful for method chaining.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
unhide Column(column)
Unhides the column in the given range.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden const range = sheet.getRange('A1'); sheet.unhideColumn(range);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
column | Range | The range to unhide, if hidden. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
unhide Row(row)
Unhides the row in the given range.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden const range = sheet.getRange('A1'); sheet.unhideRow(range);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
row | Range | The range to unhide, if hidden. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
update Chart(chart)
Updates the chart on this sheet.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts const charts = sheet.getCharts(); for (const i in charts) { const chart = charts[i]; const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build(); sheet.updateChart(newChart); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
chart | Embedded Chart | The chart to update. |
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets