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 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 metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

بازگشت

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

مجوز

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

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

getDisplayValue()

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

// 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 A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

بازگشت

String - مقدار نمایش داده شده در این سلول.

مجوز

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

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

getDisplayValues()

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

یک آرایه دو بعدی از مقادیر نمایش داده شده را برمی‌گرداند که با ردیف و سپس ستون نمایه شده است. مقادیر اشیاء String هستند. مقدار نمایش داده شده تاریخ، زمان و قالب‌بندی واحد پول را در نظر می‌گیرد، از جمله قالب‌هایی که به‌طور خودکار توسط تنظیمات محلی صفحه‌گسترده اعمال می‌شوند. سلول های خالی با یک رشته خالی در آرایه نشان داده می شوند. به یاد داشته باشید که در حالی که یک شاخص محدوده از 1, 1 شروع می شود، آرایه جاوا اسکریپت از [0][0] ایندکس می شود.

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

بازگشت

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

مجوز

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

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

getFilter()

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

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

بازگشت

Filter - فیلتر.

مجوز

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

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

getFontColorObject()

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

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

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

بازگشت

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

مجوز

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

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

getFontColorObjects()

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

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

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

بازگشت

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

مجوز

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

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

getFontFamilies()

خانواده‌های فونت سلول‌های محدوده را برمی‌گرداند.

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

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

String[][] - یک آرایه دو بعدی از خانواده فونت‌هایی که با سلول‌های محدوده مرتبط هستند.

مجوز

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

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

getFontFamily()

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

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

Logger.log(range.getFontFamily());

بازگشت

String - خانواده فونت سلول.

مجوز

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

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

getFontLine()

سبک خط سلول را در گوشه سمت چپ بالای محدوده دریافت می کند ( 'underline' ، 'line-through' یا 'none' ).

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

Logger.log(range.getFontLine());

بازگشت

String - خط فونت.

مجوز

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

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

getFontLines()

سبک خط سلول‌های محدوده را دریافت می‌کند ( 'underline' ، 'line-through' ، یا 'none' ).

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

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

String[][] - آرایه دو بعدی از خطوط فونت مرتبط با سلول های محدوده.

مجوز

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

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

getFontSize()

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

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

Logger.log(range.getFontSize());

بازگشت

Integer - اندازه قلم در اندازه نقطه.

مجوز

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

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

getFontSizes()

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

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

var results = range.getFontSizes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

Integer[][] - یک آرایه دو بعدی از اندازه فونت متن مرتبط با سلول های محدوده.

مجوز

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

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

getFontStyle()

سبک قلم ( 'italic' یا 'normal' ) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.

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

Logger.log(range.getFontStyle());

بازگشت

String - سبک فونت متن در سلول.

مجوز

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

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

getFontStyles()

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

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

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

String[][] -یک آرایه دو بعدی از سبک های فونت متن مرتبط با سلول ها در محدوده.

مجوز

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

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

getFontWeight()

وزن قلم (طبیعی/جسورانه) سلول را در گوشه بالا سمت چپ دامنه برمی گرداند.

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

Logger.log(range.getFontWeight());

بازگشت

String - وزن قلم متن در سلول.

مجوز

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

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

getFontWeights()

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

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

var results = range.getFontWeights();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

String[][] -یک آرایه دو بعدی از وزن فونت متن مرتبط با سلول ها در محدوده.

مجوز

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

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

getFormula()

فرمول (نماد A1) را برای سلول بالا سمت چپ دامنه باز می گرداند ، یا اگر سلول خالی باشد یا حاوی فرمول نباشد ، یک رشته خالی است.

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

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

بازگشت

String - فرمول سلول.

مجوز

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

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

getFormulaR1C1()

فرمول (نماد R1C1) را برای یک سلول معین باز می گرداند ، یا اگر null کدام نباشد.

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

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

بازگشت

String - فرمول در نماد R1C1.

مجوز

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

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

getFormulas()

فرمولها (نماد A1) را برای سلولهای موجود در محدوده برمی گرداند. ورودی های موجود در آرایه 2D رشته های خالی برای سلولهای بدون فرمول است.

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

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

بازگشت

String[][] -یک آرایه دو بعدی از فرمول ها در قالب رشته.

مجوز

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

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

getFormulasR1C1()

فرمولها (نماد R1C1) را برای سلولهای موجود در محدوده برمی گرداند. ورودی های موجود در آرایه 2D برای سلولهای بدون فرمول null است.

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

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

بازگشت

String[][] -یک آرایه دو بعدی از فرمول ها در نماد R1C1.

مجوز

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

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

getGridId()

شناسه شبکه برگه والدین دامنه را برمی گرداند. شناسه ها مقادیر Int غیر منفی تصادفی هستند.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

بازگشت

Integer - شناسه شبکه برگه والدین.

مجوز

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

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

getHeight()

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

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

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

بازگشت

Integer - ارتفاع دامنه.

مجوز

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

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

getHorizontalAlignment()

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

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

Logger.log(range.getHorizontalAlignment());

بازگشت

