Class Range

محدوده

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

روش ها

روش نوع برگشت شرح مختصر
activate() Range محدوده مشخص شده را به عنوان active range تنظیم می کند و سلول سمت چپ بالای محدوده را به عنوان current cell تنظیم می کند.
activate As Current Cell() Range سلول مشخص شده را به عنوان current cell تنظیم می کند.
add Developer Metadata(key) Range ابرداده توسعه دهنده را با کلید مشخص شده به محدوده اضافه می کند.
add Developer Metadata(key, visibility) Range ابرداده برنامه‌نویس را با کلید مشخص شده و قابلیت مشاهده به محدوده اضافه می‌کند.
add Developer Metadata(key, value) Range ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به محدوده اضافه می کند.
add Developer Metadata(key, value, visibility) Range ابرداده برنامه‌نویس را با کلید، مقدار و قابلیت مشاهده به محدوده اضافه می‌کند.
apply Column Banding() Banding یک طرح زمینه پیش‌فرض باندبندی ستون را در محدوده اعمال می‌کند.
apply Column Banding(bandingTheme) Banding یک طرح زمینه ستونی مشخص شده را در محدوده اعمال می کند.
apply Column Banding(bandingTheme, showHeader, showFooter) Banding یک طرح زمینه ستونی مشخص شده را با تنظیمات سرصفحه و پاورقی مشخص شده در محدوده اعمال می کند.
apply Row Banding() Banding یک طرح زمینه پیش‌فرض باندبندی ردیف را در محدوده اعمال می‌کند.
apply Row Banding(bandingTheme) Banding یک تم باندبندی ردیف مشخص شده را به محدوده اعمال می کند.
apply Row Banding(bandingTheme, showHeader, showFooter) Banding یک تم باندبندی ردیف مشخص شده را با تنظیمات سرصفحه و پاورقی مشخص شده در محدوده اعمال می کند.
auto Fill(destination, series) void destination Range با داده هایی بر اساس داده های این محدوده پر می کند.
auto Fill To Neighbor(series) void محدوده ای را برای پر کردن با داده های جدید بر اساس سلول های مجاور محاسبه می کند و به طور خودکار آن محدوده را با مقادیر جدید بر اساس داده های موجود در این محدوده پر می کند.
break Apart() Range سلول های چند ستونی در محدوده را دوباره به سلول های جداگانه تقسیم کنید.
can Edit() Boolean تعیین می کند که آیا کاربر اجازه ویرایش هر سلول در محدوده را دارد یا خیر.
check() Range وضعیت چک باکس های موجود در محدوده را به "تیک زده" تغییر می دهد.
clear() Range محدوده محتویات و قالب ها را پاک می کند.
clear(options) Range محدوده محتویات، قالب، قوانین اعتبارسنجی داده ها و/یا نظرات را همانطور که با گزینه های پیشرفته داده شده مشخص شده است پاک می کند.
clear Content() Range محتوای محدوده را پاک می کند و قالب بندی را دست نخورده باقی می گذارد.
clear Data Validations() Range قوانین اعتبارسنجی داده را برای محدوده پاک می کند.
clear Format() Range قالب بندی این محدوده را پاک می کند.
clear Note() Range یادداشت را در سلول یا سلول های داده شده پاک می کند.
collapse Groups() Range همه گروه هایی را که به طور کامل در محدوده قرار دارند جمع می کند.
copy Format To Range(gridId, column, columnEnd, row, rowEnd) void قالب بندی محدوده را در مکان مشخص شده کپی کنید.
copy Format To Range(sheet, column, columnEnd, row, rowEnd) void قالب بندی محدوده را در مکان مشخص شده کپی کنید.
copy To(destination) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copy To(destination, copyPasteType, transposed) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copy To(destination, options) void داده ها را از محدوده ای از سلول ها به محدوده دیگری از سلول ها کپی می کند.
copy Values To Range(gridId, column, columnEnd, row, rowEnd) void محتوای محدوده را در مکان داده شده کپی کنید.
copy Values To Range(sheet, column, columnEnd, row, rowEnd) void محتوای محدوده را در مکان داده شده کپی کنید.
create Data Source Pivot Table(dataSource) Data Source Pivot Table یک جدول محوری منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.
create Data Source Table(dataSource) Data Source Table یک جدول منبع داده خالی از منبع داده ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.
create Developer Metadata Finder() Developer Metadata Finder یک DeveloperMetadataFinderApi را برای یافتن ابرداده توسعه‌دهنده در محدوده این محدوده برمی‌گرداند.
create Filter() Filter یک فیلتر ایجاد می کند و آن را در محدوده مشخص شده در برگه اعمال می کند.
create Pivot Table(sourceData) Pivot Table یک جدول محوری خالی از source Data ایجاد می کند که در اولین سلول در این محدوده لنگر انداخته است.
create Text Finder(findText) Text Finder یک متن یاب برای محدوده ایجاد می کند که می تواند متن را در این محدوده پیدا کرده و جایگزین کند.
delete Cells(shiftDimension) void این محدوده از سلول ها را حذف می کند.
expand Groups() Range گروه‌های جمع‌شده را گسترش می‌دهد که تغییر دامنه یا کنترل با این محدوده تقاطع دارد.
getA1Notation() String شرح رشته ای از محدوده را با نماد A1 برمی گرداند.
get Background() String رنگ پس‌زمینه سلول بالا سمت چپ در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).
get Background Object() Color رنگ پس‌زمینه سلول بالا سمت چپ محدوده را برمی‌گرداند.
get Background Objects() Color[][] رنگ‌های پس‌زمینه سلول‌های محدوده را برمی‌گرداند.
get Backgrounds() String[][] رنگ‌های پس‌زمینه سلول‌های موجود در محدوده را برمی‌گرداند (به عنوان مثال، '#ffffff' ).
get Bandings() Banding[] همه باندهایی را که به هر سلولی در این محدوده اعمال می شود، برمی گرداند.
get Cell(row, column) Range یک سلول معین را در یک محدوده برمی گرداند.
get Column() Integer موقعیت ستون شروع را برای این محدوده برمی گرداند.
get Data Region() Range یک کپی از محدوده گسترش یافته در چهار Direction اصلی را برمی‌گرداند تا تمام سلول‌های مجاور را با داده‌های موجود در آنها پوشش دهد.
get Data Region(dimension) Range اگر بعد مشخص شده Dimension.ROWS یا Direction.NEXT و Direction.PREVIOUS باشد اگر بعد Dimension.COLUMNS باشد، یک کپی از دامنه گسترش یافته Direction.UP و Direction.DOWN برمی گرداند.
get Data Source Formula() Data Source Formula Data Source Formula برای اولین سلول در محدوده برمی‌گرداند، یا اگر سلول حاوی فرمول منبع داده نباشد، null برمی‌گرداند.
get Data Source Formulas() Data Source Formula[] Data Source Formula را برای سلول‌های محدوده برمی‌گرداند.
get Data Source Pivot Tables() Data Source Pivot Table[] همه جداول محوری منبع داده را که با محدوده متقاطع هستند را دریافت می کند.
get Data Source Tables() Data Source Table[] همه جداول منبع داده را که با محدوده متقاطع هستند را دریافت می کند.
get Data Source Url() String یک URL برای داده‌های این محدوده برمی‌گرداند که می‌توان از آن برای ایجاد نمودارها و جستارها استفاده کرد.
get Data Table() Data Table داده های داخل این شی را به عنوان DataTable برگردانید.
get Data Table(firstRowIsHeader) Data Table داده های داخل این محدوده را به عنوان DataTable برگردانید.
get Data Validation() Data Validation قانون اعتبارسنجی داده را برای سلول بالا سمت چپ در محدوده برمی‌گرداند.
get Data Validations() Data Validation[][] قوانین اعتبارسنجی داده ها را برای همه سلول های محدوده برمی گرداند.
get Developer Metadata() Developer Metadata[] فراداده توسعه دهنده مرتبط با این محدوده را دریافت می کند.
get Display Value() String مقدار نمایش داده شده سلول بالا سمت چپ در محدوده را برمی گرداند.
get Display Values() String[][] شبکه مستطیلی مقادیر این محدوده را برمی‌گرداند.
get Filter() Filter فیلتر را در برگه ای که این محدوده به آن تعلق دارد برمی گرداند، یا اگر فیلتری در برگه وجود نداشته باشد null .
get Font Color Object() Color رنگ فونت سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Font Color Objects() Color[][] رنگ فونت سلول های محدوده را برمی گرداند.
get Font Families() String[][] خانواده‌های فونت سلول‌های محدوده را برمی‌گرداند.
get Font Family() String خانواده فونت سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Font Line() String سبک خط سلول را در گوشه سمت چپ بالای محدوده دریافت می کند ( 'underline' ، 'line-through' یا 'none' ).
get Font Lines() String[][] سبک خط سلول‌های محدوده را دریافت می‌کند ( 'underline' ، 'line-through' ، یا 'none' ).
get Font Size() Integer اندازه قلم را در اندازه نقطه سلول در گوشه سمت چپ بالای محدوده برمی‌گرداند.
get Font Sizes() Integer[][] اندازه فونت سلول های محدوده را برمی گرداند.
get Font Style() String سبک قلم ( 'italic' یا 'normal' ) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Font Styles() String[][] سبک های فونت سلول های محدوده را برمی گرداند.
get Font Weight() String وزن قلم (عادی/پررنگ) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Font Weights() String[][] وزن فونت سلول های محدوده را برمی گرداند.
get Formula() String فرمول (نماد A1) را برای سلول سمت چپ بالای محدوده، یا اگر سلول خالی یا فاقد فرمول باشد، یک رشته خالی را برمی‌گرداند.
get Formula R1C1() String فرمول (نماد R1C1) را برای یک سلول معین برمی‌گرداند، یا اگر وجود نداشته باشد null برمی‌گرداند.
get Formulas() String[][] فرمول‌ها (نشان A1) را برای سلول‌های محدوده برمی‌گرداند.
get Formulas R1C1() String[][] فرمول‌ها (نماد R1C1) را برای سلول‌های محدوده برمی‌گرداند.
get Grid Id() Integer شناسه شبکه صفحه اصلی محدوده را برمی‌گرداند.
get Height() Integer ارتفاع محدوده را برمی‌گرداند.
get Horizontal Alignment() String تراز افقی متن (چپ/مرکز/راست) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Horizontal Alignments() String[][] ترازهای افقی سلول های محدوده را برمی گرداند.
get Last Column() Integer موقعیت ستون انتهایی را برمی‌گرداند.
get Last Row() Integer موقعیت ردیف انتهایی را برمی‌گرداند.
get Merged Ranges() Range[] آرایه ای از اشیاء Range را نشان می دهد که سلول های ادغام شده را نشان می دهد که یا کاملاً در محدوده فعلی هستند یا حداقل یک سلول در محدوده فعلی دارند.
get Next Data Cell(direction) Range با شروع از سلول در ستون و ردیف اول محدوده، سلول بعدی را در جهت داده شده برمی گرداند که لبه یک محدوده به هم پیوسته از سلول ها با داده ها در آنها یا سلول در لبه صفحه گسترده در آن جهت است.
get Note() String یادداشت مرتبط با محدوده داده شده را برمی گرداند.
get Notes() String[][] یادداشت های مرتبط با سلول های محدوده را برمی گرداند.
get Num Columns() Integer تعداد ستون های این محدوده را برمی گرداند.
get Num Rows() Integer تعداد ردیف‌های این محدوده را برمی‌گرداند.
get Number Format() String شماره یا قالب بندی تاریخ سلول بالا سمت چپ محدوده داده شده را دریافت کنید.
get Number Formats() String[][] تعداد یا قالب‌های تاریخ را برای سلول‌های محدوده برمی‌گرداند.
get Rich Text Value() Rich Text Value مقدار Rich Text را برای سلول سمت چپ بالای محدوده برمی‌گرداند، یا اگر مقدار سلول متنی نباشد، null برمی‌گرداند.
get Rich Text Values() Rich Text Value[][] مقادیر Rich Text را برای سلول‌های محدوده برمی‌گرداند.
get Row() Integer موقعیت ردیف را برای این محدوده برمی گرداند.
get Row Index() Integer موقعیت ردیف را برای این محدوده برمی گرداند.
get Sheet() Sheet برگه ای که این محدوده به آن تعلق دارد را برمی گرداند.
get Text Direction() Text Direction جهت متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
get Text Directions() Text Direction[][] جهت های متنی را برای سلول های محدوده برمی گرداند.
get Text Rotation() Text Rotation تنظیمات چرخش متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
get Text Rotations() Text Rotation[][] تنظیمات چرخش متن را برای سلول های محدوده برمی گرداند.
get Text Style() Text Style سبک متن را برای سلول سمت چپ بالای محدوده برمی‌گرداند.
get Text Styles() Text Style[][] سبک های متن را برای سلول های محدوده برمی گرداند.
get Value() Object مقدار سلول بالا سمت چپ در محدوده را برمی‌گرداند.
get Values() Object[][] شبکه مستطیلی مقادیر این محدوده را برمی‌گرداند.
get Vertical Alignment() String تراز عمودی (بالا/وسط/پایین) سلول در گوشه سمت چپ بالای محدوده را برمی‌گرداند.
get Vertical Alignments() String[][] ترازهای عمودی سلول های محدوده را برمی گرداند.
get Width() Integer عرض محدوده را در ستون ها برمی گرداند.
get Wrap() Boolean برمی‌گرداند که آیا متن داخل سلول بسته می‌شود یا خیر.
get Wrap Strategies() Wrap Strategy[][] استراتژی های بسته بندی متن را برای سلول های محدوده برمی گرداند.
get Wrap Strategy() Wrap Strategy استراتژی بسته بندی متن را برای سلول سمت چپ بالای محدوده برمی گرداند.
get Wraps() Boolean[][] برمی‌گرداند که آیا متن در سلول‌ها بسته می‌شود یا خیر.
insert Cells(shiftDimension) Range سلول های خالی را در این محدوده قرار می دهد.
insert Checkboxes() Range چک باکس ها را در هر سلول در محدوده وارد می کند که با true برای علامت زده و false برای علامت نشده پیکربندی شده است.
insert Checkboxes(checkedValue) Range چک باکس ها را در هر سلول در محدوده وارد می کند که با یک مقدار سفارشی برای علامت گذاری شده و رشته خالی برای علامت گذاری نشده پیکربندی شده است.
insert Checkboxes(checkedValue, uncheckedValue) Range چک باکس‌ها را در هر سلول در محدوده وارد می‌کند که با مقادیر سفارشی برای حالت‌های علامت‌گذاری شده و علامت‌نخورده پیکربندی شده است.
is Blank() Boolean اگر محدوده کاملاً خالی باشد، true برمی‌گرداند.
is Checked() Boolean برمی‌گرداند که آیا تمام سلول‌های محدوده دارای وضعیت چک باکس «بررسی» هستند یا خیر.
is End Column Bounded() Boolean تعیین می کند که آیا انتهای محدوده به یک ستون خاص محدود شده است یا خیر.
is End Row Bounded() Boolean تعیین می کند که آیا انتهای محدوده به یک ردیف خاص محدود شده است یا خیر.
is Part Of Merge() Boolean اگر سلول‌های محدوده فعلی با سلول‌های ادغام شده همپوشانی داشته باشند، مقدار true را برمی‌گرداند.
is Start Column Bounded() Boolean تعیین می کند که آیا شروع محدوده به یک ستون خاص محدود شده است یا خیر.
is Start Row Bounded() Boolean تعیین می کند که آیا شروع محدوده به یک ردیف خاص محدود شده است یا خیر.
merge() Range سلول های محدوده را با هم در یک بلوک ادغام می کند.
merge Across() Range سلول های محدوده را در ستون های محدوده ادغام کنید.
merge Vertically() Range سلول های محدوده را با هم ادغام می کند.
move To(target) void برش و چسباندن (هم فرمت و هم مقادیر) از این محدوده به محدوده هدف.
offset(rowOffset, columnOffset) Range محدوده جدیدی را برمی‌گرداند که با تعداد ردیف‌ها و ستون‌های معین (که می‌تواند منفی باشد) از این محدوده خارج می‌شود.
offset(rowOffset, columnOffset, numRows) Range محدوده جدیدی را برمی‌گرداند که نسبت به محدوده فعلی است، که نقطه بالای سمت چپ آن با ردیف‌ها و ستون‌های داده‌شده و با ارتفاع داده‌شده در سلول‌ها از محدوده فعلی خارج می‌شود.
offset(rowOffset, columnOffset, numRows, numColumns) Range محدوده جدیدی را که نسبت به محدوده فعلی است، برمی‌گرداند که نقطه بالای سمت چپ آن با ردیف‌ها و ستون‌های داده‌شده، و با ارتفاع و عرض داده‌شده در سلول‌ها، از محدوده فعلی خارج می‌شود.
protect() Protection یک شی ایجاد می کند که می تواند محدوده را از ویرایش محافظت کند مگر توسط کاربرانی که مجوز دارند.
randomize() Range ترتیب ردیف ها را در محدوده داده شده تصادفی می کند.
remove Checkboxes() Range تمام چک باکس ها را از محدوده حذف می کند.
remove Duplicates() Range ردیف هایی را در این محدوده که حاوی مقادیری هستند که تکراری از مقادیر در هر ردیف قبلی هستند، حذف می کند.
remove Duplicates(columnsToCompare) Range ردیف هایی را در این محدوده که حاوی مقادیری در ستون های مشخص شده هستند که تکراری از مقادیر هر ردیف قبلی هستند، حذف می کند.
set Background(color) Range رنگ پس‌زمینه همه سلول‌های محدوده را در نماد CSS (مانند '#ffffff' یا 'white' ) تنظیم می‌کند.
set Background Object(color) Range رنگ پس‌زمینه همه سلول‌های محدوده را تنظیم می‌کند.
set Background Objects(color) Range یک شبکه مستطیلی از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Background RGB(red, green, blue) Range با استفاده از مقادیر RGB (اعداد صحیح بین 0 تا 255) پس زمینه را به رنگ داده شده تنظیم می کند.
set Backgrounds(color) Range یک شبکه مستطیلی از رنگ های پس زمینه را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Border(top, left, bottom, right, vertical, horizontal) Range ویژگی border را تنظیم می کند.
set Border(top, left, bottom, right, vertical, horizontal, color, style) Range ویژگی حاشیه را با رنگ و/یا سبک تنظیم می کند.
set Data Validation(rule) Range یک قانون اعتبارسنجی داده را برای همه سلول‌های محدوده تنظیم می‌کند.
set Data Validations(rules) Range قوانین اعتبارسنجی داده را برای همه سلول های محدوده تنظیم می کند.
set Font Color(color) Range رنگ فونت را در نماد CSS (مانند '#ffffff' یا 'white' ) تنظیم می کند.
set Font Color Object(color) Range رنگ فونت محدوده داده شده را تنظیم می کند.
set Font Color Objects(colors) Range یک شبکه مستطیلی از رنگ فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Colors(colors) Range یک شبکه مستطیلی از رنگ فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Families(fontFamilies) Range یک شبکه مستطیلی از خانواده فونت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Family(fontFamily) Range خانواده فونت مانند "Arial" یا "Helvetica" را تنظیم می کند.
set Font Line(fontLine) Range سبک خط فونت محدوده داده شده را تنظیم می کند ( 'underline' ، 'line-through' یا 'none' ).
set Font Lines(fontLines) Range یک شبکه مستطیلی از سبک های خط را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Size(size) Range اندازه فونت را تنظیم می کند، با اندازه اندازه نقطه مورد استفاده.
set Font Sizes(sizes) Range یک شبکه مستطیلی از اندازه فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Style(fontStyle) Range سبک فونت را برای محدوده داده شده تنظیم کنید ( 'italic' یا 'normal' ).
set Font Styles(fontStyles) Range یک شبکه مستطیلی از سبک های فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Font Weight(fontWeight) Range وزن قلم را برای محدوده داده شده (معمولی/پررنگ) تنظیم کنید.
set Font Weights(fontWeights) Range یک شبکه مستطیلی از وزن فونت را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Formula(formula) Range فرمول این محدوده را به روز می کند.
set Formula R1C1(formula) Range فرمول این محدوده را به روز می کند.
set Formulas(formulas) Range یک شبکه مستطیلی از فرمول ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Formulas R1C1(formulas) Range یک شبکه مستطیلی از فرمول ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Horizontal Alignment(alignment) Range تراز افقی (از چپ به راست) را برای محدوده داده شده (چپ/مرکز/راست) تنظیم کنید.
set Horizontal Alignments(alignments) Range یک شبکه مستطیلی از ترازهای افقی را تنظیم می کند.
set Note(note) Range نت را روی مقدار داده شده تنظیم می کند.
set Notes(notes) Range یک شبکه مستطیلی از یادداشت ها را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Number Format(numberFormat) Range قالب شماره یا تاریخ را روی رشته قالب بندی داده شده تنظیم می کند.
set Number Formats(numberFormats) Range یک شبکه مستطیلی از قالب‌های شماره یا تاریخ را تنظیم می‌کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Rich Text Value(value) Range مقدار Rich Text را برای سلول های محدوده تنظیم می کند.
set Rich Text Values(values) Range یک شبکه مستطیلی از مقادیر Rich Text را تنظیم می کند.
set Show Hyperlink(showHyperlink) Range تعیین می کند که آیا محدوده باید هایپرلینک ها را نشان دهد یا خیر.
set Text Direction(direction) Range جهت متن را برای سلول های محدوده تنظیم می کند.
set Text Directions(directions) Range یک شبکه مستطیلی از جهت های متن را تنظیم می کند.
set Text Rotation(degrees) Range تنظیمات چرخش متن را برای سلول های محدوده تنظیم می کند.
set Text Rotation(rotation) Range تنظیمات چرخش متن را برای سلول های محدوده تنظیم می کند.
set Text Rotations(rotations) Range یک شبکه مستطیل شکل از چرخش متن را تنظیم می کند.
set Text Style(style) Range سبک متن را برای سلول های محدوده تنظیم می کند.
set Text Styles(styles) Range یک شبکه مستطیلی از سبک های متن را تنظیم می کند.
set Value(value) Range مقدار محدوده را تعیین می کند.
set Values(values) Range یک شبکه مستطیلی از مقادیر را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Vertical Alignment(alignment) Range تراز عمودی (بالا به پایین) را برای محدوده داده شده (بالا/وسط/پایین) تنظیم کنید.
set Vertical Alignments(alignments) Range یک شبکه مستطیلی از ترازهای عمودی را تنظیم می کند (باید با ابعاد این محدوده مطابقت داشته باشد).
set Vertical Text(isVertical) Range تنظیم می کند که آیا متن برای سلول های محدوده روی هم چیده شود یا نه.
set Wrap(isWrapEnabled) Range پوشش سلولی محدوده داده شده را تنظیم کنید.
set Wrap Strategies(strategies) Range یک شبکه مستطیل شکل از استراتژی های بسته بندی را تنظیم می کند.
set Wrap Strategy(strategy) Range استراتژی بسته بندی متن را برای سلول های محدوده تنظیم می کند.
set Wraps(isWrapEnabled) Range یک شبکه مستطیلی از خط‌مشی‌های بسته‌بندی کلمه را تنظیم می‌کند (باید با ابعاد این محدوده مطابقت داشته باشد).
shift Column Group Depth(delta) Range عمق گروه بندی ستون محدوده را با مقدار مشخص شده تغییر می دهد.
shift Row Group Depth(delta) Range عمق گروه بندی ردیف محدوده را با مقدار مشخص شده تغییر می دهد.
sort(sortSpecObj) Range سلول های محدوده داده شده را بر اساس ستون و ترتیب مشخص شده مرتب می کند.
split Text To Columns() void ستونی از متن را بر اساس یک جداکننده خودکار شناسایی شده به چندین ستون تقسیم می کند.
split Text To Columns(delimiter) void ستونی از متن را با استفاده از رشته مشخص شده به عنوان جداکننده سفارشی به چندین ستون تقسیم می کند.
split Text To Columns(delimiter) void ستونی از متن را بر اساس جداکننده مشخص شده به چندین ستون تقسیم می کند.
trim Whitespace() Range فضای خالی (مانند فاصله ها، برگه ها یا خطوط جدید) را در هر سلول در این محدوده برش می دهد.
uncheck() Range وضعیت چک باکس های موجود در محدوده را به "تیک نخورده" تغییر می دهد.

مستندات دقیق

activate()

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

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

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

بازگشت

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


activate As Current Cell()

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

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

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

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

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

// Gets the cell B5 and sets it as the active cell.
const range = sheet.getRange('B5');
const 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

add Developer Metadata(key)

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

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

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

add Developer Metadata(key, visibility)

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

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

// Gets 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 Developer Metadata Visibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

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

مجوز

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

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

add Developer Metadata(key, value)

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

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

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

add Developer Metadata(key, value, visibility)

ابرداده برنامه‌نویس را با کلید، مقدار و قابلیت مشاهده به محدوده اضافه می‌کند.

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

// Gets 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 Developer Metadata Visibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

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

مجوز

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

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

apply Column Banding()

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

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

apply Column Banding(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(),
);

پارامترها

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

بازگشت

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

مجوز

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

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

apply Column Banding(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(),
);

پارامترها

نام تایپ کنید توضیحات
banding Theme Banding Theme یک تم رنگی برای اعمال به ستون‌های محدوده.
show Header Boolean اگر true ، رنگ سرصفحه باندبندی به ستون اول اعمال می‌شود.
show Footer Boolean اگر true ، رنگ فوتر طرح زمینه نواری به آخرین ستون اعمال می شود.

بازگشت

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

مجوز

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

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

