دسترسی و ایجاد فایلهای Google Sheets. این کلاس، کلاس والد سرویس Spreadsheet است.
خواص
| ملک | نوع | توضیحات |
|---|---|---|
Auto Fill Series | Auto Fill Series | فهرستی از انواع سریهای مورد استفاده برای محاسبه مقادیر خودکار پر شده. |
Banding Theme | Banding Theme | فهرستی از مضامین احتمالی دستهبندی. |
Boolean Criteria | Boolean Criteria | شمارشی از معیارهای بولی قالببندی شرطی. |
Border Style | Border Style | فهرستی از سبکهای معتبر برای تنظیم حاشیهها روی یک Range . |
Color Type | Color Type | فهرستی از انواع رنگهای ممکن. |
Copy Paste Type | Copy Paste Type | فهرستی از انواع خمیرهای ممکن. |
Data Execution Error Code | Data Execution Error Code | فهرستی از کدهای خطای احتمالی اجرای دادهها. |
Data Execution State | Data Execution State | شمارشی از حالتهای ممکن اجرای دادهها. |
Data Source Parameter Type | Data Source Parameter Type | شمارشی از انواع پارامترهای ممکن منبع داده. |
Data Source Refresh Scope | Data Source Refresh Scope | شمارشی از محدودههای ممکن برای بهروزرسانی منبع داده. |
Data Source Type | Data Source Type | فهرستی از انواع منابع داده ممکن. |
Data Validation Criteria | Data Validation Criteria | یک نوع شمارش که معیارهای اعتبارسنجی دادهها را که میتوانند روی یک محدوده تنظیم شوند، نشان میدهد. |
Date Time Grouping Rule Type | Date Time Grouping Rule Type | شمارشی از قانون گروهبندی تاریخ و زمان. |
Developer Metadata Location Type | Developer Metadata Location Type | فهرستی از انواع مکانهای ممکن برای فرادادههای توسعهدهنده. |
Developer Metadata Visibility | Developer Metadata Visibility | فهرستی از موارد احتمالی مشاهده فراداده توسعهدهنده. |
Dimension | Dimension | شمارشی از ابعاد ممکن یک صفحه گسترده. |
Direction | Direction | فهرستی از جهتهای ممکن که میتوان با استفاده از کلیدهای جهتنما در یک صفحه گسترده حرکت کرد. |
Frequency Type | Frequency Type | فهرستی از انواع فرکانسهای ممکن. |
Group Control Toggle Position | Group Control Toggle Position | فهرستی از موقعیتهایی که دکمه کنترل گروه میتواند در آنها قرار گیرد. |
Interpolation Type | Interpolation Type | شمارش انواع درونیابی گرادیان با قالب شرطی. |
Pivot Table Summarize Function | Pivot Table Summarize Function | فهرستی از توابعی که ممکن است برای خلاصه کردن مقادیر در یک جدول محوری استفاده شوند. |
Pivot Value Display Type | Pivot Value Display Type | فهرستی از روشهایی که یک مقدار محوری میتواند نمایش داده شود. |
Protection Type | Protection Type | یک شمارشگر که بخشهایی از یک صفحهگسترده را نشان میدهد که میتوانند از ویرایش محافظت شوند. |
Recalculation Interval | Recalculation Interval | فهرستی از فواصل زمانی ممکن که میتوانند در محاسبه مجدد در صفحه گسترده استفاده شوند. |
Relative Date | Relative Date | شمارشی از گزینههای تاریخ نسبی برای محاسبه مقداری که قرار است در Boolean Criteria مبتنی بر تاریخ استفاده شود. |
Sheet Type | Sheet Type | فهرستی از انواع مختلف برگههایی که میتوانند در یک صفحه گسترده وجود داشته باشند. |
Sort Order | Sort Order | یک شمارش با ترتیب مرتبسازی. |
Text Direction | Text Direction | فهرستی از مسیرهای متنی معتبر. |
Text To Columns Delimiter | Text To Columns Delimiter | فهرستی از جداکنندههای از پیش تعیینشده برای تقسیم متن به ستونها. |
Theme Color Type | Theme Color Type | فهرستی از انواع رنگهای ممکن برای تم. |
Value Type | Value Type | یک شمارش از انواع مقادیر که توسط Range.getValue() و Range.getValues() از کلاس Range سرویس Spreadsheet برگردانده شده است. مقادیر شمارشی ذکر شده در زیر علاوه بر Number ، Boolean ، Date یا String هستند. |
Wrap Strategy | Wrap Strategy | فهرستی از استراتژیهای مورد استفاده برای پوشش سلولها. |
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
create(name) | Spreadsheet | یک صفحه گسترده جدید با نام داده شده ایجاد میکند. |
create(name, rows, columns) | Spreadsheet | یک صفحه گسترده جدید با نام داده شده و تعداد مشخص شده ردیفها و ستونها ایجاد میکند. |
enable All Data Sources Execution() | void | اجرای دادهها را برای همه انواع منابع داده فعال میکند. |
enable Big Query Execution() | void | اجرای دادهها را برای منابع داده BigQuery فعال میکند. |
enable Looker Execution() | void | اجرای دادهها را برای منابع داده Looker فعال میکند. |
flush() | void | تمام تغییرات در انتظار صفحه گسترده را اعمال میکند. |
get Active() | Spreadsheet | صفحهگسترده فعال فعلی را برمیگرداند، یا اگر وجود نداشته باشد null است. |
get Active Range() | Range | محدوده انتخاب شده در برگه فعال را برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null برمیگرداند. |
get Active Range List() | Range List |null | لیست محدودههای فعال در برگه فعال را برمیگرداند یا اگر هیچ محدودهای انتخاب نشده باشد null برمیگرداند. |
get Active Sheet() | Sheet | برگه فعال را در یک صفحه گسترده دریافت میکند. |
get Active Spreadsheet() | Spreadsheet | صفحهگسترده فعال فعلی را برمیگرداند، یا اگر وجود نداشته باشد null است. |
get Current Cell() | Range |null | سلول فعلی (هایلایت شده) که در یکی از محدودههای فعال در برگه فعال انتخاب شده است را برمیگرداند یا اگر سلول فعلی وجود نداشته باشد، null برمیگرداند. |
get Selection() | Selection | Selection فعلی را در صفحه گسترده برمیگرداند. |
get Ui() | Ui | نمونهای از محیط رابط کاربری صفحهگسترده را برمیگرداند که به اسکریپت اجازه میدهد ویژگیهایی مانند منوها، کادرهای محاورهای و نوارهای کناری را اضافه کند. |
new Cell Image() | Cell Image Builder | یک سازنده برای Cell Image ایجاد میکند. |
new Color() | Color Builder | یک سازنده برای یک Color ایجاد میکند. |
new Conditional Format Rule() | Conditional Format Rule Builder | یک سازنده برای یک قانون قالببندی شرطی ایجاد میکند. |
new Data Source Spec() | Data Source Spec Builder | یک سازنده برای Data Source Spec ایجاد میکند. |
new Data Validation() | Data Validation Builder | یک سازنده برای یک قانون اعتبارسنجی داده ایجاد میکند. |
new Filter Criteria() | Filter Criteria Builder | یک سازنده برای Filter Criteria ایجاد میکند. |
new Rich Text Value() | Rich Text Value Builder | یک سازنده برای مقدار Rich Text ایجاد میکند. |
new Text Style() | Text Style Builder | یک سازنده برای سبک متن ایجاد میکند. |
open(file) | Spreadsheet | صفحهگستردهای را که مربوط به شیء فایل داده شده است، باز میکند. |
open By Id(id) | Spreadsheet | صفحه گسترده را با شناسه داده شده باز میکند. |
open By Url(url) | Spreadsheet | صفحه گسترده را با URL داده شده باز میکند. |
set Active Range(range) | Range | محدوده مشخص شده را به عنوان active range ، با سلول بالا سمت چپ در محدوده به عنوان current cell ، تنظیم میکند. |
set Active Range List(rangeList) | Range List | لیست مشخص شده از محدودهها را به عنوان active ranges تنظیم میکند. |
set Active Sheet(sheet) | Sheet | برگه فعال را در یک صفحه گسترده تنظیم میکند. |
set Active Sheet(sheet, restoreSelection) | Sheet | برگه فعال را در یک صفحه گسترده تنظیم میکند، با این گزینه که جدیدترین انتخاب درون آن برگه را بازیابی کند. |
set Active Spreadsheet(newActiveSpreadsheet) | void | صفحه گسترده فعال را تنظیم میکند. |
set Current Cell(cell) | Range | سلول مشخص شده را به عنوان current cell تنظیم میکند. |
مستندات دقیق
create(name)
یک صفحه گسترده جدید با نام داده شده ایجاد میکند.
// The code below creates a new spreadsheet "Finances" and logs the URL for it const ssNew = SpreadsheetApp.create('Finances'); Logger.log(ssNew.getUrl());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نامی برای صفحهگسترده. |
بازگشت
Spreadsheet - یک صفحه گسترده جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets
create(name, rows, columns)
یک صفحه گسترده جدید با نام داده شده و تعداد مشخص شده ردیفها و ستونها ایجاد میکند.
// The code below creates a new spreadsheet "Finances" with 50 rows and 5 // columns and logs the URL for it const ssNew = SpreadsheetApp.create('Finances', 50, 5); Logger.log(ssNew.getUrl());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نامی برای صفحهگسترده. |
rows | Integer | تعداد ردیفهای صفحه گسترده. |
columns | Integer | تعداد ستونهای صفحه گسترده. |
بازگشت
Spreadsheet - یک صفحه گسترده جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets
enable All Data Sources Execution()
اجرای دادهها را برای همه انواع منابع داده فعال میکند.
اگر نوع منبع داده فعال نباشد، اجرای داده یک استثنا ایجاد میکند. از این روش برای فعال کردن اجرای داده برای همه انواع منبع داده استفاده کنید.
// Turns data execution on for all types of data sources. SpreadsheetApp.enableAllDataSourcesExecution(); // 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 the first data source sheet in the spreadsheet and refreshes the data. ss.getDataSourceSheets()[0].refreshData();
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/bigquery.readonly
enable Big Query Execution()
اجرای دادهها را برای منابع داده BigQuery فعال میکند.
اجرای دادهها برای منبع داده BigQuery در صورت فعال نبودن، یک استثنا ایجاد میکند.
// Turns data execution on for BigQuery data sources. SpreadsheetApp.enableBigQueryExecution(); // 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 the first data source sheet in the spreadsheet and refreshes the // BigQuery data. ss.getDataSourceSheets()[0].refreshData();
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/bigquery.readonly
enable Looker Execution()
اجرای دادهها را برای منابع داده Looker فعال میکند.
اجرای دادهها برای منبع داده Looker در صورت فعال نبودن، یک استثنا ایجاد میکند.
// Turns data execution on for Looker data sources. SpreadsheetApp.enableLookerExecution(); // 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 the first data source sheet in the spreadsheet and refreshes the // associated Looker data. ss.getDataSourceSheets()[0].refreshData();
flush()
تمام تغییرات در انتظار صفحه گسترده را اعمال میکند.
عملیات صفحه گسترده گاهی اوقات برای بهبود عملکرد، مانند هنگام انجام چندین فراخوانی به Range.getValue()، با هم ترکیب میشوند. با این حال، گاهی اوقات ممکن است بخواهید مطمئن شوید که همه تغییرات در حال انتظار بلافاصله اعمال میشوند، به عنوان مثال برای نمایش دادههای کاربران هنگام اجرای یک اسکریپت.
// The code below changes the background color of cells A1 and B1 twenty times. // You should be able to see the updates live in the spreadsheet. If flush() is // not called, the updates may be applied live or may all be applied at once // when the script completes. function colors() { const sheet = SpreadsheetApp.getActiveSheet(); for (let i = 0; i < 20; i++) { if (i % 2 === 0) { sheet.getRange('A1').setBackground('green'); sheet.getRange('B1').setBackground('red'); } else { sheet.getRange('A1').setBackground('red'); sheet.getRange('B1').setBackground('green'); } SpreadsheetApp.flush(); } }
get Active()
صفحهگسترده فعال فعلی را برمیگرداند، یا اگر وجود نداشته باشد null است.
توابعی که در متن یک صفحه گسترده اجرا میشوند، میتوانند با فراخوانی این تابع، به شیء صفحه گسترده مربوطه ارجاع دهند.
// The code below logs the URL for the active spreadsheet. Logger.log(SpreadsheetApp.getActive().getUrl());
بازگشت
Spreadsheet - شیء صفحه گسترده فعال
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Range()
محدوده انتخاب شده در برگه فعال را برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null برمیگرداند. اگر چندین محدوده انتخاب شده باشند، این روش فقط آخرین محدوده انتخاب شده را برمیگرداند.
این به طور کلی به معنای محدودهای است که کاربر در برگه فعال انتخاب کرده است، اما در یک تابع سفارشی به سلولی اشاره دارد که به طور فعال دوباره محاسبه میشود.
// The code below logs the background color for the active range. const colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject(); // Assume the color has ColorType.RGB. Logger.log(colorObject.asRgbColor().asHexString());
بازگشت
Range — محدوده فعال.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Range List()
لیست محدودههای فعال در برگه فعال را برمیگرداند یا اگر هیچ محدودهای انتخاب نشده باشد، null برمیگرداند. محدوده فعال حاوی سلول هایلایت شده فعلی در آخرین قسمت لیست قرار میگیرد.
اگر یک محدوده انتخاب شده باشد، این تابع مانند فراخوانی تابع get Active Range() عمل میکند.
// Returns the list of active ranges. const rangeList = SpreadsheetApp.getActiveRangeList();
بازگشت
Range List |null — لیست محدودههای فعال
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Sheet()
برگه فعال را در یک صفحه گسترده دریافت میکند.
برگه فعال در یک صفحه گسترده، برگهای است که در رابط کاربری صفحه گسترده نمایش داده میشود.
// The code below logs the name of the active sheet. Logger.log(SpreadsheetApp.getActiveSheet().getName());
بازگشت
Sheet — شیء فعال Sheet
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Active Spreadsheet()
صفحهگسترده فعال فعلی را برمیگرداند، یا اگر وجود نداشته باشد null است.
توابعی که در متن یک صفحه گسترده اجرا میشوند، میتوانند با فراخوانی این تابع، به شیء Spreadsheet مربوطه ارجاع دهند.
// The code below logs the URL for the active spreadsheet. Logger.log(SpreadsheetApp.getActiveSpreadsheet().getUrl());
بازگشت
Spreadsheet - شیء صفحه گسترده فعال
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Current Cell()
سلول فعلی (هایلایت شده) که در یکی از محدودههای فعال در برگه فعال انتخاب شده است را برمیگرداند یا اگر سلول فعلی وجود نداشته باشد، null برمیگرداند.
// Returns the current highlighted cell in the one of the active ranges. const currentCell = SpreadsheetApp.getCurrentCell();
بازگشت
Range |null — سلول فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Selection()
Selection فعلی را در صفحه گسترده برمیگرداند.
const selection = SpreadsheetApp.getSelection(); const currentCell = selection.getCurrentCell();
بازگشت
Selection — انتخاب فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
get Ui()
نمونهای از محیط رابط کاربری صفحهگسترده را برمیگرداند که به اسکریپت اجازه میدهد ویژگیهایی مانند منوها، کادرهای محاورهای و نوارهای کناری را اضافه کند. یک اسکریپت فقط میتواند با رابط کاربری نمونه فعلی یک صفحهگسترده باز تعامل داشته باشد، و فقط در صورتی که اسکریپت به صفحهگسترده متصل باشد. برای اطلاعات بیشتر، به راهنماهای منوها و کادرهای محاورهای و نوارهای کناری مراجعه کنید.
// Add a custom menu to the active spreadsheet, including a separator and a // sub-menu. function onOpen(e) { SpreadsheetApp.getUi() .createMenu('My Menu') .addItem('My menu item', 'myFunction') .addSeparator() .addSubMenu( SpreadsheetApp.getUi() .createMenu('My sub-menu') .addItem('One sub-menu item', 'mySecondFunction') .addItem('Another sub-menu item', 'myThirdFunction'), ) .addToUi(); }
بازگشت
رابط کاربری Ui — نمونهای از محیط رابط کاربری این صفحه گسترده
new Cell Image()
یک سازنده برای Cell Image ایجاد میکند.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A1 on Sheet1. const range = sheet.getRange('A1'); // Builds an image using a source URL. const cellImage = SpreadsheetApp.newCellImage() .setSourceUrl( 'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png', ) .build(); // Sets the image in cell A1. range.setValue(cellImage);
بازگشت
Cell Image Builder - سازنده جدید.
new Color()
یک سازنده برای یک Color ایجاد میکند.
const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();
بازگشت
Color Builder - سازنده جدید.
new Conditional Format Rule()
یک سازنده برای یک قانون قالببندی شرطی ایجاد میکند.
// Adds a conditional format rule to a sheet that causes all cells in range // A1:B3 to turn red if they contain a number between 1 and 10. const sheet = SpreadsheetApp.getActive().getActiveSheet(); const range = sheet.getRange('A1:B3'); const rule = SpreadsheetApp.newConditionalFormatRule() .whenNumberBetween(1, 10) .setBackground('#FF0000') .setRanges([range]) .build(); const rules = sheet.getConditionalFormatRules(); rules.push(rule); sheet.setConditionalFormatRules(rules);
بازگشت
new Data Source Spec()
یک سازنده برای Data Source Spec ایجاد میکند.
// 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', ); // Enables BigQuery. SpreadsheetApp.enableBigQueryExecution(); // Builds a data source specification. // TODO (developer): Update the project ID to your own Google Cloud project ID. const dataSourceSpec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('project-id-1') .setTableProjectId('bigquery-public-data') .setDatasetId('ncaa_basketball') .setTableId('mbb_historical_teams_games') .build(); // Adds the data source and its data to the spreadsheet. ss.insertDataSourceSheet(dataSourceSpec);
بازگشت
Data Source Spec Builder - سازنده جدید.
new Data Validation()
یک سازنده برای یک قانون اعتبارسنجی داده ایجاد میکند.
const cell = SpreadsheetApp.getActive().getRange('A1'); const rule = SpreadsheetApp.newDataValidation() .requireNumberBetween(1, 100) .setAllowInvalid(false) .setHelpText('Number must be between 1 and 100.') .build(); cell.setDataValidation(rule);
بازگشت
Data Validation Builder - سازنده جدید.
new Filter Criteria()
یک سازنده برای Filter Criteria ایجاد میکند.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the range to A1:D20. const range = sheet.getRange('A1:D20'); // Creates a filter and applies it to the specified range. range.createFilter(); // Gets the current filter for the range and creates filter criteria that only // shows cells that aren't empty. const filter = range.getFilter(); const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build(); // Sets the criteria to column C. filter.setColumnFilterCriteria(3, criteria);
بازگشت
Filter Criteria Builder - سازنده جدید
new Rich Text Value()
یک سازنده برای مقدار Rich Text ایجاد میکند.
// Sets cell A1 to have the text "Hello world", with "Hello" bolded. const cell = SpreadsheetApp.getActive().getRange('A1'); const bold = SpreadsheetApp.newTextStyle().setBold(true).build(); const value = SpreadsheetApp.newRichTextValue() .setText('Hello world') .setTextStyle(0, 5, bold) .build(); cell.setRichTextValue(value);
بازگشت
Rich Text Value Builder - سازندهی جدید.
new Text Style()
یک سازنده برای سبک متن ایجاد میکند.
// Sets range A1:B3 to have red, size 22, bolded, underlined text. const range = SpreadsheetApp.getActive().getRange('A1:B3'); const style = SpreadsheetApp.newTextStyle() .setForegroundColor('red') .setFontSize(22) .setBold(true) .setUnderline(true) .build(); range.setTextStyle(style);
بازگشت
Text Style Builder - سازنده جدید.
open(file)
صفحهگستردهای را که مربوط به شیء فایل داده شده است، باز میکند.
// Get any starred spreadsheets from Google Drive, then open the spreadsheets // and log the name of the first sheet within each spreadsheet. const files = DriveApp.searchFiles( `starred = true and mimeType = "${MimeType.GOOGLE_SHEETS}"`, ); while (files.hasNext()) { const spreadsheet = SpreadsheetApp.open(files.next()); const sheet = spreadsheet.getSheets()[0]; Logger.log(sheet.getName()); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
file | File | فایلی که باید باز شود. |
بازگشت
Spreadsheet - صفحه گسترده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets
open By Id(id)
صفحه گسترده را با شناسه داده شده باز میکند. شناسه صفحه گسترده را میتوان از URL آن استخراج کرد. برای مثال، شناسه صفحه گسترده در URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 برابر با "abc1234567" است.
// The code below opens a spreadsheet using its ID and logs the name for it. // Note that the spreadsheet is NOT physically opened on the client side. // It is opened on the server only (for modification by the script). const ss = SpreadsheetApp.openById('abc1234567'); Logger.log(ss.getName());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
id | String | شناسه منحصر به فرد برای صفحه گسترده. |
بازگشت
Spreadsheet - شیء Spreadsheet با شناسه داده شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets
open By Url(url)
صفحه گسترده را با URL داده شده باز میکند. اگر URL وجود نداشته باشد یا کاربر اجازه دسترسی به آن را نداشته باشد، یک خطای اسکریپتی ایجاد میکند.
// Opens a spreadsheet by its URL and logs its name. // Note that the spreadsheet doesn't physically open on the client side. // It opens on the server only (for modification by the script). const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc1234567/edit', ); console.log(ss.getName());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
url | String | آدرس اینترنتی (URL) صفحهگسترده. |
بازگشت
Spreadsheet - شیء صفحه گسترده با URL داده شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets
set Active Range(range)
محدوده مشخص شده را به عنوان active range ، با سلول بالا سمت چپ در محدوده به عنوان current cell ، تنظیم میکند.
رابط کاربری صفحه گسترده، برگهای را که شامل محدوده انتخاب شده است نمایش میدهد و سلولهای تعریف شده در محدوده انتخاب شده را انتخاب میکند.
// The code below sets range C1:D4 in the first sheet as the active range. const range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4'); SpreadsheetApp.setActiveRange(range); const selection = SpreadsheetApp.getSelection(); // Current cell: C1 const currentCell = selection.getCurrentCell(); // Active Range: C1:D4 const activeRange = selection.getActiveRange();
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
range | Range | محدودهای که قرار است به عنوان محدوده فعال در نظر گرفته شود. |
بازگشت
Range — محدوده فعال جدید
set Active Range List(rangeList)
لیست مشخص شده از محدودهها را به عنوان active ranges تنظیم میکند. آخرین محدوده در لیست به عنوان active range تنظیم میشود.
// The code below sets ranges [D4, B2:C4] in the active sheet as the active // ranges. const rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']); SpreadsheetApp.setActiveRangeList(rangeList); const selection = SpreadsheetApp.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 Sheet(sheet)
برگه فعال را در یک صفحه گسترده تنظیم میکند. رابط کاربری Google Sheets برگه انتخاب شده را نمایش میدهد، مگر اینکه آن برگه متعلق به صفحه گسترده دیگری باشد.
// The code below makes the 2nd sheet active in the active spreadsheet. const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
sheet | Sheet | برگه فعال جدید. |
بازگشت
Sheet - برگهای که به عنوان برگه فعال جدید ایجاد شده است.
set Active Sheet(sheet, restoreSelection)
برگه فعال را در یک صفحه گسترده تنظیم میکند، با این گزینه که جدیدترین انتخاب در آن صفحه را بازیابی کند. رابط کاربری Google Sheets برگه انتخاب شده را نمایش میدهد، مگر اینکه آن برگه متعلق به صفحه گسترده دیگری باشد.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const firstSheet = spreadsheet.getSheets()[0]; const secondSheet = spreadsheet.getSheets()[1]; // Set the first sheet as the active sheet and select the range D4:F4. spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate(); // Switch to the second sheet to do some work. spreadsheet.setActiveSheet(secondSheet); // Switch back to first sheet, and restore its selection. spreadsheet.setActiveSheet(firstSheet, true); // The selection of first sheet is restored, and it logs D4:F4 const range = spreadsheet.getActiveSheet().getSelection().getActiveRange(); Logger.log(range.getA1Notation());
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
sheet | Sheet | برگه فعال جدید. |
restore Selection | Boolean | اگر true ، آخرین انتخاب از برگه فعال جدید دوباره انتخاب میشود و برگه جدید فعال میشود؛ اگر false ، برگه جدید بدون تغییر انتخاب فعلی فعال میشود. |
بازگشت
Sheet — برگه فعال جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
set Active Spreadsheet(newActiveSpreadsheet)
صفحه گسترده فعال را تنظیم میکند.
// The code below makes the spreadsheet with key "1234567890" the active // spreadsheet const ss = SpreadsheetApp.openById('1234567890'); SpreadsheetApp.setActiveSpreadsheet(ss);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
new Active Spreadsheet | Spreadsheet | صفحهگستردهای که قرار است به عنوان صفحهگستردة فعال انتخاب شود. |
set Current Cell(cell)
سلول مشخص شده را به عنوان current cell تنظیم میکند.
اگر سلول مشخص شده در یک محدوده از قبل انتخاب شده وجود داشته باشد، آن محدوده به محدوده فعال تبدیل میشود و آن سلول، سلول فعلی خواهد بود.
اگر سلول مشخص شده در هیچ محدوده انتخابی وجود نداشته باشد، انتخاب موجود حذف شده و سلول به سلول فعلی و محدوده فعال تبدیل میشود.
توجه: Range مشخص شده باید شامل یک سلول باشد، در غیر این صورت این روش یک استثنا ایجاد میکند.
// The code below sets the cell B5 in the first sheet as the current cell. const cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5'); SpreadsheetApp.setCurrentCell(cell); const selection = SpreadsheetApp.getSelection(); // Current cell: B5 const currentCell = selection.getCurrentCell();
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
cell | Range | سلولی که قرار است به عنوان سلول فعلی تنظیم شود. |
بازگشت
Range - سلول فعلی که به تازگی تنظیم شده است
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets