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

Class Sheet

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

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`activate()`	`Sheet`	این برگه را فعال می کند.
`addDeveloperMetadata(key)`	`Sheet`	ابرداده توسعه دهنده را با کلید مشخص شده به برگه اضافه می کند.
`addDeveloperMetadata(key, visibility)`	`Sheet`	ابرداده توسعه دهنده را با کلید مشخص شده و قابلیت مشاهده به برگه اضافه می کند.
`addDeveloperMetadata(key, value)`	`Sheet`	ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به برگه اضافه می کند.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	ابرداده برنامه‌نویس را با کلید، مقدار و قابلیت مشاهده به برگه اضافه می‌کند.
`appendRow(rowContents)`	`Sheet`	یک ردیف به پایین منطقه داده فعلی در برگه اضافه می کند.
`asDataSourceSheet()`	`DataSourceSheet`	اگر برگه از نوع `SheetType.DATASOURCE` باشد، برگه `null` به عنوان `DataSourceSheet` برمی‌گرداند.
`autoResizeColumn(columnPosition)`	`Sheet`	عرض ستون داده شده را متناسب با محتوای آن تنظیم می کند.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	عرض همه ستون‌ها را که از موقعیت ستون داده شده شروع می‌شوند، تنظیم می‌کند تا متناسب با محتوای آنها باشد.
`autoResizeRows(startRow, numRows)`	`Sheet`	ارتفاع تمام سطرها را که از موقعیت ردیف داده شده شروع می شوند، تنظیم می کند تا با محتوای آنها مطابقت داشته باشد.
`clear()`	`Sheet`	برگه را از محتوا و اطلاعات قالب بندی پاک می کند.
`clear(options)`	`Sheet`	برگه محتویات و/یا قالب را، همانطور که با گزینه های پیشرفته داده شده مشخص شده است، پاک می کند.
`clearConditionalFormatRules()`	`void`	تمام قوانین قالب مشروط را از برگه حذف می کند.
`clearContents()`	`Sheet`	برگه محتویات را پاک می کند، در حالی که اطلاعات قالب بندی را حفظ می کند.
`clearFormats()`	`Sheet`	برگه را از قالب بندی پاک می کند، در حالی که محتویات را حفظ می کند.
`clearNotes()`	`Sheet`	برگه را از همه یادداشت ها پاک می کند.
`collapseAllColumnGroups()`	`Sheet`	همه گروه‌های ستون روی برگه را جمع می‌کند.
`collapseAllRowGroups()`	`Sheet`	همه گروه‌های ردیف روی برگه را جمع می‌کند.
`copyTo(spreadsheet)`	`Sheet`	صفحه را در یک صفحه گسترده کپی می کند، که می تواند همان صفحه گسترده منبع باشد.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	یک `DeveloperMetadataFinder` را برای یافتن ابرداده توسعه‌دهنده در محدوده این برگه برمی‌گرداند.
`createTextFinder(findText)`	`TextFinder`	یک متن یاب برای برگه ایجاد می کند که می تواند متن را در برگه پیدا کرده و جایگزین کند.
`deleteColumn(columnPosition)`	`Sheet`	ستون را در موقعیت ستون داده شده حذف می کند.
`deleteColumns(columnPosition, howMany)`	`void`	تعدادی از ستون هایی که از موقعیت ستون داده شده شروع می شوند را حذف می کند.
`deleteRow(rowPosition)`	`Sheet`	ردیف را در موقعیت ردیف داده شده حذف می کند.
`deleteRows(rowPosition, howMany)`	`void`	تعدادی از ردیف هایی که از موقعیت ردیف داده شده شروع می شوند را حذف می کند.
`expandAllColumnGroups()`	`Sheet`	همه گروه‌های ستون را در برگه گسترش می‌دهد.
`expandAllRowGroups()`	`Sheet`	همه گروه های ردیف را در برگه گسترش می دهد.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	همه گروه های ستون را تا عمق داده شده گسترش می دهد و بقیه گروه ها را جمع می کند.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	همه گروه های ردیف را تا عمق داده شده گسترش می دهد و بقیه گروه ها را جمع می کند.
`getActiveCell()`	`Range`	سلول فعال در این برگه را برمی گرداند.
`getActiveRange()`	`Range`	محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد `null` .
`getActiveRangeList()`	`RangeList`	لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد، `null` برمی گرداند.
`getBandings()`	`Banding[]`	تمام باندهای موجود در این برگه را برمی گرداند.
`getCharts()`	`EmbeddedChart[]`	آرایه ای از نمودارها را در این برگه برمی گرداند.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	گروه ستون را در نمایه و عمق گروه داده شده برمی گرداند.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	`GroupControlTogglePosition` را برای همه گروه‌های ستون در برگه برمی‌گرداند.
`getColumnGroupDepth(columnIndex)`	`Integer`	عمق گروه ستون را در شاخص داده شده برمی گرداند.
`getColumnWidth(columnPosition)`	`Integer`	عرض ستون داده شده را بر حسب پیکسل دریافت می کند.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	تمام قوانین قالب مشروط را در این برگه دریافت کنید.
`getCurrentCell()`	`Range`	سلول فعلی در برگه فعال را برمی‌گرداند یا اگر سلول فعلی وجود نداشته باشد، `null` برمی‌گرداند.
`getDataRange()`	`Range`	یک `Range` مربوط به ابعادی که داده در آن وجود دارد را برمی‌گرداند.
`getDataSourceFormulas()`	`DataSourceFormula[]`	تمام فرمول های منبع داده را دریافت می کند.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	تمام جداول محوری منبع داده را دریافت می کند.
`getDataSourceTables()`	`DataSourceTable[]`	تمام جداول منبع داده را دریافت می کند.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	تمام ابرداده های توسعه دهنده مرتبط با این برگه را دریافت کنید.
`getDrawings()`	`Drawing[]`	آرایه ای از نقاشی ها را روی برگه برمی گرداند.
`getFilter()`	`Filter`	فیلتر موجود در این برگه را برمی‌گرداند یا اگر فیلتری وجود نداشته باشد `null` .
`getFormUrl()`	`String`	نشانی اینترنتی فرمی را که پاسخ‌های خود را به این برگه ارسال می‌کند، برمی‌گرداند، یا اگر این برگه هیچ فرم مرتبطی نداشته باشد، `null` .
`getFrozenColumns()`	`Integer`	تعداد ستون های ثابت شده را برمی گرداند.
`getFrozenRows()`	`Integer`	تعداد ردیف‌های ثابت شده را برمی‌گرداند.
`getImages()`	`OverGridImage[]`	همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند.
`getIndex()`	`Integer`	موقعیت برگه را در صفحه گسترده والد خود دریافت می کند.
`getLastColumn()`	`Integer`	موقعیت آخرین ستونی که محتوا دارد را برمی‌گرداند.
`getLastRow()`	`Integer`	موقعیت آخرین ردیفی که محتوا دارد را برمی‌گرداند.
`getMaxColumns()`	`Integer`	بدون توجه به محتوا، تعداد فعلی ستون‌های صفحه را برمی‌گرداند.
`getMaxRows()`	`Integer`	بدون توجه به محتوا، تعداد ردیف‌های فعلی صفحه را برمی‌گرداند.
`getName()`	`String`	نام برگه را برمی گرداند.
`getNamedRanges()`	`NamedRange[]`	تمام محدوده های نامگذاری شده در این برگه را دریافت می کند.
`getParent()`	`Spreadsheet`	`Spreadsheet` حاوی این صفحه را برمی گرداند.
`getPivotTables()`	`PivotTable[]`	تمام جداول محوری این برگه را برمی‌گرداند.
`getProtections(type)`	`Protection[]`	آرایه‌ای از اشیاء را دریافت می‌کند که نشان‌دهنده همه محدوده‌های محافظت‌شده در برگه است، یا یک آرایه تک عنصری که نشان‌دهنده حفاظت در خود صفحه است.
`getRange(row, column)`	`Range`	محدوده را با سلول بالا سمت چپ در مختصات داده شده برمی گرداند.
`getRange(row, column, numRows)`	`Range`	محدوده را با سلول بالا سمت چپ در مختصات داده شده، و با تعداد ردیف های معین برمی گرداند.
`getRange(row, column, numRows, numColumns)`	`Range`	محدوده ای را با سلول بالا سمت چپ در مختصات داده شده با تعداد ردیف ها و ستون های معین برمی گرداند.
`getRange(a1Notation)`	`Range`	محدوده مشخص شده در نماد A1 یا R1C1 را برمی‌گرداند.
`getRangeList(a1Notations)`	`RangeList`	مجموعه `RangeList` را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای A1 یا نمادهای R1C1 نشان می دهد.
`getRowGroup(rowIndex, groupDepth)`	`Group`	گروه ردیف را در نمایه و عمق گروه داده شده برمی گرداند.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	`GroupControlTogglePosition` را برای همه گروه‌های ردیف در برگه برمی‌گرداند.
`getRowGroupDepth(rowIndex)`	`Integer`	عمق گروه ردیف را در شاخص داده شده برمی‌گرداند.
`getRowHeight(rowPosition)`	`Integer`	ارتفاع ردیف داده شده را بر حسب پیکسل دریافت می کند.
`getSelection()`	`Selection`	`Selection` فعلی را در صفحه گسترده برمی‌گرداند.
`getSheetId()`	`Integer`	شناسه برگه نشان داده شده توسط این شی را برمی گرداند.
`getSheetName()`	`String`	نام برگه را برمی گرداند.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع می شود، برمی گرداند.
`getSlicers()`	`Slicer[]`	آرایه‌ای از برش‌کن‌ها را روی برگه برمی‌گرداند.
`getTabColorObject()`	`Color`	رنگ برگه برگه را می گیرد یا اگر برگه برگه رنگی نداشته باشد `null` .
`getType()`	`SheetType`	نوع برگه را برمی گرداند.
`hasHiddenGridlines()`	`Boolean`	اگر خطوط شبکه ورق پنهان باشد، `true` را برمی‌گرداند. در غیر این صورت `false` را برمی گرداند.
`hideColumn(column)`	`void`	ستون یا ستون ها را در محدوده داده شده پنهان می کند.
`hideColumns(columnIndex)`	`void`	یک ستون را در نمایه داده شده پنهان می کند.
`hideColumns(columnIndex, numColumns)`	`void`	یک یا چند ستون متوالی را که از ایندکس داده شده شروع می شوند پنهان می کند.
`hideRow(row)`	`void`	سطرها را در محدوده داده شده پنهان می کند.
`hideRows(rowIndex)`	`void`	ردیف را در شاخص داده شده پنهان می کند.
`hideRows(rowIndex, numRows)`	`void`	یک یا چند ردیف متوالی را که از شاخص داده شده شروع می شوند، پنهان می کند.
`hideSheet()`	`Sheet`	این برگه را پنهان می کند.
`insertChart(chart)`	`void`	نمودار جدیدی به این برگه اضافه می کند.
`insertColumnAfter(afterPosition)`	`Sheet`	ستونی را بعد از موقعیت ستون داده شده درج می کند.
`insertColumnBefore(beforePosition)`	`Sheet`	یک ستون را قبل از موقعیت ستون داده شده درج می کند.
`insertColumns(columnIndex)`	`void`	یک ستون خالی را در یک صفحه در محل مشخص شده درج می کند.
`insertColumns(columnIndex, numColumns)`	`void`	یک یا چند ستون خالی متوالی را در یک صفحه درج می کند که از محل مشخص شده شروع می شود.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	تعداد مشخصی از ستون ها را بعد از موقعیت ستون داده شده درج می کند.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند.
`insertImage(blobSource, column, row)`	`OverGridImage`	`BlobSource` را به عنوان تصویر در یک سطر و ستون معین در سند درج می کند.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	`BlobSource` را به عنوان تصویر در یک سطر و ستون معین، با فاصله پیکسلی در سند درج می کند.
`insertImage(url, column, row)`	`OverGridImage`	یک تصویر را در یک سطر و ستون معین در سند درج می کند.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	یک تصویر را در یک ردیف و ستون معین، با فاصله پیکسلی در سند درج می کند.
`insertRowAfter(afterPosition)`	`Sheet`	یک ردیف بعد از موقعیت ردیف داده شده درج می کند.
`insertRowBefore(beforePosition)`	`Sheet`	یک ردیف قبل از موقعیت ردیف داده شده درج می کند.
`insertRows(rowIndex)`	`void`	یک ردیف خالی را در یک صفحه در محل مشخص شده درج می کند.
`insertRows(rowIndex, numRows)`	`void`	یک یا چند ردیف خالی متوالی را در یک برگه قرار می دهد که از محل مشخص شده شروع می شود.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	تعدادی ردیف را بعد از موقعیت ردیف داده شده درج می کند.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	تعدادی ردیف را قبل از موقعیت ردیف داده شده درج می کند.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	یک برش دهنده جدید به این برگه اضافه می کند.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	یک برش دهنده جدید به این برگه اضافه می کند.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	نشان می دهد که آیا ستون داده شده توسط کاربر پنهان شده است یا خیر.
`isRightToLeft()`	`Boolean`	اگر این صفحه‌بندی از راست به چپ باشد، `true` برمی‌گرداند.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	نشان می دهد که آیا ردیف داده شده توسط یک فیلتر (نه نمای فیلتر) پنهان شده است یا خیر.
`isRowHiddenByUser(rowPosition)`	`Boolean`	نشان می دهد که آیا ردیف داده شده توسط کاربر پنهان شده است یا خیر.
`isSheetHidden()`	`Boolean`	اگر برگه در حال حاضر پنهان باشد، `true` برمی‌گرداند.
`moveColumns(columnSpec, destinationIndex)`	`void`	ستون های انتخاب شده توسط محدوده داده شده را به موقعیت نشان داده شده توسط `destinationIndex` منتقل می کند.
`moveRows(rowSpec, destinationIndex)`	`void`	ردیف های انتخاب شده توسط محدوده داده شده را به موقعیت نشان داده شده توسط `destinationIndex` منتقل می کند.
`newChart()`	`EmbeddedChartBuilder`	سازنده ای را برای ایجاد نمودار جدید برای این برگه برمی گرداند.
`protect()`	`Protection`	یک شی ایجاد می کند که می تواند برگه را از ویرایش محافظت کند مگر توسط کاربرانی که مجوز دارند.
`removeChart(chart)`	`void`	نمودار را از صفحه اصلی حذف می کند.
`setActiveRange(range)`	`Range`	محدوده مشخص شده را به عنوان `active range` در برگه فعال، با سلول بالا سمت چپ در محدوده به عنوان `current cell` تنظیم می کند.
`setActiveRangeList(rangeList)`	`RangeList`	لیست مشخص شده محدوده ها را به عنوان `active ranges` در برگه فعال تنظیم می کند.
`setActiveSelection(range)`	`Range`	منطقه انتخاب فعال را برای این برگه تنظیم می کند.
`setActiveSelection(a1Notation)`	`Range`	انتخاب فعال را همانطور که در نماد A1 یا R1C1 مشخص شده است، تنظیم می کند.
`setColumnGroupControlPosition(position)`	`Sheet`	موقعیت کلید کنترل گروه ستون را روی صفحه تنظیم می کند.
`setColumnWidth(columnPosition, width)`	`Sheet`	عرض ستون داده شده را بر حسب پیکسل تنظیم می کند.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	عرض ستون های داده شده را بر حسب پیکسل تنظیم می کند.
`setConditionalFormatRules(rules)`	`void`	همه قوانین قالب مشروط موجود در برگه را با قوانین ورودی جایگزین می کند.
`setCurrentCell(cell)`	`Range`	سلول مشخص شده را به عنوان `current cell` تنظیم می کند.
`setFrozenColumns(columns)`	`void`	تعداد ستون ها را ثابت می کند.
`setFrozenRows(rows)`	`void`	تعداد ردیف های داده شده را ثابت می کند.
`setHiddenGridlines(hideGridlines)`	`Sheet`	خطوط شبکه ورق را پنهان یا آشکار می کند.
`setName(name)`	`Sheet`	نام برگه را تنظیم می کند.
`setRightToLeft(rightToLeft)`	`Sheet`	چیدمان برگه را از راست به چپ تنظیم یا از حالت خارج می کند.
`setRowGroupControlPosition(position)`	`Sheet`	موقعیت کلید کنترل گروه ردیف را روی برگه تنظیم می کند.
`setRowHeight(rowPosition, height)`	`Sheet`	ارتفاع ردیف ردیف داده شده را بر حسب پیکسل تنظیم می کند.
`setRowHeights(startRow, numRows, height)`	`Sheet`	ارتفاع ردیف های داده شده را بر حسب پیکسل تنظیم می کند.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	ارتفاع ردیف های داده شده را بر حسب پیکسل تنظیم می کند.
`setTabColor(color)`	`Sheet`	رنگ برگه برگه را تنظیم می کند.
`setTabColorObject(color)`	`Sheet`	رنگ برگه برگه را تنظیم می کند.
`showColumns(columnIndex)`	`void`	ستون را در نمایه داده شده باز می کند.
`showColumns(columnIndex, numColumns)`	`void`	یک یا چند ستون متوالی را که از نمایه داده شده شروع می شوند، آشکار می کند.
`showRows(rowIndex)`	`void`	سطر را در نمایه داده شده باز می کند.
`showRows(rowIndex, numRows)`	`void`	یک یا چند ردیف متوالی را که از نمایه داده شده شروع می شوند، آشکار می کند.
`showSheet()`	`Sheet`	ورق را نمایان می کند.
`sort(columnPosition)`	`Sheet`	یک ورق را بر اساس ستون، صعودی مرتب می کند.
`sort(columnPosition, ascending)`	`Sheet`	یک ورق را به ستون مرتب می کند.
`unhideColumn(column)`	`void`	ستون را در محدوده داده شده باز می کند.
`unhideRow(row)`	`void`	ردیف را در محدوده داده شده نشان می دهد.
`updateChart(chart)`	`void`	نمودار موجود در این برگه را به روز می کند.

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