apply Row Banding()

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

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

apply Row Banding(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);

پارامترها

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

بازگشت

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

مجوز

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

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

apply Row Banding(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);

پارامترها

نام تایپ کنید توضیحات
banding Theme Banding Theme یک تم رنگی برای اعمال به ردیف‌های محدوده.
show Header Boolean اگر true ، رنگ هدر طرح زمینه باندینگ در ردیف اول اعمال می شود.
show Footer Boolean اگر true ، رنگ پاورقی طرح زمینه نواری به ردیف آخر اعمال می شود.

بازگشت

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

مجوز

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

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

auto Fill(destination, series)

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

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const 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 Auto Fill Series نوع سری AutoFill که باید برای محاسبه مقادیر جدید استفاده شود. تأثیر این سری بر اساس نوع و مقدار داده های منبع متفاوت است.

مجوز

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

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

auto Fill To Neighbor(series)

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

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

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

const sheet = SpreadsheetApp.getActiveSheet();

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

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

پارامترها

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

مجوز

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

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

break Apart()

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

فراخوانی این تابع در یک محدوده معادل انتخاب یک محدوده و کلیک کردن روی 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

can Edit()

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

// 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'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

بازگشت

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

مجوز

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

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

clear()

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

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

const 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 یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام تایپ کنید توضیحات
comments Only Boolean اینکه آیا فقط نظرات پاک شود.
contents Only Boolean فقط محتویات پاک شود.
format Only Boolean اینکه آیا فقط قالب پاک شود. توجه داشته باشید که فرمت پاکسازی قوانین اعتبارسنجی داده ها را نیز پاک می کند.
validations Only Boolean اینکه آیا فقط قوانین اعتبارسنجی داده ها پاک شود.
skip Filtered Rows Boolean آیا برای جلوگیری از پاک کردن ردیف های فیلتر شده.

