این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class Sheet

به صفحات گسترده دسترسی داشته باشید و آنها را اصلاح کنید. عملیات متداول عبارتند از تغییر نام یک برگه و دسترسی به اشیاء محدوده از برگه.

روش ها

روش	نوع برگشت	شرح مختصر
`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`	اگر برگه از نوع `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`	صفحه را در یک صفحه گسترده کپی می کند، که می تواند همان صفحه گسترده منبع باشد.
`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` برمی گرداند.
`get Bandings()`	`Banding[]`	تمام باندهای موجود در این برگه را برمی گرداند.
`get Charts()`	`Embedded Chart[]`	آرایه ای از نمودارها را در این برگه برمی گرداند.
`get Column Group(columnIndex, groupDepth)`	`Group`	گروه ستون را در نمایه و عمق گروه داده شده برمی گرداند.
`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` برمی‌گرداند.
`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` .
`get Form Url()`	`String`	نشانی اینترنتی فرمی را که پاسخ‌های خود را به این برگه ارسال می‌کند، برمی‌گرداند، یا اگر این برگه هیچ فرم مرتبطی نداشته باشد، `null` .
`get Frozen Columns()`	`Integer`	تعداد ستون های ثابت شده را برمی گرداند.
`get Frozen Rows()`	`Integer`	تعداد ردیف‌های ثابت شده را برمی‌گرداند.
`get Images()`	`Over Grid Image[]`	همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند.
`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`	گروه ردیف را در نمایه و عمق گروه داده شده برمی گرداند.
`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[]`	آرایه‌ای از برش‌کن‌ها را روی برگه برمی‌گرداند.
`get Tab Color Object()`	`Color`	رنگ برگه برگه را می گیرد یا اگر برگه برگه رنگی نداشته باشد، `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`	نمودار موجود در این برگه را به روز می کند.

روش های منسوخ شده

روش	نوع برگشت	شرح مختصر
`get Sheet Protection()`	`Page Protection`	یک نمونه `Page Protection` را برمی‌گرداند که مجوزهای صفحه فعلی را توصیف می‌کند.
`get Tab Color()`	`String`	رنگ برگه برگه را می گیرد یا اگر برگه برگه رنگی نداشته باشد، `null` .
`set Sheet Protection(permissions)`	`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 - برگه منبع داده.

مجوز

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

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()`

برگه را از قالب بندی پاک می کند، در حالی که محتویات را حفظ می کند.

قالب‌بندی به نحوه قالب‌بندی داده‌ها بر اساس انتخاب‌های زیر منوی «Format» (مثلاً پررنگ، ایتالیک، قالب‌بندی شرطی) و نه عرض یا ارتفاع سلول‌ها اشاره دارد.

// 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)`

صفحه را در یک صفحه گسترده کپی می کند، که می تواند همان صفحه گسترده منبع باشد. برگه کپی شده "کپی از [نام اصلی]" نام دارد.

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`	موقعیت ستون، از 1 برای ستون اول شروع می شود.

بازگشت

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`	موقعیت ردیف، از 1 برای ردیف اول شروع می شود.

بازگشت

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

همچنین ببینید

set Active Range(range)

`get Active Range List()`

لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد، null برمی گرداند.

اگر یک محدوده انتخاب شده باشد، به عنوان یک فراخوانی get Active Range() عمل می کند.

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

بازگشت

Range List - فهرست محدوده های فعال

مجوز

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

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

همچنین ببینید

set Active Range List(rangeList)

`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[] - همه باندهای موجود در این برگه.

مجوز

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

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 - گروه ستون در نمایه و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد می کند.

مجوز

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

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 فوکوس دارد و با یک حاشیه تاریک برجسته می‌شود. هرگز بیش از یک سلول فعلی وجود ندارد. هنگامی که کاربر یک یا چند محدوده سلولی را انتخاب می کند، یکی از سلول های انتخابی سلول فعلی است.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
const currentCell = sheet.getCurrentCell();

بازگشت

Range - سلول فعلی

مجوز

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

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 - فیلتر.

مجوز

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

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

`get Form Url()`

نشانی اینترنتی فرمی را که پاسخ‌های خود را به این برگه ارسال می‌کند، برمی‌گرداند، یا اگر این برگه هیچ فرم مرتبطی نداشته باشد، null . در صورتی که کاربر مجوز ویرایش صفحه گسترده را نداشته باشد، یک استثنا ایجاد می کند.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

بازگشت

String - URL برای فرمی که پاسخ های خود را در این برگه قرار می دهد، یا اگر این برگه فرم مرتبطی نداشته باشد، 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()`

همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند.

// 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()`

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

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`	شاخص ردیف سلولی که باید برگردد. نمایه سازی ردیف با 1 شروع می شود.
`column`	`Integer`	نمایه ستون سلولی که باید برگردد. نمایه سازی ستون با 1 شروع می شود.

بازگشت

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`	شاخص ردیف شروع محدوده؛ نمایه سازی ردیف با 1 شروع می شود.
`column`	`Integer`	شاخص ستون محدوده؛ نمایه سازی ستون با 1 شروع می شود.
`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`	شاخص ردیف شروع محدوده؛ نمایه سازی ردیف با 1 شروع می شود.
`column`	`Integer`	شاخص ستون شروع محدوده؛ نمایه سازی ستون با 1 شروع می شود.
`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 - گروه ردیف در نمایه و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد می کند.

مجوز

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

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) مفید است که به‌جای یک نمونه Sheet ، پارامتر grid Id را می‌گیرند.

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()`

آرایه‌ای از برش‌کن‌ها را روی برگه برمی‌گرداند.

// 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[] - لیست برش دهنده ها در این برگه.

مجوز

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

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 .

مجوز

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

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)`

یک ستون را در نمایه داده شده پنهان می کند. برای این روش از 1-index استفاده کنید.

برای پنهان کردن بیش از یک ستون با استفاده از یک شاخص، از 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)`

یک یا چند ستون متوالی را که از ایندکس داده شده شروع می شوند پنهان می کند. برای این روش از 1-index استفاده کنید.

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 به عنوان تصویر در یک سطر و ستون معین در سند درج می کند. اندازه تصویر از محتویات حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2 مگابایت است.

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 به عنوان تصویر در یک سطر و ستون معین، با فاصله پیکسلی در سند درج می کند. اندازه تصویر از محتویات حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2 مگابایت است.

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)`

یک تصویر را در یک سطر و ستون معین در سند درج می کند.

URL ارائه شده باید برای عموم قابل دسترسی باشد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

پارامترها

نام	تایپ کنید	توضیحات
`url`	`String`	آدرس تصویر.
`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)`

یک تصویر را در یک ردیف و ستون معین، با فاصله پیکسلی در سند درج می کند.

URL ارائه شده باید برای عموم قابل دسترسی باشد.

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`	محدوده ای که برش برش دهنده ایجاد می شود.
`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`	محدوده ای که برش برش دهنده ایجاد می شود.
`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 Protection.addEditor(user) Protection.addEditor(emailAddress) , Protection.Editorerd 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)`

عرض ستون داده شده را بر حسب پیکسل تنظیم می کند.

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`	موقعیت ستون داده شده برای تنظیم.
`width`	`Integer`	عرض به پیکسل برای تنظیم آن.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

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

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

`set Column Widths(startColumn, numColumns, width)`

عرض ستون های داده شده را بر حسب پیکسل تنظیم می کند.

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`	موقعیت ستون شروع برای تغییر.
`num Columns`	`Integer`	تعداد ستون هایی که باید تغییر کند.
`width`	`Integer`	عرض به پیکسل برای تنظیم آن.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Conditional Format Rules(rules)`

همه قوانین قالب مشروط موجود در برگه را با قوانین ورودی جایگزین می کند. قوانین به ترتیب ورودی خود ارزیابی می شوند.

// 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[]`	قوانین قالب مشروط جدید.

مجوز

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

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

`set Current Cell(cell)`

سلول مشخص شده را به عنوان current cell تنظیم می کند.

اگر سلول مشخص شده در محدوده ای از قبل انتخاب شده وجود داشته باشد، آن محدوده به محدوده فعال با سلول به عنوان سلول فعلی تبدیل می شود.

اگر سلول مشخص شده در هیچ محدوده انتخابی وجود نداشته باشد، هر انتخاب موجود حذف می شود و سلول به سلول فعلی و محدوده فعال تبدیل می شود.