روش	نوع برگشت	توضیح مختصر
`getSheetProtection()`	`PageProtection`	یک نمونه `PageProtection` را برمی‌گرداند که مجوزهای برگه فعلی را توصیف می‌کند.
`getTabColor()`	`String`	رنگ برگه برگه را می گیرد یا اگر برگه برگه رنگی نداشته باشد `null` .
`setSheetProtection(permissions)`	`void`	مجوزها را برای برگه فعلی تنظیم می کند.

مستندات دقیق

`activate()`

این برگه را فعال می کند. خود برگه را تغییر نمی دهد، فقط تصور والدین از برگه فعال را تغییر می دهد.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.activate();

برگشت

Sheet - برگه تازه فعال شده است.

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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

برگشت

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

مجوز

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

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

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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

برگشت

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

مجوز

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

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

`appendRow(rowContents)`

یک ردیف به پایین منطقه داده فعلی در برگه اضافه می کند. اگر محتوای یک سلول با = شروع شود، به عنوان یک فرمول تفسیر می شود.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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"]);

مولفه های

نام	تایپ کنید	شرح
`rowContents`	`Object[]`	آرایه ای از مقادیر برای درج بعد از آخرین ردیف در برگه.

برگشت

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

مجوز

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

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

`asDataSourceSheet()`