String - تراز افقی متن در سلول.

مجوز

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

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

getHorizontalAlignments()

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

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

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

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

مجوز

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

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

getLastColumn()

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

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

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

بازگشت

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

مجوز

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

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

getLastRow()

موقعیت ردیف پایان را برمی گرداند.

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

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

بازگشت

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

مجوز

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

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

getMergedRanges()

مجموعه ای از اشیاء Range را نشان می دهد که سلول های ادغام شده ای را نشان می دهند که یا کاملاً در محدوده فعلی هستند ، یا حداقل در محدوده فعلی حاوی یک سلول هستند.

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

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

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

بازگشت

Range[] - مجموعه ای از اشیاء Range ، سلولهای ادغام شده با هم تداخل دارند.


getNextDataCell(direction)

با شروع از سلول در ستون اول و ردیف دامنه ، سلول بعدی را در جهت معین که لبه طیف وسیعی از سلول ها با داده های موجود در آنها یا سلول در لبه صفحه گسترده در آن جهت است ، برمی گرداند. این معادل تایپ Ctrl+[arrow key] در ویرایشگر است.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

پارامترها

نام تایپ کنید توضیحات
direction Direction جهت پیدا کردن سلول لبه منطقه بعدی داده می شود.

بازگشت

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

مجوز

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

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

getNote()

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

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

Logger.log(range.getNote());

بازگشت

String - یادداشت مرتبط با سلول داده شده.

مجوز

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

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

getNotes()

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

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

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

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

مجوز

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

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

getNumColumns()

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

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

بازگشت

Integer - تعداد ستون ها در این محدوده.

مجوز

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

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

getNumRows()

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

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

بازگشت

Integer - تعداد ردیف ها در این محدوده.

مجوز

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

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

getNumberFormat()

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

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

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

بازگشت

String -فرمت شماره سلول بالا سمت چپ دامنه.

مجوز

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

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

getNumberFormats()

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

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

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

بازگشت

String[][] -یک آرایه دو بعدی از قالب های شماره.

مجوز

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

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

getRichTextValue()

اگر مقدار سلول متن نباشد ، مقدار متن غنی را برای سلول بالا سمت چپ دامنه برمی null .

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

بازگشت

RichTextValue - مقدار متن غنی سلول سمت چپ بالا در محدوده ، یا اگر مقدار سلول متن نباشد ، null .

مجوز

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

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

getRichTextValues()

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

// Gets the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

بازگشت

RichTextValue[][] -یک آرایه دو بعدی از مقادیر متن غنی.

مجوز

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

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

getRow()

موقعیت ردیف را برای این محدوده برمی گرداند. یکسان با GetRowindex () .

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

var range = sheet.getRange("B2");
Logger.log(range.getRow());

بازگشت

Integer - موقعیت ردیف دامنه.

مجوز

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

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

getRowIndex()

موقعیت ردیف را برای این محدوده برمی گرداند. یکسان با GetRow () .

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

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

بازگشت

Integer - موقعیت ردیف دامنه.

مجوز

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

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

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


getSheet()

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

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

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

بازگشت

Sheet - ورق که این محدوده متعلق به آن است.

مجوز

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

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

getTextDirection()

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

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

بازگشت

TextDirection - جهت متن سلول سمت چپ بالا در محدوده.

مجوز

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

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

getTextDirections()

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

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

بازگشت

TextDirection[][] -یک آرایه دو بعدی از جهت متن.

مجوز

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

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

getTextRotation()

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

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

بازگشت

TextRotation - تنظیمات چرخش متن.

مجوز

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

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

getTextRotations()

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

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

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

بازگشت

TextRotation[][] -یک آرایه دو بعدی از چرخش متن مرتبط با سلول ها در محدوده.

مجوز

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

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

getTextStyle()

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

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

بازگشت

TextStyle - سبک متن سلول سمت چپ بالا در محدوده.

مجوز

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

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

getTextStyles()

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

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

بازگشت

TextStyle[][] -مجموعه ای از سبک های دو بعدی.

مجوز

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

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

getValue()

مقدار سلول بالا سمت چپ را در محدوده برمی گرداند. مقدار ممکن است بسته به مقدار سلول از Number ، Boolean ، Date یا String باشد. سلولهای خالی یک رشته خالی را برمی گردانند.

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

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

بازگشت

Object - مقدار در این سلول.

مجوز

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

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

getValues()

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

یک آرایه دو بعدی از مقادیر را برمی گرداند ، که توسط ردیف نمایه می شوند ، سپس توسط ستون. مقادیر بسته به مقدار سلول ممکن است از Number ، Boolean ، Date یا String باشد. سلولهای خالی توسط یک رشته خالی در آرایه نشان داده می شوند. به یاد داشته باشید که در حالی که یک شاخص دامنه از 1, 1 شروع می شود ، آرایه JavaScript از [0][0] فهرست بندی می شود.

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
در برنامه های وب ، یک مقدار Date یک پارامتر قانونی نیست. اگر دامنه حاوی سلول با مقدار Date باشد ، getValues() نتواند داده ها را به یک برنامه وب بازگرداند. در عوض ، تمام مقادیر بازیابی شده از برگه را به یک جاوا اسکریپت اولیه مانند یک Number ، Boolean یا String تبدیل کنید.

