Class Range

محدوده

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

روش ها

روش نوع برگشت شرح مختصر
activate() Range محدوده مشخص شده را به عنوان active range تنظیم می کند و سلول سمت چپ بالای محدوده را به عنوان current cell تنظیم می کند.
activateAsCurrentCell() Range سلول مشخص شده را به عنوان current cell تنظیم می کند.
addDeveloperMetadata(key) Range ابرداده توسعه دهنده را با کلید مشخص شده به محدوده اضافه می کند.
addDeveloperMetadata(key, visibility) Range ابرداده برنامه‌نویس را با کلید مشخص شده و قابلیت مشاهده به محدوده اضافه می‌کند.
addDeveloperMetadata(key, value) Range ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به محدوده اضافه می کند.
addDeveloperMetadata(key, value, visibility) Range ابرداده برنامه‌نویس را با کلید، مقدار و قابلیت مشاهده به محدوده اضافه می‌کند.
applyColumnBanding() Banding یک طرح زمینه پیش‌فرض باندبندی ستون را در محدوده اعمال می‌کند.
applyColumnBanding(bandingTheme) Banding یک طرح زمینه ستونی مشخص شده را در محدوده اعمال می کند.
applyColumnBanding(bandingTheme, showHeader, showFooter) Banding یک طرح زمینه ستونی مشخص شده را با تنظیمات سرصفحه و پاورقی مشخص شده در محدوده اعمال می کند.
applyRowBanding() Banding یک طرح زمینه پیش‌فرض باندبندی ردیف را در محدوده اعمال می‌کند.
applyRowBanding(bandingTheme) Banding یک تم باندبندی ردیف مشخص شده را به محدوده اعمال می کند.
applyRowBanding(bandingTheme, showHeader, showFooter) Banding یک تم باندبندی ردیف مشخص شده را با تنظیمات سرصفحه و پاورقی مشخص شده در محدوده اعمال می کند.
autoFill(destination, series) void destinationRange با داده‌هایی بر اساس داده‌های این محدوده پر می‌کند.
autoFillToNeighbor(series) void محدوده ای را برای پر کردن با داده های جدید بر اساس سلول های مجاور محاسبه می کند و به طور خودکار آن محدوده را با مقادیر جدید بر اساس داده های موجود در این محدوده پر می کند.
breakApart() Range سلول های چند ستونی در محدوده را دوباره به سلول های جداگانه تقسیم کنید.
canEdit() Boolean تعیین می کند که آیا کاربر اجازه ویرایش هر سلول در محدوده را دارد یا خیر.
check() Range وضعیت چک باکس های موجود در محدوده را به "تیک زده" تغییر می دهد.
clear() Range محدوده محتویات و قالب ها را پاک می کند.
clear(options) Range محدوده محتویات، قالب، قوانین اعتبارسنجی داده ها و/یا نظرات را همانطور که با گزینه های پیشرفته داده شده مشخص شده است پاک می کند.
clearContent() Range محتوای محدوده را پاک می کند و قالب بندی را دست نخورده باقی می گذارد.
clearDataValidations() Range قوانین اعتبارسنجی داده را برای محدوده پاک می کند.
clearFormat() Range قالب بندی این محدوده را پاک می کند.
clearNote() Range یادداشت را در سلول یا سلول های داده شده پاک می کند.
collapseGroups() Range همه گروه هایی را که به طور کامل در محدوده قرار دارند جمع می کند.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) void قالب بندی محدوده را در مکان مشخص شده کپی کنید.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) void قالب بندی محدوده را در مکان مشخص شده کپی کنید.
copyTo(destination) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copyTo(destination, copyPasteType, transposed) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copyTo(destination, options) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) void محتوای محدوده را در مکان داده شده کپی کنید.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) void محتوای محدوده را در مکان داده شده کپی کنید.
createDataSourcePivotTable(dataSource) DataSourcePivotTable یک جدول محوری منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.
createDataSourceTable(dataSource) DataSourceTable یک جدول منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.
createDeveloperMetadataFinder() DeveloperMetadataFinder یک DeveloperMetadataFinderApi را برای یافتن ابرداده توسعه‌دهنده در محدوده این محدوده برمی‌گرداند.
createFilter() Filter یک فیلتر ایجاد می کند و آن را در محدوده مشخص شده در برگه اعمال می کند.
createPivotTable(sourceData) PivotTable یک جدول محوری خالی از sourceData مشخص شده در اولین سلول این محدوده ایجاد می کند.
createTextFinder(findText) TextFinder یک متن یاب برای محدوده ایجاد می کند که می تواند متن را در این محدوده پیدا کرده و جایگزین کند.
deleteCells(shiftDimension) void این محدوده از سلول ها را حذف می کند.
expandGroups() Range گروه‌های جمع‌شده را گسترش می‌دهد که تغییر دامنه یا کنترل با این محدوده تقاطع دارد.
getA1Notation() String شرح رشته ای از محدوده را با نماد A1 برمی گرداند.
getBackground() String رنگ پس‌زمینه سلول بالا سمت چپ در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).
getBackgroundObject() Color رنگ پس‌زمینه سلول بالا سمت چپ محدوده را برمی‌گرداند.
getBackgroundObjects() Color[][] رنگ‌های پس‌زمینه سلول‌های محدوده را برمی‌گرداند.
getBackgrounds() String[][] رنگ‌های پس‌زمینه سلول‌های موجود در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).
getBandings() Banding[] همه باندهایی را که به هر سلولی در این محدوده اعمال می شود، برمی گرداند.
getCell(row, column) Range یک سلول معین را در یک محدوده برمی گرداند.
getColumn() Integer موقعیت ستون شروع را برای این محدوده برمی گرداند.
getDataRegion() Range یک کپی از محدوده گسترش یافته در چهار Direction اصلی را برمی‌گرداند تا تمام سلول‌های مجاور را با داده‌های موجود در آنها پوشش دهد.
getDataRegion(dimension) Range اگر بعد مشخص شده Dimension.ROWS یا Direction.NEXT و Direction.PREVIOUS باشد اگر بعد Dimension.COLUMNS باشد، یک کپی از دامنه گسترش یافته Direction.UP و Direction.DOWN برمی گرداند.
getDataSourceFormula() DataSourceFormula DataSourceFormula برای اولین سلول در محدوده برمی‌گرداند، یا اگر سلول حاوی فرمول منبع داده نباشد null برمی‌گرداند.
getDataSourceFormulas() DataSourceFormula[] DataSourceFormula s را برای سلول های محدوده برمی گرداند.
getDataSourcePivotTables() DataSourcePivotTable[] همه جداول محوری منبع داده را که با محدوده متقاطع هستند را دریافت می کند.
getDataSourceTables() DataSourceTable[] همه جداول منبع داده را که با محدوده متقاطع هستند را دریافت می کند.
getDataSourceUrl() String یک URL برای داده‌های این محدوده برمی‌گرداند که می‌توان از آن برای ایجاد نمودارها و جستارها استفاده کرد.
getDataTable() DataTable داده های داخل این شی را به عنوان DataTable برگردانید.
getDataTable(firstRowIsHeader) DataTable داده های داخل این محدوده را به عنوان DataTable برگردانید.
getDataValidation() DataValidation قانون اعتبارسنجی داده را برای سلول بالا سمت چپ در محدوده برمی‌گرداند.
getDataValidations() DataValidation[][] قوانین اعتبارسنجی داده ها را برای همه سلول های محدوده برمی گرداند.
getDeveloperMetadata() DeveloperMetadata[] فراداده توسعه دهنده مرتبط با این محدوده را دریافت می کند.
getDisplayValue() String مقدار نمایش داده شده سلول بالا سمت چپ در محدوده را برمی گرداند.
getDisplayValues() String[][] شبکه مستطیلی مقادیر این محدوده را برمی‌گرداند.
getFilter() Filter فیلتر را در برگه ای که این محدوده به آن تعلق دارد برمی گرداند، یا اگر فیلتری در برگه وجود نداشته باشد null .
getFontColorObject() Color رنگ فونت سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getFontColorObjects() Color[][] رنگ فونت سلول های محدوده را برمی گرداند.
getFontFamilies() String[][] خانواده‌های فونت سلول‌های محدوده را برمی‌گرداند.
getFontFamily() String خانواده فونت سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getFontLine() String سبک خط سلول را در گوشه سمت چپ بالای محدوده دریافت می کند ( 'underline' ، 'line-through' یا 'none' ).
getFontLines() String[][] سبک خط سلول‌های محدوده را دریافت می‌کند ( 'underline' ، 'line-through' ، یا 'none' ).
getFontSize() Integer اندازه قلم را در اندازه نقطه سلول در گوشه سمت چپ بالای محدوده برمی‌گرداند.
getFontSizes() Integer[][] اندازه فونت سلول های محدوده را برمی گرداند.
getFontStyle() String سبک قلم ( 'italic' یا 'normal' ) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getFontStyles() String[][] سبک های فونت سلول های محدوده را برمی گرداند.
getFontWeight() String وزن قلم (عادی/پررنگ) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getFontWeights() String[][] وزن فونت سلول های محدوده را برمی گرداند.
getFormula() String فرمول (نماد A1) را برای سلول سمت چپ بالای محدوده، یا اگر سلول خالی یا فاقد فرمول باشد، یک رشته خالی را برمی‌گرداند.
getFormulaR1C1() String فرمول (نماد R1C1) را برای یک سلول معین برمی‌گرداند، یا اگر وجود نداشته باشد، null برمی‌گرداند.
getFormulas() String[][] فرمول‌ها (نشان A1) را برای سلول‌های محدوده برمی‌گرداند.
getFormulasR1C1() String[][] فرمول‌ها (نماد R1C1) را برای سلول‌های محدوده برمی‌گرداند.
getGridId() Integer شناسه شبکه صفحه اصلی محدوده را برمی‌گرداند.
getHeight() Integer ارتفاع محدوده را برمی‌گرداند.
getHorizontalAlignment() String تراز افقی متن (چپ/مرکز/راست) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getHorizontalAlignments() String[][] ترازهای افقی سلول های محدوده را برمی گرداند.
getLastColumn() Integer موقعیت ستون انتهایی را برمی‌گرداند.
getLastRow() Integer موقعیت ردیف انتهایی را برمی‌گرداند.
getMergedRanges() Range[] آرایه ای از اشیاء Range را نشان می دهد که سلول های ادغام شده را نشان می دهد که یا کاملاً در محدوده فعلی هستند یا حداقل یک سلول در محدوده فعلی دارند.
getNextDataCell(direction) Range با شروع از سلول در ستون و ردیف اول محدوده، سلول بعدی را در جهت داده شده برمی گرداند که لبه یک محدوده به هم پیوسته از سلول ها با داده ها در آنها یا سلول در لبه صفحه گسترده در آن جهت است.
getNote() String یادداشت مرتبط با محدوده داده شده را برمی گرداند.
getNotes() String[][] یادداشت های مرتبط با سلول های محدوده را برمی گرداند.
getNumColumns() Integer تعداد ستون های این محدوده را برمی گرداند.
getNumRows() Integer تعداد ردیف‌های این محدوده را برمی‌گرداند.
getNumberFormat() String شماره یا قالب بندی تاریخ سلول بالا سمت چپ محدوده داده شده را دریافت کنید.
getNumberFormats() String[][] تعداد یا قالب‌های تاریخ را برای سلول‌های محدوده برمی‌گرداند.
getRichTextValue() RichTextValue مقدار Rich Text را برای سلول سمت چپ بالای محدوده برمی‌گرداند، یا اگر مقدار سلول متنی نباشد، null برمی‌گرداند.
getRichTextValues() RichTextValue[][] مقادیر Rich Text را برای سلول‌های محدوده برمی‌گرداند.
getRow() Integer موقعیت ردیف را برای این محدوده برمی گرداند.
getRowIndex() Integer موقعیت ردیف را برای این محدوده برمی گرداند.
getSheet() Sheet برگه ای که این محدوده به آن تعلق دارد را برمی گرداند.
getTextDirection() TextDirection جهت متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
getTextDirections() TextDirection[][] جهت های متنی را برای سلول های محدوده برمی گرداند.
getTextRotation() TextRotation تنظیمات چرخش متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
getTextRotations() TextRotation[][] تنظیمات چرخش متن را برای سلول های محدوده برمی گرداند.
getTextStyle() TextStyle سبک متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
getTextStyles() TextStyle[][] سبک های متن را برای سلول های محدوده برمی گرداند.
getValue() Object مقدار سلول بالا سمت چپ در محدوده را برمی‌گرداند.
getValues() Object[][] شبکه مستطیلی مقادیر این محدوده را برمی‌گرداند.
getVerticalAlignment() String تراز عمودی (بالا/وسط/پایین) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
getVerticalAlignments() String[][] ترازهای عمودی سلول های محدوده را برمی گرداند.
getWidth() Integer عرض محدوده را در ستون ها برمی گرداند.
getWrap() Boolean برمی‌گرداند که آیا متن داخل سلول بسته می‌شود یا خیر.
getWrapStrategies() WrapStrategy[][] استراتژی های بسته بندی متن را برای سلول های محدوده برمی گرداند.
getWrapStrategy() WrapStrategy استراتژی بسته بندی متن را برای سلول سمت چپ بالای محدوده برمی گرداند.
getWraps() Boolean[][] برمی‌گرداند که آیا متن در سلول‌ها بسته می‌شود یا خیر.
insertCells(shiftDimension) Range سلول های خالی را در این محدوده قرار می دهد.
insertCheckboxes() Range چک باکس ها را در هر سلول در محدوده وارد می کند که با true برای علامت زده و false برای علامت نشده پیکربندی شده است.
insertCheckboxes(checkedValue) Range چک باکس ها را در هر سلول در محدوده وارد می کند که با یک مقدار سفارشی برای علامت گذاری شده و رشته خالی برای علامت گذاری نشده پیکربندی شده است.
insertCheckboxes(checkedValue, uncheckedValue) Range چک باکس‌ها را در هر سلول در محدوده وارد می‌کند که با مقادیر سفارشی برای حالت‌های علامت‌گذاری شده و علامت‌نخورده پیکربندی شده است.
isBlank() Boolean اگر محدوده کاملاً خالی باشد، true برمی‌گرداند.
isChecked() Boolean برمی‌گرداند که آیا تمام سلول‌های محدوده دارای وضعیت چک باکس «بررسی» هستند یا خیر.
isEndColumnBounded() Boolean تعیین می کند که آیا انتهای محدوده به یک ستون خاص محدود شده است یا خیر.
isEndRowBounded() Boolean تعیین می کند که آیا انتهای محدوده به یک ردیف خاص محدود شده است یا خیر.
isPartOfMerge() Boolean اگر سلول‌های محدوده فعلی با سلول‌های ادغام شده همپوشانی داشته باشند، true را برمی‌گرداند.
isStartColumnBounded() Boolean تعیین می کند که آیا شروع محدوده به یک ستون خاص محدود شده است یا خیر.
isStartRowBounded() Boolean تعیین می کند که آیا شروع محدوده به یک ردیف خاص محدود شده است یا خیر.
merge() Range سلول های محدوده را با هم در یک بلوک ادغام می کند.
mergeAcross() Range سلول های محدوده را در ستون های محدوده ادغام کنید.
mergeVertically() Range سلول های محدوده را با هم ادغام می کند.
moveTo(target) void برش و چسباندن (هم فرمت و هم مقادیر) از این محدوده به محدوده هدف.
offset(rowOffset, columnOffset) Range محدوده جدیدی را برمی‌گرداند که با تعداد ردیف‌ها و ستون‌های معین (که می‌تواند منفی باشد) از این محدوده خارج می‌شود.
offset(rowOffset, columnOffset, numRows) Range محدوده جدیدی را برمی‌گرداند که نسبت به محدوده فعلی است، که نقطه بالای سمت چپ آن با ردیف‌ها و ستون‌های داده‌شده و با ارتفاع داده‌شده در سلول‌ها از محدوده فعلی خارج می‌شود.
offset(rowOffset, columnOffset, numRows, numColumns) Range محدوده جدیدی را که نسبت به محدوده فعلی است، برمی‌گرداند که نقطه بالای سمت چپ آن با ردیف‌ها و ستون‌های داده‌شده، و با ارتفاع و عرض داده‌شده در سلول‌ها، از محدوده فعلی خارج می‌شود.
protect() Protection یک شی ایجاد می کند که می تواند محدوده را از ویرایش محافظت کند مگر توسط کاربرانی که مجوز دارند.
randomize() Range ترتیب ردیف ها را در محدوده داده شده تصادفی می کند.
removeCheckboxes() Range تمام چک باکس ها را از محدوده حذف می کند.
removeDuplicates() Range ردیف هایی را در این محدوده که حاوی مقادیری هستند که تکراری از مقادیر در هر ردیف قبلی هستند، حذف می کند.
removeDuplicates(columnsToCompare) Range ردیف هایی را در این محدوده که حاوی مقادیری در ستون های مشخص شده هستند که تکراری از مقادیر هر ردیف قبلی هستند، حذف می کند.
setBackground(color) Range رنگ پس‌زمینه همه سلول‌های محدوده را در نماد CSS (مانند '#ffffff' یا 'white' ) تنظیم می‌کند.
setBackgroundObject(color) Range رنگ پس‌زمینه همه سلول‌های محدوده را تنظیم می‌کند.
setBackgroundObjects(color) Range یک شبکه مستطیلی از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setBackgroundRGB(red, green, blue) Range با استفاده از مقادیر RGB (اعداد صحیح بین 0 تا 255) پس زمینه را به رنگ داده شده تنظیم می کند.
setBackgrounds(color) Range یک شبکه مستطیلی از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setBorder(top, left, bottom, right, vertical, horizontal) Range ویژگی border را تنظیم می کند.
setBorder(top, left, bottom, right, vertical, horizontal, color, style) Range ویژگی حاشیه را با رنگ و/یا سبک تنظیم می کند.
setDataValidation(rule) Range یک قانون اعتبارسنجی داده را برای همه سلول‌های محدوده تنظیم می‌کند.
setDataValidations(rules) Range قوانین اعتبارسنجی داده را برای همه سلول های محدوده تنظیم می کند.
setFontColor(color) Range رنگ فونت را در نماد CSS (مانند '#ffffff' یا 'white' ) تنظیم می کند.
setFontColorObject(color) Range رنگ فونت محدوده داده شده را تنظیم می کند.
setFontColorObjects(colors) Range یک شبکه مستطیلی از رنگ فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontColors(colors) Range یک شبکه مستطیلی از رنگ فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontFamilies(fontFamilies) Range یک شبکه مستطیلی از خانواده فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontFamily(fontFamily) Range خانواده فونت مانند "Arial" یا "Helvetica" را تنظیم می کند.
setFontLine(fontLine) Range سبک خط فونت محدوده داده شده را تنظیم می کند ( 'underline' ، 'line-through' یا 'none' ).
setFontLines(fontLines) Range یک شبکه مستطیلی از سبک های خط را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontSize(size) Range اندازه فونت را تنظیم می کند، با اندازه اندازه نقطه مورد استفاده.
setFontSizes(sizes) Range یک شبکه مستطیلی از اندازه فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontStyle(fontStyle) Range سبک فونت را برای محدوده داده شده تنظیم کنید ( 'italic' یا 'normal' ).
setFontStyles(fontStyles) Range یک شبکه مستطیلی از سبک های فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFontWeight(fontWeight) Range وزن قلم را برای محدوده داده شده (معمولی/پررنگ) تنظیم کنید.
setFontWeights(fontWeights) Range یک شبکه مستطیلی از وزن فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFormula(formula) Range فرمول این محدوده را به روز می کند.
setFormulaR1C1(formula) Range فرمول این محدوده را به روز می کند.
setFormulas(formulas) Range یک شبکه مستطیلی از فرمول ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setFormulasR1C1(formulas) Range یک شبکه مستطیلی از فرمول ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setHorizontalAlignment(alignment) Range تراز افقی (از چپ به راست) را برای محدوده داده شده (چپ/مرکز/راست) تنظیم کنید.
setHorizontalAlignments(alignments) Range یک شبکه مستطیلی از ترازهای افقی را تنظیم می کند.
setNote(note) Range نت را روی مقدار داده شده تنظیم می کند.
setNotes(notes) Range یک شبکه مستطیلی از یادداشت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setNumberFormat(numberFormat) Range قالب شماره یا تاریخ را روی رشته قالب بندی داده شده تنظیم می کند.
setNumberFormats(numberFormats) Range یک شبکه مستطیلی از قالب‌های شماره یا تاریخ را تنظیم می‌کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setRichTextValue(value) Range مقدار Rich Text را برای سلول های محدوده تنظیم می کند.
setRichTextValues(values) Range یک شبکه مستطیلی از مقادیر Rich Text را تنظیم می کند.
setShowHyperlink(showHyperlink) Range تعیین می کند که آیا محدوده باید هایپرلینک ها را نشان دهد یا خیر.
setTextDirection(direction) Range جهت متن را برای سلول های محدوده تنظیم می کند.
setTextDirections(directions) Range یک شبکه مستطیلی از جهت های متن را تنظیم می کند.
setTextRotation(degrees) Range تنظیمات چرخش متن را برای سلول های محدوده تنظیم می کند.
setTextRotation(rotation) Range تنظیمات چرخش متن را برای سلول های محدوده تنظیم می کند.
setTextRotations(rotations) Range یک شبکه مستطیل شکل از چرخش متن را تنظیم می کند.
setTextStyle(style) Range سبک متن را برای سلول های محدوده تنظیم می کند.
setTextStyles(styles) Range یک شبکه مستطیلی از سبک های متن را تنظیم می کند.
setValue(value) Range مقدار محدوده را تعیین می کند.
setValues(values) Range یک شبکه مستطیلی از مقادیر را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setVerticalAlignment(alignment) Range تراز عمودی (بالا به پایین) را برای محدوده داده شده (بالا/وسط/پایین) تنظیم کنید.
setVerticalAlignments(alignments) Range یک شبکه مستطیلی از ترازهای عمودی را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
setVerticalText(isVertical) Range تنظیم می کند که آیا متن برای سلول های محدوده روی هم چیده شود یا نه.
setWrap(isWrapEnabled) Range پوشش سلولی محدوده داده شده را تنظیم کنید.
setWrapStrategies(strategies) Range یک شبکه مستطیل شکل از استراتژی های بسته بندی را تنظیم می کند.
setWrapStrategy(strategy) Range استراتژی بسته بندی متن را برای سلول های محدوده تنظیم می کند.
setWraps(isWrapEnabled) Range یک شبکه مستطیلی از خط‌مشی‌های بسته‌بندی کلمه را تنظیم می‌کند (باید با ابعاد این محدوده مطابقت داشته باشد).
shiftColumnGroupDepth(delta) Range عمق گروه بندی ستون محدوده را با مقدار مشخص شده تغییر می دهد.
shiftRowGroupDepth(delta) Range عمق گروه بندی ردیف محدوده را با مقدار مشخص شده تغییر می دهد.
sort(sortSpecObj) Range سلول های محدوده داده شده را بر اساس ستون و ترتیب مشخص شده مرتب می کند.
splitTextToColumns() void ستونی از متن را بر اساس یک جداکننده خودکار شناسایی شده به چندین ستون تقسیم می کند.
splitTextToColumns(delimiter) void ستونی از متن را با استفاده از رشته مشخص شده به عنوان جداکننده سفارشی به چندین ستون تقسیم می کند.
splitTextToColumns(delimiter) void ستونی از متن را بر اساس جداکننده مشخص شده به چندین ستون تقسیم می کند.
trimWhitespace() Range فضای خالی (مانند فاصله ها، برگه ها یا خطوط جدید) را در هر سلول در این محدوده برش می دهد.
uncheck() Range وضعیت چک باکس های موجود در محدوده را به "تیک نخورده" تغییر می دهد.