بازگشت

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

مجوز

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

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

clear Content()

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

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

const range = sheet.getRange('A1:D10');
range.clearContent();

بازگشت

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

مجوز

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

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

clear Data Validations()

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

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

بازگشت

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

مجوز

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

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

clear Format()

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

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

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

بازگشت

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

مجوز

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

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

clear Note()

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

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

const range = sheet.getRange('A1:D10');
range.clearNote();

بازگشت

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

مجوز

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

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

collapse Groups()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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

copy Format To Range(gridId, column, columnEnd, row, rowEnd)

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

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

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

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

پارامترها

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

مجوز

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

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

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


copy Format To Range(sheet, column, columnEnd, row, rowEnd)

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

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

const 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 ستون اول محدوده هدف.
column End Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
row End Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

copy To(destination)

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

// The code below copies the first 5 columns over to the 6th column.
const sheet = SpreadsheetApp.getActiveSheet();
const 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

copy To(destination, copyPasteType, transposed)

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

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

پارامترها

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

مجوز

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

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

copy To(destination, options)

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

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

پارامترها

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

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

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

مجوز

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

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

copy Values To Range(gridId, column, columnEnd, row, rowEnd)

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

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

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

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

پارامترها

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

مجوز

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

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

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


copy Values To Range(sheet, column, columnEnd, row, rowEnd)

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

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