بازگشت

Object[][] -مجموعه ای از مقادیر دو بعدی.

مجوز

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

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

getVerticalAlignment()

تراز عمودی (بالا/میانی/پایین) سلول را در گوشه بالا سمت چپ دامنه برمی گرداند.

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

Logger.log(range.getVerticalAlignment());

بازگشت

String - تراز عمودی متن در سلول.

مجوز

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

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

getVerticalAlignments()

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

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

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

بازگشت

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

مجوز

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

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

getWidth()

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

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

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

بازگشت

Integer - تعداد ستون ها در محدوده.

مجوز

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

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

getWrap()

باز می گردد که آیا متن موجود در سلول بسته می شود. برای به دست آوردن استراتژی بسته بندی دانه بیشتر ، از getWrapStrategy() استفاده کنید.

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

Logger.log(range.getWrap());

بازگشت

Boolean - چه متن موجود در این سلول یا نه.

مجوز

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

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

getWrapStrategies()

استراتژی های بسته بندی متن را برای سلول ها در محدوده برمی گرداند.

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

بازگشت

WrapStrategy[][] -یک مجموعه دو بعدی از استراتژی های بسته بندی متن.

مجوز

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

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

getWrapStrategy()

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

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

بازگشت

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

مجوز

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

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

getWraps()

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

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

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

بازگشت

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

مجوز

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

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

insertCells(shiftDimension)

سلولهای خالی را در این محدوده وارد می کند. سلولهای جدید هر قالب بندی موجود در سلولهایی را که قبلاً این محدوده را اشغال کرده بودند ، حفظ می کنند. داده های موجود در ورق در طول ابعاد ارائه شده از محدوده درج شده دور می شوند.

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertCheckboxes()

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

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

بازگشت

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

مجوز

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

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

insertCheckboxes(checkedValue)

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

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

پارامترها

نام تایپ کنید توضیحات
checkedValue Object مقدار بررسی شده برای اعتبار سنجی داده های کادر انتخاب.

بازگشت

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

مجوز

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

پارامترها

نام تایپ کنید توضیحات
checkedValue Object مقدار بررسی شده برای اعتبار سنجی داده های کادر انتخاب.
uncheckedValue Object مقدار بررسی نشده برای اعتبار سنجی داده های کادر.

بازگشت

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

مجوز

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

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

isBlank()

اگر محدوده کاملاً خالی باشد ، true برمی گردد.

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

Logger.log(range.isBlank());

بازگشت

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

مجوز

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

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

isChecked()

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

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

بازگشت

Boolean - true ، اگر همه سلولهای موجود در این محدوده بررسی شوند ، اگر همه سلولهای موجود در محدوده کنترل false باشند ، یا در صورت null کنترل هیچ یک از سلول ها یا اعتبار داده های مربوط به کادر انتخابی ، تهی نمی کنند.

مجوز

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

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

isEndColumnBounded()

تعیین می کند که آیا پایان دامنه به یک ستون خاص محدود شده است یا خیر. به عنوان مثال ، برای دامنه های A1:B10 یا B:B ، که در انتهای محدوده به ستون ها محدود می شوند ، این روش true است. برای دامنه 3:7 یا A1:5 ، که فقط در انتهای محدوده به ردیف های خاص محدود می شوند ، این روش 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

بازگشت

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

مجوز

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

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

isEndRowBounded()

تعیین می کند که آیا پایان دامنه به یک ردیف خاص محدود شده است یا خیر. به عنوان مثال ، برای دامنه های A1:B10 یا 3:7 ، که در انتهای محدوده به ردیف ها محدود می شوند ، این روش true است. برای دامنه های B:B یا A1:C ، که فقط در انتهای محدوده به ستون های خاص محدود می شوند ، این روش 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it to the console.
console.log(range.isEndRowBounded());

بازگشت

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

مجوز

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

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

isPartOfMerge()

اگر سلولهای موجود در محدوده فعلی با همپوشانی سلول های ادغام شده ، true باز می گردند.

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

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

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

بازگشت

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


isStartColumnBounded()

تعیین می کند که آیا شروع دامنه به یک ستون خاص متصل است یا خیر. به عنوان مثال ، برای دامنه های A1:B10 یا B:B ، که در ابتدای محدوده به ستون ها محدود می شوند ، این روش true است. برای محدوده 3:7 ، که فقط در شروع دامنه به یک ردیف محدود می شود ، این روش 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

بازگشت

Boolean - اگر شروع دامنه به یک ستون خاص محدود شود ، true . false در غیر این صورت

مجوز

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

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

isStartRowBounded()