مستندات دقیق

activate()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

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

بازگشت

Range - این محدوده، برای زنجیر.


activateAsCurrentCell()

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

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

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

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

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

  • 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
visibility DeveloperMetadataVisibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

  • 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
value String مقدار فراداده توسعه‌دهنده جدید.

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

  • 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
value String مقدار فراداده توسعه‌دهنده جدید.
visibility DeveloperMetadataVisibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

applyColumnBanding()

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

بازگشت

Banding - باندبندی جدید.

مجوز

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

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

applyColumnBanding(bandingTheme)

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

پارامترها

نام تایپ کنید توضیحات
bandingTheme BandingTheme یک تم رنگی برای اعمال به ستون‌های محدوده.

بازگشت

Banding - باندبندی جدید.

مجوز

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

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

پارامترها

نام تایپ کنید توضیحات
bandingTheme BandingTheme یک تم رنگی برای اعمال به ستون‌های محدوده.
showHeader Boolean اگر true ، رنگ سرصفحه باندبندی به ستون اول اعمال می‌شود.
showFooter Boolean اگر true ، رنگ فوتر طرح زمینه نواری به آخرین ستون اعمال می شود.

بازگشت

Banding - باندبندی جدید.

مجوز

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

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

applyRowBanding()

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

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

بازگشت