اگر برگه از نوع SheetType.DATASOURCE باشد، برگه null به عنوان DataSourceSheet برمی‌گرداند.

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

برگشت

DataSourceSheet - برگه منبع داده.

مجوز

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

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

`autoResizeColumn(columnPosition)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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);

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت ستون داده شده برای تغییر اندازه.

برگشت

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

مجوز

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

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

`autoResizeColumns(startColumn, numColumns)`

عرض همه ستون‌ها را که از موقعیت ستون داده شده شروع می‌شوند، تنظیم می‌کند تا متناسب با محتوای آنها باشد.

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

مولفه های

نام	تایپ کنید	شرح
`startColumn`	`Integer`	ستون شروع برای تغییر اندازه خودکار.
`numColumns`	`Integer`	تعداد ستون ها برای تغییر اندازه خودکار

برگشت

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

مجوز

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

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

`autoResizeRows(startRow, numRows)`

ارتفاع تمام سطرها را که از موقعیت ردیف داده شده شروع می‌شوند، تنظیم می‌کند تا متناسب با محتوای آنها باشد.

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

مولفه های

نام	تایپ کنید	شرح
`startRow`	`Integer`	سطر شروع برای تغییر اندازه خودکار.
`numRows`	`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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clear();

برگشت

Sheet - ورق پاک شده.

مجوز

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

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

`clear(options)`

برگه محتویات و/یا قالب را، همانطور که با گزینه های پیشرفته داده شده مشخص شده است، پاک می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.clear({ formatOnly: true, contentsOnly: true });

مولفه های

نام	تایپ کنید	شرح
`options`	`Object`	یک نقشه جاوا اسکریپت حاوی گزینه های پیشرفته که در زیر فهرست شده است.

پارامترهای پیشرفته

نام	تایپ کنید	شرح
`contentsOnly`	`Boolean`	آیا برای پاک کردن محتوا.
`formatOnly`	`Boolean`	اینکه آیا قالب را پاک کنیم.

برگشت

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

مجوز

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

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

`clearConditionalFormatRules()`

تمام قوانین قالب مشروط را از برگه حذف می کند. معادل فراخوانی setConditionalFormatRules(rules) با یک آرایه خالی به عنوان ورودی.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