تعیین می کند که آیا شروع دامنه به یک ردیف خاص متصل است یا خیر. به عنوان مثال ، برای دامنه های A1:B10 یا 3:7 ، که در ابتدای محدوده به ردیف ها محدود می شوند ، این روش true است. برای محدوده B:B ، که فقط در شروع محدوده به یک ستون خاص محدود می شود ، این روش 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it to the
// console.
console.log(range.isStartRowBounded());

بازگشت

Boolean - اگر شروع دامنه به یک ردیف خاص محدود شود ، true . false در غیر این صورت

مجوز

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

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

merge()

سلولهای موجود در محدوده را با هم در یک بلوک واحد ادغام می کند.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

بازگشت

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

مجوز

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

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

mergeAcross()

سلولها را در محدوده ستون های محدوده ادغام کنید.

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

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

بازگشت

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

مجوز

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

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

mergeVertically()

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

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

بازگشت

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

مجوز

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

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

moveTo(target)

برش و چسباندن (هر دو قالب و مقادیر) از این محدوده به محدوده هدف.

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

پارامترها

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

مجوز

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

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

offset(rowOffset, columnOffset)

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

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

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

پارامترها

نام تایپ کنید توضیحات
rowOffset Integer تعداد ردیف های پایین از سلول سمت چپ بالا. مقادیر منفی ردیف ها را از سلول سمت چپ بالا نشان می دهد.
columnOffset Integer تعداد ستون ها درست از سلول سمت چپ بالا. مقادیر منفی نشانگر ستون های باقی مانده از سلول سمت چپ بالا است.

بازگشت

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


offset(rowOffset, columnOffset, numRows)

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

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

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

پارامترها

نام تایپ کنید توضیحات
rowOffset Integer تعداد ردیف های پایین از سلول سمت چپ بالا. مقادیر منفی ردیف ها را از سلول سمت چپ بالا نشان می دهد.
columnOffset Integer تعداد ستون ها درست از سلول سمت چپ بالا. مقادیر منفی نشانگر ستون های باقی مانده از سلول سمت چپ بالا است.
numRows Integer ارتفاع در ردیف های محدوده جدید.

بازگشت

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


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

پارامترها

نام تایپ کنید توضیحات
rowOffset Integer تعداد ردیف های پایین از سلول سمت چپ بالا. مقادیر منفی ردیف ها را از سلول سمت چپ بالا نشان می دهد.
columnOffset Integer تعداد ستون ها درست از سلول سمت چپ بالا. مقادیر منفی نشانگر ستون های باقی مانده از سلول سمت چپ بالا است.
numRows Integer ارتفاع در ردیف های محدوده جدید.
numColumns Integer عرض در ستون های محدوده جدید.

بازگشت

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


protect()

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

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

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

randomize()

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

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

// Randomizes the range
range.randomize();

بازگشت

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

مجوز

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

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

removeCheckboxes()

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

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

بازگشت

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

مجوز

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

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

removeDuplicates()

ردیف ها را در این محدوده حذف می کند که حاوی مقادیری است که در هر ردیف قبلی کپی مقادیر هستند. ردیف هایی با مقادیر یکسان اما موارد مختلف نامه ، قالب بندی یا فرمول ها کپی در نظر گرفته می شوند. این روش همچنین ردیف های پنهان شده از نمای را حذف می کند (به عنوان مثال ، به دلیل فیلتر). محتوای خارج از این محدوده حذف نمی شود.

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

// Remove duplicate rows in the range.
range.removeDuplicates();

بازگشت

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

مجوز

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

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

removeDuplicates(columnsToCompare)

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

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

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

پارامترها

نام تایپ کنید توضیحات
columnsToCompare Integer[] ستون ها برای تجزیه و تحلیل مقادیر تکراری. اگر هیچ ستون ارائه نشده باشد ، تمام ستون ها برای نسخه های تکراری تجزیه و تحلیل می شوند.

بازگشت

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

مجوز

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

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

setBackground(color)

رنگ پس زمینه تمام سلول ها را در محدوده CSS (مانند '#ffffff' یا 'white' ) تنظیم می کند.

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

var range = sheet.getRange("B2:D5");
range.setBackground("red");

پارامترها

نام تایپ کنید توضیحات
color String یک کد رنگی در نماد CSS (مانند '#ffffff' یا 'white' ) ؛ یک مقدار null رنگ را بازنشانی می کند.

بازگشت

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

مجوز

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

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

setBackgroundObject(color)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

پارامترها

نام تایپ کنید توضیحات
color Color رنگ پس زمینه برای تنظیم ؛ مقدار null رنگ پس زمینه را بازنشانی می کند.

بازگشت

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

مجوز

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

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

setBackgroundObjects(color)

یک شبکه مستطیل شکل از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

پارامترها

نام تایپ کنید توضیحات
color Color[][] مجموعه ای از رنگ های دو بعدی ؛ مقادیر null رنگ را دوباره تنظیم می کنند.

بازگشت

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

مجوز

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

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

setBackgroundRGB(red, green, blue)

پس زمینه را با استفاده از مقادیر RGB به رنگ داده شده (عدد صحیح بین 0 تا 255 شامل) تنظیم می کند.

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

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

پارامترها