Banding - باندبندی.

مجوز

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

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

applyRowBanding(bandingTheme)

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

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

پارامترها

نام تایپ کنید توضیحات
bandingTheme BandingTheme یک تم رنگی برای اعمال به ردیف‌های محدوده.

بازگشت

Banding - باندبندی جدید.

مجوز

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

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

applyRowBanding(bandingTheme, showHeader, showFooter)

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

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

پارامترها

نام تایپ کنید توضیحات
bandingTheme BandingTheme یک تم رنگی برای اعمال به ردیف‌های محدوده.
showHeader Boolean اگر true ، رنگ هدر طرح زمینه باندینگ در ردیف اول اعمال می شود.
showFooter Boolean اگر true ، رنگ پاورقی طرح زمینه نواری به ردیف آخر اعمال می شود.

بازگشت

Banding - باندبندی جدید.

مجوز

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

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

autoFill(destination, series)

destinationRange با داده‌هایی بر اساس داده‌های این محدوده پر می‌کند. مقادیر جدید نیز بر اساس نوع series مشخص شده تعیین می شوند. محدوده مقصد باید شامل این محدوده باشد و آن را فقط در یک جهت گسترش دهد. به عنوان مثال، موارد زیر A1:A20 را با یک سری اعداد فزاینده بر اساس مقادیر فعلی در A1:A4 پر می کند:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