مجوز

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

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

`clearContents()`

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

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearContents();

برگشت

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

مجوز

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

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

`clearFormats()`

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

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

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearFormats();

برگشت

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

مجوز

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

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

`clearNotes()`

برگه را از همه یادداشت ها پاک می کند.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearNotes();

برگشت

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

مجوز

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

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

`collapseAllColumnGroups()`

همه گروه‌های ستون روی صفحه را جمع می‌کند.

var 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

`collapseAllRowGroups()`

همه گروه‌های ردیف روی برگه را جمع می‌کند.

var 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

`copyTo(spreadsheet)`

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

var source = SpreadsheetApp.getActiveSpreadsheet();
var sheet = source.getSheets()[0];

var 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

`createDeveloperMetadataFinder()`

یک DeveloperMetadataFinder را برای یافتن ابرداده توسعه‌دهنده در محدوده این برگه برمی‌گرداند. اگر با خود برگه مرتبط باشد یا با یک ردیف، ستون یا محدوده در آن برگه مرتبط باشد، فراداده در محدوده یک برگه خاص قرار دارد.

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

برگشت

DeveloperMetadataFinder - یاب ابرداده توسعه دهنده برای جستجوی ابرداده در محدوده این برگه.

`createTextFinder(findText)`

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

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

// Creates  a text finder.
var textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

مولفه های

نام	تایپ کنید	شرح
`findText`	`String`	متن مورد جستجو

برگشت

TextFinder - TextFinder برای برگه.

`deleteColumn(columnPosition)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت ستون، از 1 برای ستون اول شروع می شود.

برگشت

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

مجوز

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

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

`deleteColumns(columnPosition, howMany)`

تعدادی از ستون هایی که از موقعیت ستون داده شده شروع می شوند را حذف می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت اولین ستون برای حذف.
`howMany`	`Integer`	تعداد ستون هایی که باید حذف شوند.

مجوز

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

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

`deleteRow(rowPosition)`

ردیف را در موقعیت ردیف داده شده حذف می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف، از 1 برای ردیف اول شروع می شود.

برگشت

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

مجوز

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

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

`deleteRows(rowPosition, howMany)`

تعدادی از ردیف هایی که از موقعیت ردیف داده شده شروع می شوند را حذف می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف اول برای حذف.
`howMany`	`Integer`	تعداد ردیف هایی که باید حذف شوند.

مجوز

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

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

`expandAllColumnGroups()`

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

var 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

`expandAllRowGroups()`

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

var 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

`expandColumnGroupsUpToDepth(groupDepth)`

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

var 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);

مولفه های

نام	تایپ کنید	شرح
`groupDepth`	`Integer`	عمق گروه که تا آن گروه ستون ها را گسترش دهید.

برگشت

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

مجوز

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

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

`expandRowGroupsUpToDepth(groupDepth)`

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

var 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);

مولفه های

نام	تایپ کنید	شرح
`groupDepth`	`Integer`	عمق گروه تا آن که گروه های ردیف را گسترش دهید.

برگشت

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

مجوز

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

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

`getActiveCell()`

سلول فعال در این برگه را برمی گرداند.

توجه: ترجیحاً getCurrentCell() استفاده کنید که سلول هایلایت شده فعلی را برمی گرداند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

برگشت

Range - سلول فعال فعلی

مجوز

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

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

`getActiveRange()`

محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد null . اگر چندین محدوده انتخاب شده باشد، این روش فقط آخرین محدوده انتخاب شده را برمی گرداند.

اصطلاح "محدوده فعال" به محدوده ای اطلاق می شود که کاربر در برگه فعال انتخاب کرده است، اما در یک تابع سفارشی به سلولی اشاره دارد که به طور فعال مجدداً محاسبه می شود.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

برگشت

Range - محدوده فعال

مجوز

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

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

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

setActiveRange(range)

`getActiveRangeList()`

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

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

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

برگشت

RangeList - لیست محدوده های فعال

مجوز

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

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

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

setActiveRangeList(rangeList)

`getBandings()`

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

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

`getCharts()`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var charts = sheet.getCharts();

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

برگشت

EmbeddedChart[] - آرایه ای از نمودارها.

مجوز

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

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

`getColumnGroup(columnIndex, groupDepth)`

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

var 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.
var columnGroup = sheet.getColumnGroup(2, 1);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	نمایه ستون ضامن کنترل گروه یا نمایه ای در داخل گروه.
`groupDepth`	`Integer`	عمق گروه.

برگشت

Group - گروه ستون در نمایه و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد می کند.

مجوز

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

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

`getColumnGroupControlPosition()`

GroupControlTogglePosition را برای همه گروه‌های ستون در برگه برمی‌گرداند.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the
// group.
var columnGroupControlPosition = sheet.getColumnGroupControlPosition();

برگشت

GroupControlTogglePosition - true اگر ضامن کنترل گروه بندی ستون بعد از گروه در این صفحه نشان داده شود و در غیر این صورت false .

مجوز

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

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

`getColumnGroupDepth(columnIndex)`

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

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

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

// 1 if there is a group over columns 1 through 3
var groupDepth = sheet.getColumnGroupDepth(1);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	شاخص ستون.

برگشت

Integer - عمق گروه ستون در شاخص داده شده.

مجوز

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

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

`getColumnWidth(columnPosition)`

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

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

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت ستون برای بررسی.

برگشت

Integer - عرض ستون بر حسب پیکسل

مجوز

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

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

`getConditionalFormatRules()`

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

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

برگشت

ConditionalFormatRule[] - آرایه ای از تمام قوانین موجود در برگه.

مجوز

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

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

`getCurrentCell()`

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

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

برگشت

Range - سلول فعلی

مجوز

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

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

`getDataRange()`

یک Range مربوط به ابعادی که داده در آن وجود دارد را برمی‌گرداند.

این از نظر عملکردی معادل ایجاد یک محدوده محدود شده با A1 و (Sheet.getLastColumn()، Sheet.getLastRow()) است.

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

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var 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

`getDataSourceFormulas()`

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

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

برگشت

DataSourceFormula[] - فهرستی از فرمول های منبع داده.

مجوز

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

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

`getDataSourcePivotTables()`

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

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

برگشت

DataSourcePivotTable[] - فهرستی از جداول محوری منبع داده.

مجوز

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

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

`getDataSourceTables()`

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

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

برگشت

DataSourceTable[] - فهرستی از جداول منبع داده.

مجوز

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

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

`getDeveloperMetadata()`

تمام ابرداده های توسعه دهنده مرتبط با این برگه را دریافت کنید.

// 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());
}

برگشت

DeveloperMetadata[] - فراداده توسعه دهنده مرتبط با این برگه.

مجوز

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

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

`getDrawings()`

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

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

`getFilter()`

فیلتر موجود در این برگه را برمی‌گرداند یا اگر فیلتری وجود نداشته باشد null .

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

برگشت

Filter - فیلتر.

مجوز

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

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

`getFormUrl()`

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

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

برگشت

String - URL برای فرمی که پاسخ های خود را در این برگه قرار می دهد، یا اگر این برگه فرم مرتبطی نداشته باشد، null .

مجوز

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

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

`getFrozenColumns()`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

`getFrozenRows()`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

`getImages()`

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

// 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());
}

برگشت

OverGridImage[] - آرایه ای از تصاویر بیش از شبکه.

مجوز

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

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

`getIndex()`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var 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

`getLastColumn()`

موقعیت آخرین ستونی که محتوا دارد را برمی‌گرداند.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

برگشت

Integer - آخرین ستون برگه که حاوی محتوا است

مجوز

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

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

`getLastRow()`

موقعیت آخرین ردیفی که محتوا دارد را برمی‌گرداند.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

برگشت

Integer - آخرین ردیف برگه که حاوی محتوا است

مجوز

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

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

`getMaxColumns()`

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

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

برگشت

Integer - حداکثر عرض ورق.

مجوز

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

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

`getMaxRows()`

بدون توجه به محتوا، تعداد ردیف‌های فعلی صفحه را برمی‌گرداند.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

برگشت

Integer - حداکثر ارتفاع ورق.

مجوز

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

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

`getName()`

نام برگه را برمی گرداند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
Logger.log(sheet.getName());

برگشت

String - نام ورق.

مجوز

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

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

`getNamedRanges()`

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

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

برگشت

NamedRange[] - آرایه ای از تمام محدوده های نامگذاری شده در برگه.

مجوز

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

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

`getParent()`

Spreadsheet حاوی این صفحه را برمی گرداند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

برگشت

Spreadsheet - صفحه گسترده والد.

مجوز

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

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

`getPivotTables()`

تمام جداول محوری این برگه را برمی‌گرداند.

// 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());
}

برگشت

PivotTable[] - جداول محوری در این صفحه.

مجوز

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

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

`getProtections(type)`

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

// Remove all range protections in the spreadsheet that the user has permission to edit.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

مولفه های

نام	تایپ کنید	شرح
`type`	`ProtectionType`	نوع منطقه محافظت شده، `SpreadsheetApp.ProtectionType.RANGE` یا `SpreadsheetApp.ProtectionType.SHEET` .

برگشت

Protection[] - آرایه ای از اشیاء که تمام محدوده های محافظت شده در برگه را نشان می دهد، یا یک آرایه تک عنصری که حفاظت در خود برگه را نشان می دهد.

مجوز

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

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

`getRange(row, column)`

محدوده را با سلول بالا سمت چپ در مختصات داده شده برمی گرداند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var 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

`getRange(row, column, numRows)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is returned.
var range = sheet.getRange(1, 1, 3);
var values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