نام تایپ کنید توضیحات
red Integer مقدار قرمز در نماد RGB.
green Integer مقدار سبز در نماد RGB.
blue Integer مقدار آبی در نماد RGB.

بازگشت

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

مجوز

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

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

setBackgrounds(color)

یک شبکه مستطیل شکل از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). رنگ ها در نماد CSS (مانند '#ffffff' یا 'white' ) قرار دارند.

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

پارامترها

نام تایپ کنید توضیحات
color String[][] مجموعه ای از رنگ های دو بعدی در نماد CSS (مانند '#ffffff' یا 'white' ). مقادیر null رنگ را دوباره تنظیم می کنند.

بازگشت

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

مجوز

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

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

setBorder(top, left, bottom, right, vertical, horizontal)

خاصیت مرزی را تنظیم می کند. مقادیر معتبر true (روشن) ، false (خاموش) و null (بدون تغییر) هستند.

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

پارامترها

نام تایپ کنید توضیحات
top Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
left Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
bottom Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
right Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
vertical Boolean true در مورد مرزهای عمودی داخلی ، برای هیچ یک null false .
horizontal Boolean true در مورد مرزهای افقی داخلی ، برای هیچکدام false ، null تغییر.

بازگشت

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

مجوز

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

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

خاصیت مرزی را با رنگ و/یا سبک تنظیم می کند. مقادیر معتبر true (روشن) ، false (خاموش) و null (بدون تغییر) هستند. برای رنگ ، از رنگ در نماد CSS استفاده کنید (مانند '#ffffff' یا 'white' ).

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

پارامترها

نام تایپ کنید توضیحات
top Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
left Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
bottom Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
right Boolean true برای مرز ، false برای هیچکدام ، null بدون تغییر.
vertical Boolean true در مورد مرزهای عمودی داخلی ، برای هیچ یک null false .
horizontal Boolean true در مورد مرزهای افقی داخلی ، برای هیچکدام false ، null تغییر.
color String رنگ در نماد CSS (مانند '#ffffff' یا 'white' ) ، null برای رنگ پیش فرض (سیاه).
style BorderStyle سبکی برای مرزها ، null برای سبک پیش فرض (جامد).

بازگشت

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

مجوز

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

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

setDataValidation(rule)

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

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

پارامترها

نام تایپ کنید توضیحات
rule DataValidation قانون اعتبار سنجی داده ها برای تنظیم یا null برای حذف اعتبار سنجی داده ها.

بازگشت

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

مجوز

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

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

setDataValidations(rules)

قوانین اعتبار سنجی داده را برای کلیه سلولهای موجود در محدوده تنظیم می کند. این روش یک آرایه دو بعدی از اعتبار سنجی داده ها را می گیرد ، که توسط Row و سپس توسط ستون نمایه می شوند. ابعاد آرایه باید با ابعاد دامنه مطابقت داشته باشد.

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

پارامترها

نام تایپ کنید توضیحات
rules DataValidation[][] یک آرایه دو بعدی از قوانین اعتبار سنجی داده ها برای تنظیم. مقادیر null اعتبار داده را حذف می کند.

بازگشت

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

مجوز

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

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

setFontColor(color)

رنگ قلم را در نماد CSS تنظیم می کند (مانند '#ffffff' یا 'white' ).

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

var cell = sheet.getRange("B2");
cell.setFontColor("red");

پارامترها

نام تایپ کنید توضیحات
color String رنگ قلم در نماد CSS (مانند '#ffffff' یا 'white' ) ؛ یک مقدار null رنگ را بازنشانی می کند.

بازگشت

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

مجوز

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

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

setFontColorObject(color)

رنگ قلم دامنه داده شده را تنظیم می کند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

پارامترها

نام تایپ کنید توضیحات
color Color رنگ قلم برای تنظیم ؛ یک مقدار null رنگ را بازنشانی می کند.

بازگشت

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

مجوز

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

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

setFontColorObjects(colors)

یک شبکه مستطیل شکل از رنگ های قلم را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

پارامترها

نام تایپ کنید توضیحات
colors Color[][] مجموعه ای از رنگ های دو بعدی ؛ مقادیر null رنگ قلم را تنظیم می کند.

بازگشت

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

مجوز

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

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

setFontColors(colors)

یک شبکه مستطیل شکل از رنگ های قلم را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). رنگ ها در نماد CSS (مانند '#ffffff' یا 'white' ) قرار دارند.

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

پارامترها

نام تایپ کنید توضیحات
colors Object[][] مجموعه ای از رنگ های دو بعدی در نماد CSS (مانند '#ffffff' یا 'white' ). مقادیر null رنگ را دوباره تنظیم می کنند.

بازگشت

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

مجوز

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

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

setFontFamilies(fontFamilies)

یک شبکه مستطیل شکل از خانواده های قلم تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). نمونه هایی از خانواده های قلم "arial" یا "helvetica" هستند.

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

پارامترها

نام تایپ کنید توضیحات
fontFamilies Object[][] مجموعه ای دو بعدی از خانواده های قلم. مقادیر null خانواده قلم را دوباره تنظیم می کنند.