پارامترها

نام تایپ کنید توضیحات
destination Range محدوده ای که باید به صورت خودکار با مقادیر پر شود. محدوده مقصد باید شامل این محدوده باشد و آن را فقط در یک جهت (به سمت بالا، پایین، چپ یا راست) گسترش دهد.
series AutoFillSeries نوع سری AutoFill که باید برای محاسبه مقادیر جدید استفاده شود. تأثیر این سری بر اساس نوع و مقدار داده های منبع متفاوت است.

مجوز

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

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

autoFillToNeighbor(series)

محدوده ای را برای پر کردن با داده های جدید بر اساس سلول های مجاور محاسبه می کند و به طور خودکار آن محدوده را با مقادیر جدید بر اساس داده های موجود در این محدوده پر می کند. این مقادیر جدید نیز بر اساس نوع series مشخص شده تعیین می شوند.

محدوده مقصد محاسبه‌شده، داده‌های اطراف را برای تعیین مکان درج مقادیر جدید در نظر می‌گیرد: اگر داده‌هایی در سمت چپ یا راست ستونی وجود داشته باشد که به طور خودکار پر می‌شود، مقادیر جدید فقط تا اندازه این داده‌های مجاور گسترش می‌یابند.

به عنوان مثال، اگر A1:A20 با یک سری اعداد در حال افزایش پر شود و این روش در محدوده B1:B4 که شامل یک سری تاریخ است فراخوانی شود، مقادیر جدید فقط در B5:B20 درج می شوند. به این ترتیب، این مقادیر جدید به سلول‌هایی که حاوی مقادیر ستون A هستند، می‌چسبند.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

