این سرویس به اسکریپتها اجازه میدهد فایلهای Google Sheets را ایجاد، دسترسی و تغییر دهند. همچنین به راهنمای ذخیره دادهها در صفحات گسترده مراجعه کنید.
گاهی اوقات، عملیات صفحهگسترده برای بهبود عملکرد، مانند هنگام انجام چندین فراخوانی به یک متد، با هم ترکیب میشوند. اگر میخواهید مطمئن شوید که همه تغییرات در حال انتظار فوراً اعمال میشوند، به عنوان مثال برای نمایش اطلاعات کاربران هنگام اجرای یک اسکریپت، Spreadsheet App.flush() را فراخوانی کنید.
کلاسها
| نام | شرح مختصر |
|---|---|
Auto Fill Series | فهرستی از انواع سریهای مورد استفاده برای محاسبه مقادیر خودکار پر شده. |
Banding | به نواربندیها، الگوهای رنگی اعمال شده روی ردیفها یا ستونهای یک محدوده، دسترسی پیدا کرده و آنها را تغییر دهید. |
Banding Theme | فهرستی از تمهای باندینگ. |
Big Query Data Source Spec | به مشخصات منبع داده موجود BigQuery دسترسی پیدا کنید. |
Big Query Data Source Spec Builder | سازندهی ابزار Big Query Data Source Spec Builder . |
Boolean Condition | به شرطهای بولی در Conditional Format Rules دسترسی پیدا کنید. |
Boolean Criteria | یک نوع شمارش که معیارهای بولی را نشان میدهد که میتوانند در قالببندی شرطی یا فیلتر استفاده شوند. |
Border Style | استایلهایی که میتوانند با استفاده از Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) روی یک محدوده تنظیم شوند. |
Cell Image | نشان دهنده مقدار تصویر در یک سلول است. |
Cell Image Builder | سازنده برای Cell Image . |
Color | نمادی برای یک رنگ. |
Color Builder | سازنده برای Color Builder . |
Conditional Format Rule | دسترسی به قوانین قالببندی شرطی |
Conditional Format Rule Builder | سازنده برای قوانین قالببندی شرطی. |
Container Info | به موقعیت نمودار در یک برگه دسترسی پیدا کنید. |
Copy Paste Type | فهرستی از انواع خمیرهای ویژه ممکن. |
Data Execution Error Code | فهرستی از کدهای خطای اجرای دادهها. |
Data Execution State | شمارشی از وضعیتهای اجرای دادهها. |
Data Execution Status | وضعیت اجرای دادهها |
Data Source | دسترسی و تغییر منبع داده موجود. |
Data Source Chart | به نمودار منبع داده موجود دسترسی پیدا کنید و آن را تغییر دهید. |
Data Source Column | دسترسی و تغییر یک ستون منبع داده |
Data Source Formula | به فرمولهای منبع داده موجود دسترسی پیدا کنید و آنها را تغییر دهید. |
Data Source Parameter | دسترسی به پارامترهای منبع داده موجود. |
Data Source Parameter Type | شمارشی از انواع پارامترهای منبع داده. |
Data Source Pivot Table | دسترسی و تغییر جدول محوری منبع داده موجود. |
Data Source Refresh Schedule | به یک برنامه بهروزرسانی موجود دسترسی پیدا کنید و آن را تغییر دهید. |
Data Source Refresh Schedule Frequency | به فرکانس برنامه بهروزرسانی دسترسی پیدا کنید، که مشخص میکند هر چند وقت یکبار و چه زمانی بهروزرسانی انجام شود. |
Data Source Refresh Scope | فهرستی از محدودههای بهروزرسانی. |
Data Source Sheet | به برگه منبع داده موجود دسترسی پیدا کرده و آن را تغییر دهید. |
Data Source Sheet Filter | به یک فیلتر موجود در برگه منبع داده دسترسی پیدا کرده و آن را تغییر دهید. |
Data Source Spec | به تنظیمات عمومی مشخصات منبع داده موجود دسترسی پیدا کنید. |
Data Source Spec Builder | سازنده برای Data Source Spec . |
Data Source Table | دسترسی و تغییر جدول منبع داده موجود. |
Data Source Table Column | دسترسی و تغییر یک ستون موجود در Data Source Table . |
Data Source Table Filter | به یک فیلتر جدول منبع داده موجود دسترسی پیدا کنید و آن را تغییر دهید. |
Data Source Type | فهرستی از انواع منابع داده. |
Data Validation | قوانین اعتبارسنجی دادهها را بررسی کنید. |
Data Validation Builder | سازنده برای قوانین اعتبارسنجی دادهها. |
Data Validation Criteria | یک نوع شمارش که معیارهای اعتبارسنجی دادهها را که میتوانند روی یک محدوده تنظیم شوند، نشان میدهد. |
Date Time Grouping Rule | به یک قانون گروهبندی تاریخ-زمان موجود دسترسی پیدا کنید. |
Date Time Grouping Rule Type | انواع قوانین گروهبندی تاریخ-زمان |
Developer Metadata | دسترسی و تغییر فرادادههای توسعهدهنده. |
Developer Metadata Finder | جستجوی فرادادههای توسعهدهنده در یک صفحه گسترده. |
Developer Metadata Location | به اطلاعات مکان فراداده توسعهدهنده دسترسی پیدا کنید. |
Developer Metadata Location Type | فهرستی از انواع مکانهای فراداده توسعهدهنده. |
Developer Metadata Visibility | فهرستی از انواع قابلیت مشاهده فراداده توسعهدهنده. |
Dimension | فهرستی از مسیرهای ممکن که دادهها میتوانند در یک صفحه گسترده ذخیره شوند. |
Direction | یک شمارش که نشاندهندهی جهتهای ممکن برای حرکت در یک صفحه گسترده با استفاده از کلیدهای جهتنما است. |
Drawing | نشان دهنده ترسیم روی یک برگه در یک صفحه گسترده است. |
Embedded Area Chart Builder | سازنده نمودارهای مساحت. |
Embedded Bar Chart Builder | سازنده نمودارهای میلهای. |
Embedded Chart | نموداری را نشان میدهد که در یک صفحه گسترده جاسازی شده است. |
Embedded Chart Builder | سازنده برای ویرایش Embedded Chart استفاده میشود. |
Embedded Column Chart Builder | سازنده نمودارهای ستونی. |
Embedded Combo Chart Builder | سازنده نمودارهای ترکیبی. |
Embedded Histogram Chart Builder | سازنده نمودارهای هیستوگرام. |
Embedded Line Chart Builder | سازنده نمودارهای خطی. |
Embedded Pie Chart Builder | سازنده نمودارهای دایرهای. |
Embedded Scatter Chart Builder | سازنده نمودارهای پراکندگی. |
Embedded Table Chart Builder | سازنده نمودارهای جدولی. |
Filter | از این کلاس برای تغییر فیلترهای موجود روی صفحات Grid ، نوع پیشفرض صفحات، استفاده کنید. |
Filter Criteria | از این کلاس برای دریافت اطلاعات یا کپی کردن معیارهای فیلترهای موجود استفاده کنید. |
Filter Criteria Builder | سازنده برای معیارهای فیلتر. |
Frequency Type | فهرستی از انواع فرکانس. |
Gradient Condition | به شرایط گرادیان (رنگ) در Conditional Format Rule Apis دسترسی پیدا کنید. |
Group | دسترسی و تغییر گروههای صفحهگسترده |
Group Control Toggle Position | یک نوع شمارش که موقعیتهای ممکنی را که یک دکمه کنترل گروهی میتواند داشته باشد، نشان میدهد. |
Interpolation Type | یک نوع شمارش که گزینههای درونیابی برای محاسبه مقداری که قرار است در یک Gradient Condition در یک Conditional Format Rule استفاده شود را نشان میدهد. |
Looker Data Source Spec | Data Source Spec که برای دسترسی خاص به مشخصات منبع داده موجود Looker استفاده میشود. |
Looker Data Source Spec Builder | سازندهی Looker Data Source Spec Builder . |
Named Range | ایجاد، دسترسی و تغییر محدودههای نامگذاری شده در یک صفحه گسترده. |
Over Grid Image | یک تصویر را روی شبکه در یک صفحه گسترده نشان میدهد. |
| دسترسی و تغییر برگههای محافظتشده در نسخه قدیمی Google Sheets. |
Pivot Filter | دسترسی و تغییر فیلترهای جدول محوری |
Pivot Group | به گروههای جداگانه جدول محوری دسترسی پیدا کنید و آنها را تغییر دهید. |
Pivot Group Limit | دسترسی و تغییر محدودیت گروه جدول محوری. |
Pivot Table | دسترسی و تغییر جداول محوری |
Pivot Table Summarize Function | فهرستی از توابع که دادههای جدول محوری را خلاصه میکنند. |
Pivot Value | دسترسی و تغییر گروههای مقادیر در جداول محوری |
Pivot Value Display Type | فهرستی از روشهای نمایش یک مقدار محوری به عنوان تابعی از یک مقدار دیگر. |
Protection | دسترسی و تغییر محدودهها و صفحات محافظتشده |
Protection Type | یک شمارشگر که بخشهایی از یک صفحهگسترده را نشان میدهد که میتوانند از ویرایش محافظت شوند. |
Range | دسترسی و تغییر محدودههای صفحهگسترده |
Range List | مجموعهای از یک یا چند نمونه Range در یک برگه. |
Recalculation Interval | یک نوع شمارش که نشاندهندهی فواصل زمانی ممکن مورد استفاده در محاسبهی مجدد صفحهگسترده است. |
Relative Date | یک نوع شمارش که گزینههای تاریخ نسبی را برای محاسبه مقداری که قرار است در Boolean Criteria مبتنی بر تاریخ استفاده شود، نشان میدهد. |
Rich Text Value | یک رشته متنی استایلبندیشده که برای نمایش متن سلول استفاده میشود. |
Rich Text Value Builder | سازندهای برای مقادیر Rich Text. |
Selection | به انتخاب فعال فعلی در برگه فعال دسترسی پیدا کنید. |
Sheet | به صفحات گسترده دسترسی پیدا کنید و آنها را تغییر دهید. |
Sheet Type | انواع مختلف برگههایی که میتوانند در یک صفحه گسترده وجود داشته باشند. |
Slicer | نشان دهنده یک برش دهنده است که برای فیلتر کردن محدودهها، نمودارها و جداول محوری به شیوهای غیر مشارکتی استفاده میشود. |
Sort Order | یک نوع داده شمارشی که ترتیب مرتبسازی را نشان میدهد. |
Sort Spec | مشخصات مرتبسازی. |
Spreadsheet | دسترسی و تغییر فایلهای گوگل شیت |
Spreadsheet App | دسترسی و ایجاد فایلهای Google Sheets |
Spreadsheet Theme | به تمهای موجود دسترسی پیدا کنید و آنها را تغییر دهید. |
Text Direction | فهرستی از مسیرهای متنی. |
Text Finder | متن را در یک محدوده، برگه یا صفحه گسترده پیدا یا جایگزین کنید. |
Text Rotation | به تنظیمات چرخش متن برای یک سلول دسترسی پیدا کنید. |
Text Style | سبک رندر شده متن در یک سلول. |
Text Style Builder | سازندهای برای استایلهای متن. |
Text To Columns Delimiter | فهرستی از انواع جداکنندههای از پیش تعیینشده که میتوانند یک ستون متن را به چندین ستون تقسیم کنند. |
Theme Color | نمایشی برای رنگ تم. |
Theme Color Type | یک enum که ورودیهای رنگ مختلف پشتیبانیشده در قالبها را توصیف میکند. |
Value Type | شمارشی از انواع مقادیر که توسط Range.getValue() و Range.getValues() از کلاس Range سرویس Spreadsheet برگردانده شده است. |
Wrap Strategy | فهرستی از استراتژیهای مورد استفاده برای مدیریت بستهبندی متن سلول. |
Auto Fill Series
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DEFAULT_SERIES | Enum | پیشفرض |
ALTERNATE_SERIES | Enum | پر کردن خودکار با این تنظیم منجر به پر شدن سلولهای خالی در محدودهی گسترشیافته با کپیهایی از مقادیر موجود میشود. |
Banding
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy To(range) | Banding | این نواربندی را در محدوده دیگری کپی میکند. |
get First Column Color Object() | Color |null | اولین رنگ ستون متناوب در نواربندی را برمیگرداند، یا اگر رنگی تنظیم نشده باشد، null برمیگرداند. |
get First Row Color Object() | Color |null | رنگ اولین ردیف متناوب را برمیگرداند، یا اگر رنگی تنظیم نشده باشد null برمیگرداند. |
get Footer Column Color Object() | Color |null | رنگ آخرین ستون در نواربندی را برمیگرداند، یا اگر رنگی تنظیم نشده باشد null برمیگرداند. |
get Footer Row Color Object() | Color |null | رنگ آخرین ردیف در نواربندی را برمیگرداند، یا اگر رنگی تنظیم نشده باشد null برمیگرداند. |
get Header Column Color Object() | Color |null | رنگ اولین ستون در نواربندی را برمیگرداند، یا اگر رنگی تنظیم نشده باشد null برمیگرداند. |
get Header Row Color Object() | Color |null | رنگ سطر هدر را برمیگرداند و در صورت عدم تنظیم رنگ، null برمیگرداند. |
get Range() | Range | محدودهی این نواربندی را برمیگرداند. |
get Second Column Color Object() | Color |null | رنگ ستون متناوب دوم را در نواربندی برمیگرداند، یا اگر رنگی تنظیم نشده باشد، null برمیگرداند. |
get Second Row Color Object() | Color |null | رنگ ردیف دوم را به صورت متناوب برمیگرداند، و در صورت عدم تنظیم رنگ، null برمیگرداند. |
remove() | void | این نواربندی را از بین میبرد. |
set First Column Color(color) | Banding | رنگ اولین ستونی که به صورت متناوب است را تنظیم میکند. |
set First Column Color Object(color) | Banding | اولین رنگ ستون متناوب را در نواربندی تنظیم میکند. |
set First Row Color(color) | Banding | رنگ اولین ردیفی که به صورت متناوب است را تنظیم میکند. |
set First Row Color Object(color) | Banding | اولین رنگ ردیف متناوب را در نواربندی تنظیم میکند. |
set Footer Column Color(color) | Banding | رنگ آخرین ستون را تنظیم میکند. |
set Footer Column Color Object(color) | Banding | رنگ آخرین ستون در نواربندی را تنظیم میکند. |
set Footer Row Color(color) | Banding | رنگ آخرین ردیف را تنظیم میکند. |
set Footer Row Color Object(color) | Banding | رنگ ردیف پاورقی را در نواربندی تنظیم میکند. |
set Header Column Color(color) | Banding | رنگ ستون هدر را تنظیم میکند. |
set Header Column Color Object(color) | Banding | رنگ ستون هدر را تنظیم میکند. |
set Header Row Color(color) | Banding | رنگ ردیف هدر را تنظیم میکند. |
set Header Row Color Object(color) | Banding | رنگ ردیف هدر را تنظیم میکند. |
set Range(range) | Banding | محدوده این باندینگ را تعیین میکند. |
set Second Column Color(color) | Banding | رنگ ستون دوم که به صورت متناوب است را تنظیم میکند. |
set Second Column Color Object(color) | Banding | رنگ ستون متناوب دوم را در نواربندی تنظیم میکند. |
set Second Row Color(color) | Banding | رنگ ردیف دوم را که متناوب است، تنظیم میکند. |
set Second Row Color Object(color) | Banding | دومین رنگ متناوب را در نواربندی تنظیم میکند. |
Banding Theme
خواص
| ملک | نوع | توضیحات |
|---|---|---|
LIGHT_GREY | Enum | یک تم نواری خاکستری روشن. |
CYAN | Enum | یک تم با نواربندی فیروزهای. |
GREEN | Enum | یک تم با نوارهای سبز. |
YELLOW | Enum | یک تم با نوارهای زرد. |
ORANGE | Enum | یک تم با نوارهای نارنجی. |
BLUE | Enum | یک تم با نوارهای آبی. |
TEAL | Enum | یک تم با طرح فیروزهای. |
GREY | Enum | یک تم با نوارهای خاکستری. |
BROWN | Enum | یک تم با نوارهای قهوهای. |
LIGHT_GREEN | Enum | یک تم نواری سبز روشن. |
INDIGO | Enum | یک تم با نواربندی نیلی. |
PINK | Enum | یک تم نواری صورتی. |
Big Query Data Source Spec
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Data Source Spec Builder | بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد میکند. |
get Dataset Id() | String | شناسه مجموعه داده BigQuery را دریافت میکند. |
get Parameters() | Data Source Parameter[] | پارامترهای منبع داده را دریافت میکند. |
get Project Id() | String | شناسه پروژه صورتحساب را دریافت میکند. |
get Raw Query() | String | رشته پرس و جوی خام را دریافت میکند. |
get Table Id() | String | شناسه جدول BigQuery را دریافت میکند. |
get Table Project Id() | String | شناسه پروژه BigQuery را برای جدول دریافت میکند. |
get Type() | Data Source Type | نوع منبع داده را دریافت میکند. |
Big Query Data Source Spec Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Data Source Spec | مشخصات منبع داده را از تنظیمات موجود در این سازنده میسازد. |
copy() | Data Source Spec Builder | بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد میکند. |
get Dataset Id() | String | شناسه مجموعه داده BigQuery را دریافت میکند. |
get Parameters() | Data Source Parameter[] | پارامترهای منبع داده را دریافت میکند. |
get Project Id() | String | شناسه پروژه صورتحساب را دریافت میکند. |
get Raw Query() | String | رشته پرس و جوی خام را دریافت میکند. |
get Table Id() | String | شناسه جدول BigQuery را دریافت میکند. |
get Table Project Id() | String | شناسه پروژه BigQuery را برای جدول دریافت میکند. |
get Type() | Data Source Type | نوع منبع داده را دریافت میکند. |
remove All Parameters() | Big Query Data Source Spec Builder | تمام پارامترها را حذف میکند. |
remove Parameter(parameterName) | Big Query Data Source Spec Builder | پارامتر مشخص شده را حذف میکند. |
set Dataset Id(datasetId) | Big Query Data Source Spec Builder | شناسه مجموعه داده BigQuery را تنظیم میکند. |
set Parameter From Cell(parameterName, sourceCell) | Big Query Data Source Spec Builder | یک پارامتر اضافه میکند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را برای سازندگان مشخصات منبع داده از نوع Data Source Type.BIGQUERY بهروزرسانی میکند. |
set Project Id(projectId) | Big Query Data Source Spec Builder | شناسه پروژه BigQuery مربوط به پرداخت را تنظیم میکند. |
set Raw Query(rawQuery) | Big Query Data Source Spec Builder | رشته پرس و جوی خام را تنظیم میکند. |
set Table Id(tableId) | Big Query Data Source Spec Builder | شناسه جدول BigQuery را تنظیم میکند. |
set Table Project Id(projectId) | Big Query Data Source Spec Builder | شناسه پروژه BigQuery را برای جدول تنظیم میکند. |
Boolean Condition
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Background Object() | Color |null | رنگ پسزمینه را برای این شرط بولی برمیگرداند. |
get Bold() | Boolean|null | اگر این شرط بولی متن را پررنگ کند، true را برمیگرداند و اگر این شرط بولی، پررنگ شدن متن را حذف کند، false را برمیگرداند. |
get Criteria Type() | Boolean Criteria | نوع معیار قاعده را همانطور که در شمارش Boolean Criteria تعریف شده است، برمیگرداند. |
get Criteria Values() | Object[] | آرایهای از آرگومانها را برای معیارهای قاعده دریافت میکند. |
get Font Color Object() | Color |null | رنگ فونت را برای این شرط بولی برمیگرداند. |
get Italic() | Boolean|null | اگر این شرط بولی متن را کج (italic) کند، true را برمیگرداند و اگر این شرط بولی، حروف کج (italic) را از متن حذف کند، false را برمیگرداند. |
get Strikethrough() | Boolean|null | اگر این شرط بولی متن را خط بزند، true را برمیگرداند و اگر این شرط بولی، خط خورده را از متن حذف کند، false را برمیگرداند. |
get Underline() | Boolean|null | اگر این شرط بولی متن را زیرخطدار کند، true را برمیگرداند و اگر این شرط بولی زیرخطدار را از متن حذف کند، false را برمیگرداند. |
Boolean Criteria
خواص
| ملک | نوع | توضیحات |
|---|---|---|
CELL_EMPTY | Enum | معیار زمانی برآورده میشود که یک سلول خالی باشد. |
CELL_NOT_EMPTY | Enum | این معیار زمانی برآورده میشود که یک سلول خالی نباشد. |
DATE_AFTER | Enum | این معیار زمانی برقرار است که تاریخ بعد از مقدار داده شده باشد. |
DATE_BEFORE | Enum | این معیار زمانی برآورده میشود که تاریخ قبل از مقدار داده شده باشد. |
DATE_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که یک تاریخ برابر با مقدار داده شده باشد. |
DATE_NOT_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که یک تاریخ با مقدار داده شده برابر نباشد. |
DATE_AFTER_RELATIVE | Enum | این معیار زمانی برقرار است که یک تاریخ بعد از مقدار تاریخ نسبی باشد. |
DATE_BEFORE_RELATIVE | Enum | این معیار زمانی برآورده میشود که یک تاریخ قبل از مقدار تاریخ نسبی باشد. |
DATE_EQUAL_TO_RELATIVE | Enum | این معیار زمانی برآورده میشود که یک تاریخ با مقدار نسبی تاریخ برابر باشد. |
NUMBER_BETWEEN | Enum | معیار زمانی برآورده میشود که عددی بین مقادیر داده شده باشد. |
NUMBER_EQUAL_TO | Enum | معیار زمانی برآورده میشود که عددی برابر با مقدار داده شده باشد. |
NUMBER_GREATER_THAN | Enum | معیار زمانی برآورده میشود که عددی بزرگتر از مقدار داده شده باشد. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که عددی بزرگتر یا مساوی مقدار داده شده باشد. |
NUMBER_LESS_THAN | Enum | این معیار زمانی برآورده میشود که عددی کمتر از مقدار داده شده باشد. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که عددی کمتر یا مساوی مقدار داده شده باشد. |
NUMBER_NOT_BETWEEN | Enum | معیار زمانی برآورده میشود که عددی بین مقادیر داده شده نباشد. |
NUMBER_NOT_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که عددی با مقدار داده شده برابر نباشد. |
TEXT_CONTAINS | Enum | معیار زمانی برآورده میشود که ورودی شامل مقدار داده شده باشد. |
TEXT_DOES_NOT_CONTAIN | Enum | معیار زمانی برآورده میشود که ورودی شامل مقدار داده شده نباشد. |
TEXT_EQUAL_TO | Enum | معیار زمانی برآورده میشود که ورودی برابر با مقدار داده شده باشد. |
TEXT_NOT_EQUAL_TO | Enum | این معیار زمانی برآورده میشود که ورودی با مقدار داده شده برابر نباشد. |
TEXT_STARTS_WITH | Enum | معیار زمانی برآورده میشود که ورودی با مقدار داده شده شروع شود. |
TEXT_ENDS_WITH | Enum | معیار زمانی برآورده میشود که ورودی با مقدار داده شده به پایان برسد. |
CUSTOM_FORMULA | Enum | معیار زمانی برآورده میشود که ورودی، فرمول داده شده را به true ارزیابی کند. |
Border Style
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DOTTED | Enum | مرزهای نقطه چین. |
DASHED | Enum | مرزهای خط چین. |
SOLID | Enum | مرزها با خطوط نازک و پیوسته. |
SOLID_MEDIUM | Enum | حاشیههای خط پیوسته متوسط. |
SOLID_THICK | Enum | حاشیههای ضخیم و یکدست. |
DOUBLE | Enum | دو حاشیه با خط ممتد. |
Cell Image
خواص
| ملک | نوع | توضیحات |
|---|---|---|
value Type | Value Type | نوع مقدار تصویر سلول، که Value Type.IMAGE است. |
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Alt Text Description() | String | توضیحات متن جایگزین (alt text) را برای این تصویر برمیگرداند. |
get Alt Text Title() | String | عنوان متن جایگزین (alt text) را برای این تصویر برمیگرداند. |
get Content Url() | String | یک URL میزبانی شده توسط گوگل را به تصویر برمیگرداند. |
to Builder() | Cell Image Builder | بر اساس ویژگیهای تصویر فعلی، یک سازنده تصویر سلول ایجاد میکند. |
Cell Image Builder
خواص
| ملک | نوع | توضیحات |
|---|---|---|
value Type | Value Type | نوع مقدار تصویر سلول، که Value Type.IMAGE است. |
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Cell Image | نوع مقدار تصویر مورد نیاز برای افزودن تصویر به یک سلول را ایجاد میکند. |
get Alt Text Description() | String | توضیحات متن جایگزین (alt text) را برای این تصویر برمیگرداند. |
get Alt Text Title() | String | عنوان متن جایگزین (alt text) را برای این تصویر برمیگرداند. |
get Content Url() | String | یک URL میزبانی شده توسط گوگل را به تصویر برمیگرداند. |
set Alt Text Description(description) | Cell Image | توضیحات متن جایگزین (alt-text) را برای این تصویر تنظیم میکند. |
set Alt Text Title(title) | Cell Image | عنوان متن جایگزین (alt text) را برای این تصویر تنظیم میکند. |
set Source Url(url) | Cell Image Builder | آدرس منبع تصویر (URL) را تنظیم میکند. |
to Builder() | Cell Image Builder | بر اساس ویژگیهای تصویر فعلی، یک سازنده تصویر سلول ایجاد میکند. |
Color
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
as Rgb Color() | Rgb Color | این رنگ را به یک Rgb Color تبدیل میکند. |
as Theme Color() | Theme Color | این رنگ را به Theme Color تبدیل میکند. |
get Color Type() | Color Type | نوع این رنگ را بدست آورید. |
Color Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
as Rgb Color() | Rgb Color | این رنگ را به یک Rgb Color تبدیل میکند. |
as Theme Color() | Theme Color | این رنگ را به Theme Color تبدیل میکند. |
build() | Color | یک شیء رنگ از تنظیمات ارائه شده به سازنده ایجاد میکند. |
get Color Type() | Color Type | نوع این رنگ را بدست آورید. |
set Rgb Color(cssString) | Color Builder | به عنوان رنگ RGB تنظیم میکند. |
set Theme Color(themeColorType) | Color Builder | به عنوان رنگ تم تنظیم میشود. |
Conditional Format Rule
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Conditional Format Rule Builder | یک پیشتنظیم سازندهی قانون با تنظیمات این قانون برمیگرداند. |
get Boolean Condition() | Boolean Condition |null | اگر این قانون از معیارهای شرط بولی استفاده کند، اطلاعات Boolean Condition آن قانون را بازیابی میکند. |
get Gradient Condition() | Gradient Condition |null | اطلاعات Gradient Condition قانون را بازیابی میکند، اگر این قانون از معیارهای شرط گرادیان استفاده کند. |
get Ranges() | Range[] | محدودههایی را که این قانون قالببندی شرطی به آنها اعمال میشود، بازیابی میکند. |
Conditional Format Rule Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Conditional Format Rule | یک قانون قالببندی شرطی از تنظیمات اعمال شده به سازنده میسازد. |
copy() | Conditional Format Rule Builder | یک پیشتنظیم سازندهی قانون با تنظیمات این قانون برمیگرداند. |
get Boolean Condition() | Boolean Condition |null | اگر این قانون از معیارهای شرط بولی استفاده کند، اطلاعات Boolean Condition آن قانون را بازیابی میکند. |
get Gradient Condition() | Gradient Condition |null | اطلاعات Gradient Condition قانون را بازیابی میکند، اگر این قانون از معیارهای شرط گرادیان استفاده کند. |
get Ranges() | Range[] | محدودههایی را که این قانون قالببندی شرطی به آنها اعمال میشود، بازیابی میکند. |
set Background(color) | Conditional Format Rule Builder | رنگ پسزمینه را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Background Object(color) | Conditional Format Rule Builder | رنگ پسزمینه را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Bold(bold) | Conditional Format Rule Builder | میزان پررنگ شدن متن را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Font Color(color) | Conditional Format Rule Builder | رنگ فونت را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Font Color Object(color) | Conditional Format Rule Builder | رنگ فونت را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Gradient Maxpoint(color) | Conditional Format Rule Builder | مقدار گرادیان maxpoint قانون قالببندی شرطی را پاک میکند و در عوض از حداکثر مقدار در محدودههای قانون استفاده میکند. |
set Gradient Maxpoint Object(color) | Conditional Format Rule Builder | مقدار گرادیان maxpoint قانون قالببندی شرطی را پاک میکند و در عوض از حداکثر مقدار در محدودههای قانون استفاده میکند. |
set Gradient Maxpoint Object With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای حداکثر نقطه گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Gradient Maxpoint With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای حداکثر نقطه گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Gradient Midpoint Object With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای نقطه میانی گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Gradient Midpoint With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای نقطه میانی گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Gradient Minpoint(color) | Conditional Format Rule Builder | مقدار نقطه حداقل گرادیان قانون قالببندی شرطی را پاک میکند و در عوض از حداقل مقدار در محدودههای قانون استفاده میکند. |
set Gradient Minpoint Object(color) | Conditional Format Rule Builder | مقدار نقطه حداقل گرادیان قانون قالببندی شرطی را پاک میکند و در عوض از حداقل مقدار در محدودههای قانون استفاده میکند. |
set Gradient Minpoint Object With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای نقطهی حداقل گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Gradient Minpoint With Value(color, type, value) | Conditional Format Rule Builder | فیلدهای نقطهی حداقل گرادیان قانون قالببندی شرطی را تنظیم میکند. |
set Italic(italic) | Conditional Format Rule Builder | متن را برای قالب قانون قالببندی شرطی به صورت مورب تنظیم میکند. |
set Ranges(ranges) | Conditional Format Rule Builder | یک یا چند محدوده را که این قانون قالببندی شرطی روی آنها اعمال میشود، تنظیم میکند. |
set Strikethrough(strikethrough) | Conditional Format Rule Builder | متن خط خورده را برای قالب قانون قالببندی شرطی تنظیم میکند. |
set Underline(underline) | Conditional Format Rule Builder | زیرخطدار شدن متن را برای قالب قانون قالببندی شرطی تنظیم میکند. |
when Cell Empty() | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا در صورت خالی بودن سلول فعال شود. |
when Cell Not Empty() | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی سلول خالی نیست، فعال شود. |
when Date After(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی تاریخ بعد از مقدار داده شده قرار میگیرد، فعال شود. |
when Date After(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی یک تاریخ بعد از تاریخ نسبی داده شده قرار میگیرد، فعال شود. |
when Date Before(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی تاریخ قبل از تاریخ داده شده است، فعال شود. |
when Date Before(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی یک تاریخ قبل از تاریخ نسبی داده شده است، فعال شود. |
when Date Equal To(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی تاریخ برابر با تاریخ داده شده است، فعال شود. |
when Date Equal To(date) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که یک تاریخ برابر با تاریخ نسبی داده شده باشد، فعال شود. |
when Formula Satisfied(formula) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که فرمول داده شده به true ارزیابی شود، فعال شود. |
when Number Between(start, end) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی یک عدد بین دو مقدار مشخص شده قرار میگیرد یا یکی از آنها است، فعال شود. |
when Number Equal To(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی عددی برابر با مقدار داده شده است، فعال شود. |
when Number Greater Than(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی عددی بزرگتر از مقدار داده شده است، فعال شود. |
when Number Greater Than Or Equal To(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی عددی بزرگتر یا مساوی مقدار داده شده است، فعال شود. |
when Number Less Than(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی عددی کمتر از مقدار داده شده باشد، فعال شود. |
when Number Less Than Or Equal To(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی عددی کمتر یا مساوی مقدار داده شده باشد، فعال شود. |
when Number Not Between(start, end) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که یک عدد بین دو مقدار مشخص شده قرار نمیگیرد و هیچکدام از آنها نیست، فعال شود. |
when Number Not Equal To(number) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا در صورت برابر نبودن یک عدد با مقدار داده شده، فعال شود. |
when Text Contains(text) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که ورودی حاوی مقدار داده شده باشد، فعال شود. |
when Text Does Not Contain(text) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که ورودی حاوی مقدار داده شده نیست، فعال شود. |
when Text Ends With(text) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی ورودی با مقدار داده شده پایان مییابد، فعال شود. |
when Text Equal To(text) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا زمانی که ورودی برابر با مقدار داده شده باشد، فعال شود. |
when Text Starts With(text) | Conditional Format Rule Builder | قانون قالببندی شرطی را تنظیم میکند تا وقتی ورودی با مقدار داده شده شروع میشود، فعال شود. |
with Criteria(criteria, args) | Conditional Format Rule Builder | قانون قالببندی شرطی را روی معیارهای تعریفشده توسط مقادیر Boolean Criteria تنظیم میکند، که معمولاً از criteria و arguments یک قانون موجود گرفته میشوند. |
Container Info
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Anchor Column() | Integer | سمت چپ نمودار در این ستون ثابت شده است. |
get Anchor Row() | Integer | ضلع بالایی نمودار در این ردیف ثابت شده است. |
get Offset X() | Integer | گوشه سمت چپ بالای نمودار به اندازه این تعداد پیکسل از ستون لنگر فاصله دارد. |
get Offset Y() | Integer | گوشه سمت چپ بالای نمودار به اندازه این تعداد پیکسل از ردیف لنگر فاصله دارد. |
Copy Paste Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
PASTE_NORMAL | Enum | مقادیر، فرمولها، قالبها و ادغامها را جایگذاری کنید. |
PASTE_NO_BORDERS | Enum | مقادیر، فرمولها، قالبها و ادغامها را بدون حاشیه جایگذاری کنید. |
PASTE_FORMAT | Enum | فقط قالب را بچسبانید. |
PASTE_FORMULA | Enum | فقط فرمولها را جایگذاری کنید. |
PASTE_DATA_VALIDATION | Enum | فقط اعتبارسنجی دادهها را جایگذاری کنید. |
PASTE_VALUES | Enum | فقط مقادیر را بدون فرمت، فرمول یا ادغام پیست کنید. |
PASTE_CONDITIONAL_FORMATTING | Enum | فقط قوانین رنگ را بچسبانید. |
PASTE_COLUMN_WIDTHS | Enum | فقط عرض ستونها را جایگذاری کنید. |
Data Execution Error Code
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | یک کد خطای اجرای داده که در Apps Script پشتیبانی نمیشود. |
NONE | Enum | اجرای دادهها هیچ خطایی ندارد. |
TIME_OUT | Enum | زمان اجرای داده به پایان رسید. |
TOO_MANY_ROWS | Enum | اجرای دادهها، ردیفهای بیشتری از حد مجاز را برمیگرداند. |
TOO_MANY_COLUMNS | Enum | اجرای دادهها، ستونهای بیشتری از حد مجاز را برمیگرداند. |
TOO_MANY_CELLS | Enum | اجرای دادهها، سلولهای بیشتری از حد مجاز را برمیگرداند. |
ENGINE | Enum | خطای موتور اجرای داده. |
PARAMETER_INVALID | Enum | پارامتر اجرای داده نامعتبر است. |
UNSUPPORTED_DATA_TYPE | Enum | اجرای دادهها نوع دادهی پشتیبانی نشده را برمیگرداند. |
DUPLICATE_COLUMN_NAMES | Enum | اجرای دادهها، نام ستونهای تکراری را برمیگرداند. |
INTERRUPTED | Enum | اجرای دادهها با وقفه مواجه میشود. |
OTHER | Enum | خطاهای دیگر. |
TOO_MANY_CHARS_PER_CELL | Enum | اجرای دادهها مقادیری را برمیگرداند که از حداکثر کاراکترهای مجاز در یک سلول واحد بیشتر هستند. |
DATA_NOT_FOUND | Enum | پایگاه دادهای که منبع داده به آن ارجاع داده است، یافت نشد. |
PERMISSION_DENIED | Enum | کاربر به پایگاه دادهای که توسط منبع داده به آن ارجاع داده شده است، دسترسی ندارد. |
Data Execution State
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | وضعیت اجرای داده در Apps Script پشتیبانی نمیشود. |
RUNNING | Enum | اجرای دادهها آغاز شده و در حال اجرا است. |
SUCCESS | Enum | اجرای دادهها تکمیل و با موفقیت انجام شد. |
ERROR | Enum | اجرای دادهها تکمیل شده و دارای خطا است. |
NOT_STARTED | Enum | اجرای دادهها شروع نشده است. |
Data Execution Status
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Error Code() | Data Execution Error Code | کد خطای اجرای دادهها را دریافت میکند. |
get Error Message() | String | پیام خطای اجرای داده را دریافت میکند. |
get Execution State() | Data Execution State | وضعیت اجرای دادهها را دریافت میکند. |
get Last Execution Time() | Date|null | صرف نظر از وضعیت اجرا، زمان تکمیل آخرین اجرای داده را دریافت میکند. |
get Last Refreshed Time() | Date|null | آخرین باری که دادهها با موفقیت بهروزرسانی شدهاند را برمیگرداند. |
is Truncated() | Boolean | اگر دادههای آخرین اجرای موفق کوتاه شده باشند، true و در غیر این صورت false را برمیگرداند. |
Data Source
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
cancel All Linked Data Source Object Refreshes() | void | تمام بهروزرسانیهای در حال اجرای فعلی اشیاء منبع دادهی لینکشده به این منبع داده را لغو میکند. |
create Calculated Column(name, formula) | Data Source Column | یک ستون محاسباتی ایجاد میکند. |
create Data Source Pivot Table On New Sheet() | Data Source Pivot Table | یک جدول محوری منبع داده از این منبع داده در اولین سلول یک برگه جدید ایجاد میکند. |
create Data Source Table On New Sheet() | Data Source Table | یک جدول منبع داده از این منبع داده در اولین سلول یک برگه جدید ایجاد میکند. |
get Calculated Column By Name(columnName) | Data Source Column |null | ستون محاسبهشده در منبع داده که با نام ستون مطابقت دارد را برمیگرداند. |
get Calculated Columns() | Data Source Column[] | تمام ستونهای محاسبهشده در منبع داده را برمیگرداند. |
get Columns() | Data Source Column[] | تمام ستونهای موجود در منبع داده را برمیگرداند. |
get Data Source Sheets() | Data Source Sheet[] | برگههای منبع داده مرتبط با این منبع داده را برمیگرداند. |
get Spec() | Data Source Spec | مشخصات منبع داده را دریافت میکند. |
refresh All Linked Data Source Objects() | void | تمام اشیاء منبع داده مرتبط با منبع داده را بهروزرسانی میکند. |
update Spec(spec) | Data Source | مشخصات منبع داده را بهروزرسانی میکند و اشیاء منبع داده مرتبط با این منبع داده را با مشخصات جدید بهروزرسانی میکند. |
update Spec(spec, refreshAllLinkedObjects) | Data Source | مشخصات منبع داده را بهروزرسانی میکند و data source sheets پیوند داده شده را با مشخصات جدید بهروزرسانی میکند. |
wait For All Data Executions Completion(timeoutInSeconds) | void | منتظر میماند تا تمام اجراهای فعلی اشیاء منبع دادهی پیوند شده کامل شوند و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Chart
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
cancel Data Refresh() | Data Source Chart | اگر در حال حاضر این شیء در حال اجرا باشد، بهروزرسانی دادههای مرتبط با آن را لغو میکند. |
force Refresh Data() | Data Source Chart | دادههای این شیء را صرف نظر از وضعیت فعلی آن، بهروزرسانی میکند. |
get Data Source() | Data Source | منبع دادهای که شیء به آن لینک شده است را دریافت میکند. |
get Status() | Data Execution Status | وضعیت اجرای دادهی شیء را دریافت میکند. |
refresh Data() | Data Source Chart | دادههای شیء را بهروزرسانی میکند. |
wait For Completion(timeoutInSeconds) | Data Execution Status | منتظر میماند تا اجرای فعلی کامل شود و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Column
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Data Source() | Data Source | منبع داده مرتبط با ستون منبع داده را دریافت میکند. |
get Formula() | String | فرمول مربوط به ستون منبع داده را دریافت میکند. |
get Name() | String | نام ستون منبع داده را برمیگرداند. |
has Array Dependency() | Boolean | مشخص میکند که آیا ستون مورد نظر به آرایه وابستگی دارد یا خیر. |
is Calculated Column() | Boolean | برمیگرداند که آیا ستون، یک ستون محاسباتی است یا خیر. |
remove() | void | ستون منبع داده را حذف میکند. |
set Formula(formula) | Data Source Column | فرمول مربوط به ستون منبع داده را تنظیم میکند. |
set Name(name) | Data Source Column | نام ستون منبع داده را تنظیم میکند. |
Data Source Formula
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
cancel Data Refresh() | Data Source Formula | اگر در حال حاضر این شیء در حال اجرا باشد، بهروزرسانی دادههای مرتبط با آن را لغو میکند. |
force Refresh Data() | Data Source Formula | دادههای این شیء را صرف نظر از وضعیت فعلی آن، بهروزرسانی میکند. |
get Anchor Cell() | Range | Range برمیگرداند که نشاندهندهی سلولی است که این فرمول منبع داده در آن قرار دارد. |
get Data Source() | Data Source | منبع دادهای که شیء به آن لینک شده است را دریافت میکند. |
get Display Value() | String | مقدار نمایش فرمول منبع داده را برمیگرداند. |
get Formula() | String | فرمول مربوط به این فرمول منبع داده را برمیگرداند. |
get Status() | Data Execution Status | وضعیت اجرای دادهی شیء را دریافت میکند. |
refresh Data() | Data Source Formula | دادههای شیء را بهروزرسانی میکند. |
set Formula(formula) | Data Source Formula | فرمول را بهروزرسانی میکند. |
wait For Completion(timeoutInSeconds) | Data Execution Status | منتظر میماند تا اجرای فعلی کامل شود و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Parameter
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Name() | String | نام پارامتر را دریافت میکند. |
get Source Cell() | String|null | سلول منبعی را که پارامتر بر اساس آن مقداردهی میشود، برمیگرداند، یا اگر نوع پارامتر Data Source Parameter Type.CELL نباشد null برمیگرداند. |
get Type() | Data Source Parameter Type | نوع پارامتر را دریافت میکند. |
Data Source Parameter Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | یک نوع پارامتر منبع داده که در Apps Script پشتیبانی نمیشود. |
CELL | Enum | پارامتر منبع داده بر اساس یک سلول مقداردهی میشود. |
Data Source Pivot Table
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Column Group(columnName) | Pivot Group | یک گروه ستون محوری جدید بر اساس ستون منبع داده مشخص شده اضافه میکند. |
add Filter(columnName, filterCriteria) | Pivot Filter | یک فیلتر جدید بر اساس ستون منبع داده مشخص شده با معیارهای فیلتر مشخص شده اضافه میکند. |
add Pivot Value(columnName) | Pivot Value | یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده بدون هیچ تابع خلاصهسازی اضافه میکند. |
add Pivot Value(columnName, summarizeFunction) | Pivot Value | یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده با تابع خلاصه مشخص شده اضافه میکند. |
add Row Group(columnName) | Pivot Group | یک گروه ردیف محوری جدید بر اساس ستون منبع داده مشخص شده اضافه میکند. |
as Pivot Table() | Pivot Table | جدول محوری منبع داده را به عنوان یک شیء جدول محوری معمولی برمیگرداند. |
cancel Data Refresh() | Data Source Pivot Table | اگر در حال حاضر این شیء در حال اجرا باشد، بهروزرسانی دادههای مرتبط با آن را لغو میکند. |
force Refresh Data() | Data Source Pivot Table | دادههای این شیء را صرف نظر از وضعیت فعلی آن، بهروزرسانی میکند. |
get Data Source() | Data Source | منبع دادهای که شیء به آن لینک شده است را دریافت میکند. |
get Status() | Data Execution Status | وضعیت اجرای دادهی شیء را دریافت میکند. |
refresh Data() | Data Source Pivot Table | دادههای شیء را بهروزرسانی میکند. |
wait For Completion(timeoutInSeconds) | Data Execution Status | منتظر میماند تا اجرای فعلی کامل شود و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Refresh Schedule
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Frequency() | Data Source Refresh Schedule Frequency | فرکانس زمانبندی بهروزرسانی را دریافت میکند، که مشخص میکند هر چند وقت یکبار و چه زمانی بهروزرسانی انجام شود. |
get Scope() | Data Source Refresh Scope | دامنه این برنامه بهروزرسانی را دریافت میکند. |
get Time Interval Of Next Run() | Time Interval | بازه زمانی اجرای بعدی این برنامه بهروزرسانی را دریافت میکند. |
is Enabled() | Boolean | تعیین میکند که آیا این برنامهی بهروزرسانی فعال است یا خیر. |
Data Source Refresh Schedule Frequency
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Days Of The Month() | Integer[] | روزهای ماه را به صورت اعداد (۱-۲۸) دریافت میکند که در آنها منبع داده باید بهروزرسانی شود. |
get Days Of The Week() | Weekday[] | روزهای هفته را برای بهروزرسانی منبع داده دریافت میکند. |
get Frequency Type() | Frequency Type | نوع فرکانس را دریافت میکند. |
get Start Hour() | Integer | ساعت شروع (به صورت عددی بین ۰ تا ۲۳) را از بازه زمانی که برنامه بهروزرسانی در طول آن اجرا میشود، دریافت میکند. |
Data Source Refresh Scope
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | دامنهی بهروزرسانی منبع داده پشتیبانی نمیشود. |
ALL_DATA_SOURCES | Enum | بهروزرسانی برای همه منابع داده در صفحه گسترده اعمال میشود. |
Data Source Sheet
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Filter(columnName, filterCriteria) | Data Source Sheet | یک فیلتر اعمال شده به برگه منبع داده اضافه میکند. |
as Sheet() | Sheet | برگه منبع داده را به عنوان یک شیء برگه معمولی برمیگرداند. |
auto Resize Column(columnName) | Data Source Sheet | عرض ستون مشخص شده را به طور خودکار تغییر میدهد. |
auto Resize Columns(columnNames) | Data Source Sheet | عرض ستونهای مشخص شده را به طور خودکار تغییر میدهد. |
cancel Data Refresh() | Data Source Sheet | اگر در حال حاضر این شیء در حال اجرا باشد، بهروزرسانی دادههای مرتبط با آن را لغو میکند. |
force Refresh Data() | Data Source Sheet | دادههای این شیء را صرف نظر از وضعیت فعلی آن، بهروزرسانی میکند. |
get Column Width(columnName) | Integer|null | عرض ستون مشخص شده را برمیگرداند. |
get Data Source() | Data Source | منبع دادهای که شیء به آن لینک شده است را دریافت میکند. |
get Filters() | Data Source Sheet Filter[] | تمام فیلترهای اعمال شده روی برگه منبع داده را برمیگرداند. |
get Sheet Values(columnName) | Object[] | تمام مقادیر مربوط به برگه منبع داده را برای نام ستون ارائه شده برمیگرداند. |
get Sheet Values(columnName, startRow, numRows) | Object[] | تمام مقادیر مربوط به برگه منبع داده را برای نام ستون ارائه شده از ردیف شروع ارائه شده (مبتنی بر ۱) و تا num Rows ارائه شده برمیگرداند. |
get Sort Specs() | Sort Spec[] | تمام مشخصات مرتبسازی را در برگه منبع داده دریافت میکند. |
get Status() | Data Execution Status | وضعیت اجرای دادهی شیء را دریافت میکند. |
refresh Data() | Data Source Sheet | دادههای شیء را بهروزرسانی میکند. |
remove Filters(columnName) | Data Source Sheet | تمام فیلترهای اعمال شده روی ستون برگه منبع داده را حذف میکند. |
remove Sort Spec(columnName) | Data Source Sheet | مشخصات مرتبسازی را روی یک ستون در برگه منبع داده حذف میکند. |
set Column Width(columnName, width) | Data Source Sheet | عرض ستون مشخص شده را تنظیم میکند. |
set Column Widths(columnNames, width) | Data Source Sheet | عرض ستونهای مشخص شده را تنظیم میکند. |
set Sort Spec(columnName, ascending) | Data Source Sheet | مشخصات مرتبسازی را روی یک ستون در برگه منبع داده تنظیم میکند. |
set Sort Spec(columnName, sortOrder) | Data Source Sheet | مشخصات مرتبسازی را روی یک ستون در برگه منبع داده تنظیم میکند. |
wait For Completion(timeoutInSeconds) | Data Execution Status | منتظر میماند تا اجرای فعلی کامل شود و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Sheet Filter
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Data Source Column() | Data Source Column | ستون منبع دادهای که این فیلتر روی آن اعمال میشود را برمیگرداند. |
get Data Source Sheet() | Data Source Sheet | Data Source Sheet را که این فیلتر به آن تعلق دارد، برمیگرداند. |
get Filter Criteria() | Filter Criteria | معیارهای فیلتر برای این فیلتر را برمیگرداند. |
remove() | void | این فیلتر را از شیء منبع داده حذف میکند. |
set Filter Criteria(filterCriteria) | Data Source Sheet Filter | معیارهای فیلتر را برای این فیلتر تنظیم میکند. |
Data Source Spec
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
as Big Query() | Big Query Data Source Spec | مشخصات منبع داده BigQuery را دریافت میکند. |
as Looker() | Looker Data Source Spec | مشخصات منبع داده Looker را دریافت میکند. |
copy() | Data Source Spec Builder | بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد میکند. |
get Parameters() | Data Source Parameter[] | پارامترهای منبع داده را دریافت میکند. |
get Type() | Data Source Type | نوع منبع داده را دریافت میکند. |
Data Source Spec Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
as Big Query() | Big Query Data Source Spec Builder | سازندهی منبع دادهی BigQuery را دریافت میکند. |
as Looker() | Looker Data Source Spec Builder | سازندهی منبع دادهی Looker را دریافت میکند. |
build() | Data Source Spec | مشخصات منبع داده را از تنظیمات موجود در این سازنده میسازد. |
copy() | Data Source Spec Builder | بر اساس تنظیمات این منبع داده، یک Data Source Spec Builder ایجاد میکند. |
get Parameters() | Data Source Parameter[] | پارامترهای منبع داده را دریافت میکند. |
get Type() | Data Source Type | نوع منبع داده را دریافت میکند. |
remove All Parameters() | Data Source Spec Builder | تمام پارامترها را حذف میکند. |
remove Parameter(parameterName) | Data Source Spec Builder | پارامتر مشخص شده را حذف میکند. |
set Parameter From Cell(parameterName, sourceCell) | Data Source Spec Builder | یک پارامتر اضافه میکند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را برای سازندگان مشخصات منبع داده از نوع Data Source Type.BIGQUERY بهروزرسانی میکند. |
Data Source Table
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Columns(columnNames) | Data Source Table | ستونهایی را به جدول منبع داده اضافه میکند. |
add Filter(columnName, filterCriteria) | Data Source Table | یک فیلتر اعمال شده به جدول منبع داده اضافه میکند. |
add Sort Spec(columnName, ascending) | Data Source Table | یک مشخصات مرتبسازی روی یک ستون در جدول منبع داده اضافه میکند. |
add Sort Spec(columnName, sortOrder) | Data Source Table | یک مشخصات مرتبسازی روی یک ستون در جدول منبع داده اضافه میکند. |
cancel Data Refresh() | Data Source Table | اگر در حال حاضر این شیء در حال اجرا باشد، بهروزرسانی دادههای مرتبط با آن را لغو میکند. |
force Refresh Data() | Data Source Table | دادههای این شیء را صرف نظر از وضعیت فعلی آن، بهروزرسانی میکند. |
get Columns() | Data Source Table Column[] | تمام ستونهای منبع داده اضافه شده به جدول منبع داده را دریافت میکند. |
get Data Source() | Data Source | منبع دادهای که شیء به آن لینک شده است را دریافت میکند. |
get Filters() | Data Source Table Filter[] | تمام فیلترهای اعمال شده روی جدول منبع داده را برمیگرداند. |
get Range() | Range | Range این جدول منبع داده پوشش میدهد را برمیگرداند. |
get Row Limit() | Integer|null | محدودیت ردیف را برای جدول منبع داده برمیگرداند. |
get Sort Specs() | Sort Spec[] | تمام مشخصات مرتبسازی را در جدول منبع داده دریافت میکند. |
get Status() | Data Execution Status | وضعیت اجرای دادهی شیء را دریافت میکند. |
is Syncing All Columns() | Boolean | برمیگرداند که آیا جدول منبع داده، تمام ستونهای منبع داده مرتبط را همگامسازی میکند یا خیر. |
refresh Data() | Data Source Table | دادههای شیء را بهروزرسانی میکند. |
remove All Columns() | Data Source Table | تمام ستونهای جدول منبع داده را حذف میکند. |
remove All Sort Specs() | Data Source Table | تمام مشخصات مرتبسازی را در جدول منبع داده حذف میکند. |
set Row Limit(rowLimit) | Data Source Table | محدودیت تعداد سطرها را برای جدول منبع داده بهروزرسانی میکند. |
sync All Columns() | Data Source Table | تمام ستونهای فعلی و آینده در منبع داده مرتبط را با جدول منبع داده همگامسازی کنید. |
wait For Completion(timeoutInSeconds) | Data Execution Status | منتظر میماند تا اجرای فعلی کامل شود و پس از تعداد ثانیههای ارائه شده، زمانبندی خاتمه مییابد. |
Data Source Table Column
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Data Source Column() | Data Source Column | ستون منبع داده را دریافت میکند. |
remove() | void | ستون را از Data Source Table حذف میکند. |
Data Source Table Filter
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Data Source Column() | Data Source Column | ستون منبع دادهای که این فیلتر روی آن اعمال میشود را برمیگرداند. |
get Data Source Table() | Data Source Table | Data Source Table که این فیلتر به آن تعلق دارد را برمیگرداند. |
get Filter Criteria() | Filter Criteria | معیارهای فیلتر برای این فیلتر را برمیگرداند. |
remove() | void | این فیلتر را از شیء منبع داده حذف میکند. |
set Filter Criteria(filterCriteria) | Data Source Table Filter | معیارهای فیلتر را برای این فیلتر تنظیم میکند. |
Data Source Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | یک نوع منبع داده که در Apps Script پشتیبانی نمیشود. |
BIGQUERY | Enum | یک منبع داده BigQuery. |
LOOKER | Enum | منبع داده Looker. |
Data Validation
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Data Validation Builder | بر اساس تنظیمات این قانون، یک سازنده برای قانون اعتبارسنجی دادهها ایجاد میکند. |
get Allow Invalid() | Boolean | اگر قانون هنگام عدم اعتبارسنجی ورودی، هشداری نشان دهد، true را برمیگرداند، و اگر ورودی را به طور کامل رد کند، false را برمیگرداند. |
get Criteria Type() | Data Validation Criteria | نوع معیار قانون را همانطور که در شمارش Data Validation Criteria تعریف شده است، برمیگرداند. |
get Criteria Values() | Object[] | آرایهای از آرگومانها را برای معیارهای قاعده دریافت میکند. |
get Help Text() | String | متن راهنمای قانون را برمیگرداند، یا اگر متن راهنمایی تنظیم نشده باشد، null برمیگرداند. |
Data Validation Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Data Validation | یک قانون اعتبارسنجی داده از تنظیمات اعمال شده به سازنده میسازد. |
copy() | Data Validation Builder | بر اساس تنظیمات این قانون، یک سازنده برای قانون اعتبارسنجی دادهها ایجاد میکند. |
get Allow Invalid() | Boolean | اگر قانون هنگام عدم اعتبارسنجی ورودی، هشداری نشان دهد، true را برمیگرداند، و اگر ورودی را به طور کامل رد کند، false را برمیگرداند. |
get Criteria Type() | Data Validation Criteria | نوع معیار قانون را همانطور که در شمارش Data Validation Criteria تعریف شده است، برمیگرداند. |
get Criteria Values() | Object[] | آرایهای از آرگومانها را برای معیارهای قاعده دریافت میکند. |
get Help Text() | String | متن راهنمای قانون را برمیگرداند، یا اگر متن راهنمایی تنظیم نشده باشد، null برمیگرداند. |
require Checkbox() | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید یک مقدار بولی باشد؛ این مقدار به صورت یک کادر انتخاب نمایش داده میشود. |
require Checkbox(checkedValue) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید مقدار مشخص شده یا خالی باشد. |
require Checkbox(checkedValue, uncheckedValue) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید یکی از مقادیر مشخص شده باشد. |
require Date() | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که به تاریخ نیاز داشته باشد. |
require Date After(date) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که پس از مقدار داده شده، به تاریخ نیاز داشته باشد. |
require Date Before(date) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که قبل از مقدار داده شده، به تاریخ نیاز داشته باشد. |
require Date Between(start, end) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که تاریخی را الزامی کند که بین دو تاریخ مشخص شده یا یکی از آنها باشد. |
require Date Equal To(date) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که تاریخی برابر با مقدار داده شده را الزامی کند. |
require Date Not Between(start, end) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که تاریخی را الزامی کند که بین دو تاریخ مشخص شده قرار نگیرد و هیچکدام از آنها نباشد. |
require Date On Or After(date) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که نیاز به یک تاریخ در یا بعد از مقدار داده شده داشته باشد. |
require Date On Or Before(date) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که نیاز به یک تاریخ قبل یا بعد از مقدار داده شده داشته باشد. |
require Formula Satisfied(formula) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که الزام کند فرمول داده شده به true ارزیابی شود. |
require Number Between(start, end) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی را که بین دو عدد مشخص شده قرار میگیرد یا یکی از آنهاست، الزامی کند. |
require Number Equal To(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی برابر با مقدار داده شده را الزامی کند. |
require Number Greater Than(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی بزرگتر از مقدار داده شده را الزامی کند. |
require Number Greater Than Or Equal To(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی بزرگتر یا مساوی مقدار داده شده را الزامی کند. |
require Number Less Than(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی کمتر از مقدار داده شده را الزامی کند. |
require Number Less Than Or Equal To(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی کمتر یا مساوی مقدار داده شده را الزامی کند. |
require Number Not Between(start, end) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی را الزامی کند که بین دو عدد مشخص شده قرار نگیرد و هیچکدام از آنها نباشد. |
require Number Not Equal To(number) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که عددی غیر از مقدار داده شده را الزامی کند. |
require Text Contains(text) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی حتماً باید حاوی مقدار داده شده باشد. |
require Text Does Not Contain(text) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی حاوی مقدار داده شده نباشد. |
require Text Equal To(text) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که الزام کند ورودی برابر با مقدار داده شده باشد. |
require Text Is Email() | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید به شکل آدرس ایمیل باشد. |
require Text Is Url() | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید به شکل URL باشد. |
require Value In List(values) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید برابر با یکی از مقادیر داده شده باشد. |
require Value In List(values, showDropdown) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید برابر با یکی از مقادیر داده شده باشد، و گزینهای برای پنهان کردن منوی کشویی نیز دارد. |
require Value In Range(range) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید برابر با مقداری در محدوده داده شده باشد. |
require Value In Range(range, showDropdown) | Data Validation Builder | قانون اعتبارسنجی دادهها را طوری تنظیم میکند که ورودی باید برابر با مقداری در محدوده داده شده باشد، و گزینهای برای پنهان کردن منوی کشویی نیز دارد. |
set Allow Invalid(allowInvalidData) | Data Validation Builder | تعیین میکند که آیا هنگام عدم موفقیت اعتبارسنجی داده در ورودی، هشداری نمایش داده شود یا اینکه ورودی به طور کامل رد شود. |
set Help Text(helpText) | Data Validation Builder | متن راهنمایی را تنظیم میکند که هنگام قرار گرفتن ماوس کاربر روی سلولی که اعتبارسنجی دادهها روی آن تنظیم شده است، نمایش داده میشود. |
with Criteria(criteria, args) | Data Validation Builder | قانون اعتبارسنجی دادهها را بر اساس معیارهای تعریفشده توسط مقادیر Data Validation Criteria تنظیم میکند، که معمولاً از criteria و arguments یک قانون موجود گرفته میشوند. |
Data Validation Criteria
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DATE_AFTER | Enum | به تاریخی نیاز دارد که بعد از مقدار داده شده باشد. |
DATE_BEFORE | Enum | به تاریخی نیاز دارد که قبل از مقدار داده شده باشد. |
DATE_BETWEEN | Enum | به تاریخی نیاز دارد که بین مقادیر داده شده باشد. |
DATE_EQUAL_TO | Enum | به تاریخی نیاز دارد که برابر با مقدار داده شده باشد. |
DATE_IS_VALID_DATE | Enum | نیاز به تاریخ دارد. |
DATE_NOT_BETWEEN | Enum | به تاریخی نیاز دارد که بین مقادیر داده شده نباشد. |
DATE_ON_OR_AFTER | Enum | تاریخی را درخواست کنید که روی مقدار داده شده یا بعد از آن باشد. |
DATE_ON_OR_BEFORE | Enum | به تاریخی نیاز دارد که همزمان با یا قبل از مقدار داده شده باشد. |
NUMBER_BETWEEN | Enum | به عددی نیاز دارد که بین مقادیر داده شده باشد. |
NUMBER_EQUAL_TO | Enum | به عددی نیاز دارد که برابر با مقدار داده شده باشد. |
NUMBER_GREATER_THAN | Enum | عددی را درخواست کنید که از مقدار داده شده بزرگتر باشد. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | Requires a number that is greater than or equal to the given value. |
NUMBER_LESS_THAN | Enum | Requires a number that is less than the given value. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | Requires a number that is less than or equal to the given value. |
NUMBER_NOT_BETWEEN | Enum | Requires a number that is not between the given values. |
NUMBER_NOT_EQUAL_TO | Enum | Requires a number that is not equal to the given value. |
TEXT_CONTAINS | Enum | Requires that the input contains the given value. |
TEXT_DOES_NOT_CONTAIN | Enum | Requires that the input does not contain the given value. |
TEXT_EQUAL_TO | Enum | Requires that the input is equal to the given value. |
TEXT_IS_VALID_EMAIL | Enum | Requires that the input is in the form of an email address. |
TEXT_IS_VALID_URL | Enum | Requires that the input is in the form of a URL. |
VALUE_IN_LIST | Enum | Requires that the input is equal to one of the given values. |
VALUE_IN_RANGE | Enum | Requires that the input is equal to a value in the given range. |
CUSTOM_FORMULA | Enum | Requires that the input makes the given formula evaluate to true . |
CHECKBOX | Enum | Requires that the input is a custom value or a boolean; rendered as a checkbox. |
DATE_AFTER_RELATIVE | Enum | Requires a date that is after the relative date value. |
DATE_BEFORE_RELATIVE | Enum | Requires a date that is before the relative date value. |
DATE_EQUAL_TO_RELATIVE | Enum | Requires a date that is equal to the relative date value. |
Date Time Grouping Rule
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Rule Type() | Date Time Grouping Rule Type | Gets the type of the date-time grouping rule. |
Date Time Grouping Rule Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
UNSUPPORTED | Enum | A date-time grouping rule type that is not supported. |
SECOND | Enum | Group date-time by second, from 0 to 59. |
MINUTE | Enum | Group date-time by minute, from 0 to 59. |
HOUR | Enum | Group date-time by hour using a 24-hour system, from 0 to 23. |
HOUR_MINUTE | Enum | Group date-time by hour and minute using a 24-hour system, for example 19:45 . |
HOUR_MINUTE_AMPM | Enum | Group date-time by hour and minute using a 12-hour system, for example 7:45 PM . |
DAY_OF_WEEK | Enum | Group date-time by day of week, for example Sunday . |
DAY_OF_YEAR | Enum | Group date-time by day of year, from 1 to 366. |
DAY_OF_MONTH | Enum | Group date-time by day of month, from 1 to 31. |
DAY_MONTH | Enum | Group date-time by day and month, for example 22-Nov . |
MONTH | Enum | Group date-time by month, for example Nov . |
QUARTER | Enum | Group date-time by quarter, for example Q1 (which represents Jan-Mar). |
YEAR | Enum | Group date-time by year, for example 2008. |
YEAR_MONTH | Enum | Group date-time by year and month, for example 2008-Nov . |
YEAR_QUARTER | Enum | Group date-time by year and quarter, for example 2008 Q4 . |
YEAR_MONTH_DAY | Enum | Group date-time by year, month, and day, for example 2008-11-22 . |
Developer Metadata
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Id() | Integer | Returns the unique ID associated with this developer metadata. |
get Key() | String | Returns the key associated with this developer metadata. |
get Location() | Developer Metadata Location | Returns the location of this developer metadata. |
get Value() | String | Returns the value associated with this developer metadata, or null if this metadata has no value. |
get Visibility() | Developer Metadata Visibility | Returns the visibility of this developer metadata. |
move To Column(column) | Developer Metadata | Moves this developer metadata to the specified column. |
move To Row(row) | Developer Metadata | Moves this developer metadata to the specified row. |
move To Sheet(sheet) | Developer Metadata | Moves this developer metadata to the specified sheet. |
move To Spreadsheet() | Developer Metadata | Moves this developer metadata to the top-level spreadsheet. |
remove() | void | Deletes this metadata. |
set Key(key) | Developer Metadata | Sets the key of this developer metadata to the specified value. |
set Value(value) | Developer Metadata | Sets the value associated with this developer metadata to the specified value. |
set Visibility(visibility) | Developer Metadata | Sets the visibility of this developer metadata to the specified visibility. |
Developer Metadata Finder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
find() | Developer Metadata[] | Executes this search and returns the matching metadata. |
on Intersecting Locations() | Developer Metadata Finder | Configures the search to consider intersecting locations that have metadata. |
with Id(id) | Developer Metadata Finder | Limits this search to consider only metadata that match the specified ID. |
with Key(key) | Developer Metadata Finder | Limits this search to consider only metadata that match the specified key. |
with Location Type(locationType) | Developer Metadata Finder | Limits this search to consider only metadata that match the specified location type. |
with Value(value) | Developer Metadata Finder | Limits this search to consider only metadata that match the specified value. |
with Visibility(visibility) | Developer Metadata Finder | Limits this search to consider only metadata that match the specified visibility. |
Developer Metadata Location
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Column() | Range |null | Returns the Range for the column location of this metadata, or null if the location type is not Developer Metadata Location Type.COLUMN . |
get Location Type() | Developer Metadata Location Type | Gets the type of location. |
get Row() | Range |null | Returns the Range for the row location of this metadata, or null if the location type is not Developer Metadata Location Type.ROW . |
get Sheet() | Sheet |null | Returns the Sheet location of this metadata, or null if the location type is not Developer Metadata Location Type.SHEET . |
get Spreadsheet() | Spreadsheet |null | Returns the Spreadsheet location of this metadata, or null if the location type is not Developer Metadata Location Type.SPREADSHEET . |
Developer Metadata Location Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
SPREADSHEET | Enum | The location type for developer metadata associated with the top-level spreadsheet. |
SHEET | Enum | The location type for developer metadata associated with a whole sheet. |
ROW | Enum | The location type for developer metadata associated with a row. |
COLUMN | Enum | The location type for developer metadata associated with a column. |
Developer Metadata Visibility
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DOCUMENT | Enum | Document-visible metadata is accessible from any developer project with access to the document. |
PROJECT | Enum | Project-visible metadata is only visible to and accessible by the developer project that created the metadata. |
Dimension
خواص
| ملک | نوع | توضیحات |
|---|---|---|
COLUMNS | Enum | The column (vertical) dimension. |
ROWS | Enum | The row (horizontal) dimension. |
Direction
خواص
| ملک | نوع | توضیحات |
|---|---|---|
UP | Enum | The direction of decreasing row indices. |
DOWN | Enum | The direction of increasing row indices. |
PREVIOUS | Enum | The direction of decreasing column indices. |
NEXT | Enum | The direction of increasing column indices. |
Drawing
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Container Info() | Container Info | Gets information about where the drawing is positioned in the sheet. |
get Height() | Integer | Returns the actual height of this drawing in pixels. |
get On Action() | String|null | Returns the name of the macro attached to this drawing. |
get Sheet() | Sheet | Returns the sheet this drawing appears on. |
get Width() | Integer | Returns the actual width of this drawing in pixels. |
get ZIndex() | Number | Returns the z-index of this drawing. |
remove() | void | Deletes this drawing from the spreadsheet. |
set Height(height) | Drawing | Sets the actual height of this drawing in pixels. |
set On Action(macroName) | Drawing | Assigns a macro function to this drawing. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Sets the position where the drawing appears on the sheet. |
set Width(width) | Drawing | Sets the actual width of this drawing in pixels. |
set ZIndex(zIndex) | Drawing | Sets the z-index of this drawing. |
Embedded Area Chart Builder
روشها
Embedded Bar Chart Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
reverse Categories() | Embedded Bar Chart Builder | Reverses the drawing of series in the domain axis. |
reverse Direction() | Embedded Bar Chart Builder | Reverses the direction in which the bars grow along the horizontal axis. |
set Background Color(cssValue) | Embedded Bar Chart Builder | Sets the background color for the chart. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Colors(cssValues) | Embedded Bar Chart Builder | Sets the colors for the lines in the chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Legend Position(position) | Embedded Bar Chart Builder | Sets the position of the legend with respect to the chart. |
set Legend Text Style(textStyle) | Embedded Bar Chart Builder | Sets the text style of the chart legend. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Range(start, end) | Embedded Bar Chart Builder | Sets the range for the chart. |
set Stacked() | Embedded Bar Chart Builder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
set Title(chartTitle) | Embedded Bar Chart Builder | Sets the title of the chart. |
set Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the text style of the chart title. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
set XAxis Text Style(textStyle) | Embedded Bar Chart Builder | Sets the horizontal axis text style. |
set XAxis Title(title) | Embedded Bar Chart Builder | Adds a title to the horizontal axis. |
set XAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the horizontal axis title text style. |
set YAxis Text Style(textStyle) | Embedded Bar Chart Builder | Sets the vertical axis text style. |
set YAxis Title(title) | Embedded Bar Chart Builder | Adds a title to the vertical axis. |
set YAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the vertical axis title text style. |
use Log Scale() | Embedded Bar Chart Builder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
Embedded Chart
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
as Data Source Chart() | Data Source Chart |null | Casts to a data source chart instance if the chart is a data source chart, or null otherwise. |
get As(contentType) | Blob | دادههای درون این شیء را به صورت یک blob تبدیلشده به نوع محتوای مشخصشده، برمیگرداند. |
get Blob() | Blob | دادههای درون این شیء را به صورت یک blob برمیگرداند. |
get Chart Id() | Integer|null | Returns a stable identifier for the chart that is unique across the spreadsheet containing the chart or null if the chart is not in a spreadsheet. |
get Container Info() | Container Info | Returns information about where the chart is positioned within a sheet. |
get Hidden Dimension Strategy() | Chart Hidden Dimension Strategy | Returns the strategy to use for handling hidden rows and columns. |
get Merge Strategy() | Chart Merge Strategy | Returns the merge strategy used when more than one range exists. |
get Num Headers() | Integer | Returns the number of rows or columns the range that are treated as headers. |
get Options() | Chart Options | Returns the options for this chart, such as height, colors, and axes. |
get Ranges() | Range[] | Returns the ranges that this chart uses as a data source. |
get Transpose Rows And Columns() | Boolean | If true , the rows and columns used to populate the chart are switched. |
modify() | Embedded Chart Builder | Returns an Embedded Chart Builder that can be used to modify this chart. |
Embedded Chart Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
Embedded Column Chart Builder
روشها
Embedded Combo Chart Builder
روشها
Embedded Histogram Chart Builder
روشها
Embedded Line Chart Builder
روشها
Embedded Pie Chart Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
reverse Categories() | Embedded Pie Chart Builder | Reverses the drawing of series in the domain axis. |
set3D() | Embedded Pie Chart Builder | Sets the chart to be three-dimensional. |
set Background Color(cssValue) | Embedded Pie Chart Builder | Sets the background color for the chart. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Colors(cssValues) | Embedded Pie Chart Builder | Sets the colors for the lines in the chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Legend Position(position) | Embedded Pie Chart Builder | Sets the position of the legend with respect to the chart. |
set Legend Text Style(textStyle) | Embedded Pie Chart Builder | Sets the text style of the chart legend. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Title(chartTitle) | Embedded Pie Chart Builder | Sets the title of the chart. |
set Title Text Style(textStyle) | Embedded Pie Chart Builder | Sets the text style of the chart title. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
Embedded Scatter Chart Builder
روشها
Embedded Table Chart Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
enable Paging(enablePaging) | Embedded Table Chart Builder | Sets whether to enable paging through the data. |
enable Paging(pageSize) | Embedded Table Chart Builder | Enables paging and sets the number of rows in each page. |
enable Paging(pageSize, startPage) | Embedded Table Chart Builder | Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based). |
enable Rtl Table(rtlEnabled) | Embedded Table Chart Builder | Adds basic support for right-to-left languages (such as Arabic or Hebrew) by reversing the column order of the table, so that column zero is the right-most column, and the last column is the left-most column. |
enable Sorting(enableSorting) | Embedded Table Chart Builder | Sets whether to sort columns when the user clicks a column heading. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set First Row Number(number) | Embedded Table Chart Builder | Sets the row number for the first row in the data table. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Initial Sorting Ascending(column) | Embedded Table Chart Builder | Sets the index of the column according to which the table should be initially sorted (ascending). |
set Initial Sorting Descending(column) | Embedded Table Chart Builder | Sets the index of the column according to which the table should be initially sorted (descending). |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
show Row Number Column(showRowNumber) | Embedded Table Chart Builder | Sets whether to show the row number as the first column of the table. |
use Alternating Row Style(alternate) | Embedded Table Chart Builder | Sets whether alternating color style is assigned to odd and even rows of a table chart. |
Filter
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Column Filter Criteria(columnPosition) | Filter Criteria |null | Gets the filter criteria on the specified column, or null if the column doesn't have filter criteria applied to it. |
get Range() | Range | Gets the range this filter applies to. |
remove() | void | Removes this filter. |
remove Column Filter Criteria(columnPosition) | Filter | Removes the filter criteria from the specified column. |
set Column Filter Criteria(columnPosition, filterCriteria) | Filter | Sets the filter criteria on the specified column. |
sort(columnPosition, ascending) | Filter | Sorts the filtered range by the specified column, excluding the first row (the header row) in the range this filter applies to. |
Filter Criteria
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Filter Criteria Builder | Copies this filter criteria and creates a criteria builder that you can apply to another filter. |
get Criteria Type() | Boolean Criteria |null | Returns the criteria's boolean type, for example, CELL_EMPTY . |
get Criteria Values() | Object[] | Returns an array of arguments for boolean criteria. |
get Hidden Values() | String[] | Returns the values that the filter hides. |
get Visible Background Color() | Color |null | Returns the background color used as filter criteria. |
get Visible Foreground Color() | Color |null | Returns the foreground color used as a filter criteria. |
get Visible Values() | String[] | Returns the values that the pivot table filter shows. |
Filter Criteria Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Filter Criteria | Assembles the filter criteria using the settings you add to the criteria builder. |
copy() | Filter Criteria Builder | Copies this filter criteria and creates a criteria builder that you can apply to another filter. |
get Criteria Type() | Boolean Criteria |null | Returns the criteria's boolean type, for example, CELL_EMPTY . |
get Criteria Values() | Object[] | Returns an array of arguments for boolean criteria. |
get Hidden Values() | String[] | Returns the values that the filter hides. |
get Visible Background Color() | Color |null | Returns the background color used as filter criteria. |
get Visible Foreground Color() | Color |null | Returns the foreground color used as a filter criteria. |
get Visible Values() | String[] | Returns the values that the pivot table filter shows. |
set Hidden Values(values) | Filter Criteria Builder | Sets the values to hide. |
set Visible Background Color(visibleBackgroundColor) | Filter Criteria Builder | Sets the background color used as filter criteria. |
set Visible Foreground Color(visibleForegroundColor) | Filter Criteria Builder | Sets the foreground color used as filter criteria. |
set Visible Values(values) | Filter Criteria Builder | Sets the values to show on a pivot table. |
when Cell Empty() | Filter Criteria Builder | Sets the filter criteria to show empty cells. |
when Cell Not Empty() | Filter Criteria Builder | Sets the filter criteria to show cells that aren't empty. |
when Date After(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are after the specified date. |
when Date After(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are after the specified relative date. |
when Date Before(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are before the specified date. |
when Date Before(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are before the specified relative date. |
when Date Equal To(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are equal to the specified date. |
when Date Equal To(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are equal to the specified relative date. |
when Date Equal To Any(dates) | Filter Criteria Builder | Sets the filter criteria to show cells with dates that are equal to any of the specified dates. |
when Date Not Equal To(date) | Filter Criteria Builder | Sets the filter criteria to show cells that aren't equal to the specified date. |
when Date Not Equal To Any(dates) | Filter Criteria Builder | Sets the filter criteria to show cells with dates that aren't equal to any of the specified dates. |
when Formula Satisfied(formula) | Filter Criteria Builder | Sets the filter criteria to show cells with a specified formula (such as =B:B<C:C ) that evaluates to true . |
when Number Between(start, end) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that falls between, or is either of, 2 specified numbers. |
when Number Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's equal to the specified number. |
when Number Equal To Any(numbers) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's equal to any of the specified numbers. |
when Number Greater Than(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number greater than the specified number |
when Number Greater Than Or Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number greater than or equal to the specified number. |
when Number Less Than(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's less than the specified number. |
when Number Less Than Or Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number less than or equal to the specified number. |
when Number Not Between(start, end) | Filter Criteria Builder | Sets the filter criteria to show cells with a number doesn't fall between, and is neither of, 2 specified numbers. |
when Number Not Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that isn't equal to the specified number. |
when Number Not Equal To Any(numbers) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that isn't equal to any of the specified numbers. |
when Text Contains(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that contains the specified text. |
when Text Does Not Contain(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that doesn't contain the specified text. |
when Text Ends With(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that ends with the specified text. |
when Text Equal To(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that's equal to the specified text. |
when Text Equal To Any(texts) | Filter Criteria Builder | Sets the filter criteria to show cells with text that's equal to any of the specified text values. |
when Text Not Equal To(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that isn't equal to the specified text. |
when Text Not Equal To Any(texts) | Filter Criteria Builder | Sets the filter criteria to show cells with text that isn't equal to any of the specified values. |
when Text Starts With(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that starts with the specified text. |
with Criteria(criteria, args) | Filter Criteria Builder | Sets the filter criteria to a boolean condition defined by Boolean Criteria values, such as CELL_EMPTY or NUMBER_GREATER_THAN . |
Frequency Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | The frequency type is unsupported. |
DAILY | Enum | Refresh daily. |
WEEKLY | Enum | Refresh weekly, on given days of the week. |
MONTHLY | Enum | Refresh monthly, on given days of the month. |
Gradient Condition
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Max Color Object() | Color |null | رنگ تنظیم شده برای حداکثر مقدار این شرط گرادیان را برمیگرداند. |
get Max Type() | Interpolation Type |null | نوع درونیابی را برای حداکثر مقدار این شرط گرادیان دریافت میکند. |
get Max Value() | String | حداکثر مقدار این شرط گرادیان را دریافت میکند. |
get Mid Color Object() | Color |null | رنگ تنظیم شده برای مقدار نقطه میانی این شرط گرادیان را دریافت میکند. |
get Mid Type() | Interpolation Type |null | نوع درونیابی را برای مقدار نقطه میانی این شرط گرادیان دریافت میکند. |
get Mid Value() | String | مقدار نقطه میانی این شرط گرادیان را دریافت میکند. |
get Min Color Object() | Color |null | رنگ تنظیم شده برای حداقل مقدار این شرط گرادیان را برمیگرداند. |
get Min Type() | Interpolation Type |null | نوع درونیابی را برای حداقل مقدار این شرط گرادیان دریافت میکند. |
get Min Value() | String | حداقل مقدار این شرط گرادیان را دریافت میکند. |
Group
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
collapse() | Group | Collapses this group. |
expand() | Group | Expands this group. |
get Control Index() | Integer | Returns the control toggle index of this group. |
get Depth() | Integer | Returns the depth of this group. |
get Range() | Range | Returns the range over which this group exists. |
is Collapsed() | Boolean | Returns true if this group is collapsed. |
remove() | void | Removes this group from the sheet, reducing the group depth of the range by one. |
Group Control Toggle Position
خواص
| ملک | نوع | توضیحات |
|---|---|---|
BEFORE | Enum | The position where the control toggle is before the group (at lower indices). |
AFTER | Enum | The position where the control toggle is after the group (at higher indices). |
Interpolation Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
NUMBER | Enum | Use the number as as specific interpolation point for a gradient condition. |
PERCENT | Enum | Use the number as a percentage interpolation point for a gradient condition. |
PERCENTILE | Enum | Use the number as a percentile interpolation point for a gradient condition. |
MIN | Enum | Infer the minimum number as a specific interpolation point for a gradient condition. |
MAX | Enum | Infer the maximum number as a specific interpolation point for a gradient condition. |
Looker Data Source Spec
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Data Source Spec Builder | Creates a Data Source Spec Builder based on this data source's settings. |
get Explore Name() | String | Gets the name of the Looker explore in the model. |
get Instance Url() | String | Gets the URL of the Looker instance. |
get Model Name() | String | Gets the name of the Looker model in the instance. |
get Parameters() | Data Source Parameter[] | Gets the parameters of the data source. |
get Type() | Data Source Type | Gets the type of the data source. |
Looker Data Source Spec Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Data Source Spec | Builds a data source specification from the settings in this builder. |
copy() | Data Source Spec Builder | Creates a Data Source Spec Builder based on this data source's settings. |
get Explore Name() | String | Gets the name of the Looker explore in the model. |
get Instance Url() | String | Gets the URL of the Looker instance. |
get Model Name() | String | Gets the name of the Looker model in the instance. |
get Parameters() | Data Source Parameter[] | Gets the parameters of the data source. |
get Type() | Data Source Type | Gets the type of the data source. |
remove All Parameters() | Looker Data Source Spec Builder | Removes all the parameters. |
remove Parameter(parameterName) | Looker Data Source Spec Builder | Removes the specified parameter. |
set Explore Name(exploreName) | Looker Data Source Spec Builder | Sets the explore name in the Looker model. |
set Instance Url(instanceUrl) | Looker Data Source Spec Builder | Sets the instance URL for Looker. |
set Model Name(modelName) | Looker Data Source Spec Builder | Sets the Looker model name in the Looker instance. |
set Parameter From Cell(parameterName, sourceCell) | Looker Data Source Spec Builder | Adds a parameter, or if the parameter with the name exists, updates its source cell for data source spec builders of type Data Source Type.BIGQUERY . |
Named Range
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Name() | String | Gets the name of this named range. |
get Range() | Range | Gets the range referenced by this named range. |
remove() | void | Deletes this named range. |
set Name(name) | Named Range | Sets/updates the name of the named range. |
set Range(range) | Named Range | Sets/updates the range for this named range. |
Over Grid Image
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
assign Script(functionName) | Over Grid Image | Assigns the function with the specified function name to this image. |
get Alt Text Description() | String | Returns the alt text description for this image. |
get Alt Text Title() | String | Returns the alt text title for this image. |
get Anchor Cell() | Range | Returns the cell where an image is anchored. |
get Anchor Cell XOffset() | Integer | Returns the horizontal pixel offset from the anchor cell. |
get Anchor Cell YOffset() | Integer | Returns the vertical pixel offset from the anchor cell. |
get Height() | Integer | Returns the actual height of this image in pixels. |
get Inherent Height() | Integer | Returns the inherent height of this image in pixels. |
get Inherent Width() | Integer | Returns the inherent height of this image in pixels. |
get Script() | String | Returns the name of the function assigned to this image. |
get Sheet() | Sheet | Returns the sheet this image appears on. |
get Width() | Integer | Returns the actual width of this image in pixels. |
remove() | void | Deletes this image from the spreadsheet. |
replace(blob) | Over Grid Image | Replaces this image with the one specified by the provided Blob Source . |
replace(url) | Over Grid Image | Replaces this image with the one from the specified URL. |
reset Size() | Over Grid Image | Resets this image to its inherent dimensions. |
set Alt Text Description(description) | Over Grid Image | Sets the alt-text description for this image. |
set Alt Text Title(title) | Over Grid Image | Sets the alt text title for this image. |
set Anchor Cell(cell) | Over Grid Image | Sets the cell where an image is anchored. |
set Anchor Cell XOffset(offset) | Over Grid Image | Sets the horizontal pixel offset from the anchor cell. |
set Anchor Cell YOffset(offset) | Over Grid Image | Sets the vertical pixel offset from the anchor cell. |
set Height(height) | Over Grid Image | Sets the actual height of this image in pixels. |
set Width(width) | Over Grid Image | Sets the actual width of this image in pixels. |
Page Protection
Pivot Filter
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Filter Criteria() | Filter Criteria | Returns the filter criteria for this pivot filter. |
get Pivot Table() | Pivot Table | Returns the Pivot Table that this filter belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column this filter operates on. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the filter operates on. |
remove() | void | Removes this pivot filter from the pivot table. |
set Filter Criteria(filterCriteria) | Pivot Filter | Sets the filter criteria for this pivot filter. |
Pivot Group
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Manual Grouping Rule(groupName, groupMembers) | Pivot Group | Adds a manual grouping rule for this pivot group. |
are Labels Repeated() | Boolean | Returns whether labels are displayed as repeated. |
clear Grouping Rule() | Pivot Group | Removes any grouping rules from this pivot group. |
clear Sort() | Pivot Group | Removes any sorting applied to this group. |
get Date Time Grouping Rule() | Date Time Grouping Rule |null | Returns the date-time grouping rule on the pivot group, or null if no date-time grouping rule is set. |
get Dimension() | Dimension | Returns whether this is a row or column group. |
get Group Limit() | Pivot Group Limit |null | Returns the pivot group limit on the pivot group. |
get Index() | Integer | Returns the index of this pivot group in the current group order. |
get Pivot Table() | Pivot Table | Returns the Pivot Table which this grouping belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column this group summarizes. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the pivot group operates on. |
hide Repeated Labels() | Pivot Group | Hides repeated labels for this grouping. |
is Sort Ascending() | Boolean | Returns true if the sort is ascending, returns false if the sort order is descending. |
move To Index(index) | Pivot Group | Moves this group to the specified position in the current list of row or column groups. |
remove() | void | Removes this pivot group from the table. |
remove Manual Grouping Rule(groupName) | Pivot Group | Removes the manual grouping rule with the specified group Name . |
reset Display Name() | Pivot Group | Resets the display name of this group in the pivot table to its default value. |
set Date Time Grouping Rule(dateTimeGroupingRuleType) | Pivot Group | Sets the date-time grouping rule on the pivot group. |
set Display Name(name) | Pivot Group | Sets the display name of this group in the pivot table. |
set Group Limit(countLimit) | Pivot Group | Sets the pivot group limit on the pivot group. |
set Histogram Grouping Rule(minValue, maxValue, intervalSize) | Pivot Group | Sets a histogram grouping rule for this pivot group. |
show Repeated Labels() | Pivot Group | When there is more than one row or column grouping, this method displays this grouping's label for each entry of the subsequent grouping. |
show Totals(showTotals) | Pivot Group | Sets whether to show total values for this pivot group in the table. |
sort Ascending() | Pivot Group | Sets the sort order to be ascending. |
sort By(value, oppositeGroupValues) | Pivot Group | Sorts this group by the specified Pivot Value for the values from the opposite Group Values . |
sort Descending() | Pivot Group | Sets the sort order to be descending. |
totals Are Shown() | Boolean | Returns whether total values are currently shown for this pivot group. |
Pivot Group Limit
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Count Limit() | Integer | Gets the count limit on rows or columns in the pivot group. |
get Pivot Group() | Pivot Group | Returns the pivot group the limit belongs to. |
remove() | void | Removes the pivot group limit. |
set Count Limit(countLimit) | Pivot Group Limit | Sets the count limit on rows or columns in the pivot group. |
Pivot Table
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Calculated Pivot Value(name, formula) | Pivot Value | Creates a new pivot value in the pivot table calculated from the specified formula with the specified name . |
add Column Group(sourceDataColumn) | Pivot Group | Defines a new pivot column grouping in the pivot table. |
add Filter(sourceDataColumn, filterCriteria) | Pivot Filter | Creates a new pivot filter for the pivot table. |
add Pivot Value(sourceDataColumn, summarizeFunction) | Pivot Value | Defines a new pivot value in the pivot table with the specified summarize Function . |
add Row Group(sourceDataColumn) | Pivot Group | Defines a new pivot row grouping in the pivot table. |
as Data Source Pivot Table() | Data Source Pivot Table |null | Returns the pivot table as a data source pivot table if the pivot table is linked to a Data Source , or null otherwise. |
get Anchor Cell() | Range | Returns the Range representing the cell where this pivot table is anchored. |
get Column Groups() | Pivot Group[] | Returns an ordered list of the column groups in this pivot table. |
get Filters() | Pivot Filter[] | Returns an ordered list of the filters in this pivot table. |
get Pivot Values() | Pivot Value[] | Returns an ordered list of the pivot values in this pivot table. |
get Row Groups() | Pivot Group[] | Returns an ordered list of the row groups in this pivot table. |
get Source Data Range() | Range | Returns the source data range on which the pivot table is constructed. |
get Values Display Orientation() | Dimension | Returns whether values are displayed as rows or columns. |
remove() | void | Deletes this pivot table. |
set Values Display Orientation(dimension) | Pivot Table | Sets the layout of this pivot table to display values as columns or rows. |
Pivot Table Summarize Function
خواص
| ملک | نوع | توضیحات |
|---|---|---|
CUSTOM | Enum | A custom function, this value is only valid for calculated fields. |
SUM | Enum | The SUM function |
COUNTA | Enum | The COUNTA function |
COUNT | Enum | The COUNT function |
COUNTUNIQUE | Enum | The COUNTUNIQUE function |
AVERAGE | Enum | The AVERAGE function |
MAX | Enum | The MAX function |
MIN | Enum | The MIN function |
MEDIAN | Enum | The MEDIAN function |
PRODUCT | Enum | The PRODUCT function |
STDEV | Enum | The STDEV function |
STDEVP | Enum | The STDEVP function |
VAR | Enum | The VAR function |
VARP | Enum | The VARP function |
Pivot Value
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Display Type() | Pivot Value Display Type | Returns the display type describing how this pivot value is currently displayed in the table. |
get Formula() | String | Returns the formula used to calculate this value. |
get Pivot Table() | Pivot Table | Returns the Pivot Table which this value belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column the pivot value summarizes. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the pivot value summarizes. |
get Summarized By() | Pivot Table Summarize Function | Returns this group's summarization function. |
remove() | void | Remove this value from the pivot table. |
set Display Name(name) | Pivot Value | Sets the display name for this value in the pivot table. |
set Formula(formula) | Pivot Value | Sets the formula used to calculate this value. |
show As(displayType) | Pivot Value | Displays this value in the pivot table as a function of another value. |
summarize By(summarizeFunction) | Pivot Value | Sets the summarization function. |
Pivot Value Display Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
DEFAULT | Enum | پیشفرض |
PERCENT_OF_ROW_TOTAL | Enum | Displays pivot values as a percent of the total for that row. |
PERCENT_OF_COLUMN_TOTAL | Enum | Displays pivot values as a percent of the total for that column. |
PERCENT_OF_GRAND_TOTAL | Enum | Displays pivot values as a percent of the grand total. |
Protection
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Editor(emailAddress) | Protection | Adds the given user to the list of editors for the protected sheet or range. |
add Editor(user) | Protection | Adds the given user to the list of editors for the protected sheet or range. |
add Editors(emailAddresses) | Protection | Adds the given array of users to the list of editors for the protected sheet or range. |
add Target Audience(audienceId) | Protection | Adds the specified target audience as an editor of the protected range. |
can Domain Edit() | Boolean | Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. |
can Edit() | Boolean | Determines whether the user has permission to edit the protected range or sheet. |
get Description() | String | Gets the description of the protected range or sheet. |
get Editors() | User[] | Gets the list of editors for the protected range or sheet. |
get Protection Type() | Protection Type | Gets the type of the protected area, either RANGE or SHEET . |
get Range() | Range | Gets the range that is being protected. |
get Range Name() | String|null | Gets the name of the protected range if it is associated with a named range. |
get Target Audiences() | Target Audience[] | Returns the IDs of the target audiences that can edit the protected range. |
get Unprotected Ranges() | Range[] | Gets an array of unprotected ranges within a protected sheet. |
is Warning Only() | Boolean | Determines if the protected area is using "warning based" protection. |
remove() | void | Unprotects the range or sheet. |
remove Editor(emailAddress) | Protection | Removes the given user from the list of editors for the protected sheet or range. |
remove Editor(user) | Protection | Removes the given user from the list of editors for the protected sheet or range. |
remove Editors(emailAddresses) | Protection | Removes the given array of users from the list of editors for the protected sheet or range. |
remove Target Audience(audienceId) | Protection | Removes the specified target audience as an editor of the protected range. |
set Description(description) | Protection | Sets the description of the protected range or sheet. |
set Domain Edit(editable) | Protection | Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. |
set Named Range(namedRange) | Protection | Associates the protected range with an existing named range. |
set Range(range) | Protection | Adjusts the range that is being protected. |
set Range Name(rangeName) | Protection | Associates the protected range with an existing named range. |
set Unprotected Ranges(ranges) | Protection | Unprotects the given array of ranges within a protected sheet. |
set Warning Only(warningOnly) | Protection | Sets whether or not this protected range is using "warning based" protection. |
Protection Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
RANGE | Enum | Protection for a range. |
SHEET | Enum | Protection for a sheet. |
Range
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
activate() | Range | Sets the specified range as the active range , with the top left cell in the range as the current cell . |
activate As Current Cell() | Range | Sets the specified cell as the current cell . |
add Developer Metadata(key) | Range | Adds developer metadata with the specified key to the range. |
add Developer Metadata(key, visibility) | Range | Adds developer metadata with the specified key and visibility to the range. |
add Developer Metadata(key, value) | Range | Adds developer metadata with the specified key and value to the range. |
add Developer Metadata(key, value, visibility) | Range | Adds developer metadata with the specified key, value, and visibility to the range. |
apply Column Banding() | Banding | Applies a default column banding theme to the range. |
apply Column Banding(bandingTheme) | Banding | Applies a specified column banding theme to the range. |
apply Column Banding(bandingTheme, showHeader, showFooter) | Banding | Applies a specified column banding theme to the range with specified header and footer settings. |
apply Row Banding() | Banding | Applies a default row banding theme to the range. |
apply Row Banding(bandingTheme) | Banding | Applies a specified row banding theme to the range. |
apply Row Banding(bandingTheme, showHeader, showFooter) | Banding | Applies a specified row banding theme to the range with specified header and footer settings. |
auto Fill(destination, series) | void | Fills the destination Range with data based on the data in this range. |
auto Fill To Neighbor(series) | void | Calculates a range to fill with new data based on neighboring cells and automatically fills that range with new values based on the data contained in this range. |
break Apart() | Range | Break any multi-column cells in the range into individual cells again. |
can Edit() | Boolean | Determines whether the user has permission to edit every cell in the range. |
check() | Range | Changes the state of the checkboxes in the range to “checked”. |
clear() | Range | Clears the range of contents and formats. |
clear(options) | Range | Clears the range of contents, format, data validation rules, and/or comments, as specified with the given advanced options. |
clear Content() | Range | Clears the content of the range, leaving the formatting intact. |
clear Data Validations() | Range | Clears the data validation rules for the range. |
clear Format() | Range | Clears formatting for this range. |
clear Note() | Range | Clears the note in the given cell or cells. |
collapse Groups() | Range | Collapses all groups that are wholly contained within the range. |
copy Format To Range(gridId, column, columnEnd, row, rowEnd) | void | Copy the formatting of the range to the given location. |
copy Format To Range(sheet, column, columnEnd, row, rowEnd) | void | Copy the formatting of the range to the given location. |
copy To(destination) | void | Copies the data from a range of cells to another range of cells. |
copy To(destination, copyPasteType, transposed) | void | Copies the data from a range of cells to another range of cells. |
copy To(destination, options) | void | Copies the data from a range of cells to another range of cells. |
copy Values To Range(gridId, column, columnEnd, row, rowEnd) | void | Copy the content of the range to the given location. |
copy Values To Range(sheet, column, columnEnd, row, rowEnd) | void | Copy the content of the range to the given location. |
create Data Source Pivot Table(dataSource) | Data Source Pivot Table | Creates an empty data source pivot table from the data source, anchored at the first cell in this range. |
create Data Source Table(dataSource) | Data Source Table | Creates an empty data source table from the data source, anchored at the first cell in this range. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a DeveloperMetadataFinderApi for finding developer metadata within the scope of this range. |
create Filter() | Filter | Creates a filter and applies it to the specified range on the sheet. |
create Pivot Table(sourceData) | Pivot Table | Creates an empty pivot table from the specified source Data anchored at the first cell in this range. |
create Text Finder(findText) | Text Finder | Creates a text finder for the range, which can find and replace text in this range. |
delete Cells(shiftDimension) | void | Deletes this range of cells. |
expand Groups() | Range | Expands the collapsed groups whose range or control toggle intersects with this range. |
getA1Notation() | String | Returns a string description of the range, in A1 notation. |
get Background() | String | Returns the background color of the top-left cell in the range (for example, '#ffffff' ). |
get Background Object() | Color | Returns the background color of the top-left cell in the range. |
get Background Objects() | Color[][] | Returns the background colors of the cells in the range. |
get Backgrounds() | String[][] | Returns the background colors of the cells in the range (for example, '#ffffff' ). |
get Bandings() | Banding[] | Returns all the bandings that are applied to any cells in this range. |
get Cell(row, column) | Range | Returns a given cell within a range. |
get Column() | Integer | Returns the starting column position for this range. |
get Data Region() | Range | Returns a copy of the range expanded in the four cardinal Direction s to cover all adjacent cells with data in them. |
get Data Region(dimension) | Range | Returns a copy of the range expanded Direction.UP and Direction.DOWN if the specified dimension is Dimension.ROWS , or Direction.NEXT and Direction.PREVIOUS if the dimension is Dimension.COLUMNS . |
get Data Source Formula() | Data Source Formula |null | Returns the Data Source Formula for the first cell in the range, or null if the cell doesn't contain a data source formula. |
get Data Source Formulas() | Data Source Formula[] | Returns the Data Source Formula s for the cells in the range. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables intersecting with the range. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables intersecting with the range. |
get Data Source Url() | String | Returns a URL for the data in this range, which can be used to create charts and queries. |
get Data Table() | Data Table | Return the data inside this object as a DataTable. |
get Data Table(firstRowIsHeader) | Data Table | Return the data inside this range as a DataTable. |
get Data Validation() | Data Validation | Returns the data validation rule for the top-left cell in the range. |
get Data Validations() | Data Validation[][] | Returns the data validation rules for all cells in the range. |
get Developer Metadata() | Developer Metadata[] | Gets the developer metadata associated with this range. |
get Display Value() | String | Returns the displayed value of the top-left cell in the range. |
get Display Values() | String[][] | Returns the rectangular grid of values for this range. |
get Filter() | Filter |null | Returns the filter on the sheet this range belongs to, or null if there is no filter on the sheet. |
get Font Color Object() | Color | Returns the font color of the cell in the top-left corner of the range. |
get Font Color Objects() | Color[][] | Returns the font colors of the cells in the range. |
get Font Families() | String[][] | Returns the font families of the cells in the range. |
get Font Family() | String | Returns the font family of the cell in the top-left corner of the range. |
get Font Line() | String | Gets the line style of the cell in the top-left corner of the range ( 'underline' , 'line-through' , or 'none' ). |
get Font Lines() | String[][] | Gets the line style of the cells in the range ( 'underline' , 'line-through' , or 'none' ). |
get Font Size() | Integer | Returns the font size in point size of the cell in the top-left corner of the range. |
get Font Sizes() | Integer[][] | Returns the font sizes of the cells in the range. |
get Font Style() | String | Returns the font style ( 'italic' or 'normal' ) of the cell in the top-left corner of the range. |
get Font Styles() | String[][] | Returns the font styles of the cells in the range. |
get Font Weight() | String | Returns the font weight (normal/bold) of the cell in the top-left corner of the range. |
get Font Weights() | String[][] | Returns the font weights of the cells in the range. |
get Formula() | String | Returns the formula (A1 notation) for the top-left cell of the range, or an empty string if the cell is empty or doesn't contain a formula. |
get Formula R1C1() | String | Returns the formula (R1C1 notation) for a given cell, or null if none. |
get Formulas() | String[][] | Returns the formulas (A1 notation) for the cells in the range. |
get Formulas R1C1() | String[][] | Returns the formulas (R1C1 notation) for the cells in the range. |
get Grid Id() | Integer | Returns the grid ID of the range's parent sheet. |
get Height() | Integer | Returns the height of the range. |
get Horizontal Alignment() | String | Returns the horizontal alignment of the text (left/center/right) of the cell in the top-left corner of the range. |
get Horizontal Alignments() | String[][] | Returns the horizontal alignments of the cells in the range. |
get Last Column() | Integer | Returns the end column position. |
get Last Row() | Integer | Returns the end row position. |
get Merged Ranges() | Range[] | Returns an array of Range objects representing merged cells that either are fully within the current range, or contain at least one cell in the current range. |
get Next Data Cell(direction) | Range | Starting at the cell in the first column and row of the range, returns the next cell in the given direction that is the edge of a contiguous range of cells with data in them or the cell at the edge of the spreadsheet in that direction. |
get Note() | String | Returns the note associated with the given range. |
get Notes() | String[][] | Returns the notes associated with the cells in the range. |
get Num Columns() | Integer | Returns the number of columns in this range. |
get Num Rows() | Integer | Returns the number of rows in this range. |
get Number Format() | String | Get the number or date formatting of the top-left cell of the given range. |
get Number Formats() | String[][] | Returns the number or date formats for the cells in the range. |
get Rich Text Value() | Rich Text Value |null | Returns the Rich Text value for the top left cell of the range, or null if the cell value is not text. |
get Rich Text Values() | Rich Text Value[][] | Returns the Rich Text values for the cells in the range. |
get Row() | Integer | Returns the row position for this range. |
get Row Index() | Integer | Returns the row position for this range. |
get Sheet() | Sheet | Returns the sheet this range belongs to. |
get Text Direction() | Text Direction | Returns the text direction for the top left cell of the range. |
get Text Directions() | Text Direction[][] | Returns the text directions for the cells in the range. |
get Text Rotation() | Text Rotation | Returns the text rotation settings for the top left cell of the range. |
get Text Rotations() | Text Rotation[][] | Returns the text rotation settings for the cells in the range. |
get Text Style() | Text Style | Returns the text style for the top left cell of the range. |
get Text Styles() | Text Style[][] | Returns the text styles for the cells in the range. |
get Value() | Object | Returns the value of the top-left cell in the range. |
get Values() | Object[][] | Returns the rectangular grid of values for this range. |
get Vertical Alignment() | String | Returns the vertical alignment (top/middle/bottom) of the cell in the top-left corner of the range. |
get Vertical Alignments() | String[][] | Returns the vertical alignments of the cells in the range. |
get Width() | Integer | Returns the width of the range in columns. |
get Wrap() | Boolean | Returns whether the text in the cell wraps. |
get Wrap Strategies() | Wrap Strategy[][] | Returns the text wrapping strategies for the cells in the range. |
get Wrap Strategy() | Wrap Strategy | Returns the text wrapping strategy for the top left cell of the range. |
get Wraps() | Boolean[][] | Returns whether the text in the cells wrap. |
insert Cells(shiftDimension) | Range | Inserts empty cells into this range. |
insert Checkboxes() | Range | Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked. |
insert Checkboxes(checkedValue) | Range | Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked. |
insert Checkboxes(checkedValue, uncheckedValue) | Range | Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states. |
is Blank() | Boolean | Returns true if the range is totally blank. |
is Checked() | Boolean | Returns whether all cells in the range have their checkbox state as 'checked'. |
is End Column Bounded() | Boolean | Determines whether the end of the range is bound to a particular column. |
is End Row Bounded() | Boolean | Determines whether the end of the range is bound to a particular row. |
is Part Of Merge() | Boolean | Returns true if the cells in the current range overlap any merged cells. |
is Start Column Bounded() | Boolean | Determines whether the start of the range is bound to a particular column. |
is Start Row Bounded() | Boolean | Determines whether the start of the range is bound to a particular row. |
merge() | Range | Merges the cells in the range together into a single block. |
merge Across() | Range | Merge the cells in the range across the columns of the range. |
merge Vertically() | Range | Merges the cells in the range together. |
move To(target) | void | Cut and paste (both format and values) from this range to the target range. |
offset(rowOffset, columnOffset) | Range | Returns a new range that is offset from this range by the given number of rows and columns (which can be negative). |
offset(rowOffset, columnOffset, numRows) | Range | Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height in cells. |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height and width in cells. |
protect() | Protection | Creates an object that can protect the range from being edited except by users who have permission. |
randomize() | Range | Randomizes the order of the rows in the given range. |
remove Checkboxes() | Range | Removes all checkboxes from the range. |
remove Duplicates() | Range | Removes rows within this range that contain values that are duplicates of values in any previous row. |
remove Duplicates(columnsToCompare) | Range | Removes rows within this range that contain values in the specified columns that are duplicates of values any previous row. |
set Background(color) | Range | Sets the background color of all cells in the range in CSS notation (such as '#ffffff' or 'white' ). |
set Background Object(color) | Range | Sets the background color of all cells in the range. |
set Background Objects(color) | Range | Sets a rectangular grid of background colors (must match dimensions of this range). |
set Background RGB(red, green, blue) | Range | Sets the background to the given color using RGB values (integers between 0 and 255 inclusive). |
set Backgrounds(color) | Range | Sets a rectangular grid of background colors (must match dimensions of this range). |
set Border(top, left, bottom, right, vertical, horizontal) | Range | Sets the border property. |
set Border(top, left, bottom, right, vertical, horizontal, color, style) | Range | Sets the border property with color and/or style. |
set Data Validation(rule) | Range | Sets one data validation rule for all cells in the range. |
set Data Validations(rules) | Range | Sets the data validation rules for all cells in the range. |
set Font Color(color) | Range | Sets the font color in CSS notation (such as '#ffffff' or 'white' ). |
set Font Color Object(color) | Range | Sets the font color of the given range. |
set Font Color Objects(colors) | Range | Sets a rectangular grid of font colors (must match dimensions of this range). |
set Font Colors(colors) | Range | Sets a rectangular grid of font colors (must match dimensions of this range). |
set Font Families(fontFamilies) | Range | Sets a rectangular grid of font families (must match dimensions of this range). |
set Font Family(fontFamily) | Range | Sets the font family, such as "Arial" or "Helvetica". |
set Font Line(fontLine) | Range | Sets the font line style of the given range ( 'underline' , 'line-through' , or 'none' ). |
set Font Lines(fontLines) | Range | Sets a rectangular grid of line styles (must match dimensions of this range). |
set Font Size(size) | Range | Sets the font size, with the size being the point size to use. |
set Font Sizes(sizes) | Range | Sets a rectangular grid of font sizes (must match dimensions of this range). |
set Font Style(fontStyle) | Range | Set the font style for the given range ( 'italic' or 'normal' ). |
set Font Styles(fontStyles) | Range | Sets a rectangular grid of font styles (must match dimensions of this range). |
set Font Weight(fontWeight) | Range | Set the font weight for the given range (normal/bold). |
set Font Weights(fontWeights) | Range | Sets a rectangular grid of font weights (must match dimensions of this range). |
set Formula(formula) | Range | Updates the formula for this range. |
set Formula R1C1(formula) | Range | Updates the formula for this range. |
set Formulas(formulas) | Range | Sets a rectangular grid of formulas (must match dimensions of this range). |
set Formulas R1C1(formulas) | Range | Sets a rectangular grid of formulas (must match dimensions of this range). |
set Horizontal Alignment(alignment) | Range | Set the horizontal (left to right) alignment for the given range (left/center/right). |
set Horizontal Alignments(alignments) | Range | Sets a rectangular grid of horizontal alignments. |
set Note(note) | Range | Sets the note to the given value. |
set Notes(notes) | Range | Sets a rectangular grid of notes (must match dimensions of this range). |
set Number Format(numberFormat) | Range | Sets the number or date format to the given formatting string. |
set Number Formats(numberFormats) | Range | Sets a rectangular grid of number or date formats (must match dimensions of this range). |
set Rich Text Value(value) | Range | Sets the Rich Text value for the cells in the range. |
set Rich Text Values(values) | Range | Sets a rectangular grid of Rich Text values. |
set Show Hyperlink(showHyperlink) | Range | Sets whether or not the range should show hyperlinks. |
set Text Direction(direction) | Range | Sets the text direction for the cells in the range. |
set Text Directions(directions) | Range | Sets a rectangular grid of text directions. |
set Text Rotation(degrees) | Range | Sets the text rotation settings for the cells in the range. |
set Text Rotation(rotation) | Range | Sets the text rotation settings for the cells in the range. |
set Text Rotations(rotations) | Range | Sets a rectangular grid of text rotations. |
set Text Style(style) | Range | Sets the text style for the cells in the range. |
set Text Styles(styles) | Range | Sets a rectangular grid of text styles. |
set Value(value) | Range | Sets the value of the range. |
set Values(values) | Range | Sets a rectangular grid of values (must match dimensions of this range). |
set Vertical Alignment(alignment) | Range | Set the vertical (top to bottom) alignment for the given range (top/middle/bottom). |
set Vertical Alignments(alignments) | Range | Sets a rectangular grid of vertical alignments (must match dimensions of this range). |
set Vertical Text(isVertical) | Range | Sets whether or not to stack the text for the cells in the range. |
set Wrap(isWrapEnabled) | Range | Set the cell wrap of the given range. |
set Wrap Strategies(strategies) | Range | Sets a rectangular grid of wrap strategies. |
set Wrap Strategy(strategy) | Range | Sets the text wrapping strategy for the cells in the range. |
set Wraps(isWrapEnabled) | Range | Sets a rectangular grid of word wrap policies (must match dimensions of this range). |
shift Column Group Depth(delta) | Range | Changes the column grouping depth of the range by the specified amount. |
shift Row Group Depth(delta) | Range | Changes the row grouping depth of the range by the specified amount. |
sort(sortSpecObj) | Range | Sorts the cells in the given range, by column and order specified. |
split Text To Columns() | void | Splits a column of text into multiple columns based on an auto-detected delimiter. |
split Text To Columns(delimiter) | void | Splits a column of text into multiple columns using the specified string as a custom delimiter. |
split Text To Columns(delimiter) | void | Splits a column of text into multiple columns based on the specified delimiter. |
trim Whitespace() | Range | Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range. |
uncheck() | Range | Changes the state of the checkboxes in the range to “unchecked”. |
Range List
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
activate() | Range List | Selects the list of Range instances. |
break Apart() | Range List | Break all horizontally- or vertically-merged cells contained within the range list into individual cells again. |
check() | Range List | Changes the state of the checkboxes in the range to “checked”. |
clear() | Range List | Clears the range of contents, formats, and data validation rules for each Range in the range list. |
clear(options) | Range List | Clears the range of contents, format, data validation rules, and comments, as specified with the given options. |
clear Content() | Range List | Clears the content of each Range in the range list, leaving the formatting intact. |
clear Data Validations() | Range List | Clears the data validation rules for each Range in the range list. |
clear Format() | Range List | Clears text formatting for each Range in the range list. |
clear Note() | Range List | Clears the note for each Range in the range list. |
get Ranges() | Range[] | Returns a list of one or more Range instances in the same sheet. |
insert Checkboxes() | Range List | Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked. |
insert Checkboxes(checkedValue) | Range List | Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked. |
insert Checkboxes(checkedValue, uncheckedValue) | Range List | Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states. |
remove Checkboxes() | Range List | Removes all checkboxes from the range. |
set Background(color) | Range List | Sets the background color for each Range in the range list. |
set Background RGB(red, green, blue) | Range List | Sets the background to the given RGB color. |
set Border(top, left, bottom, right, vertical, horizontal) | Range List | Sets the border property for each Range in the range list. |
set Border(top, left, bottom, right, vertical, horizontal, color, style) | Range List | Sets the border property with color and/or style for each Range in the range list. |
set Font Color(color) | Range List | Sets the font color for each Range in the range list. |
set Font Family(fontFamily) | Range List | Sets the font family for each Range in the range list. |
set Font Line(fontLine) | Range List | Sets the font line style for each Range in the range list. |
set Font Size(size) | Range List | Sets the font size (in points) for each Range in the range list. |
set Font Style(fontStyle) | Range List | Set the font style for each Range in the range list. |
set Font Weight(fontWeight) | Range List | Set the font weight for each Range in the range list. |
set Formula(formula) | Range List | Updates the formula for each Range in the range list. |
set Formula R1C1(formula) | Range List | Updates the formula for each Range in the range list. |
set Horizontal Alignment(alignment) | Range List | Set the horizontal alignment for each Range in the range list. |
set Note(note) | Range List | Sets the note text for each Range in the range list. |
set Number Format(numberFormat) | Range List | Sets the number or date format for each Range in the range list. |
set Show Hyperlink(showHyperlink) | Range List | Sets whether or not each Range in the range list should show hyperlinks. |
set Text Direction(direction) | Range List | Sets the text direction for the cells in each Range in the range list. |
set Text Rotation(degrees) | Range List | Sets the text rotation settings for the cells in each Range in the range list. |
set Value(value) | Range List | Sets the value for each Range in the range list. |
set Vertical Alignment(alignment) | Range List | Set the vertical alignment for each Range in the range list. |
set Vertical Text(isVertical) | Range List | Sets whether or not to stack the text for the cells for each Range in the range list. |
set Wrap(isWrapEnabled) | Range List | Set text wrapping for each Range in the range list. |
set Wrap Strategy(strategy) | Range List | Sets the text wrapping strategy for each Range in the range list. |
trim Whitespace() | Range List | Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range list. |
uncheck() | Range List | Changes the state of the checkboxes in the range to “unchecked”. |
Recalculation Interval
خواص
| ملک | نوع | توضیحات |
|---|---|---|
ON_CHANGE | Enum | Recalculate only when values are changed. |
MINUTE | Enum | Recalculate when values are changed, and every minute. |
HOUR | Enum | Recalculate when values are changed, and every hour. |
Relative Date
خواص
| ملک | نوع | توضیحات |
|---|---|---|
TODAY | Enum | Dates compared against the current date. |
TOMORROW | Enum | Dates compared against the date after the current date. |
YESTERDAY | Enum | Dates compared against the date before the current date. |
PAST_WEEK | Enum | Dates that fall within the past week period. |
PAST_MONTH | Enum | Dates that fall within the past month period. |
PAST_YEAR | Enum | Dates that fall within the past year period. |
Rich Text Value
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Rich Text Value Builder | Returns a builder for a Rich Text value initialized with the values of this Rich Text value. |
get End Index() | Integer | Gets the end index of this value in the cell. |
get Link Url() | String|null | Returns the link URL for this value. |
get Link Url(startOffset, endOffset) | String|null | Returns the link URL for the text from start Offset to end Offset . |
get Runs() | Rich Text Value[] | Returns the Rich Text string split into an array of runs, wherein each run is the longest possible substring having a consistent text style. |
get Start Index() | Integer | Gets the start index of this value in the cell. |
get Text() | String | Returns the text of this value. |
get Text Style() | Text Style | Returns the text style of this value. |
get Text Style(startOffset, endOffset) | Text Style | Returns the text style of the text from start Offset to end Offset . |
Rich Text Value Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Rich Text Value | Creates a Rich Text value from this builder. |
set Link Url(startOffset, endOffset, linkUrl) | Rich Text Value Builder | Sets the link URL for the given substring of this value, or clears it if link Url is null . |
set Link Url(linkUrl) | Rich Text Value Builder | Sets the link URL for the entire value, or clears it if link Url is null . |
set Text(text) | Rich Text Value Builder | Sets the text for this value and clears any existing text style. |
set Text Style(startOffset, endOffset, textStyle) | Rich Text Value Builder | Applies a text style to the given substring of this value. |
set Text Style(textStyle) | Rich Text Value Builder | Applies a text style to the entire value. |
Selection
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Active Range() | Range |null | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Active Sheet() | Sheet | Returns the active sheet in the spreadsheet. |
get Current Cell() | Range |null | Returns the current (highlighted) cell that is selected in one of the active ranges or null if there is no current cell. |
get Next Data Range(direction) | Range |null | Starting from the current cell and active range and moving in the given direction, returns an adjusted range where the appropriate edge of the range has been shifted to cover the next data cell while still covering the current cell. |
Sheet
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
activate() | Sheet | Activates this sheet. |
add Developer Metadata(key) | Sheet | Adds developer metadata with the specified key to the sheet. |
add Developer Metadata(key, visibility) | Sheet | Adds developer metadata with the specified key and visibility to the sheet. |
add Developer Metadata(key, value) | Sheet | Adds developer metadata with the specified key and value to the sheet. |
add Developer Metadata(key, value, visibility) | Sheet | Adds developer metadata with the specified key, value, and visibility to the sheet. |
append Row(rowContents) | Sheet | Appends a row to the bottom of the current data region in the sheet. |
as Data Source Sheet() | Data Source Sheet |null | Returns the sheet as a Data Source Sheet if the sheet is of type Sheet Type.DATASOURCE , or null otherwise. |
auto Resize Column(columnPosition) | Sheet | Sets the width of the given column to fit its contents. |
auto Resize Columns(startColumn, numColumns) | Sheet | Sets the width of all columns starting at the given column position to fit their contents. |
auto Resize Rows(startRow, numRows) | Sheet | Sets the height of all rows starting at the given row position to fit their contents. |
clear() | Sheet | Clears the sheet of content and formatting information. |
clear(options) | Sheet | Clears the sheet of contents and/or format, as specified with the given advanced options. |
clear Conditional Format Rules() | void | Removes all conditional format rules from the sheet. |
clear Contents() | Sheet | Clears the sheet of contents, while preserving formatting information. |
clear Formats() | Sheet | Clears the sheet of formatting, while preserving contents. |
clear Notes() | Sheet | Clears the sheet of all notes. |
collapse All Column Groups() | Sheet | Collapses all column groups on the sheet. |
collapse All Row Groups() | Sheet | Collapses all row groups on the sheet. |
copy To(spreadsheet) | Sheet | Copies the sheet to a given spreadsheet, which can be the same spreadsheet as the source. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a Developer Metadata Finder for finding developer metadata within the scope of this sheet. |
create Text Finder(findText) | Text Finder | Creates a text finder for the sheet, which can find and replace text within the sheet. |
delete Column(columnPosition) | Sheet | Deletes the column at the given column position. |
delete Columns(columnPosition, howMany) | void | Deletes a number of columns starting at the given column position. |
delete Row(rowPosition) | Sheet | Deletes the row at the given row position. |
delete Rows(rowPosition, howMany) | void | Deletes a number of rows starting at the given row position. |
expand All Column Groups() | Sheet | Expands all column groups on the sheet. |
expand All Row Groups() | Sheet | Expands all row groups on the sheet. |
expand Column Groups Up To Depth(groupDepth) | Sheet | Expands all column groups up to the given depth, and collapses all others. |
expand Row Groups Up To Depth(groupDepth) | Sheet | Expands all row groups up to the given depth, and collapses all others. |
get Active Cell() | Range | Returns the active cell in this sheet. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Bandings() | Banding[] | Returns all the bandings in this sheet. |
get Charts() | Embedded Chart[] | Returns an array of charts on this sheet. |
get Column Group(columnIndex, groupDepth) | Group |null | Returns the column group at the given index and group depth. |
get Column Group Control Position() | Group Control Toggle Position | Returns the Group Control Toggle Position for all column groups on the sheet. |
get Column Group Depth(columnIndex) | Integer | Returns the group depth of the column at the given index. |
get Column Width(columnPosition) | Integer | Gets the width in pixels of the given column. |
get Conditional Format Rules() | Conditional Format Rule[] | Get all conditional format rules in this sheet. |
get Current Cell() | Range |null | Returns the current cell in the active sheet or null if there is no current cell. |
get Data Range() | Range | Returns a Range corresponding to the dimensions in which data is present. |
get Data Source Formulas() | Data Source Formula[] | Gets all the data source formulas. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables. |
get Developer Metadata() | Developer Metadata[] | Get all developer metadata associated with this sheet. |
get Drawings() | Drawing[] | Returns an array of drawings on the sheet. |
get Filter() | Filter |null | Returns the filter in this sheet, or null if there is no filter. |
get Form Url() | String|null | Returns the URL for the form that sends its responses to this sheet, or null if this sheet has no associated form. |
get Frozen Columns() | Integer | Returns the number of frozen columns. |
get Frozen Rows() | Integer | Returns the number of frozen rows. |
get Images() | Over Grid Image[] | Returns all over-the-grid images on the sheet. |
get Index() | Integer | Gets the position of the sheet in its parent spreadsheet. |
get Last Column() | Integer | Returns the position of the last column that has content. |
get Last Row() | Integer | Returns the position of the last row that has content. |
get Max Columns() | Integer | Returns the current number of columns in the sheet, regardless of content. |
get Max Rows() | Integer | Returns the current number of rows in the sheet, regardless of content. |
get Name() | String | Returns the name of the sheet. |
get Named Ranges() | Named Range[] | Gets all the named ranges in this sheet. |
get Parent() | Spreadsheet | Returns the Spreadsheet that contains this sheet. |
get Pivot Tables() | Pivot Table[] | Returns all the pivot tables on this sheet. |
get Protections(type) | Protection[] | Gets an array of objects representing all protected ranges in the sheet, or a single-element array representing the protection on the sheet itself. |
get Range(row, column) | Range | Returns the range with the top left cell at the given coordinates. |
get Range(row, column, numRows) | Range | Returns the range with the top left cell at the given coordinates, and with the given number of rows. |
get Range(row, column, numRows, numColumns) | Range | Returns the range with the top left cell at the given coordinates with the given number of rows and columns. |
get Range(a1Notation) | Range | Returns the range as specified in A1 notation or R1C1 notation. |
get Range List(a1Notations) | Range List | Returns the Range List collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations. |
get Row Group(rowIndex, groupDepth) | Group |null | Returns the row group at the given index and group depth. |
get Row Group Control Position() | Group Control Toggle Position | Returns the Group Control Toggle Position for all row groups on the sheet. |
get Row Group Depth(rowIndex) | Integer | Returns the group depth of the row at the given index. |
get Row Height(rowPosition) | Integer | Gets the height in pixels of the given row. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Sheet Id() | Integer | Returns the ID of the sheet represented by this object. |
get Sheet Name() | String | Returns the sheet name. |
get Sheet Values(startRow, startColumn, numRows, numColumns) | Object[][] | Returns the rectangular grid of values for this range starting at the given coordinates. |
get Slicers() | Slicer[] | Returns an array of slicers on the sheet. |
get Tab Color Object() | Color |null | Gets the sheet tab color, or null if the sheet tab has no color. |
get Type() | Sheet Type | Returns the type of the sheet. |
has Hidden Gridlines() | Boolean | Returns true if the sheet's gridlines are hidden; otherwise returns false . |
hide Column(column) | void | Hides the column or columns in the given range. |
hide Columns(columnIndex) | void | Hides a single column at the given index. |
hide Columns(columnIndex, numColumns) | void | Hides one or more consecutive columns starting at the given index. |
hide Row(row) | void | Hides the rows in the given range. |
hide Rows(rowIndex) | void | Hides the row at the given index. |
hide Rows(rowIndex, numRows) | void | Hides one or more consecutive rows starting at the given index. |
hide Sheet() | Sheet | Hides this sheet. |
insert Chart(chart) | void | Adds a new chart to this sheet. |
insert Column After(afterPosition) | Sheet | Inserts a column after the given column position. |
insert Column Before(beforePosition) | Sheet | Inserts a column before the given column position. |
insert Columns(columnIndex) | void | Inserts a blank column in a sheet at the specified location. |
insert Columns(columnIndex, numColumns) | void | Inserts one or more consecutive blank columns in a sheet starting at the specified location. |
insert Columns After(afterPosition, howMany) | Sheet | Inserts a given number of columns after the given column position. |
insert Columns Before(beforePosition, howMany) | Sheet | Inserts a number of columns before the given column position. |
insert Image(blobSource, column, row) | Over Grid Image | Inserts a Blob Source as an image in the document at a given row and column. |
insert Image(blobSource, column, row, offsetX, offsetY) | Over Grid Image | Inserts a Blob Source as an image in the document at a given row and column, with a pixel offset. |
insert Image(url, column, row) | Over Grid Image | Inserts an image in the document at a given row and column. |
insert Image(url, column, row, offsetX, offsetY) | Over Grid Image | Inserts an image in the document at a given row and column, with a pixel offset. |
insert Row After(afterPosition) | Sheet | Inserts a row after the given row position. |
insert Row Before(beforePosition) | Sheet | Inserts a row before the given row position. |
insert Rows(rowIndex) | void | Inserts a blank row in a sheet at the specified location. |
insert Rows(rowIndex, numRows) | void | Inserts one or more consecutive blank rows in a sheet starting at the specified location. |
insert Rows After(afterPosition, howMany) | Sheet | Inserts a number of rows after the given row position. |
insert Rows Before(beforePosition, howMany) | Sheet | Inserts a number of rows before the given row position. |
insert Slicer(range, anchorRowPos, anchorColPos) | Slicer | Adds a new slicer to this sheet. |
insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Adds a new slicer to this sheet. |
is Column Hidden By User(columnPosition) | Boolean | Returns whether the given column is hidden by the user. |
is Right To Left() | Boolean | Returns true if this sheet layout is right-to-left. |
is Row Hidden By Filter(rowPosition) | Boolean | Returns whether the given row is hidden by a filter (not a filter view). |
is Row Hidden By User(rowPosition) | Boolean | Returns whether the given row is hidden by the user. |
is Sheet Hidden() | Boolean | Returns true if the sheet is currently hidden. |
move Columns(columnSpec, destinationIndex) | void | Moves the columns selected by the given range to the position indicated by the destination Index . |
move Rows(rowSpec, destinationIndex) | void | Moves the rows selected by the given range to the position indicated by the destination Index . |
new Chart() | Embedded Chart Builder | Returns a builder to create a new chart for this sheet. |
protect() | Protection | Creates an object that can protect the sheet from being edited except by users who have permission. |
remove Chart(chart) | void | Removes a chart from the parent sheet. |
set Active Range(range) | Range | Sets the specified range as the active range in the active sheet, with the top left cell in the range as the current cell . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges in the active sheet. |
set Active Selection(range) | Range | Sets the active selection region for this sheet. |
set Active Selection(a1Notation) | Range | Sets the active selection, as specified in A1 notation or R1C1 notation. |
set Column Group Control Position(position) | Sheet | Sets the position of the column group control toggle on the sheet. |
set Column Width(columnPosition, width) | Sheet | Sets the width of the given column in pixels. |
set Column Widths(startColumn, numColumns, width) | Sheet | Sets the width of the given columns in pixels. |
set Conditional Format Rules(rules) | void | Replaces all currently existing conditional format rules in the sheet with the input rules. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
set Frozen Columns(columns) | void | Freezes the given number of columns. |
set Frozen Rows(rows) | void | Freezes the given number of rows. |
set Hidden Gridlines(hideGridlines) | Sheet | Hides or reveals the sheet gridlines. |
set Name(name) | Sheet | Sets the sheet name. |
set Right To Left(rightToLeft) | Sheet | Sets or unsets the sheet layout to right-to-left. |
set Row Group Control Position(position) | Sheet | Sets the position of the row group control toggle on the sheet. |
set Row Height(rowPosition, height) | Sheet | Sets the row height of the given row in pixels. |
set Row Heights(startRow, numRows, height) | Sheet | Sets the height of the given rows in pixels. |
set Row Heights Forced(startRow, numRows, height) | Sheet | Sets the height of the given rows in pixels. |
set Tab Color(color) | Sheet | Sets the sheet tab color. |
set Tab Color Object(color) | Sheet | Sets the sheet tab color. |
show Columns(columnIndex) | void | Unhides the column at the given index. |
show Columns(columnIndex, numColumns) | void | Unhides one or more consecutive columns starting at the given index. |
show Rows(rowIndex) | void | Unhides the row at the given index. |
show Rows(rowIndex, numRows) | void | Unhides one or more consecutive rows starting at the given index. |
show Sheet() | Sheet | Makes the sheet visible. |
sort(columnPosition) | Sheet | Sorts a sheet by column, ascending. |
sort(columnPosition, ascending) | Sheet | Sorts a sheet by column. |
unhide Column(column) | void | Unhides the column in the given range. |
unhide Row(row) | void | Unhides the row in the given range. |
update Chart(chart) | void | Updates the chart on this sheet. |
Sheet Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
GRID | Enum | A sheet containing a grid. |
OBJECT | Enum | A sheet containing a single embedded object such as an Embedded Chart . |
DATASOURCE | Enum | A sheet containing a Data Source . |
Slicer
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Background Color Object() | Color |null | Return the background Color of the slicer. |
get Column Position() | Integer|null | Returns the column position (relative to the data range of the slicer) on which the filter is applied in the slicer, or null if the column position is not set. |
get Container Info() | Container Info | Gets information about where the slicer is positioned in the sheet. |
get Filter Criteria() | Filter Criteria |null | Returns the filter criteria of the slicer, or null if the filter criteria is not set. |
get Range() | Range | Gets the data range on which the slicer is applied to. |
get Title() | String | Returns the title of the slicer. |
get Title Horizontal Alignment() | String | Gets the horizontal alignment of the title. |
get Title Text Style() | Text Style | Returns the text style of the slicer's title. |
is Applied To Pivot Tables() | Boolean | Returns whether the given slicer is applied to pivot tables. |
remove() | void | Deletes the slicer. |
set Apply To Pivot Tables(applyToPivotTables) | Slicer | Sets if the given slicer should be applied to pivot tables in the worksheet. |
set Background Color(color) | Slicer | Sets the background color of the slicer. |
set Background Color Object(color) | Slicer | Sets the background Color of the slicer. |
set Column Filter Criteria(columnPosition, filterCriteria) | Slicer | Sets the column index and filtering criteria of the slicer. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Sets the position where the slicer appears on the sheet. |
set Range(rangeApi) | Slicer | Sets the data range on which the slicer is applied. |
set Title(title) | Slicer | Sets the title of the slicer. |
set Title Horizontal Alignment(horizontalAlignment) | Slicer | Sets the horizontal alignment of the title in the slicer. |
set Title Text Style(textStyle) | Slicer | Sets the text style of the slicer. |
Sort Order
خواص
| ملک | نوع | توضیحات |
|---|---|---|
ASCENDING | Enum | Ascending sort order. |
DESCENDING | Enum | Descending sort order. |
Sort Spec
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Background Color() | Color |null | Returns the background color used for sorting, or null if absent. |
get Data Source Column() | Data Source Column |null | Gets the data source column the sort spec acts on. |
get Dimension Index() | Integer|null | Returns the dimension index or null if not linked to a local filter. |
get Foreground Color() | Color |null | Returns the foreground color used for sorting, or null if absent. |
get Sort Order() | Sort Order | Returns the sort order. |
is Ascending() | Boolean | Returns whether the sort order is ascending. |
Spreadsheet
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Developer Metadata(key) | Spreadsheet | Adds developer metadata with the specified key to the top-level spreadsheet. |
add Developer Metadata(key, visibility) | Spreadsheet | Adds developer metadata with the specified key and visibility to the spreadsheet. |
add Developer Metadata(key, value) | Spreadsheet | Adds developer metadata with the specified key and value to the spreadsheet. |
add Developer Metadata(key, value, visibility) | Spreadsheet | Adds developer metadata with the specified key, value, and visibility to the spreadsheet. |
add Editor(emailAddress) | Spreadsheet | Adds the given user to the list of editors for the Spreadsheet . |
add Editor(user) | Spreadsheet | Adds the given user to the list of editors for the Spreadsheet . |
add Editors(emailAddresses) | Spreadsheet | Adds the given array of users to the list of editors for the Spreadsheet . |
add Menu(name, subMenus) | void | Creates a new menu in the Spreadsheet UI. |
add Viewer(emailAddress) | Spreadsheet | Adds the given user to the list of viewers for the Spreadsheet . |
add Viewer(user) | Spreadsheet | Adds the given user to the list of viewers for the Spreadsheet . |
add Viewers(emailAddresses) | Spreadsheet | Adds the given array of users to the list of viewers for the Spreadsheet . |
append Row(rowContents) | Sheet | Appends a row to the bottom of the current data region in the sheet. |
auto Resize Column(columnPosition) | Sheet | Sets the width of the given column to fit its contents. |
copy(name) | Spreadsheet | Copies the spreadsheet and returns the new one. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a Developer Metadata Finder for finding developer metadata within the scope of this spreadsheet. |
create Text Finder(findText) | Text Finder | Creates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet. |
delete Active Sheet() | Sheet | Deletes the currently active sheet. |
delete Column(columnPosition) | Sheet | Deletes the column at the given column position. |
delete Columns(columnPosition, howMany) | void | Deletes a number of columns starting at the given column position. |
delete Row(rowPosition) | Sheet | Deletes the row at the given row position. |
delete Rows(rowPosition, howMany) | void | Deletes a number of rows starting at the given row position. |
delete Sheet(sheet) | void | Deletes the specified sheet. |
duplicate Active Sheet() | Sheet | Duplicates the active sheet and makes it the active sheet. |
get Active Cell() | Range | Returns the active cell in this sheet. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Active Sheet() | Sheet | Gets the active sheet in a spreadsheet. |
get As(contentType) | Blob | دادههای درون این شیء را به صورت یک blob تبدیلشده به نوع محتوای مشخصشده، برمیگرداند. |
get Bandings() | Banding[] | Returns all the bandings in this spreadsheet. |
get Blob() | Blob | دادههای درون این شیء را به صورت یک blob برمیگرداند. |
get Column Width(columnPosition) | Integer | Gets the width in pixels of the given column. |
get Current Cell() | Range |null | Returns the current cell in the active sheet or null if there is no current cell. |
get Data Range() | Range | Returns a Range corresponding to the dimensions in which data is present. |
get Data Source Formulas() | Data Source Formula[] | Gets all the data source formulas. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables. |
get Data Source Refresh Schedules() | Data Source Refresh Schedule[] | Gets the refresh schedules of this spreadsheet. |
get Data Source Sheets() | Data Source Sheet[] | Returns all the data source sheets in the spreadsheet. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables. |
get Data Sources() | Data Source[] | Returns all the data sources in the spreadsheet. |
get Developer Metadata() | Developer Metadata[] | Gets the developer metadata associated with the top-level spreadsheet. |
get Editors() | User[] | Gets the list of editors for this Spreadsheet . |
get Form Url() | String | Returns the URL for the form that sends its responses to this spreadsheet, or null if this spreadsheet has no associated form. |
get Frozen Columns() | Integer | Returns the number of frozen columns. |
get Frozen Rows() | Integer | Returns the number of frozen rows. |
get Id() | String | Gets a unique identifier for this spreadsheet. |
get Images() | Over Grid Image[] | Returns all over-the-grid images on the sheet. |
get Iterative Calculation Convergence Threshold() | Number | Returns the threshold value used during iterative calculation. |
get Last Column() | Integer | Returns the position of the last column that has content. |
get Last Row() | Integer | Returns the position of the last row that has content. |
get Max Iterative Calculation Cycles() | Integer | Returns the maximum number of iterations to use during iterative calculation. |
get Name() | String | Gets the name of the document. |
get Named Ranges() | Named Range[] | Gets all the named ranges in this spreadsheet. |
get Num Sheets() | Integer | Returns the number of sheets in this spreadsheet. |
get Owner() | User | Returns the owner of the document, or null for a document in a shared drive. |
get Predefined Spreadsheet Themes() | Spreadsheet Theme[] | Returns the list of predefined themes. |
get Protections(type) | Protection[] | Gets an array of objects representing all protected ranges or sheets in the spreadsheet. |
get Range(a1Notation) | Range | Returns the range as specified in A1 notation or R1C1 notation. |
get Range By Name(name) | Range | Returns a named range, or null if no range with the given name is found. |
get Range List(a1Notations) | Range List | Returns the Range List collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations. |
get Recalculation Interval() | Recalculation Interval | Returns the calculation interval for this spreadsheet. |
get Row Height(rowPosition) | Integer | Gets the height in pixels of the given row. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Sheet By Id(id) | Sheet |null | Gets the sheet with the given ID. |
get Sheet By Name(name) | Sheet | Returns a sheet with the given name. |
get Sheet Id() | Integer | Returns the ID of the sheet represented by this object. |
get Sheet Name() | String | Returns the sheet name. |
get Sheet Values(startRow, startColumn, numRows, numColumns) | Object[][] | Returns the rectangular grid of values for this range starting at the given coordinates. |
get Sheets() | Sheet[] | Gets all the sheets in this spreadsheet. |
get Spreadsheet Locale() | String | Gets the spreadsheet locale. |
get Spreadsheet Theme() | Spreadsheet Theme |null | Returns the current theme of the spreadsheet, or null if no theme is applied. |
get Spreadsheet Time Zone() | String | Gets the time zone for the spreadsheet. |
get Url() | String | Returns the URL for the given spreadsheet. |
get Viewers() | User[] | Gets the list of viewers and commenters for this Spreadsheet . |
hide Column(column) | void | Hides the column or columns in the given range. |
hide Row(row) | void | Hides the rows in the given range. |
insert Column After(afterPosition) | Sheet | Inserts a column after the given column position. |
insert Column Before(beforePosition) | Sheet | Inserts a column before the given column position. |
insert Columns After(afterPosition, howMany) | Sheet | Inserts a given number of columns after the given column position. |
insert Columns Before(beforePosition, howMany) | Sheet | Inserts a number of columns before the given column position. |
insert Data Source Sheet(spec) | Data Source Sheet | Inserts a new Data Source Sheet in the spreadsheet and starts data execution. |
insert Image(blobSource, column, row) | Over Grid Image | Inserts a Spreadsheet as an image in the document at a given row and column. |
insert Image(blobSource, column, row, offsetX, offsetY) | Over Grid Image | Inserts a Spreadsheet as an image in the document at a given row and column, with a pixel offset. |
insert Image(url, column, row) | Over Grid Image | Inserts an image in the document at a given row and column. |
insert Image(url, column, row, offsetX, offsetY) | Over Grid Image | Inserts an image in the document at a given row and column, with a pixel offset. |
insert Row After(afterPosition) | Sheet | Inserts a row after the given row position. |
insert Row Before(beforePosition) | Sheet | Inserts a row before the given row position. |
insert Rows After(afterPosition, howMany) | Sheet | Inserts a number of rows after the given row position. |
insert Rows Before(beforePosition, howMany) | Sheet | Inserts a number of rows before the given row position. |
insert Sheet() | Sheet | Inserts a new sheet into the spreadsheet, using a default sheet name. |
insert Sheet(sheetIndex) | Sheet | Inserts a new sheet into the spreadsheet at the given index. |
insert Sheet(sheetIndex, options) | Sheet | Inserts a new sheet into the spreadsheet at the given index and uses optional advanced arguments. |
insert Sheet(options) | Sheet | Inserts a new sheet into the spreadsheet, using a default sheet name and optional advanced arguments. |
insert Sheet(sheetName) | Sheet | Inserts a new sheet into the spreadsheet with the given name. |
insert Sheet(sheetName, sheetIndex) | Sheet | Inserts a new sheet into the spreadsheet with the given name at the given index. |
insert Sheet(sheetName, sheetIndex, options) | Sheet | Inserts a new sheet into the spreadsheet with the given name at the given index and uses optional advanced arguments. |
insert Sheet(sheetName, options) | Sheet | Inserts a new sheet into the spreadsheet with the given name and uses optional advanced arguments. |
insert Sheet With Data Source Table(spec) | Sheet | Inserts a new sheet in the spreadsheet, creates a Data Source Table spanning the entire sheet with the given data source specification, and starts data execution. |
is Column Hidden By User(columnPosition) | Boolean | Returns whether the given column is hidden by the user. |
is Iterative Calculation Enabled() | Boolean | Returns whether iterative calculation is activated in this spreadsheet. |
is Row Hidden By Filter(rowPosition) | Boolean | Returns whether the given row is hidden by a filter (not a filter view). |
is Row Hidden By User(rowPosition) | Boolean | Returns whether the given row is hidden by the user. |
move Active Sheet(pos) | void | Moves the active sheet to the given position in the list of sheets. |
move Chart To Object Sheet(chart) | Sheet | Creates a new Sheet Type.OBJECT sheet and moves the provided chart to it. |
refresh All Data Sources() | void | Refreshes all supported data sources and their linked data source objects, skipping invalid data source objects. |
remove Editor(emailAddress) | Spreadsheet | Removes the given user from the list of editors for the Spreadsheet . |
remove Editor(user) | Spreadsheet | Removes the given user from the list of editors for the Spreadsheet . |
remove Menu(name) | void | Removes a menu that was added by add Menu(name, subMenus) . |
remove Named Range(name) | void | Deletes a named range with the given name. |
remove Viewer(emailAddress) | Spreadsheet | Removes the given user from the list of viewers and commenters for the Spreadsheet . |
remove Viewer(user) | Spreadsheet | Removes the given user from the list of viewers and commenters for the Spreadsheet . |
rename(newName) | void | Renames the document. |
rename Active Sheet(newName) | void | Renames the current active sheet to the given new name. |
reset Spreadsheet Theme() | Spreadsheet Theme | Removes the applied theme and sets the default theme on the spreadsheet. |
set Active Range(range) | Range | Sets the specified range as the active range in the active sheet, with the top left cell in the range as the current cell . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges in the active sheet. |
set Active Selection(range) | Range | Sets the active selection region for this sheet. |
set Active Selection(a1Notation) | Range | Sets the active selection, as specified in A1 notation or R1C1 notation. |
set Active Sheet(sheet) | Sheet | Sets the given sheet to be the active sheet in the spreadsheet. |
set Active Sheet(sheet, restoreSelection) | Sheet | Sets the given sheet to be the active sheet in the spreadsheet, with an option to restore the most recent selection within that sheet. |
set Column Width(columnPosition, width) | Sheet | Sets the width of the given column in pixels. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
set Frozen Columns(columns) | void | Freezes the given number of columns. |
set Frozen Rows(rows) | void | Freezes the given number of rows. |
set Iterative Calculation Convergence Threshold(minThreshold) | Spreadsheet | Sets the minimum threshold value for iterative calculation. |
set Iterative Calculation Enabled(isEnabled) | Spreadsheet | Sets whether iterative calculation is activated in this spreadsheet. |
set Max Iterative Calculation Cycles(maxIterations) | Spreadsheet | Sets the maximum number of calculation iterations that should be performed during iterative calculation. |
set Named Range(name, range) | void | Names a range. |
set Recalculation Interval(recalculationInterval) | Spreadsheet | Sets how often this spreadsheet should recalculate. |
set Row Height(rowPosition, height) | Sheet | Sets the row height of the given row in pixels. |
set Spreadsheet Locale(locale) | void | Sets the spreadsheet locale. |
set Spreadsheet Theme(theme) | Spreadsheet Theme | Sets a theme on the spreadsheet. |
set Spreadsheet Time Zone(timezone) | void | Sets the time zone for the spreadsheet. |
show(userInterface) | void | Displays a custom user interface component in a dialog centered in the user's browser's viewport. |
sort(columnPosition) | Sheet | Sorts a sheet by column, ascending. |
sort(columnPosition, ascending) | Sheet | Sorts a sheet by column. |
toast(msg) | void | Shows a popup window in the lower right corner of the spreadsheet with the given message. |
toast(msg, title) | void | Shows a popup window in the lower right corner of the spreadsheet with the given message and title. |
toast(msg, title, timeoutSeconds) | void | Shows a popup window in the lower right corner of the spreadsheet with the given title and message, that stays visible for a certain length of time. |
unhide Column(column) | void | Unhides the column in the given range. |
unhide Row(row) | void | Unhides the row in the given range. |
update Menu(name, subMenus) | void | Updates a menu that was added by add Menu(name, subMenus) . |
wait For All Data Executions Completion(timeoutInSeconds) | void | Waits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds. |
Spreadsheet App
خواص
| ملک | نوع | توضیحات |
|---|---|---|
Auto Fill Series | Auto Fill Series | An enumeration of the types of series used to calculate auto-filled values. |
Banding Theme | Banding Theme | An enumeration of the possible banding themes. |
Boolean Criteria | Boolean Criteria | An enumeration of conditional formatting boolean criteria. |
Border Style | Border Style | An enumeration of the valid styles for setting borders on a Range . |
Color Type | Color Type | An enumeration of possible color types. |
Copy Paste Type | Copy Paste Type | An enumeration of the possible paste types. |
Data Execution Error Code | Data Execution Error Code | An enumeration of the possible data execution error codes. |
Data Execution State | Data Execution State | An enumeration of the possible data execution states. |
Data Source Parameter Type | Data Source Parameter Type | An enumeration of the possible data source parameter types. |
Data Source Refresh Scope | Data Source Refresh Scope | An enumeration of possible data source refresh scopes. |
Data Source Type | Data Source Type | An enumeration of the possible data source types. |
Data Validation Criteria | Data Validation Criteria | An enumeration representing the data validation criteria that can be set on a range. |
Date Time Grouping Rule Type | Date Time Grouping Rule Type | An enumeration of date time grouping rule. |
Developer Metadata Location Type | Developer Metadata Location Type | An enumeration of possible developer metadata location types. |
Developer Metadata Visibility | Developer Metadata Visibility | An enumeration of the possible developer metadata visibilities. |
Dimension | Dimension | An enumeration of the possible dimensions of a spreadsheet. |
Direction | Direction | A enumeration of the possible directions that one can move within a spreadsheet using the arrow keys. |
Frequency Type | Frequency Type | An enumeration of possible frequency types. |
Group Control Toggle Position | Group Control Toggle Position | An enumeration of the positions that the group control toggle can be in. |
Interpolation Type | Interpolation Type | An enumeration of conditional format gradient interpolation types. |
Pivot Table Summarize Function | Pivot Table Summarize Function | An enumeration of the functions that may be used to summarize values in a pivot table. |
Pivot Value Display Type | Pivot Value Display Type | An enumeration of the ways that a pivot value may be displayed. |
Protection Type | Protection Type | An enumeration representing the parts of a spreadsheet that can be protected from edits. |
Recalculation Interval | Recalculation Interval | An enumeration of the possible intervals that can be used in spreadsheet recalculation. |
Relative Date | Relative Date | An enumeration of relative date options for calculating a value to be used in date-based Boolean Criteria . |
Sheet Type | Sheet Type | An enumeration of the different types of sheets that can exist in a spreadsheet. |
Sort Order | Sort Order | An enumeration of sort order. |
Text Direction | Text Direction | An enumeration of valid text directions. |
Text To Columns Delimiter | Text To Columns Delimiter | An enumeration of the preset delimiters for split text to columns. |
Theme Color Type | Theme Color Type | An enumeration of possible theme color types. |
Value Type | Value Type | An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service. |
Wrap Strategy | Wrap Strategy | An enumeration of the strategies used for wrapping cells. |
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
create(name) | Spreadsheet | Creates a new spreadsheet with the given name. |
create(name, rows, columns) | Spreadsheet | Creates a new spreadsheet with the given name and the specified number of rows and columns. |
enable All Data Sources Execution() | void | Turns data execution on for all types of data sources. |
enable Big Query Execution() | void | Turns data execution on for BigQuery data sources. |
enable Looker Execution() | void | Turns data execution on for Looker data sources. |
flush() | void | Applies all pending Spreadsheet changes. |
get Active() | Spreadsheet | Returns the currently active spreadsheet, or null if there is none. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no ranges selected. |
get Active Sheet() | Sheet | Gets the active sheet in a spreadsheet. |
get Active Spreadsheet() | Spreadsheet | Returns the currently active spreadsheet, or null if there is none. |
get Current Cell() | Range |null | Returns the current (highlighted) cell that is selected in one of the active ranges in the active sheet or null if there is no current cell. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Ui() | Ui | Returns an instance of the spreadsheet's user-interface environment that allows the script to add features like menus, dialogs, and sidebars. |
new Cell Image() | Cell Image Builder | Creates a builder for a Cell Image . |
new Color() | Color Builder | Creates a builder for a Color . |
new Conditional Format Rule() | Conditional Format Rule Builder | Creates a builder for a conditional formatting rule. |
new Data Source Spec() | Data Source Spec Builder | Creates a builder for a Data Source Spec . |
new Data Validation() | Data Validation Builder | Creates a builder for a data validation rule. |
new Filter Criteria() | Filter Criteria Builder | Creates a builder for a Filter Criteria . |
new Rich Text Value() | Rich Text Value Builder | Creates a builder for a Rich Text value. |
new Text Style() | Text Style Builder | Creates a builder for a text style. |
open(file) | Spreadsheet | Opens the spreadsheet that corresponds to the given File object. |
open By Id(id) | Spreadsheet | Opens the spreadsheet with the given ID. |
open By Url(url) | Spreadsheet | Opens the spreadsheet with the given URL. |
set Active Range(range) | Range | Sets the specified range as the active range , with the top left cell in the range as the current cell . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges . |
set Active Sheet(sheet) | Sheet | Sets the active sheet in a spreadsheet. |
set Active Sheet(sheet, restoreSelection) | Sheet | Sets the active sheet in a spreadsheet, with the option to restore the most recent selection within that sheet. |
set Active Spreadsheet(newActiveSpreadsheet) | void | Sets the active spreadsheet. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
Spreadsheet Theme
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Concrete Color(themeColorType) | Color | Returns the concrete Color for a valid theme color type. |
get Font Family() | String|null | Returns the font family of the theme, or null if it's a null theme. |
get Theme Colors() | Theme Color Type[] | Returns a list of all possible theme color types for the current theme. |
set Concrete Color(themeColorType, color) | Spreadsheet Theme | Sets the concrete color associated with the Theme Color Type in this color scheme to the given color. |
set Concrete Color(themeColorType, red, green, blue) | Spreadsheet Theme | Sets the concrete color associated with the Theme Color Type in this color scheme to the given color in RGB format. |
set Font Family(fontFamily) | Spreadsheet Theme | Sets the font family for the theme. |
Text Direction
خواص
| ملک | نوع | توضیحات |
|---|---|---|
LEFT_TO_RIGHT | Enum | Left-to-right text direction. |
RIGHT_TO_LEFT | Enum | Right-to-left text direction. |
Text Finder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
find All() | Range[] | Returns all cells matching the search criteria. |
find Next() | Range | Returns the next cell matching the search criteria. |
find Previous() | Range | Returns the previous cell matching the search criteria. |
get Current Match() | Range | Returns the current cell matching the search criteria. |
ignore Diacritics(ignoreDiacritics) | Text Finder | If true , configures the search to ignore diacritics while matching; otherwise the search matches diacritics. |
match Case(matchCase) | Text Finder | If true , configures the search to match the search text's case exactly, otherwise the search defaults to case-insensitive matching. |
match Entire Cell(matchEntireCell) | Text Finder | If true , configures the search to match the entire contents of a cell; otherwise, the search defaults to partial matching. |
match Formula Text(matchFormulaText) | Text Finder | If true , configures the search to return matches that appear within formula text; otherwise cells with formulas are considered based on their displayed value. |
replace All With(replaceText) | Integer | Replaces all matches with the specified text. |
replace With(replaceText) | Integer | Replaces the search text in the currently matched cell with the specified text and returns the number of occurrences replaced. |
start From(startRange) | Text Finder | Configures the search to start searching immediately after the specified cell range. |
use Regular Expression(useRegEx) | Text Finder | If true , configures the search to interpret the search string as a regular expression; otherwise the search interprets the search string as normal text. |
Text Rotation
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Degrees() | Integer | Gets the angle between standard text orientation and the current text orientation. |
is Vertical() | Boolean | Returns true if the text is stacked vertically; returns false otherwise. |
Text Style
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Text Style Builder | Creates a text style builder initialized with the values of this text style. |
get Font Family() | String | Gets the font family of the text. |
get Font Size() | Integer | Gets the font size of the text in points. |
get Foreground Color Object() | Color |null | Gets the font color of the text. |
is Bold() | Boolean | Gets whether or not the text is bold. |
is Italic() | Boolean | Gets whether or not the cell is italic. |
is Strikethrough() | Boolean | Gets whether or not the cell has strikethrough. |
is Underline() | Boolean | Gets whether or not the cell is underlined. |
Text Style Builder
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
build() | Text Style | Creates a text style from this builder. |
set Bold(bold) | Text Style Builder | Sets whether or not the text is bold. |
set Font Family(fontFamily) | Text Style Builder | Sets the text font family, such as "Arial". |
set Font Size(fontSize) | Text Style Builder | Sets the text font size in points. |
set Foreground Color(cssString) | Text Style Builder | Sets the text font color. |
set Foreground Color Object(color) | Text Style Builder | Sets the text font color. |
set Italic(italic) | Text Style Builder | Sets whether or not the text is italic. |
set Strikethrough(strikethrough) | Text Style Builder | Sets whether or not the text has strikethrough. |
set Underline(underline) | Text Style Builder | Sets whether or not the text is underlined. |
Text To Columns Delimiter
خواص
| ملک | نوع | توضیحات |
|---|---|---|
COMMA | Enum | "," delimiter. |
SEMICOLON | Enum | ";" delimiter. |
PERIOD | Enum | "." delimiter. |
SPACE | Enum | " " delimiter. |
Theme Color
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
get Color Type() | Color Type | Get the type of this color. |
get Theme Color Type() | Theme Color Type | Gets the theme color type of this color. |
Theme Color Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
UNSUPPORTED | Enum | Represents a theme color that is not supported. |
TEXT | Enum | Represents the text color. |
BACKGROUND | Enum | Represents the color to use for chart's background. |
ACCENT1 | Enum | Represents the first accent color. |
ACCENT2 | Enum | Represents the second accent color. |
ACCENT3 | Enum | Represents the third accent color. |
ACCENT4 | Enum | Represents the fourth accent color. |
ACCENT5 | Enum | Represents the fifth accent color. |
ACCENT6 | Enum | Represents the sixth accent color. |
HYPERLINK | Enum | Represents the color to use for hyperlinks. |
Value Type
خواص
| ملک | نوع | توضیحات |
|---|---|---|
IMAGE | Enum | The value type when the cell contains an image. |
Wrap Strategy
خواص
| ملک | نوع | توضیحات |
|---|---|---|
WRAP | Enum | Wrap lines that are longer than the cell width onto a new line. |
OVERFLOW | Enum | Overflow lines into the next cell, so long as that cell is empty. |
CLIP | Enum | Clip lines that are longer than the cell width. |