مولفه های

نام	تایپ کنید	شرح
`row`	`Integer`	شاخص ردیف شروع محدوده؛ نمایه سازی ردیف با 1 شروع می شود.
`column`	`Integer`	شاخص ستون محدوده؛ نمایه سازی ستون با 1 شروع می شود.
`numRows`	`Integer`	تعداد ردیف هایی که باید برگردانده شوند.

برگشت

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

مجوز

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

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

`getRange(row, column, numRows, numColumns)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 3, 3);
var values = range.getValues();

// Print values from a 3x3 box.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

مولفه های

نام	تایپ کنید	شرح
`row`	`Integer`	شاخص ردیف شروع محدوده؛ نمایه سازی ردیف با 1 شروع می شود.
`column`	`Integer`	شاخص ستون شروع محدوده؛ نمایه سازی ستون با 1 شروع می شود.
`numRows`	`Integer`	تعداد ردیف هایی که باید برگردانده شوند.
`numColumns`	`Integer`	تعداد ستون هایی که باید برگردانده شوند.

برگشت

Range - محدوده مربوط به منطقه مشخص شده.

مجوز

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

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

`getRange(a1Notation)`

محدوده مشخص شده در نماد A1 یا R1C1 را برمی‌گرداند.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

مولفه های

نام	تایپ کنید	شرح
`a1Notation`	`String`	محدوده ای که باید برگردانده شود، همانطور که در نماد A1 یا نماد R1C1 مشخص شده است.

برگشت

Range - محدوده در مکان تعیین شده

مجوز

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

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

`getRangeList(a1Notations)`

مجموعه RangeList را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای A1 یا نمادهای R1C1 نشان می دهد.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

مولفه های

نام	تایپ کنید	شرح
`a1Notations`	`String[]`	فهرست محدوده هایی که باید برگردانده شوند، همانطور که در نماد A1 یا R1C1 مشخص شده است.

برگشت

RangeList - لیست محدوده در مکان تعیین شده

مجوز

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

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

`getRowGroup(rowIndex, groupDepth)`

گروه ردیف را در نمایه و عمق گروه داده شده برمی گرداند.

var 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.
var rowGroup = sheet.getRowGroup(2, 1);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	نمایه ردیف دسته کنترل گروه یا شاخصی در داخل گروه.
`groupDepth`	`Integer`	عمق گروه.

برگشت

Group - گروه ردیف در نمایه و عمق کنترل، یا اگر گروه وجود نداشته باشد، یک استثنا ایجاد می کند.

مجوز

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

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

`getRowGroupControlPosition()`

GroupControlTogglePosition را برای همه گروه‌های ردیف در برگه برمی‌گرداند.

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the
// group.
var rowGroupControlPosition = sheet.getRowGroupControlPosition();

برگشت

GroupControlTogglePosition - true اگر ضامن کنترل گروه بندی ردیف بعد از گروه در این صفحه نشان داده شود و در غیر این صورت false .

مجوز

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

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

`getRowGroupDepth(rowIndex)`

عمق گروه ردیف را در شاخص داده شده برمی‌گرداند.

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

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

// 1 if there is a group over rows 1 through 3
var groupDepth = sheet.getRowGroupDepth(1);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	شاخص ردیف.

برگشت

Integer - عمق گروه ردیف در شاخص داده شده.

مجوز

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

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

`getRowHeight(rowPosition)`

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

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

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف برای بررسی.

برگشت

Integer - ارتفاع ردیف بر حسب پیکسل

مجوز

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

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

`getSelection()`

Selection فعلی را در صفحه گسترده برمی‌گرداند.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

برگشت

Selection - انتخاب فعلی

مجوز

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

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

`getSheetId()`

شناسه برگه نشان داده شده توسط این شی را برمی گرداند.

این یک شناسه برای صفحه‌ای است که مختص صفحه‌گسترده است. شناسه یک عدد صحیح افزایش دهنده یکنواخت است که در زمان ایجاد برگه اختصاص داده می شود که مستقل از موقعیت ورق است. این در ارتباط با روش هایی مانند Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) که یک پارامتر gridId را به جای نمونه Sheet می گیرند، مفید است.

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

Logger.log(sheet.getSheetId());

برگشت

Integer - شناسه ای برای صفحه منحصر به فرد صفحه گسترده

مجوز

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

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

`getSheetName()`

نام برگه را برمی گرداند.

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

Logger.log(sheet.getSheetName());

برگشت

String - نام ورق

مجوز

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

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

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

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

مولفه های

نام	تایپ کنید	شرح
`startRow`	`Integer`	موقعیت ردیف شروع.
`startColumn`	`Integer`	موقعیت ستون شروع.
`numRows`	`Integer`	تعداد سطرهایی که باید مقادیر را برگرداند.
`numColumns`	`Integer`	تعداد ستون‌هایی که باید مقادیر را برگرداند.

برگشت

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

مجوز

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

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

`getSlicers()`

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

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

`getTabColorObject()`

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

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

برگشت

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

مجوز

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

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

`getType()`

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

نوع پیش فرض برگه SheetType.GRID است. برگه ای که شامل یک شی جاسازی شده مانند EmbeddedChart باشد، یک برگه SheetType.OBJECT است.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
Logger.log(sheet.getType());

برگشت

SheetType - نوع برگه.

مجوز

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

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

`hasHiddenGridlines()`

اگر خطوط شبکه ورق پنهان باشد، 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

`hideColumn(column)`

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

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

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

مولفه های

نام	تایپ کنید	شرح
`column`	`Range`	محدوده ستون برای پنهان کردن.

مجوز

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

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

`hideColumns(columnIndex)`

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

برای پنهان کردن بیش از یک ستون با استفاده از یک نمایه، از hideColumns(columnIndex, numColumns) استفاده کنید.

برای مخفی کردن بیش از یک ستون با استفاده از یک محدوده، از hideColumn() استفاده کنید.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	نمایه ستونی که باید پنهان شود.

مجوز

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

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

`hideColumns(columnIndex, numColumns)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	نمایه شروع ستون هایی که باید پنهان شوند.
`numColumns`	`Integer`	تعداد ستون هایی که باید پنهان شوند.