پارامترها

نام تایپ کنید توضیحات
series AutoFillSeries نوع سری AutoFill که باید برای محاسبه مقادیر جدید استفاده شود. تأثیر این سری بر اساس نوع و مقدار داده های منبع متفاوت است.

مجوز

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

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

breakApart()

سلول های چند ستونی در محدوده را دوباره به سلول های جداگانه تقسیم کنید.

فراخوانی این تابع در یک محدوده معادل انتخاب یک محدوده و کلیک کردن روی Format > Mergecells > Unmerge است.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

canEdit()

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

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

بازگشت

Boolean - true اگر کاربر اجازه ویرایش هر سلول در محدوده را داشته باشد. false در غیر این صورت

مجوز

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

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

check()

وضعیت چک باکس های موجود در محدوده را به "تیک زده" تغییر می دهد. سلول‌های موجود در محدوده را که در حال حاضر حاوی مقدار علامت‌گذاری شده یا علامت‌نخورده پیکربندی شده نیستند، نادیده می‌گیرد.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clear()

محدوده محتویات و قالب ها را پاک می کند.

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

var range = sheet.getRange("A1:D10");
range.clear();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clear(options)

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

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

پارامترها

نام تایپ کنید توضیحات
options Object یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام تایپ کنید توضیحات
commentsOnly Boolean اینکه آیا فقط نظرات پاک شود.
contentsOnly Boolean فقط محتویات پاک شود.
formatOnly Boolean اینکه آیا فقط قالب پاک شود. توجه داشته باشید که فرمت پاکسازی قوانین اعتبارسنجی داده ها را نیز پاک می کند.
validationsOnly Boolean اینکه آیا فقط قوانین اعتبارسنجی داده ها پاک شود.
skipFilteredRows Boolean آیا برای جلوگیری از پاک کردن ردیف های فیلتر شده.

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clearContent()