بازگشت

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

مجوز

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

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

setFontFamily(fontFamily)

خانواده قلم مانند "Arial" یا "Helvetica" را تنظیم می کند.

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

پارامترها

نام تایپ کنید توضیحات
fontFamily String خانواده قلم برای تنظیم ؛ یک ارزش null خانواده قلم را تنظیم می کند.

بازگشت

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

مجوز

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

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

setFontLine(fontLine)

سبک خط قلم محدوده داده شده ( 'underline' ، 'line-through' یا 'none' را تنظیم می کند.

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

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

پارامترها

نام تایپ کنید توضیحات
fontLine String سبک خط قلم ، یا 'underline' ، 'line-through' یا 'none' ؛ یک مقدار null سبک خط قلم را تنظیم می کند.

بازگشت

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

مجوز

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

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

setFontLines(fontLines)

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

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

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

پارامترها

نام تایپ کنید توضیحات
fontLines Object[][] یک آرایه دو بعدی از سبک های خط قلم ( 'underline' ، 'line-through' یا 'none' ). مقادیر null تنظیم مجدد سبک خط قلم.

بازگشت

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

مجوز

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

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

setFontSize(size)

اندازه قلم را تنظیم می کند ، با اندازه اندازه نقطه برای استفاده است.

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

پارامترها

نام تایپ کنید توضیحات
size Integer اندازه قلم در اندازه نقطه.

بازگشت

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

مجوز

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

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

setFontSizes(sizes)

یک شبکه مستطیل شکل از اندازه قلم را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). اندازه ها در امتیاز هستند.

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

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

پارامترها

نام تایپ کنید توضیحات
sizes Object[][] یک آرایه دو بعدی از اندازه.

بازگشت

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

مجوز

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

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

setFontStyle(fontStyle)

سبک قلم را برای محدوده داده شده ( 'italic' یا 'normal' ) تنظیم کنید.

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

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

پارامترها

نام تایپ کنید توضیحات
fontStyle String سبک قلم ، یا 'italic' یا 'normal' ؛ یک مقدار null سبک قلم را تنظیم می کند.

بازگشت

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

مجوز

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

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

setFontStyles(fontStyles)

یک شبکه مستطیل شکل از سبک های قلم (باید با ابعاد این محدوده مطابقت داشته باشد).

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

پارامترها

نام تایپ کنید توضیحات
fontStyles Object[][] یک آرایه دو بعدی از سبک های قلم ، یا 'italic' یا 'normal' . مقادیر null تنظیم مجدد سبک قلم.

بازگشت

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

مجوز

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

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

setFontWeight(fontWeight)

وزن قلم را برای محدوده داده شده (طبیعی/جسورانه) تنظیم کنید.

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

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

پارامترها

نام تایپ کنید توضیحات
fontWeight String وزن قلم ، یا 'bold' یا 'normal' ؛ مقدار null وزن قلم را بازنشانی می کند.

بازگشت

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

مجوز

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

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

setFontWeights(fontWeights)

یک شبکه مستطیل شکل از وزن قلم را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). نمونه ای از وزن قلم "جسورانه" است.

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

پارامترها

نام تایپ کنید توضیحات
fontWeights Object[][] یک آرایه دو بعدی از وزن قلم ، یا 'bold' یا 'normal' . مقادیر null وزن قلم را دوباره تنظیم می کند.

بازگشت

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

مجوز

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

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

setFormula(formula)

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

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

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

پارامترها

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

بازگشت

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

مجوز

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

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

setFormulaR1C1(formula)

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

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

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

پارامترها

نام تایپ کنید توضیحات
formula String فرمول رشته ای.

بازگشت

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

مجوز

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

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

setFormulas(formulas)

یک شبکه مستطیل شکل از فرمول ها تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). فرمول های داده شده باید در نماد A1 باشند. این روش یک آرایه دو بعدی از فرمولها را می گیرد ، که توسط ردیف نمایه می شوند ، سپس توسط ستون. ابعاد آرایه باید با ابعاد دامنه مطابقت داشته باشد.

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

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

پارامترها

نام تایپ کنید توضیحات
formulas String[][] یک آرایه رشته دو بعدی از فرمول ها.

بازگشت

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

مجوز

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

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

setFormulasR1C1(formulas)

یک شبکه مستطیل شکل از فرمول ها تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). فرمول های داده شده باید در نماد R1C1 باشند.

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

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

پارامترها

نام تایپ کنید توضیحات
formulas String[][] یک آرایه دو بعدی از فرمول ها در قالب R1C1.

بازگشت

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

مجوز

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

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

setHorizontalAlignment(alignment)

تراز افقی (چپ به راست) را برای محدوده داده شده (چپ/مرکز/راست) تنظیم کنید.

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

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

پارامترها

نام تایپ کنید توضیحات
alignment String تراز ، یا 'left' ، 'center' یا 'normal' ؛ یک مقدار null مجدداً تراز را تنظیم می کند.

بازگشت

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