const 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 ستون اول محدوده هدف.
column End Integer ستون انتهایی محدوده هدف.
row Integer ردیف شروع محدوده هدف.
row End Integer ردیف انتهایی محدوده هدف.

مجوز

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

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

create Data Source Pivot Table(dataSource)

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

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

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

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

پارامترها

نام تایپ کنید توضیحات
data Source Data Source منبع داده برای ایجاد جدول محوری.

بازگشت

Data Source Pivot Table - جدول محوری منبع داده جدید ایجاد شده است.

مجوز

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

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

create Data Source Table(dataSource)

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

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

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

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

پارامترها

نام تایپ کنید توضیحات
data Source Data Source منبع داده برای ایجاد جدول محوری.

بازگشت

Data Source Table - جدول منبع داده جدید ایجاد شده.

مجوز

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

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

create Developer Metadata Finder()

یک 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());

بازگشت

Developer Metadata Finder — یاب فراداده توسعه دهنده برای جستجوی فراداده در محدوده این محدوده.


create Filter()

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

const ss = SpreadsheetApp.getActiveSheet();
const 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() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}
از این روش برای ایجاد فیلتر برای صفحات Grid ، نوع پیش فرض برگه استفاده کنید. صفحات گرید برگه هایی هستند که به پایگاه داده متصل نیستند. برای ایجاد انواع دیگر فیلترها به موارد زیر مراجعه کنید:

بازگشت

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

مجوز

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

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

create Pivot Table(sourceData)

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

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

پارامترها

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

بازگشت

Pivot Table - Pivot Table تازه ایجاد شده.

مجوز

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

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

create Text Finder(findText)

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

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

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

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

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

پارامترها

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

بازگشت

Text Finder - Text Finder برای محدوده


delete Cells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

پارامترها

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

مجوز

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

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

expand Groups()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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 برمی گرداند.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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

get Background()

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

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

بازگشت

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

مجوز

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

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

get Background Object()

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

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

بازگشت

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

مجوز

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

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

get Background Objects()

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

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const 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

get Backgrounds()

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

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

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

بازگشت

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

مجوز

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

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

get Bandings()

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

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

// Gets 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 (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

بازگشت

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

مجوز

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

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

get Cell(row, column)

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

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

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

get Column()

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

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

const 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

get Data Region()

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

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

get Data Region(dimension)

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

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

get Data Source Formula()

اگر سلول حاوی فرمول منبع داده نباشد null Data Source Formula برای اولین سلول در محدوده برمی گرداند.

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

بازگشت

Data Source Formula - Data Source Formula برای سلول.

مجوز

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

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

get Data Source Formulas()

Data Source Formula را برای سلولهای موجود در محدوده برمی گرداند.

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

بازگشت

Data Source Formula[] - مجموعه ای از Data Source Formula .

مجوز

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

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

get Data Source Pivot Tables()

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

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

بازگشت

Data Source Pivot Table[] - لیستی از جداول محوری منبع داده.

مجوز

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

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

get Data Source Tables()

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

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

بازگشت

Data Source Table[] - لیستی از جداول منبع داده.

مجوز

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

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

get Data Source Url()

یک URL را برای داده های موجود در این محدوده برمی گرداند ، که می تواند برای ایجاد نمودارها و نمایش داده ها استفاده شود.

code.gs

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

  const 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

get Data Table()

داده های داخل این شی را به عنوان 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();

بازگشت

Data Table - داده ها به عنوان یک dataTable.


get Data Table(firstRowIsHeader)

داده های موجود در این محدوده را به عنوان یک dataTable برگردانید.

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

// Calling this method with "true" sets the first line to be the title of the
// axes
const 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.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

پارامترها

نام تایپ کنید توضیحات
first Row Is Header Boolean این که آیا ردیف اول را به عنوان هدر رفتار کنید.

بازگشت

Data Table - داده ها به عنوان یک dataTable.

مجوز

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

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

get Data Validation()

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

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const 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.');
}

بازگشت

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

مجوز

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

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

get Data Validations()

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

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

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

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const 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);

بازگشت

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

مجوز

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

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

get Developer Metadata()

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

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

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

بازگشت

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

مجوز

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

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

get Display Value()

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

get Display Values()

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