محتوای محدوده را پاک می کند و قالب بندی را دست نخورده باقی می گذارد.

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

var range = sheet.getRange("A1:D10");
range.clearContent();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clearDataValidations()

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

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clearFormat()

قالب بندی این محدوده را پاک می کند.

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

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

clearNote()

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

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

var range = sheet.getRange("A1:D10");
range.clearNote();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

collapseGroups()

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

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

copyFormatToRange(gridId, column, columnEnd, row, rowEnd)

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

برای توضیح دقیق پارامتر gridId، به getGridId() مراجعه کنید.

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

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

پارامترها

نام تایپ کنید توضیحات
gridId Integer شناسه منحصر به فرد برگه در صفحه گسترده، صرف نظر از موقعیت.
column Integer ستون اول محدوده هدف.
columnEnd Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
rowEnd Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

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


copyFormatToRange(sheet, column, columnEnd, row, rowEnd)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

پارامترها

نام تایپ کنید توضیحات
sheet Sheet ورق هدف.
column Integer ستون اول محدوده هدف.
columnEnd Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
rowEnd Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

copyTo(destination)

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

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

پارامترها

نام تایپ کنید توضیحات
destination Range محدوده مقصد برای کپی کردن؛ فقط موقعیت سلول بالا سمت چپ مرتبط است.