مجوز

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

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

setHorizontalAlignments(alignments)

یک شبکه مستطیل شکل از ترازهای افقی تنظیم می کند. به setHorizontalAlignment(alignment) مراجعه کنید

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

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

پارامترها

نام تایپ کنید توضیحات
alignments Object[][] مجموعه ای از ترازهای دو بعدی ، یا 'left' ، 'center' یا 'normal' . یک مقدار null مجدداً تراز را تنظیم می کند.

بازگشت

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

مجوز

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

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

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


setNote(note)

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

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

پارامترها

نام تایپ کنید توضیحات
note String مقدار یادداشت برای تنظیم محدوده ؛ مقدار null نت را حذف می کند.

بازگشت

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

مجوز

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

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

setNotes(notes)

یک شبکه مستطیل شکل از یادداشت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).

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

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

پارامترها

نام تایپ کنید توضیحات
notes Object[][] یک آرایه دو بعدی از یادداشت ها. مقادیر null نت را حذف می کنند.

بازگشت

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

مجوز

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

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

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


setNumberFormat(numberFormat)

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

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

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

پارامترها

نام تایپ کنید توضیحات
numberFormat String یک رشته فرمت شماره.

بازگشت

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

مجوز

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

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

setNumberFormats(numberFormats)

یک شبکه مستطیل شکل از قالب های شماره یا تاریخ را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). مقادیر رشته های الگوی فرمت هستند که در مستندات API برگه توضیح داده شده است.

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

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

پارامترها

نام تایپ کنید توضیحات
numberFormats Object[][] یک آرایه دو بعدی از قالب های شماره.

بازگشت

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

مجوز

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

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

setRichTextValue(value)

مقدار متن غنی را برای سلول ها در محدوده تنظیم می کند.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

پارامترها

نام تایپ کنید توضیحات
value RichTextValue مقدار متن غنی مورد نظر.

بازگشت

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

مجوز

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

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

setRichTextValues(values)

یک شبکه مستطیل شکل از مقادیر متن غنی را تنظیم می کند.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

پارامترها

نام تایپ کنید توضیحات
values RichTextValue[][] مقادیر متن غنی مورد نظر.

بازگشت

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

مجوز

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

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

مجموعه ای را نشان می دهد که آیا دامنه باید لینک های لینک را نشان دهد یا خیر.

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

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

پارامترها

نام تایپ کنید توضیحات
showHyperlink Boolean آیا لینک لینک را نشان می دهد یا نه.

بازگشت

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

مجوز

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

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

setTextDirection(direction)

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

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

پارامترها

نام تایپ کنید توضیحات
direction TextDirection جهت متن مورد نظر ؛ اگر null قبل از تنظیم استنباط شود.

بازگشت

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

مجوز

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

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

setTextDirections(directions)

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

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

پارامترها

نام تایپ کنید توضیحات
directions TextDirection[][] جهت متن مورد نظر ؛ اگر یک جهت مشخص null داشته باشد ، قبل از تنظیم استنباط می شود.

بازگشت

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

مجوز

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

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

setTextRotation(degrees)

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

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

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

پارامترها

نام تایپ کنید توضیحات
degrees Integer زاویه مورد نظر بین جهت گیری استاندارد و جهت گیری مورد نظر. برای متن چپ به راست ، زاویه های مثبت در جهت خلاف جهت عقربه های ساعت قرار دارند.

بازگشت

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

مجوز

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

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

setTextRotation(rotation)

تنظیمات چرخش متن را برای سلول ها در محدوده تنظیم می کند.

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

پارامترها

نام تایپ کنید توضیحات
rotation TextRotation تنظیمات چرخش متن مورد نظر.

بازگشت

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

مجوز

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

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

setTextRotations(rotations)

یک شبکه مستطیل شکل از چرخش متن را تنظیم می کند.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

پارامترها

نام تایپ کنید توضیحات
rotations TextRotation[][] تنظیمات چرخش متن مورد نظر.

بازگشت

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

مجوز

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

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

setTextStyle(style)

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

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

پارامترها

نام تایپ کنید توضیحات
style TextStyle سبک متن مورد نظر

بازگشت

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

مجوز

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

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

setTextStyles(styles)

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

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

پارامترها

نام تایپ کنید توضیحات
styles TextStyle[][] سبک های متن مورد نظر.

بازگشت

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

مجوز

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

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

setValue(value)

مقدار دامنه را تعیین می کند. مقدار می تواند عددی ، رشته ، بولی یا تاریخ باشد. اگر با '=' شروع شود ، به عنوان یک فرمول تعبیر می شود.

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

var cell = sheet.getRange("B2");
cell.setValue(100);

پارامترها

نام تایپ کنید توضیحات
value Object مقدار برای دامنه.

بازگشت

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

مجوز

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

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

setValues(values)

یک شبکه مستطیل شکل از مقادیر را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد). اگر یک مقدار با = شروع شود ، به عنوان یک فرمول تعبیر می شود.

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

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

پارامترها