یک آرایه دو بعدی از مقادیر نمایش داده شده را برمی گرداند ، که توسط ردیف نمایه می شوند ، سپس توسط ستون. مقادیر اشیاء String هستند. مقدار نمایش داده شده تاریخ ، زمان و قالب بندی ارزی را در نظر می گیرد ، از جمله قالب هایی که به طور خودکار توسط تنظیم محلی صفحه گسترده اعمال می شود. سلولهای خالی توسط یک رشته خالی در آرایه نشان داده می شوند. به یاد داشته باشید که در حالی که یک شاخص دامنه از 1, 1 شروع می شود ، آرایه JavaScript از [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.
const 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

get Filter()

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

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

بازگشت

Filter - فیلتر.

مجوز

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

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

get Font Color Object()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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

get Font Color Objects()

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

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

const results = range.getFontColorObjects();

for (const i in results) {
  for (const 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

get Font Families()

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

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

const results = range.getFontFamilies();

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

بازگشت

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

مجوز

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

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

get Font Family()

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

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

Logger.log(range.getFontFamily());

بازگشت

String - خانواده قلم سلول.

مجوز

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

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

get Font Line()

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

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

Logger.log(range.getFontLine());

بازگشت

String - خط قلم.

مجوز

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

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

get Font Lines()

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

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

const results = range.getFontLines();

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

بازگشت

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

مجوز

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

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

get Font Size()

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

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

Logger.log(range.getFontSize());

بازگشت

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

مجوز

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

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

get Font Sizes()

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

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

const results = range.getFontSizes();

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

بازگشت

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

مجوز

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

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

get Font Style()

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

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

Logger.log(range.getFontStyle());

بازگشت

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

مجوز

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

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

get Font Styles()

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

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

const results = range.getFontStyles();

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

بازگشت

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

مجوز

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

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

get Font Weight()

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

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

Logger.log(range.getFontWeight());

بازگشت

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

مجوز

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

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

get Font Weights()

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

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

const results = range.getFontWeights();

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

بازگشت

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

مجوز

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

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

get Formula()

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

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

// This assumes you have a function in B5 that sums up
// B2:B4
const 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

get Formula R1C1()

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

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

بازگشت

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

مجوز

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

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

get Formulas()

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

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

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

بازگشت

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

مجوز

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

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

get Formulas R1C1()

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

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

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

بازگشت

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

مجوز

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

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

get Grid Id()

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

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

Logger.log(range.getGridId());

بازگشت

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

مجوز

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

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

get Height()

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

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

const 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

get Horizontal Alignment()

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

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

Logger.log(range.getHorizontalAlignment());

بازگشت

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

مجوز

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

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

get Horizontal Alignments()

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

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

const results = range.getHorizontalAlignments();

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

بازگشت

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

مجوز

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

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

get Last Column()

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

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

const 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

get Last Row()

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

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

const 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

get Merged Ranges()

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

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

const range = sheet.getRange('A1:B3');

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

بازگشت

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


get Next Data Cell(direction)

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

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

const 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

get Note()

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

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

Logger.log(range.getNote());

بازگشت

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

مجوز

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

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

get Notes()

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

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

const results = range.getNotes();

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

بازگشت

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

مجوز

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

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

get Num Columns()

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

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

بازگشت

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

مجوز

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

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

get Num Rows()

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

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

بازگشت

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

مجوز

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

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

get Number Format()

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

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

بازگشت

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

مجوز

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

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

get Number Formats()

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

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

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

بازگشت

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

مجوز

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

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

get Rich Text Value()

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

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

بازگشت

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

مجوز

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

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

get Rich Text Values()

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

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

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

بازگشت

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

مجوز

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

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

get Row()

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

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

const range = sheet.getRange('B2');
Logger.log(range.getRow());

بازگشت

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

مجوز

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

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

get Row Index()

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

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

const range = sheet.getRange('B2');
Logger.log(range.getRowIndex());

بازگشت

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

مجوز

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

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

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


get Sheet()

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

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

get Text Direction()

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

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

بازگشت

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

مجوز

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

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

get Text Directions()

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

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

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

بازگشت

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

مجوز

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

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

get Text Rotation()

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

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

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

بازگشت

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

مجوز

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

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

get Text Rotations()

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

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

بازگشت

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

مجوز

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

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

get Text Style()

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

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

بازگشت

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

مجوز

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

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

get Text Styles()

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

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

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

بازگشت

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

مجوز

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

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

get Value()

مقدار سلول بالا سمت چپ را در محدوده برمی گرداند. مقدار ممکن است بسته به 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

get Values()

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

یک آرایه دو بعدی از مقادیر را برمی گرداند ، که توسط ردیف نمایه می شوند ، سپس توسط ستون. مقادیر بسته به مقدار سلول ممکن است از 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.
const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
در برنامه های وب ، یک مقدار Date یک پارامتر قانونی نیست. در صورتی که دامنه حاوی سلول با مقدار Date باشد get Values() داده را به یک برنامه وب بازگرداند. در عوض ، تمام مقادیر بازیابی شده از برگه را به یک جاوا اسکریپت اولیه مانند یک Number ، Boolean یا String تبدیل کنید.

بازگشت

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

مجوز

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

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

get Vertical Alignment()

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

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

Logger.log(range.getVerticalAlignment());

بازگشت

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

مجوز

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

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

get Vertical Alignments()

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

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

const results = range.getVerticalAlignments();

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

بازگشت

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

مجوز

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

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

get Width()

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

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

get Wrap()

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

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

Logger.log(range.getWrap());

بازگشت

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

مجوز

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

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

get Wrap Strategies()

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

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

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

بازگشت

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

مجوز

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

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

get Wrap Strategy()

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

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

بازگشت

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

مجوز

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

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

get Wraps()

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

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

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const 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

insert Cells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

پارامترها

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

بازگشت

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

مجوز

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

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

insert Checkboxes()

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

const 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

insert Checkboxes(checkedValue)

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

const 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');

پارامترها

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

بازگشت

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

مجوز

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

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

insert Checkboxes(checkedValue, uncheckedValue)

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

const 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');

پارامترها

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

بازگشت

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

مجوز

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

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

is Blank()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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

is Checked()

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

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

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

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

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

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

بازگشت

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

مجوز

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

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

is End Column Bounded()

تعیین می کند که آیا پایان دامنه به یک ستون خاص محدود شده است یا خیر. به عنوان مثال ، برای دامنه های 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

is End Row Bounded()

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

is Part Of Merge()

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

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

const range = sheet.getRange('A1:B3');

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

بازگشت

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


is Start Column Bounded()

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

is Start Row Bounded()

تعیین می کند که آیا شروع دامنه به یک ردیف خاص متصل است یا خیر. به عنوان مثال ، برای دامنه های 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()

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

const 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

merge Across()

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

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

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

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

بازگشت

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

مجوز

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

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

merge Vertically()

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

const 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

move To(target)

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

// The code below moves the first 5 columns over to the 6th column
const 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)

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

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

const cell = sheet.getRange('A1');

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

پارامترها

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

بازگشت

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


offset(rowOffset, columnOffset, numRows)

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

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

const cell = sheet.getRange('A1');

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

پارامترها

نام تایپ کنید توضیحات
row Offset Integer تعداد ردیف های پایین از سلول سمت چپ بالا. مقادیر منفی ردیف ها را از سلول سمت چپ بالا نشان می دهد.
column Offset Integer تعداد ستون ها درست از سلول سمت چپ بالا. مقادیر منفی نشانگر ستون های باقی مانده از سلول سمت چپ بالا است.
num Rows Integer ارتفاع در ردیف های محدوده جدید.

بازگشت

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


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

const cell = sheet.getRange('A1');

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

پارامترها

نام تایپ کنید توضیحات
row Offset Integer تعداد ردیف های پایین از سلول سمت چپ بالا. مقادیر منفی ردیف ها را از سلول سمت چپ بالا نشان می دهد.
column Offset Integer تعداد ستون ها درست از سلول سمت چپ بالا. مقادیر منفی نشانگر ستون های باقی مانده از سلول سمت چپ بالا است.
num Rows Integer ارتفاع در ردیف های محدوده جدید.
num Columns 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.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

بازگشت

Protection - شیء نماینده تنظیمات حفاظت.

مجوز

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

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

randomize()

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

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

// Randomizes the range
range.randomize();

بازگشت

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

مجوز

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

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

remove Checkboxes()

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

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

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

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

const 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

remove Duplicates()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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

remove Duplicates(columnsToCompare)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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]);