مجوز

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

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

`hideRow(row)`

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

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

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

مولفه های

نام	تایپ کنید	شرح
`row`	`Range`	محدوده ردیف برای پنهان کردن.

مجوز

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

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

`hideRows(rowIndex)`

ردیف را در شاخص داده شده پنهان می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	نمایه سطر برای پنهان کردن.

مجوز

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

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

`hideRows(rowIndex, numRows)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	نمایه شروع ردیف هایی که باید پنهان شوند.
`numRows`	`Integer`	تعداد ردیف هایی که باید پنهان شوند.

مجوز

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

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

`hideSheet()`

این برگه را پنهان می کند. اگر برگه قبلاً پنهان شده باشد تأثیری ندارد. اگر این متد در تنها صفحه قابل مشاهده فراخوانی شود، یک استثنا ایجاد می کند.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

برگشت

Sheet - برگه فعلی.

مجوز

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

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

`insertChart(chart)`

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

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var 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`	`EmbeddedChart`	نمودار برای درج.

مجوز

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

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

`insertColumnAfter(afterPosition)`

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

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

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

مولفه های

نام	تایپ کنید	شرح
`afterPosition`	`Integer`	ستون پس از آن باید ستون جدید اضافه شود.

برگشت

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

مجوز

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

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

`insertColumnBefore(beforePosition)`

قبل از موقعیت ستون داده شده ، یک ستون درج می کند.

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

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

مولفه های

نام	تایپ کنید	شرح
`beforePosition`	`Integer`	ستون قبل از آن باید ستون جدید اضافه شود.

برگشت

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

مجوز

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

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

`insertColumns(columnIndex)`

یک ستون خالی را در یک ورق در مکان مشخص قرار می دهد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	شاخص نشان می دهد که در کجا می توان ستون را وارد کرد.

مجوز

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

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

`insertColumns(columnIndex, numColumns)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	شاخص نشان می دهد که در کجا می توان ستون را وارد کرد.
`numColumns`	`Integer`	تعداد ستون ها برای درج.

مجوز

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

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

`insertColumnsAfter(afterPosition, howMany)`

بعد از موقعیت ستون داده شده ، تعداد مشخصی از ستون ها را درج می کند.

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

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

مولفه های

نام	تایپ کنید	شرح
`afterPosition`	`Integer`	ستون پس از آن باید ستون جدید اضافه شود.
`howMany`	`Integer`	تعداد ستون ها برای درج.

برگشت

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

مجوز

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

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

`insertColumnsBefore(beforePosition, howMany)`

تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند.

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

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

مولفه های

نام	تایپ کنید	شرح
`beforePosition`	`Integer`	ستون قبل از آن باید ستون جدید اضافه شود.
`howMany`	`Integer`	تعداد ستون ها برای درج.

برگشت

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

مجوز

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

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

`insertImage(blobSource, column, row)`

در یک ردیف و ستون معین ، یک BlobSource به عنوان یک تصویر در سند درج می کند. اندازه تصویر از محتوای حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2MB است.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

مولفه های

نام	تایپ کنید	شرح
`blobSource`	`BlobSource`	حباب حاوی محتویات تصویر ، نوع MIME و نام (اختیاری).
`column`	`Integer`	موقعیت ستون
`row`	`Integer`	موقعیت ردیف

برگشت

OverGridImage - تصویر درج شده.

مجوز

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

یک BlobSource به عنوان یک تصویر در سند در یک ردیف و ستون معین ، با جبران پیکسل درج می کند. اندازه تصویر از محتوای حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2MB است.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

مولفه های

نام	تایپ کنید	شرح
`blobSource`	`BlobSource`	حباب حاوی محتویات تصویر ، نوع MIME و نام (اختیاری).
`column`	`Integer`	موقعیت ستون
`row`	`Integer`	موقعیت ردیف
`offsetX`	`Integer`	جبران افقی از گوشه سلول در پیکسل ها.
`offsetY`	`Integer`	جبران عمودی از گوشه سلول در پیکسل ها.

برگشت

OverGridImage - تصویر درج شده.

مجوز

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

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

`insertImage(url, column, row)`

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

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

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

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

مولفه های

نام	تایپ کنید	شرح
`url`	`String`	URL تصویر.
`column`	`Integer`	موقعیت ستون شبکه.
`row`	`Integer`	موقعیت ردیف شبکه.

برگشت

OverGridImage - تصویر درج شده.

مجوز

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

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

`insertImage(url, column, row, offsetX, offsetY)`

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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`	جبران عمودی از گوشه سلول در پیکسل ها.

برگشت

OverGridImage - تصویر درج شده.

مجوز

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

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

`insertRowAfter(afterPosition)`

یک ردیف را بعد از موقعیت ردیف داده شده وارد کنید.

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

// This inserts a row after the first row position
sheet.insertRowAfter(1);

مولفه های

نام	تایپ کنید	شرح
`afterPosition`	`Integer`	ردیف پس از آن باید ردیف جدید اضافه شود.

برگشت

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

مجوز

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

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

`insertRowBefore(beforePosition)`

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

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

// This inserts a row before the first row position
sheet.insertRowBefore(1);

مولفه های

نام	تایپ کنید	شرح
`beforePosition`	`Integer`	ردیف قبل از آن باید ردیف جدید اضافه شود.

برگشت

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

مجوز

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

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

`insertRows(rowIndex)`

یک ردیف خالی را در یک ورق در مکان مشخص قرار می دهد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	شاخص نشان می دهد که در کجا می توان یک ردیف را وارد کرد.

مجوز

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

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