مجوز

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

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

copyTo(destination, copyPasteType, transposed)

داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

پارامترها

نام تایپ کنید توضیحات
destination Range محدوده مقصد برای کپی کردن؛ فقط موقعیت سلول بالا سمت چپ مرتبط است.
copyPasteType CopyPasteType نوعی که نحوه چسباندن محتویات محدوده به مقصد را مشخص می کند.
transposed Boolean اینکه آیا محدوده باید در جهت جابجایی آن چسبانده شود یا خیر.

مجوز

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

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

copyTo(destination, options)

داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند. به‌طور پیش‌فرض، هم مقادیر و هم قالب‌بندی کپی می‌شوند، اما می‌توان با استفاده از آرگومان‌های پیشرفته آن را لغو کرد.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

پارامترها

نام تایپ کنید توضیحات
destination Range محدوده مقصد برای کپی کردن؛ فقط موقعیت سلول بالا سمت چپ مرتبط است.
options Object یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام تایپ کنید توضیحات
formatOnly Boolean مشخص می کند که فقط قالب باید کپی شود
contentsOnly Boolean مشخص می کند که فقط محتوا باید کپی شود

مجوز

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

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

copyValuesToRange(gridId, column, columnEnd, row, rowEnd)

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

برای توضیح دقیق پارامتر gridId، به getGridId() مراجعه کنید.

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

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

پارامترها

نام تایپ کنید توضیحات
gridId Integer شناسه منحصر به فرد برگه در صفحه گسترده، صرف نظر از موقعیت.
column Integer ستون اول محدوده هدف.
columnEnd Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
rowEnd Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

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


copyValuesToRange(sheet, column, columnEnd, row, rowEnd)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

پارامترها

نام تایپ کنید توضیحات
sheet Sheet ورق هدف.
column Integer ستون اول محدوده هدف.
columnEnd Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
rowEnd Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

createDataSourcePivotTable(dataSource)

یک جدول محوری منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.

این مثال نحوه ایجاد و پیکربندی یک جدول محوری منبع داده جدید را نشان می دهد.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

پارامترها

نام تایپ کنید توضیحات
dataSource DataSource منبع داده برای ایجاد جدول محوری.

بازگشت

DataSourcePivotTable - جدول محوری منبع داده جدید ایجاد شده.

مجوز

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

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

createDataSourceTable(dataSource)

یک جدول منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.

این مثال نحوه ایجاد و پیکربندی جدول منبع داده جدید را نشان می دهد.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

پارامترها

نام تایپ کنید توضیحات
dataSource DataSource منبع داده برای ایجاد جدول محوری.

بازگشت

DataSourceTable - جدول منبع داده جدید ایجاد شده.

مجوز

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

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

createDeveloperMetadataFinder()

یک DeveloperMetadataFinderApi را برای یافتن ابرداده توسعه‌دهنده در محدوده این محدوده برمی‌گرداند. فراداده تنها در صورتی در محدوده محدوده قرار دارد که به طور کامل در آن محدوده باشد. برای مثال، ابرداده مرتبط با ردیف «3:3» در محدوده «A1:D5» نیست، اما در محدوده «1:5» قرار دارد.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

بازگشت

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


createFilter()

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

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
از این روش برای ایجاد فیلتر برای صفحات Grid ، نوع پیش فرض برگه استفاده کنید. صفحات گرید برگه هایی هستند که به پایگاه داده متصل نیستند. برای ایجاد انواع دیگر فیلترها به موارد زیر مراجعه کنید:

بازگشت

Filter - فیلتر جدید.

مجوز

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

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

createPivotTable(sourceData)

یک جدول محوری خالی از sourceData مشخص شده در اولین سلول این محدوده ایجاد می کند.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

پارامترها

نام تایپ کنید توضیحات
sourceData Range داده هایی برای ایجاد جدول محوری.

بازگشت

PivotTable - PivotTable تازه ایجاد شده.

مجوز

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

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

createTextFinder(findText)

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

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

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

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

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

پارامترها

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

بازگشت

TextFinder - TextFinder برای محدوده


deleteCells(shiftDimension)

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

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

پارامترها

نام تایپ کنید توضیحات
shiftDimension Dimension بعد که در امتداد آن داده های موجود جابه جا می شوند.

مجوز

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

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

expandGroups()

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

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

// All row and column groups within the range are expanded.
range.expandGroups();

بازگشت

Range - این محدوده، برای زنجیر.

مجوز

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

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

getA1Notation()

شرح رشته ای از محدوده را با نماد A1 برمی گرداند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

بازگشت

String - شرح رشته محدوده در نماد A1.

مجوز

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

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