پارامترها

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

بازگشت

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

مجوز

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

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

set Background(color)

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

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

const 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

set Background Object(color)

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

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

const 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

set Background Objects(color)

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

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

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

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

const 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

set Background RGB(red, green, blue)

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

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

const 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

set Backgrounds(color)

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

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

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

const 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

set Border(top, left, bottom, right, vertical, horizontal)

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

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

const 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 در مورد مرزهای عمودی داخلی ، false هیچ یک ، null تغییر.
horizontal Boolean true در مورد مرزهای افقی داخلی ، برای هیچکدام false ، null تغییر.

بازگشت

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

مجوز

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

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

set Border(top, left, bottom, right, vertical, horizontal, color, style)

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

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

const 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 در مورد مرزهای عمودی داخلی ، false هیچ یک ، null تغییر.
horizontal Boolean true در مورد مرزهای افقی داخلی ، برای هیچکدام false ، null تغییر.
color String رنگ در نماد CSS (مانند '#ffffff' یا 'white' ) ، null برای رنگ پیش فرض (سیاه).
style Border Style سبکی برای مرزها ، null برای سبک پیش فرض (جامد).

بازگشت

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

مجوز

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

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

set Data Validation(rule)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

set Data Validations(rules)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

set Font Color(color)

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

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

const 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

set Font Color Object(color)

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

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

const cell = sheet.getRange('B2');
cell.setFontColor(color);

پارامترها

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

بازگشت

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

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Color Objects(colors)

Sets a rectangular grid of font colors (must match dimensions of this range).

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

پارامترها

نام تایپ کنید توضیحات
colors Color[][] A two-dimensional array of colors; null values reset the font color.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Colors(colors)

Sets a rectangular grid of font colors (must match dimensions of this range). The colors are in CSS notation (such as '#ffffff' or 'white' ).

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

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

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

پارامترها

نام تایپ کنید توضیحات
colors Object[][] A two-dimensional array of colors in CSS notation (such as '#ffffff' or 'white' ); null values reset the color.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Families(fontFamilies)

Sets a rectangular grid of font families (must match dimensions of this range). Examples of font families are "Arial" or "Helvetica".

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

پارامترها

نام تایپ کنید توضیحات
font Families Object[][] A two-dimensional array of font families; null values reset the font family.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Family(fontFamily)

Sets the font family, such as "Arial" or "Helvetica".

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

پارامترها

نام تایپ کنید توضیحات
font Family String The font family to set; a null value resets the font family.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Line(fontLine)

Sets the font line style of the given range ( 'underline' , 'line-through' , or 'none' ).

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

پارامترها

نام تایپ کنید توضیحات
font Line String The font line style, either 'underline' , 'line-through' , or 'none' ; a null value resets the font line style.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Lines(fontLines)

Sets a rectangular grid of line styles (must match dimensions of this range).

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

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

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

پارامترها

نام تایپ کنید توضیحات
font Lines Object[][] A two-dimensional array of font line styles ( 'underline' , 'line-through' , or 'none' ); null values reset the font line style.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Size(size)

Sets the font size, with the size being the point size to use.

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

پارامترها

نام تایپ کنید توضیحات
size Integer A font size in point size.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Sizes(sizes)

Sets a rectangular grid of font sizes (must match dimensions of this range). The sizes are in points.

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

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

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

پارامترها

نام تایپ کنید توضیحات
sizes Object[][] A two-dimensional array of sizes.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Style(fontStyle)

Set the font style for the given range ( 'italic' or 'normal' ).

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

پارامترها

نام تایپ کنید توضیحات
font Style String The font style, either 'italic' or 'normal' ; a null value resets the font style.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Styles(fontStyles)

Sets a rectangular grid of font styles (must match dimensions of this range).

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

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

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

پارامترها

نام تایپ کنید توضیحات
font Styles Object[][] A two-dimensional array of font styles, either 'italic' or 'normal' ; null values reset the font style.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Weight(fontWeight)

Set the font weight for the given range (normal/bold).

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

پارامترها

نام تایپ کنید توضیحات
font Weight String The font weight, either 'bold' or 'normal' ; a null value resets the font weight.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Font Weights(fontWeights)

Sets a rectangular grid of font weights (must match dimensions of this range). An example of a font weight is "bold".

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

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

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

پارامترها

نام تایپ کنید توضیحات
font Weights Object[][] A two-dimensional array of font weights, either 'bold' or 'normal' ; null values reset the font weight.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Formula(formula)

Updates the formula for this range. The given formula must be in A1 notation.

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

پارامترها

نام تایپ کنید توضیحات
formula String A string representing the formula to set for the cell.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Formula R1C1(formula)

Updates the formula for this range. The given formula must be in R1C1 notation.

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

const 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 A string formula.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Formulas(formulas)

Sets a rectangular grid of formulas (must match dimensions of this range). The given formulas must be in A1 notation. This method takes a two-dimensional array of formulas, indexed by row, then by column. The array dimensions must correspond to the range dimensions.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

پارامترها

نام تایپ کنید توضیحات
formulas String[][] A two-dimensional string array of formulas.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Formulas R1C1(formulas)

Sets a rectangular grid of formulas (must match dimensions of this range). The given formulas must be in R1C1 notation.

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

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

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

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

پارامترها

نام تایپ کنید توضیحات
formulas String[][] A two-dimensional array of formulas in R1C1 format.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Horizontal Alignment(alignment)

Set the horizontal (left to right) alignment for the given range (left/center/right).

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

پارامترها

نام تایپ کنید توضیحات
alignment String The alignment, either 'left' , 'center' or 'normal' ; a null value resets the alignment.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Horizontal Alignments(alignments)

Sets a rectangular grid of horizontal alignments. see set Horizontal Alignment(alignment)

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

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

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

پارامترها

نام تایپ کنید توضیحات
alignments Object[][] A two-dimensional array of alignments, either 'left' , 'center' or 'normal' ; a null value resets the alignment.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

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


set Note(note)

Sets the note to the given value.

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

پارامترها

نام تایپ کنید توضیحات
note String The note value to set for the range; a null value removes the note.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Notes(notes)

Sets a rectangular grid of notes (must match dimensions of this range).

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

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

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

پارامترها

نام تایپ کنید توضیحات
notes Object[][] A two-dimensional array of notes; null values remove the note.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

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


set Number Format(numberFormat)

Sets the number or date format to the given formatting string. The accepted format patterns are described in the Sheets API documentation .

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

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

پارامترها

نام تایپ کنید توضیحات
number Format String A number format string.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Number Formats(numberFormats)

Sets a rectangular grid of number or date formats (must match dimensions of this range). The values are format pattern strings as described in the Sheets API documentation .

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

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

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

پارامترها

نام تایپ کنید توضیحات
number Formats Object[][] A two-dimensional array of number formats.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Rich Text Value(value)