`insertRows(rowIndex, numRows)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	شاخص نشان می دهد که در کجا می توان یک ردیف را وارد کرد.
`numRows`	`Integer`	تعداد ردیف ها برای درج.

مجوز

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

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

`insertRowsAfter(afterPosition, howMany)`

تعدادی ردیف را پس از موقعیت ردیف داده شده درج می کند.

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

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

مولفه های

نام	تایپ کنید	شرح
`afterPosition`	`Integer`	ردیف پس از آن باید ردیف های جدید اضافه شود.
`howMany`	`Integer`	تعداد ردیف ها برای درج.

برگشت

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

مجوز

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

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

`insertRowsBefore(beforePosition, howMany)`

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

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

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

مولفه های

نام	تایپ کنید	شرح
`beforePosition`	`Integer`	ردیف قبل از آن باید ردیف های جدید اضافه شود.
`howMany`	`Integer`	تعداد ردیف ها برای درج.

برگشت

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

مجوز

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

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

`insertSlicer(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`	دامنه ای که بر روی برش برش ایجاد می شود.
`anchorRowPos`	`Integer`	قسمت بالای برش در این ردیف لنگر است.
`anchorColPos`	`Integer`	قسمت بالای برش در این سرهنگ لنگر است.

برگشت

Slicer - برش تازه وارد شده.

مجوز

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

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

`insertSlicer(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`	دامنه ای که بر روی برش برش ایجاد می شود.
`anchorRowPos`	`Integer`	قسمت بالای برش در این ردیف لنگر است.
`anchorColPos`	`Integer`	قسمت بالای برش در این سرهنگ لنگر است.
`offsetX`	`Integer`	جبران افقی از گوشه سلول در پیکسل ها.
`offsetY`	`Integer`	جبران عمودی از گوشه سلول در پیکسل ها.

برگشت

Slicer - برش تازه وارد شده.

مجوز

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

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

`isColumnHiddenByUser(columnPosition)`

باز می گردد که آیا ستون داده شده توسط کاربر پنهان است.

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

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت ستون برای بررسی.

برگشت

Boolean - اگر ستون پنهان باشد ، در غیر این صورت true false .

مجوز

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

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

`isRightToLeft()`

اگر این طرح ورق راست به چپ باشد ، 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

`isRowHiddenByFilter(rowPosition)`

باز می گردد که آیا ردیف داده شده توسط یک فیلتر پنهان است (نه نمای فیلتر).

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف برای بررسی.

برگشت

Boolean - اگر ردیف پنهان باشد ، در غیر این صورت true false .

مجوز

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

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

`isRowHiddenByUser(rowPosition)`

باز می گردد که آیا ردیف داده شده توسط کاربر پنهان است.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف برای بررسی.

برگشت

Boolean - اگر ردیف پنهان باشد ، در غیر این صورت true false .

مجوز

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

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

`isSheetHidden()`

اگر برگه در حال حاضر پنهان باشد ، true باز می گردد.

var sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

برگشت

Boolean - اگر ورق پنهان باشد ، در غیر این صورت true false .

مجوز

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

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

`moveColumns(columnSpec, destinationIndex)`

ستون های انتخاب شده توسط محدوده داده شده را به موقعیت نشان داده شده توسط destinationIndex منتقل می کند. خود columnSpec خود نیازی به نمایش کامل ستون یا گروهی از ستون ها برای جابجایی ندارد - تمام ستون هایی را که دامنه آن را انتخاب می کند ، انتخاب می کند.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

مولفه های

نام	تایپ کنید	شرح
`columnSpec`	`Range`	دامنه ای که ستون هایی را که باید جابجا شوند ، پوشانده است.
`destinationIndex`	`Integer`	شاخصی که ستون ها باید به آن منتقل شوند. توجه داشته باشید که این شاخص قبل از جابجایی ستون ها بر اساس مختصات است. داده های موجود به درستی جابجا می شوند تا در حالی که ستون های منبع از شبکه خارج می شوند ، فضای ستون های جابجایی را ایجاد کنند. بنابراین ، داده ها ممکن است در یک شاخص متفاوت از آنچه در ابتدا مشخص شده است به پایان برسد.

مجوز

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

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

`moveRows(rowSpec, destinationIndex)`

ردیف های انتخاب شده توسط محدوده داده شده را به موقعیت نشان داده شده توسط destinationIndex منتقل می کند. خود rowSpec برای حرکت دقیقاً نیازی به نمایش کامل ردیف یا گروهی از ردیف ها ندارد - تمام ردیف هایی را که دامنه آن را انتخاب می کند ، انتخاب می کند.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

مولفه های

نام	تایپ کنید	شرح
`rowSpec`	`Range`	دامنه ای که باید از ردیف هایی که باید جابجا شوند.
`destinationIndex`	`Integer`	شاخصی که ردیف ها باید به آن منتقل شوند. توجه داشته باشید که این شاخص قبل از جابجایی ردیف ها بر اساس مختصات است. داده های موجود به پایین منتقل می شوند تا در حالی که ردیف های منبع از شبکه خارج می شوند ، جایی برای ردیف های جابجایی ایجاد شود. بنابراین ، داده ها ممکن است در یک شاخص متفاوت از آنچه در ابتدا مشخص شده است به پایان برسد.

مجوز

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

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

`newChart()`

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

این مثال نحوه ایجاد یک نمودار جدید را نشان می دهد:

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

برگشت

EmbeddedChartBuilder - سازنده ای برای ایجاد نمودار جدید.

`protect()`

یک شیء ایجاد می کند که می تواند از ویرایش ورق محافظت کند ، مگر توسط کاربرانی که اجازه دارند. تا زمانی که اسکریپت در واقع لیست ویرایشگران را برای برگه تغییر دهد (با فراخوانی Protection.removeEditor(emailAddress) ، Protection.removeEditor(user) ، Protection.RemoveEditors Protection.removeEditors(emailAddresses) ، Protection.addEditor(emailAddress) ، Protection.addEditor(user) ، Protection.addEditors(emailAddresses) ، یا تعیین مقدار جدید برای Protection.setDomainEdit(editable) ) ، مجوزها آینه های صفحه گسترده خود را آینه می کنند ، که به طور مؤثر به معنای عدم محافظت باقی مانده است. اگر ورق از قبل محافظت شده باشد ، این روش یک شیء را نشان می دهد که تنظیمات حفاظت موجود خود را نشان می دهد. یک برگه محافظت شده ممکن است شامل مناطق محافظت نشده باشد.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var 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

`removeChart(chart)`

نمودار را از برگه والدین حذف می کند.

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

// This removes all the embedded charts from the spreadsheet
var charts = sheet.getCharts();
for (var i in charts) {
  sheet.removeChart(charts[i]);
}

مولفه های

نام	تایپ کنید	شرح
`chart`	`EmbeddedChart`	نمودار برای حذف.

مجوز

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

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

`setActiveRange(range)`

دامنه مشخص شده را به عنوان active range در ورق فعال تنظیم می کند ، با سلول بالا سمت چپ در محدوده به عنوان current cell .

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

مولفه های

نام	تایپ کنید	شرح
`range`	`Range`	دامنه ای که به عنوان محدوده فعال تنظیم می شود.

برگشت

Range - محدوده تازه فعال

مجوز

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

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

`setActiveRangeList(rangeList)`

لیست مشخص شده دامنه ها را به عنوان active ranges در برگه فعال تنظیم می کند. آخرین محدوده در لیست به عنوان active range تنظیم شده است.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

مولفه های

نام	تایپ کنید	شرح
`rangeList`	`RangeList`	لیست محدوده ها برای انتخاب.

برگشت

RangeList - لیست تازه انتخاب شده محدوده ها

مجوز

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

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

`setActiveSelection(range)`

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

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

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

مولفه های

نام	تایپ کنید	شرح
`range`	`Range`	دامنه ای که به عنوان انتخاب فعال تنظیم می شود.

برگشت

Range - محدوده تازه فعال

مجوز

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

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

`setActiveSelection(a1Notation)`

انتخاب فعال را تنظیم می کند ، همانطور که در نماد A1 یا نماد R1C1 مشخص شده است.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

`setColumnGroupControlPosition(position)`

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

مولفه های

نام	تایپ کنید	شرح
`position`	`GroupControlTogglePosition`	موقعیت ضامع کنترل گروه ستون.

برگشت

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

مجوز

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

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

`setColumnWidth(columnPosition, width)`

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

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	موقعیت ستون داده شده برای تنظیم.
`width`	`Integer`	عرض در پیکسل ها برای تنظیم آن.

برگشت

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

مجوز

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

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

`setColumnWidths(startColumn, numColumns, width)`

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

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

مولفه های

نام	تایپ کنید	شرح
`startColumn`	`Integer`	موقعیت ستون شروع برای تغییر.
`numColumns`	`Integer`	تعداد ستون ها برای تغییر.
`width`	`Integer`	عرض در پیکسل ها برای تنظیم آن.

برگشت

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

مجوز

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

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

`setConditionalFormatRules(rules)`

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

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
rules.splice(1, 1); // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

مولفه های

نام	تایپ کنید	شرح
`rules`	`ConditionalFormatRule[]`	قوانین جدید فرمت شرطی.

مجوز

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

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

`setCurrentCell(cell)`

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

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

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

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

مولفه های

نام	تایپ کنید	شرح
`cell`	`Range`	سلول به عنوان سلول فعلی تنظیم می شود.

برگشت

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

مجوز

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

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

`setFrozenColumns(columns)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

`setFrozenRows(rows)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

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

مولفه های

نام	تایپ کنید	شرح
`hideGridlines`	`Boolean`	اگر `true` ، خطوط شبکه را در این برگه پنهان کنید. در غیر این صورت خطوط را نشان دهید.

برگشت

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

مجوز

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

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

`setName(name)`

نام ورق را تنظیم می کند.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

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

مولفه های

نام	تایپ کنید	شرح
`rightToLeft`	`Boolean`	اگر `true` ، طرح ورق روی سمت راست به چپ تنظیم شده است ، با سلول A1 در گوشه بالا سمت راست. اگر `false` ، طرح ورق در سمت چپ به سمت چپ به سمت چپ به سمت چپ تنظیم شده است ، با سلول A1 در سمت چپ بالا.

برگشت

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

مجوز

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

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

`setRowGroupControlPosition(position)`

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

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

مولفه های

نام	تایپ کنید	شرح
`position`	`GroupControlTogglePosition`	موقعیت ضامن کنترل گروه ردیف.

برگشت

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

مجوز

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

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

`setRowHeight(rowPosition, height)`

ارتفاع ردیف ردیف داده شده را در پیکسل ها تنظیم می کند. به طور پیش فرض ، ردیف ها رشد می کنند تا محتوای سلول متناسب باشند. اگر می خواهید ردیف ها را به یک ارتفاع مشخص مجبور کنید ، از setRowHeightsForced(startRow, numRows, height) استفاده کنید.

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

مولفه های

نام	تایپ کنید	شرح
`rowPosition`	`Integer`	موقعیت ردیف برای تغییر.
`height`	`Integer`	ارتفاع پیکسل ها برای تنظیم آن.

برگشت

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

مجوز

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

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

`setRowHeights(startRow, numRows, height)`

ارتفاع ردیف های داده شده را در پیکسل ها قرار می دهد. به طور پیش فرض ، ردیف ها رشد می کنند تا محتوای سلول متناسب باشند. اگر می خواهید ردیف ها را به یک ارتفاع مشخص مجبور کنید ، از setRowHeightsForced(startRow, numRows, height) استفاده کنید.

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

مولفه های

نام	تایپ کنید	شرح
`startRow`	`Integer`	موقعیت ردیف شروع برای تغییر.
`numRows`	`Integer`	تعداد ردیف ها برای تغییر.
`height`	`Integer`	ارتفاع پیکسل ها برای تنظیم آن.

برگشت

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

مجوز

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

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

`setRowHeightsForced(startRow, numRows, height)`

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

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

مولفه های

نام	تایپ کنید	شرح
`startRow`	`Integer`	موقعیت ردیف شروع برای تغییر.
`numRows`	`Integer`	تعداد ردیف ها برای تغییر.
`height`	`Integer`	ارتفاع پیکسل ها برای تنظیم آن.

برگشت

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

مجوز

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

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

`setTabColor(color)`

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

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

`setTabColorObject(color)`

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

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var 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

`showColumns(columnIndex)`

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

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

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	شاخص ستون برای جدا کردن.

مجوز

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

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

`showColumns(columnIndex, numColumns)`

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

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

مولفه های

نام	تایپ کنید	شرح
`columnIndex`	`Integer`	شاخص شروع ستون ها برای جدا کردن.
`numColumns`	`Integer`	تعداد ستون ها برای قطع کردن.

مجوز

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

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

`showRows(rowIndex)`

ردیف را در شاخص داده شده باز می کند.

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

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	شاخص ردیف برای جدا کردن.

مجوز

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

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

`showRows(rowIndex, numRows)`

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

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

مولفه های

نام	تایپ کنید	شرح
`rowIndex`	`Integer`	شاخص شروع ردیف ها برای جدا کردن.
`numRows`	`Integer`	تعداد ردیف ها برای از بین بردن.

مجوز

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

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

`showSheet()`

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

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

برگشت

Sheet - برگه فعلی.

مجوز

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

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

`sort(columnPosition)`

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

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

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

مولفه های

نام	تایپ کنید	شرح
`columnPosition`	`Integer`	ستون برای مرتب کردن.

برگشت

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

مجوز

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

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

`sort(columnPosition, ascending)`

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

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

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

مولفه های

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

برگشت

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

مجوز

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

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

`unhideColumn(column)`

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

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

مولفه های

نام	تایپ کنید	شرح
`column`	`Range`	اگر پنهان باشد ، محدوده ای برای خنثی کردن.

مجوز

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

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

`unhideRow(row)`

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

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

مولفه های

نام	تایپ کنید	شرح
`row`	`Range`	اگر پنهان باشد ، محدوده ای برای خنثی کردن.

مجوز

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

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

`updateChart(chart)`

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

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

مولفه های

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

مجوز

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

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

روشهای مستهلک

`getSheetProtection()`

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

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

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

var 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.
var users = permissions.getUsers();
Logger.log(users);

برگشت

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

اعتبار

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

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

`getTabColor()`

منسوخ. جایگزین شده توسط getTabColorObject()

اگر برگه ورق null رنگی نداشته باشد ، رنگ برگه ورق را دریافت می کند.

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

برگشت

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

اعتبار

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

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

`setSheetProtection(permissions)`

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

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

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

var permissions = sheet.getSheetProtection();

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

مولفه های

نام	تایپ کنید	شرح
`permissions`	`PageProtection`	مجوزهای دسترسی برای تنظیم این برگه هدف قرار دارند.

اعتبار

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

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