توجه: Range مشخص شده باید از یک سلول تشکیل شده باشد، در غیر این صورت یک استثنا ایجاد می کند.

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`	سلولی که باید به عنوان سلول فعلی تنظیم شود.

بازگشت

Range - سلول فعلی تازه تنظیم شده است

مجوز

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

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

`set Frozen Columns(columns)`

تعداد ستون ها را ثابت می کند. اگر صفر باشد، هیچ ستونی ثابت نمی شود.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

پارامترها

نام	تایپ کنید	توضیحات
`columns`	`Integer`	تعداد ستون‌هایی که باید ثابت شوند.

مجوز

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

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

`set Frozen Rows(rows)`

تعداد ردیف های داده شده را ثابت می کند. اگر صفر باشد، هیچ ردیفی ثابت نمی شود.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

پارامترها

نام	تایپ کنید	توضیحات
`rows`	`Integer`	تعداد ردیف هایی که باید ثابت شوند.

مجوز

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

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

`set Hidden Gridlines(hideGridlines)`

خطوط شبکه ورق را پنهان یا آشکار می کند.

// 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`	اگر `true` ، خطوط شبکه را در این برگه پنهان کنید. در غیر این صورت خطوط شبکه را نشان دهید.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Name(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`	نام جدید برای ورق.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Right To Left(rightToLeft)`

چیدمان برگه را از راست به چپ تنظیم یا از حالت خارج می کند.

// 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`	اگر `true` ، طرح صفحه روی راست به چپ تنظیم می شود و سلول A1 در گوشه بالا سمت راست قرار دارد. اگر `false` ، طرح‌بندی صفحه روی حالت پیش‌فرض چپ به راست تنظیم می‌شود و سلول A1 در بالا سمت چپ قرار دارد.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Row Group Control Position(position)`

موقعیت کلید کنترل گروه ردیف را روی برگه تنظیم می کند.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

پارامترها

نام	تایپ کنید	توضیحات
`position`	`Group Control Toggle Position`	موقعیت ضامن کنترل گروه ردیف.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Row Height(rowPosition, height)`

ارتفاع ردیف ردیف داده شده را بر حسب پیکسل تنظیم می کند. به‌طور پیش‌فرض، ردیف‌ها به گونه‌ای رشد می‌کنند که با محتویات سلول متناسب شوند. اگر می‌خواهید ردیف‌ها را به یک ارتفاع مشخص وادار کنید، 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`	موقعیت ردیف برای تغییر.
`height`	`Integer`	ارتفاع به پیکسل برای تنظیم آن.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای.

مجوز

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

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

`set Row Heights(startRow, numRows, height)`

ارتفاع ردیف های داده شده را بر حسب پیکسل تنظیم می کند. به‌طور پیش‌فرض، ردیف‌ها به گونه‌ای رشد می‌کنند که با محتویات سلول متناسب شوند. اگر می‌خواهید ردیف‌ها را به یک ارتفاع مشخص وادار کنید، 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`	موقعیت ردیف شروع برای تغییر.
`num Rows`	`Integer`	تعداد ردیف هایی که باید تغییر کند.
`height`	`Integer`	ارتفاع به پیکسل برای تنظیم آن.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Row Heights Forced(startRow, numRows, height)`

ارتفاع ردیف های داده شده را بر حسب پیکسل تنظیم می کند. به‌طور پیش‌فرض، ردیف‌ها به گونه‌ای رشد می‌کنند که با محتویات سلول متناسب شوند. وقتی از set Row Heights Forced استفاده می‌کنید، ردیف‌ها به ارتفاع تعیین‌شده مجبور می‌شوند حتی اگر محتوای سلول از ارتفاع ردیف بلندتر باشد.

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`	موقعیت ردیف شروع برای تغییر.
`num Rows`	`Integer`	تعداد ردیف هایی که باید تغییر کند.
`height`	`Integer`	ارتفاع به پیکسل برای تنظیم آن.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Tab Color(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`	یک کد رنگ در نماد CSS (مانند `'#ffffff'` یا `'white'` ) یا `null` برای تنظیم مجدد رنگ برگه.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`set Tab Color Object(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`	رنگ برگه ورق برای تنظیم.

بازگشت

Sheet - این ورق، برای زنجیر زدن.

مجوز

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

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

`show Columns(columnIndex)`

ستون را در نمایه داده شده باز می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

پارامترها

نام	تایپ کنید	توضیحات
`column Index`	`Integer`	نمایه ستونی که باید نمایش داده شود.

مجوز

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

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

`show Columns(columnIndex, numColumns)`

یک یا چند ستون متوالی را که از نمایه داده شده شروع می شوند، آشکار می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

پارامترها

نام	تایپ کنید	توضیحات
`column Index`	`Integer`	نمایه شروع ستون ها برای آشکار شدن.
`num Columns`	`Integer`	تعداد ستون هایی که باید نمایش داده شوند.

مجوز

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

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

`show Rows(rowIndex)`

سطر را در نمایه داده شده باز می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

پارامترها

نام	تایپ کنید	توضیحات
`row Index`	`Integer`	نمایه سطر برای نمایش.

مجوز

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

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

`show Rows(rowIndex, numRows)`

یک یا چند ردیف متوالی را که از نمایه داده شده شروع می شوند، آشکار می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

پارامترها

نام	تایپ کنید	توضیحات
`row Index`	`Integer`	نمایه شروع سطرها برای آشکار شدن.
`num Rows`	`Integer`	تعداد ردیف هایی که باید نمایش داده شوند.

مجوز

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

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

`show Sheet()`

ورق را نمایان می کند. اگر برگه از قبل قابل مشاهده باشد، تأثیری ندارد.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

بازگشت

Sheet - برگه فعلی.

مجوز

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

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

`sort(columnPosition)`

یک ورق را بر اساس ستون، صعودی مرتب می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

پارامترها

نام	تایپ کنید	توضیحات
`column Position`	`Integer`	ستونی که بر اساس آن مرتب می شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

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

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

`sort(columnPosition, ascending)`

یک ورق را به ستون مرتب می کند. پارامتری را برای تعیین صعودی یا نزولی می گیرد.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

پارامترها

نام	تایپ کنید	توضیحات
`column Position`	`Integer`	ستونی که بر اساس آن مرتب می شود.
`ascending`	`Boolean`	`true` برای انواع صعودی، `false` برای نزولی.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

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

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

`unhide Column(column)`

ستون را در محدوده داده شده باز می کند.

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`	محدوده ای که در صورت پنهان شدن، نمایش داده می شود.

مجوز

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

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

`unhide Row(row)`

ردیف را در محدوده داده شده نشان می دهد.

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`	محدوده ای که در صورت پنهان بودن، نمایش داده می شود.

مجوز

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

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

`update Chart(chart)`

نمودار موجود در این برگه را به روز می کند.

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`	نمودار برای به روز رسانی.

مجوز

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

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

روش های منسوخ شده

`get Sheet Protection()`

منسوخ شده است. برای صفحات گسترده ایجاد شده در نسخه جدیدتر Google Sheets، از get Protections(type) استفاده کنید که کلاس Protection قدرتمندتر را برمی گرداند. اگرچه این روش منسوخ شده است، اما برای سازگاری با نسخه قدیمی Sheets همچنان در دسترس است

یک نمونه Page Protection را برمی‌گرداند که مجوزهای صفحه فعلی را توصیف می‌کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

بازگشت

Page Protection - شیئی که مجوزهای دسترسی برگه را توصیف می کند

مجوز

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

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

`get Tab Color()`

منسوخ شده است. با get Tab Color Object() جایگزین شد

رنگ برگه برگه را می گیرد یا اگر برگه برگه رنگی نداشته باشد، null .

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

بازگشت

String - کد رنگ در نماد CSS (مانند '#ffffff' ).

مجوز

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

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

`set Sheet Protection(permissions)`

منسوخ شده است. برای صفحات گسترده ایجاد شده در نسخه جدیدتر Google Sheets، از protect() استفاده کنید که کلاس Protection قدرتمندتر را برمی گرداند. اگرچه این روش منسوخ شده است، اما برای سازگاری با نسخه قدیمی Sheets همچنان در دسترس است

مجوزها را برای برگه فعلی تنظیم می کند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

پارامترها

نام	تایپ کنید	توضیحات
`permissions`	`Page Protection`	مجوزهای دسترسی برای تنظیم در این برگه مخالف هستند.

مجوز

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

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