getBackground()

رنگ پس‌زمینه سلول بالا سمت چپ در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

بازگشت

String - کد رنگ پس زمینه.

مجوز

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

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

getBackgroundObject()

رنگ پس‌زمینه سلول بالا سمت چپ محدوده را برمی‌گرداند.

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

بازگشت

Color - رنگ پس زمینه سلول بالا سمت چپ در محدوده.

مجوز

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

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

getBackgroundObjects()

رنگ‌های پس‌زمینه سلول‌های محدوده را برمی‌گرداند.

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

بازگشت

Color[][] - آرایه دو بعدی از رنگ های پس زمینه.

مجوز

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

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

getBackgrounds()

رنگ‌های پس‌زمینه سلول‌های موجود در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

بازگشت

String[][] - آرایه دو بعدی از کدهای رنگی پس زمینه.

مجوز

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

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

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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

بازگشت

Banding[] - همه باندهایی که برای هر سلولی در این محدوده اعمال می شود.

مجوز

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

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

getCell(row, column)

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

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

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

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

پارامترها

نام تایپ کنید توضیحات
row Integer ردیف سلول نسبت به محدوده.
column Integer ستون سلول نسبت به محدوده.

بازگشت

Range - محدوده ای که شامل یک سلول در مختصات مشخص شده است.

مجوز

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

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

getColumn()

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

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

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

بازگشت

Integer - موقعیت ستون شروع محدوده در صفحه گسترده.

مجوز

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

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

getDataRegion()

یک کپی از محدوده گسترش یافته در چهار Direction اصلی را برمی‌گرداند تا تمام سلول‌های مجاور را با داده‌های موجود در آنها پوشش دهد. اگر محدوده با سلول‌های خالی احاطه شده باشد که در امتداد مورب‌ها قرار ندارند، خود محدوده برگردانده می‌شود. این شبیه به انتخاب محدوده و تایپ Ctrl+A در ویرایشگر است.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

بازگشت

Range - منطقه داده محدوده یا محدوده ای برای کل صفحه گسترده.

مجوز

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

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

getDataRegion(dimension)

اگر بعد مشخص شده Dimension.ROWS یا Direction.NEXT و Direction.PREVIOUS باشد اگر بعد Dimension.COLUMNS باشد، یک کپی از دامنه گسترش یافته Direction.UP و Direction.DOWN برمی گرداند. گسترش دامنه بر اساس تشخیص داده ها در کنار محدوده ای است که مانند یک جدول سازماندهی شده است. محدوده گسترش یافته تمام سلول های مجاور را با داده های موجود در آنها در امتداد بعد مشخص شده از جمله مرزهای جدول پوشش می دهد. اگر محدوده اصلی توسط سلول های خالی در امتداد بعد مشخص شده احاطه شود، خود محدوده برگردانده می شود. این روش شبیه انتخاب محدوده و تایپ Ctrl+Space برای ستون‌ها یا Shift+Space برای ردیف‌ها در ویرایشگر است.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

پارامترها

نام تایپ کنید توضیحات
dimension Dimension ابعادی که در امتداد آن دامنه گسترش می یابد.

بازگشت

Range - منطقه داده‌های محدوده یا محدوده‌ای که هر ستون یا هر ردیف را که در محدوده اصلی قرار دارد را پوشش می‌دهد.

مجوز

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

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

getDataSourceFormula()

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

// 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

بازگشت

DataSourceFormula - DataSourceFormula برای سلول.

مجوز

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

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

getDataSourceFormulas()

DataSourceFormula s را برای سلول های محدوده برمی گرداند.

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

بازگشت

DataSourceFormula[] - آرایه ای از DataSourceFormula s.

مجوز

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

  • 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

بازگشت

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

مجوز

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

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

getDataSourceUrl()

یک URL برای داده‌های این محدوده برمی‌گرداند که می‌توان از آن برای ایجاد نمودارها و جستارها استفاده کرد.

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

بازگشت

String - یک URL برای این محدوده به عنوان منبع داده که می تواند به API های دیگر مانند نمودارها ارسال شود.

مجوز

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

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

getDataTable()

داده های داخل این شی را به عنوان DataTable برگردانید.

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

بازگشت

DataTable - داده ها به عنوان یک جدول داده.


getDataTable(firstRowIsHeader)

داده های داخل این محدوده را به عنوان DataTable برگردانید.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

پارامترها

نام تایپ کنید توضیحات
firstRowIsHeader Boolean آیا باید ردیف اول را به عنوان یک سربرگ در نظر گرفت.

بازگشت

DataTable - داده ها به عنوان یک جدول داده.

مجوز

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

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

getDataValidation()

قانون اعتبارسنجی داده را برای سلول بالا سمت چپ در محدوده برمی‌گرداند. اگر اعتبارسنجی داده روی سلول تنظیم نشده باشد، این روش null را برمی‌گرداند.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

بازگشت

DataValidation - قانون اعتبارسنجی داده برای سلول بالا سمت چپ در محدوده.

مجوز

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

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

getDataValidations()

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

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

بازگشت

DataValidation[][] - یک آرایه دو بعدی از قوانین اعتبارسنجی داده مرتبط با سلول‌های موجود در محدوده.

مجوز

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

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