نام تایپ کنید توضیحات
values Object[][] یک آرایه دو بعدی از مقادیر.

بازگشت

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

مجوز

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

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

setVerticalAlignment(alignment)

تراز عمودی (بالا به پایین) را برای محدوده داده شده (بالا/میانه/پایین) تنظیم کنید.

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

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

پارامترها

نام تایپ کنید توضیحات
alignment String تراز ، یا 'top' ، 'middle' یا 'bottom' ؛ یک مقدار null مجدداً تراز را تنظیم می کند.

بازگشت

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

مجوز

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

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

setVerticalAlignments(alignments)

یک شبکه مستطیل شکل از ترازهای عمودی را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).

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

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

پارامترها

نام تایپ کنید توضیحات
alignments Object[][] مجموعه ای از ترازهای دو بعدی ، یا 'top' ، 'middle' یا 'bottom' . یک مقدار null مجدداً تراز را تنظیم می کند.

بازگشت

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

مجوز

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

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

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


setVerticalText(isVertical)

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

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

پارامترها

نام تایپ کنید توضیحات
isVertical Boolean آیا متن را پشته یا نه.

بازگشت

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

مجوز

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

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

setWrap(isWrapEnabled)

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

سلولهای دارای بسته بندی فعال شده (پیش فرض) تغییر اندازه می دهند تا محتوای کامل خود را نشان دهند. سلولهایی که دارای بسته بندی شده اند ، بدون تغییر اندازه یا دویدن به چندین خط ، تا حد امکان در سلول نمایش داده می شوند.

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

var cell = sheet.getRange("B2");
cell.setWrap(true);

پارامترها

نام تایپ کنید توضیحات
isWrapEnabled Boolean آیا متن را بسته بندی کنید یا نه.

بازگشت

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

مجوز

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

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

setWrapStrategies(strategies)

یک شبکه مستطیل شکل از استراتژی های بسته بندی را تنظیم می کند.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

پارامترها

نام تایپ کنید توضیحات
strategies WrapStrategy[][] استراتژی های بسته بندی مورد نظر.

بازگشت

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

مجوز

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

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

setWrapStrategy(strategy)

استراتژی بسته بندی متن را برای سلول ها در محدوده تنظیم می کند.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

پارامترها

نام تایپ کنید توضیحات
strategy WrapStrategy استراتژی بسته بندی مورد نظر.

بازگشت

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

مجوز

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

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

setWraps(isWrapEnabled)

یک شبکه مستطیل شکل از سیاست های Wrap Wrap (باید با ابعاد این محدوده مطابقت داشته باشد). سلولهای دارای بسته بندی فعال شده (پیش فرض) تغییر اندازه می دهند تا محتوای کامل خود را نشان دهند. سلولهایی که دارای بسته بندی شده اند ، بدون تغییر اندازه یا دویدن به چندین خط ، تا حد امکان در سلول نمایش داده می شوند.

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

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

پارامترها

نام تایپ کنید توضیحات
isWrapEnabled Object[][] یک آرایه دو بعدی از متغیرهای بسته بندی که تعیین می کنند متن را در یک سلول بسته بندی کنند یا خیر.

بازگشت

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

مجوز

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

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

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


shiftColumnGroupDepth(delta)

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

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

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

اگر column group control position BEFORE باشد ، هنگام تلاش برای تغییر عمق ردیف اول ، این خطایی را به وجود می آورد.

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

پارامترها

نام تایپ کنید توضیحات
delta Integer مبلغی که برای تغییر عمق گروه ستون این محدوده تغییر می کند.

بازگشت

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

پرتاب می کند

Error - هنگام تلاش برای تغییر عمق ستون اول هنگامی که موقعیت کنترل GroupControlTogglePosition.BEFORE است.

مجوز

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

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

shiftRowGroupDepth(delta)

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

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

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

اگر row group control position BEFORE باشد ، این خطایی را هنگام تلاش برای تغییر عمق ردیف اول به وجود می آورد.

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

پارامترها

نام تایپ کنید توضیحات
delta Integer مبلغی که برای تغییر عمق گروه ردیف این محدوده تغییر می کند.

بازگشت

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

پرتاب می کند

Error - هنگام تلاش برای تغییر عمق ردیف اول هنگامی که موقعیت کنترل GroupControlTogglePosition.BEFORE است.

مجوز

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

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

sort(sortSpecObj)

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

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

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

پارامترها

نام تایپ کنید توضیحات
sortSpecObj Object ستون ها برای مرتب سازی بر اساس.

بازگشت

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

مجوز

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

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

splitTextToColumns()

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

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

مجوز

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

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

splitTextToColumns(delimiter)

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

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

پارامترها

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

مجوز

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

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

splitTextToColumns(delimiter)

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

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

پارامترها

نام تایپ کنید توضیحات
delimiter TextToColumnsDelimiter تعیین کننده از پیش تعیین شده برای تقسیم.

مجوز

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

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

trimWhitespace()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

بازگشت

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

مجوز

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

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

uncheck()

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

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

بازگشت

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

مجوز

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

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

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