Sets the Rich Text value for the cells in the range.

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

پارامترها

نام تایپ کنید توضیحات
value Rich Text Value The desired Rich Text value.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Rich Text Values(values)

Sets a rectangular grid of Rich Text values.

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

پارامترها

نام تایپ کنید توضیحات
values Rich Text Value[][] The desired Rich Text values.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

Sets whether or not the range should show hyperlinks.

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

پارامترها

نام تایپ کنید توضیحات
show Hyperlink Boolean Whether or not to show the hyperlink.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Direction(direction)

Sets the text direction for the cells in the range. If a specified direction is null , the direction is inferred and then set.

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

پارامترها

نام تایپ کنید توضیحات
direction Text Direction The desired text direction; if null the direction is inferred before setting.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Directions(directions)

Sets a rectangular grid of text directions. If a specified direction is null , the direction is inferred and then set.

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

range2.setTextRotations(range1.getTextDirections());

پارامترها

نام تایپ کنید توضیحات
directions Text Direction[][] The desired text directions; if a specified direction is null it is inferred before setting.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Rotation(degrees)

Sets the text rotation settings for the cells in the range. The input corresponds to the angle between the standard text orientation and the desired orientation. An input of zero indicates that the text is set to the standard orientation.

For left to right text direction, positive angles are in the counterclockwise direction, whereas for right to left they are in the clockwise direction.

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

range.setTextRotation(45);

پارامترها

نام تایپ کنید توضیحات
degrees Integer The desired angle between the standard orientation and the desired orientation. For left to right text, positive angles are in the counterclockwise direction.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Rotation(rotation)

Sets the text rotation settings for the cells in the range.

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

const rotation = sheet.getRange('A1').getTextRotation();

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

پارامترها

نام تایپ کنید توضیحات
rotation Text Rotation The desired text rotation settings.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Rotations(rotations)

Sets a rectangular grid of text rotations.

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

range2.setTextRotations(range1.getTextRotations());

پارامترها

نام تایپ کنید توضیحات
rotations Text Rotation[][] The desired text rotation settings.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Style(style)

Sets the text style for the cells in the range.

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

پارامترها

نام تایپ کنید توضیحات
style Text Style The desired text style.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Text Styles(styles)

Sets a rectangular grid of text styles.

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

پارامترها

نام تایپ کنید توضیحات
styles Text Style[][] The desired text styles.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Value(value)

Sets the value of the range. The value can be numeric, string, boolean or date. If it begins with '=' it is interpreted as a formula.

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

const cell = sheet.getRange('B2');
cell.setValue(100);

پارامترها

نام تایپ کنید توضیحات
value Object The value for the range.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Values(values)

Sets a rectangular grid of values (must match dimensions of this range). If a value begins with = , it's interpreted as a formula.

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

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

const range = sheet.getRange('B2:D2');
range.setValues(values);

پارامترها

نام تایپ کنید توضیحات
values Object[][] A two-dimensional array of values.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Vertical Alignment(alignment)

Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

پارامترها

نام تایپ کنید توضیحات
alignment String The alignment, either 'top' , 'middle' or 'bottom' ; a null value resets the alignment.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Vertical Alignments(alignments)

Sets a rectangular grid of vertical alignments (must match dimensions of this range).

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

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

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

پارامترها

نام تایپ کنید توضیحات
alignments Object[][] A two-dimensional array of alignments, either 'top' , 'middle' or 'bottom' ; a null value resets the alignment.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

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


set Vertical Text(isVertical)

Sets whether or not to stack the text for the cells in the range. If the text is stacked vertically, the degree text rotation setting is ignored.

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

range.setVerticalText(true);

پارامترها

نام تایپ کنید توضیحات
is Vertical Boolean Whether or not to stack the text.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Wrap(isWrapEnabled)

Set the cell wrap of the given range.

Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

پارامترها

نام تایپ کنید توضیحات
is Wrap Enabled Boolean Whether to wrap text or not.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Wrap Strategies(strategies)

Sets a rectangular grid of wrap strategies.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

پارامترها

نام تایپ کنید توضیحات
strategies Wrap Strategy[][] The desired wrapping strategies.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Wrap Strategy(strategy)

Sets the text wrapping strategy for the cells in the range.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

پارامترها

نام تایپ کنید توضیحات
strategy Wrap Strategy The desired wrapping strategy.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

set Wraps(isWrapEnabled)

Sets a rectangular grid of word wrap policies (must match dimensions of this range). Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.

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

// The size of the two-dimensional array must match the size of the range.
const wraps = [[true, true, false]];

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

پارامترها

نام تایپ کنید توضیحات
is Wrap Enabled Object[][] A two-dimensional array of wrap variables that determine whether to wrap text in a cell or not.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

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


shift Column Group Depth(delta)

Changes the column grouping depth of the range by the specified amount.

This has the effect of creating, modifying, or deleting groups that intersect with the range. For positive deltas, groups are created and/or modified; for negative deltas, groups are destroyed and/or modified.

This has no effect when decreasing the group depth below zero or above eight.

If the column group control position is BEFORE , this throws an error when attempting to shift the depth of the first row.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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 The amount by which to change the column group depth of this range.

بازگشت

Range — This range, for chaining.

پرتاب می کند

Error — when attempting to shift the depth of the first column when the control position is Group Control Toggle Position.BEFORE

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

shift Row Group Depth(delta)

Changes the row grouping depth of the range by the specified amount.

This has the effect of creating, modifying, or deleting groups that intersect with the range. For positive deltas, groups are created and/or modified; for negative deltas, groups are destroyed and/or modified.

This has no effect when decreasing the group depth below zero or above eight.

If the row group control position is BEFORE , this throws an error when attempting to shift the depth of the first row.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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 The amount by which to change the row group depth of this range.

بازگشت

Range — This range, for chaining.

پرتاب می کند

Error — when attempting to shift the depth of the first row when the control position is Group Control Toggle Position.BEFORE

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

sort(sortSpecObj)

Sorts the cells in the given range, by column and order specified.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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},
]);

پارامترها

نام تایپ کنید توضیحات
sort Spec Obj Object The columns to sort by.

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

split Text To Columns()

Splits a column of text into multiple columns based on an auto-detected delimiter.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

split Text To Columns(delimiter)

Splits a column of text into multiple columns using the specified string as a custom delimiter.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns('#');

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

پارامترها

نام تایپ کنید توضیحات
delimiter String The custom delimiter to split on.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

split Text To Columns(delimiter)

Splits a column of text into multiple columns based on the specified delimiter.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

پارامترها

نام تایپ کنید توضیحات
delimiter Text To Columns Delimiter The preset delimiter to split on.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

trim Whitespace()

Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range. Removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

range.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

uncheck()

Changes the state of the checkboxes in the range to “unchecked”. Ignores the cells in the range which currently do not contain either the checked or unchecked value configured.

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

بازگشت

Range — This range, for chaining.

مجوز

Scripts that use this method require authorization with one or more of the following scopes :

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

Deprecated methods