Spreadsheet Service

صفحه گسترده

این سرویس به اسکریپت‌ها اجازه می‌دهد فایل‌های Google Sheets را ایجاد، دسترسی و اصلاح کنند. همچنین به راهنمای ذخیره داده ها در صفحات گسترده مراجعه کنید.

گاهی اوقات، عملیات صفحه‌گسترده برای بهبود عملکرد با هم ترکیب می‌شوند، مانند زمانی که چندین تماس با یک متد انجام می‌شود. اگر می‌خواهید مطمئن شوید که همه تغییرات معلق بلافاصله انجام می‌شوند، به عنوان مثال برای نشان دادن اطلاعات کاربران در حین اجرای یک اسکریپت، SpreadsheetApp.flush() را فراخوانی کنید.

کلاس ها

نام توضیح مختصر
AutoFillSeries شمارشی از انواع سری های مورد استفاده برای محاسبه مقادیر پر شده خودکار.
Banding به باندها، الگوهای رنگی اعمال شده روی ردیف ها یا ستون های یک محدوده دسترسی داشته باشید و آن ها را اصلاح کنید.
BandingTheme شمارشی از مضامین باندینگ.
BigQueryDataSourceSpec به مشخصات منبع داده BigQuery موجود دسترسی داشته باشید.
BigQueryDataSourceSpecBuilder سازنده BigQueryDataSourceSpecBuilder .
BooleanCondition به شرایط بولی در ConditionalFormatRules دسترسی پیدا کنید.
BooleanCriteria شمارشی نشان دهنده معیارهای بولی است که می تواند در قالب شرطی یا فیلتر استفاده شود.
BorderStyle سبک‌هایی که می‌توانند با استفاده از Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) روی یک محدوده تنظیم شوند.
CellImage تصویری را برای افزودن به یک سلول نشان می دهد.
CellImageBuilder سازنده برای CellImage .
Color نمایشی برای یک رنگ
ColorBuilder سازنده برای ColorBuilder .
ConditionalFormatRule دسترسی به قوانین قالب بندی شرطی
ConditionalFormatRuleBuilder سازنده قوانین قالب مشروط.
ContainerInfo به موقعیت نمودار در یک صفحه دسترسی داشته باشید.
CopyPasteType شمارشی از انواع خمیر مخصوص ممکن.
DataExecutionErrorCode شمارشی از کدهای خطای اجرای داده ها.
DataExecutionState شمارشی از حالات اجرای داده ها.
DataExecutionStatus وضعیت اجرای داده ها
DataSource به منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید.
DataSourceChart به نمودار منبع داده موجود دسترسی داشته باشید و آن را تغییر دهید.
DataSourceColumn به ستون منبع داده دسترسی داشته باشید و آن را تغییر دهید.
DataSourceFormula به فرمول های منبع داده موجود دسترسی داشته باشید و آن ها را اصلاح کنید.
DataSourceParameter دسترسی به پارامترهای منبع داده موجود
DataSourceParameterType شمارش انواع پارامترهای منبع داده
DataSourcePivotTable به جدول محوری منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید.
DataSourceRefreshSchedule به یک برنامه به‌روزرسانی موجود دسترسی داشته باشید و آن را تغییر دهید.
DataSourceRefreshScheduleFrequency به فرکانس برنامه بازخوانی دسترسی داشته باشید، که مشخص می‌کند چند وقت یکبار و چه زمانی به‌روزرسانی شود.
DataSourceRefreshScope شمارشی از حوزه‌های تازه‌سازی.
DataSourceSheet به برگه منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید.
DataSourceSheetFilter به فیلتر برگه منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید.
DataSourceSpec دسترسی به تنظیمات کلی یک منبع داده موجود.
DataSourceSpecBuilder سازنده برای DataSourceSpec .
DataSourceTable به جدول منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید.
DataSourceTableColumn به ستون موجود در DataSourceTable دسترسی داشته باشید و آن را تغییر دهید.
DataSourceTableFilter به فیلتر جدول منبع داده موجود دسترسی پیدا کرده و آن را اصلاح کنید.
DataSourceType شمارش انواع منابع داده
DataValidation دسترسی به قوانین اعتبارسنجی داده ها
DataValidationBuilder سازنده قوانین اعتبارسنجی داده ها.
DataValidationCriteria شمارشی که معیارهای اعتبارسنجی داده را نشان می دهد که می تواند روی یک محدوده تنظیم شود.
DateTimeGroupingRule به یک قانون گروه بندی تاریخ-زمان موجود دسترسی داشته باشید.
DateTimeGroupingRuleType انواع قانون گروه بندی تاریخ-زمان
DeveloperMetadata به ابرداده توسعه‌دهنده دسترسی داشته باشید و آن را تغییر دهید.
DeveloperMetadataFinder ابرداده توسعه دهنده را در یک صفحه گسترده جستجو کنید.
DeveloperMetadataLocation به اطلاعات موقعیت مکانی ابرداده توسعه دهنده دسترسی داشته باشید.
DeveloperMetadataLocationType شمارشی از انواع مکان‌های ابرداده توسعه‌دهنده.
DeveloperMetadataVisibility شمارشی از انواع مشاهده فراداده توسعه‌دهنده.
Dimension شمارشی از جهت‌های ممکن که داده‌ها را می‌توان در یک صفحه‌گسترده ذخیره کرد.
Direction شمارشی که نشان‌دهنده جهت‌های احتمالی است که می‌توان با استفاده از کلیدهای جهت دار در یک صفحه گسترده حرکت کرد.
Drawing یک طراحی روی یک صفحه را در یک صفحه گسترده نشان می دهد.
EmbeddedAreaChartBuilder سازنده برای نمودارهای منطقه.
EmbeddedBarChartBuilder سازنده نمودارهای میله ای
EmbeddedChart نموداری را نشان می دهد که در یک صفحه گسترده جاسازی شده است.
EmbeddedChartBuilder Builder برای ویرایش EmbeddedChart استفاده می‌کرد.
EmbeddedColumnChartBuilder سازنده نمودارهای ستونی.
EmbeddedComboChartBuilder سازنده نمودارهای ترکیبی.
EmbeddedHistogramChartBuilder سازنده نمودارهای هیستوگرام.
EmbeddedLineChartBuilder سازنده برای نمودارهای خطی.
EmbeddedPieChartBuilder سازنده نمودارهای دایره ای.
EmbeddedScatterChartBuilder سازنده نمودارهای پراکندگی.
EmbeddedTableChartBuilder سازنده برای نمودارهای جدول.
Filter از این کلاس برای اصلاح فیلترهای موجود در صفحات Grid ، نوع پیش فرض برگه استفاده کنید.
FilterCriteria از این کلاس برای به دست آوردن اطلاعات یا کپی کردن معیارهای فیلترهای موجود استفاده کنید.
FilterCriteriaBuilder برای افزودن معیار به فیلتر، باید موارد زیر را انجام دهید:
  1. سازنده معیارها را با استفاده از SpreadsheetApp.newFilterCriteria() ایجاد کنید.
  2. با استفاده از متدهای این کلاس تنظیمات را به سازنده اضافه کنید.
  3. از build() برای جمع آوری معیارها با تنظیمات مشخص شده خود استفاده کنید.
FrequencyType شمارش انواع فرکانس
GradientCondition دسترسی به شرایط گرادیان (رنگی) در ConditionalFormatRuleApis .
Group دسترسی و اصلاح گروه های صفحه گسترده
GroupControlTogglePosition شمارشی نشان دهنده موقعیت های احتمالی که یک ضامن کنترل گروهی می تواند داشته باشد.
InterpolationType شمارشی که گزینه‌های درون‌یابی را برای محاسبه مقدار مورد استفاده در GradientCondition در ConditionalFormatRule نشان می‌دهد.
NamedRange محدوده های نامگذاری شده را در یک صفحه گسترده ایجاد، دسترسی و اصلاح کنید.
OverGridImage تصویری را روی شبکه در یک صفحه گسترده نشان می دهد.
PageProtection به برگه‌های محافظت شده در نسخه قدیمی Google Sheets دسترسی داشته باشید و آنها را اصلاح کنید.
PivotFilter دسترسی و اصلاح فیلترهای جدول محوری
PivotGroup به گروه‌های شکست جدول محوری دسترسی داشته باشید و آن‌ها را اصلاح کنید.
PivotGroupLimit دسترسی و تغییر محدودیت گروه جدول محوری.
PivotTable به جداول محوری دسترسی داشته باشید و آنها را اصلاح کنید.
PivotTableSummarizeFunction شمارشی از توابع که داده های جدول محوری را خلاصه می کند.
PivotValue به گروه‌های ارزش در جداول محوری دسترسی داشته باشید و آن‌ها را تغییر دهید.
PivotValueDisplayType شمارش راه هایی برای نمایش یک مقدار محوری به عنوان تابعی از مقدار دیگر.
Protection به محدوده ها و برگه های محافظت شده دسترسی داشته باشید و آنها را اصلاح کنید.
ProtectionType شمارشی که نمایانگر بخش‌هایی از صفحه‌گسترده است که می‌توان از ویرایش‌ها محافظت کرد.
Range دسترسی و اصلاح محدوده های صفحه گسترده.
RangeList مجموعه ای از یک یا چند نمونه Range در همان برگه.
RecalculationInterval شمارشی که نشان دهنده فواصل احتمالی مورد استفاده در محاسبه مجدد صفحه گسترده است.
RelativeDate شمارشی که گزینه‌های تاریخ نسبی را برای محاسبه مقدار مورد استفاده در BooleanCriteria مبتنی بر تاریخ نشان می‌دهد.
RichTextValue یک رشته متن تلطیف شده که برای نمایش متن سلول استفاده می شود.
RichTextValueBuilder سازنده مقادیر Rich Text.
Selection به انتخاب فعال فعلی در برگه فعال دسترسی پیدا کنید.
Sheet به صفحات گسترده دسترسی داشته باشید و آنها را اصلاح کنید.
SheetType انواع مختلف برگه هایی که می توانند در یک صفحه گسترده وجود داشته باشند.
Slicer نشان دهنده یک برش دهنده است که برای فیلتر کردن محدوده ها، نمودارها و جداول محوری به روشی غیرهمکاری استفاده می شود.
SortOrder شمارشی که نشان دهنده ترتیب مرتب سازی است.
SortSpec مشخصات مرتب سازی
Spreadsheet به فایل‌های Google Sheets دسترسی داشته باشید و آن‌ها را تغییر دهید.
SpreadsheetApp به فایل‌های Google Sheets دسترسی پیدا کرده و ایجاد کنید.
SpreadsheetTheme به تم های موجود دسترسی داشته باشید و آن ها را اصلاح کنید.
TextDirection شمارشی از جهت های متنی.
TextFinder متن را در محدوده، صفحه یا صفحه گسترده پیدا یا جایگزین کنید.
TextRotation به تنظیمات چرخش متن برای یک سلول دسترسی داشته باشید.
TextStyle سبک رندر شده متن در یک سلول.
TextStyleBuilder سازنده برای سبک های متن.
TextToColumnsDelimiter شمارشی از انواع جداکننده های از پیش تعیین شده که می توانند یک ستون متن را به چندین ستون تقسیم کنند.
ThemeColor نمایشی برای رنگ تم.
ThemeColorType فهرستی که ورودی های رنگی مختلف را که در تم ها پشتیبانی می شوند را توصیف می کند.
ValueType شمارشی از انواع مقادیر که توسط Range.getValue() و Range.getValues() از کلاس Range سرویس صفحه گسترده برگردانده شده است.
WrapStrategy شمارشی از راهبردهای مورد استفاده برای مدیریت بسته بندی متن سلول.

AutoFillSeries

خواص

ویژگی تایپ کنید شرح
DEFAULT_SERIES Enum پیش فرض
ALTERNATE_SERIES Enum پر کردن خودکار با این تنظیم باعث می شود که سلول های خالی در محدوده گسترش یافته با کپی هایی از مقادیر موجود پر شوند.

Banding

مواد و روش ها

روش نوع برگشت توضیح مختصر
copyTo(range) Banding این باند را در محدوده دیگری کپی می کند.
getFirstColumnColorObject() Color اولین رنگ ستون متناوب در باند را برمی‌گرداند یا اگر رنگی تنظیم نشده باشد، null .
getFirstRowColorObject() Color اولین رنگ ردیف متناوب را برمی‌گرداند یا اگر رنگی تنظیم نشده باشد null .
getFooterColumnColorObject() Color رنگ آخرین ستون در باند را برمی‌گرداند، یا اگر رنگی تنظیم نشده باشد null .
getFooterRowColorObject() Color آخرین رنگ ردیف را در نواربندی برمی‌گرداند، یا اگر رنگی تنظیم نشده باشد، null .
getHeaderColumnColorObject() Color رنگ اولین ستون در باند را برمی‌گرداند یا اگر رنگی تنظیم نشده باشد، null .
getHeaderRowColorObject() Color اگر رنگی تنظیم نشده باشد، رنگ ردیف سرصفحه یا null را برمی‌گرداند.
getRange() Range محدوده این باند را برمی‌گرداند.
getSecondColumnColorObject() Color دومین رنگ ستون متناوب را در نواربندی برمی‌گرداند، یا اگر رنگی تنظیم نشده باشد، null .
getSecondRowColorObject() Color دومین رنگ ردیف متناوب را برمی‌گرداند یا اگر رنگی تنظیم نشده باشد null .
remove() void این باند را حذف می کند.
setFirstColumnColor(color) Banding اولین رنگ ستون را که متناوب است را تنظیم می کند.
setFirstColumnColorObject(color) Banding اولین رنگ ستون متناوب را در نواربندی تنظیم می کند.
setFirstRowColor(color) Banding رنگ ردیف اول را که متناوب است را تنظیم می کند.
setFirstRowColorObject(color) Banding اولین رنگ ردیف متناوب را در نواربندی تنظیم می کند.
setFooterColumnColor(color) Banding رنگ آخرین ستون را تنظیم می کند.
setFooterColumnColorObject(color) Banding رنگ آخرین ستون در باند را تنظیم می کند.
setFooterRowColor(color) Banding رنگ ردیف آخر را تنظیم می کند.
setFooterRowColorObject(color) Banding رنگ ردیف پاورقی را در باند تنظیم می کند.
setHeaderColumnColor(color) Banding رنگ ستون هدر را تنظیم می کند.
setHeaderColumnColorObject(color) Banding رنگ ستون هدر را تنظیم می کند.
setHeaderRowColor(color) Banding رنگ ردیف سرصفحه را تنظیم می کند.
setHeaderRowColorObject(color) Banding رنگ ردیف سرصفحه را تنظیم می کند.
setRange(range) Banding محدوده این باند را تنظیم می کند.
setSecondColumnColor(color) Banding رنگ ستون دوم را که متناوب است را تنظیم می کند.
setSecondColumnColorObject(color) Banding دومین رنگ ستون متناوب را در نواربندی تنظیم می کند.
setSecondRowColor(color) Banding رنگ ردیف دوم را که متناوب است تنظیم می کند.
setSecondRowColorObject(color) Banding دومین رنگ متناوب را در نواربندی تنظیم می کند.

BandingTheme

خواص

ویژگی تایپ کنید شرح
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 تم باند صورتی.

BigQueryDataSourceSpec

مواد و روش ها

روش نوع برگشت توضیح مختصر
copy() DataSourceSpecBuilder یک DataSourceSpecBuilder بر اساس تنظیمات این منبع داده ایجاد می کند.
getDatasetId() String شناسه مجموعه داده BigQuery را دریافت می کند.
getParameters() DataSourceParameter[] پارامترهای منبع داده را دریافت می کند.
getProjectId() String شناسه پروژه صورتحساب را دریافت می کند.
getRawQuery() String رشته پرس و جو خام را دریافت می کند.
getTableId() String شناسه جدول BigQuery را دریافت می کند.
getTableProjectId() String شناسه پروژه BigQuery را برای جدول دریافت می کند.
getType() DataSourceType نوع منبع داده را دریافت می کند.

BigQueryDataSourceSpecBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
build() DataSourceSpec مشخصات منبع داده را از تنظیمات این سازنده می سازد.
copy() DataSourceSpecBuilder یک DataSourceSpecBuilder بر اساس تنظیمات این منبع داده ایجاد می کند.
getDatasetId() String شناسه مجموعه داده BigQuery را دریافت می کند.
getParameters() DataSourceParameter[] پارامترهای منبع داده را دریافت می کند.
getProjectId() String شناسه پروژه صورتحساب را دریافت می کند.
getRawQuery() String رشته پرس و جو خام را دریافت می کند.
getTableId() String شناسه جدول BigQuery را دریافت می کند.
getTableProjectId() String شناسه پروژه BigQuery را برای جدول دریافت می کند.
getType() DataSourceType نوع منبع داده را دریافت می کند.
removeAllParameters() BigQueryDataSourceSpecBuilder تمام پارامترها را حذف می کند.
removeParameter(parameterName) BigQueryDataSourceSpecBuilder پارامتر مشخص شده را حذف می کند.
setDatasetId(datasetId) BigQueryDataSourceSpecBuilder شناسه مجموعه داده BigQuery را تنظیم می کند.
setParameterFromCell(parameterName, sourceCell) BigQueryDataSourceSpecBuilder پارامتری را اضافه می کند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را به روز می کند.
setProjectId(projectId) BigQueryDataSourceSpecBuilder شناسه پروژه BigQuery صورتحساب را تنظیم می کند.
setRawQuery(rawQuery) BigQueryDataSourceSpecBuilder رشته پرس و جو خام را تنظیم می کند.
setTableId(tableId) BigQueryDataSourceSpecBuilder شناسه جدول BigQuery را تنظیم می کند.
setTableProjectId(projectId) BigQueryDataSourceSpecBuilder شناسه پروژه BigQuery را برای جدول تنظیم می کند.

BooleanCondition

مواد و روش ها

روش نوع برگشت توضیح مختصر
getBackgroundObject() Color رنگ پس زمینه این شرط بولی را دریافت می کند.
getBold() Boolean اگر این شرط بولی متن را پررنگ کند true برمی‌گرداند و اگر این شرط بولی بولدینگ را از متن حذف کند، false برمی‌گرداند.
getCriteriaType() BooleanCriteria نوع معیار قانون را همانطور که در فهرست BooleanCriteria تعریف شده است دریافت می کند.
getCriteriaValues() Object[] آرایه ای از آرگومان ها را برای معیارهای قاعده دریافت می کند.
getFontColorObject() Color رنگ فونت این شرط بولی را دریافت می کند.
getItalic() Boolean اگر این شرط بولی متن را ایتالیک کند true برمی‌گرداند و اگر این شرط بولی حروف کج را از متن حذف کند، false برمی‌گرداند.
getStrikethrough() Boolean اگر این شرط بولی از متن عبور کند true برمی گرداند و اگر این شرط بولی خط خطی را از متن حذف کند، false برمی گرداند.
getUnderline() Boolean اگر این شرط بولی زیر متن زیر خط بکشد true برمی‌گرداند و اگر این شرط بولی خط زیر را از متن حذف کند، false برمی‌گرداند.

BooleanCriteria

خواص

ویژگی تایپ کنید شرح
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 ارزیابی کند.

BorderStyle

خواص

ویژگی تایپ کنید شرح
DOTTED Enum مرزهای خط نقطه.
DASHED Enum مرزهای خط چین
SOLID Enum مرزهای نازک خط جامد.
SOLID_MEDIUM Enum مرزهای خط جامد متوسط.
SOLID_THICK Enum مرزهای خط جامد ضخیم.
DOUBLE Enum دو مرز خط ثابت

CellImage

خواص

ویژگی تایپ کنید شرح
valueType ValueType فیلدی که روی ValueType.IMAGE تنظیم شده است که نشان دهنده نوع مقدار تصویر است.

مواد و روش ها

روش نوع برگشت توضیح مختصر
getAltTextDescription() String توضیحات متن جایگزین را برای این تصویر برمی گرداند.
getAltTextTitle() String عنوان متن جایگزین را برای این تصویر برمی گرداند.
getContentUrl() String یک URL میزبانی شده توسط Google را به تصویر برمی گرداند.
getUrl() String آدرس منبع تصویر را دریافت می کند. اگر URL در دسترس نباشد، null برمی‌گرداند.
toBuilder() CellImageBuilder سازنده ای ایجاد می کند که یک تصویر را به یک نوع مقدار تصویر تبدیل می کند تا بتوانید آن را در یک سلول قرار دهید.

CellImageBuilder

خواص

ویژگی تایپ کنید شرح
valueType ValueType فیلدی که روی ValueType.IMAGE تنظیم شده است که نشان دهنده نوع مقدار تصویر است.

مواد و روش ها

روش نوع برگشت توضیح مختصر
build() CellImage نوع مقدار تصویر مورد نیاز برای افزودن یک تصویر به یک سلول را ایجاد می کند.
getAltTextDescription() String توضیحات متن جایگزین را برای این تصویر برمی گرداند.
getAltTextTitle() String عنوان متن جایگزین را برای این تصویر برمی گرداند.
getContentUrl() String یک URL میزبانی شده توسط Google را به تصویر برمی گرداند.
getUrl() String آدرس منبع تصویر را دریافت می کند. اگر URL در دسترس نباشد، null برمی‌گرداند.
setAltTextDescription(description) CellImage توضیحات متن جایگزین را برای این تصویر تنظیم می کند.
setAltTextTitle(title) CellImage عنوان متن جایگزین را برای این تصویر تنظیم می کند.
setSourceUrl(url) CellImageBuilder URL منبع تصویر را تنظیم می کند.
toBuilder() CellImageBuilder سازنده ای ایجاد می کند که یک تصویر را به یک نوع مقدار تصویر تبدیل می کند تا بتوانید آن را در یک سلول قرار دهید.

Color

مواد و روش ها

روش نوع برگشت توضیح مختصر
asRgbColor() RgbColor این رنگ را به RgbColor تبدیل می کند.
asThemeColor() ThemeColor این رنگ را به ThemeColor تبدیل می کند.
getColorType() ColorType نوع این رنگ را دریافت کنید.

ColorBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
asRgbColor() RgbColor این رنگ را به RgbColor تبدیل می کند.
asThemeColor() ThemeColor این رنگ را به ThemeColor تبدیل می کند.
build() Color یک شی رنگی از تنظیمات ارائه شده به سازنده ایجاد می کند.
getColorType() ColorType نوع این رنگ را دریافت کنید.
setRgbColor(cssString) ColorBuilder به عنوان رنگ RGB تنظیم می شود.
setThemeColor(themeColorType) ColorBuilder به عنوان رنگ تم تنظیم می شود.

ConditionalFormatRule

مواد و روش ها

روش نوع برگشت توضیح مختصر
copy() ConditionalFormatRuleBuilder یک قانون ساز از پیش تنظیم شده را با تنظیمات این قانون برمی گرداند.
getBooleanCondition() BooleanCondition اگر این قانون از معیارهای شرط بولی استفاده کند، اطلاعات BooleanCondition قانون را بازیابی می کند.
getGradientCondition() GradientCondition اگر این قانون از معیارهای شرایط گرادیان استفاده کند، اطلاعات GradientCondition قانون را بازیابی می کند.
getRanges() Range[] محدوده هایی را که این قانون قالب شرطی برای آنها اعمال می شود، بازیابی می کند.

ConditionalFormatRuleBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
build() ConditionalFormatRule یک قانون قالب شرطی از تنظیمات اعمال شده برای سازنده می سازد.
copy() ConditionalFormatRuleBuilder یک قانون ساز از پیش تنظیم شده را با تنظیمات این قانون برمی گرداند.
getBooleanCondition() BooleanCondition اگر این قانون از معیارهای شرط بولی استفاده کند، اطلاعات BooleanCondition قانون را بازیابی می کند.
getGradientCondition() GradientCondition اگر این قانون از معیارهای شرایط گرادیان استفاده کند، اطلاعات GradientCondition قانون را بازیابی می کند.
getRanges() Range[] محدوده هایی را که این قانون قالب شرطی برای آنها اعمال می شود، بازیابی می کند.
setBackground(color) ConditionalFormatRuleBuilder رنگ پس زمینه را برای قالب قانون قالب شرطی تنظیم می کند.
setBackgroundObject(color) ConditionalFormatRuleBuilder رنگ پس زمینه را برای قالب قانون قالب شرطی تنظیم می کند.
setBold(bold) ConditionalFormatRuleBuilder متن پررنگ را برای قالب قاعده قالب شرطی تنظیم می کند.
setFontColor(color) ConditionalFormatRuleBuilder رنگ فونت را برای قالب قاعده قالب شرطی تنظیم می کند.
setFontColorObject(color) ConditionalFormatRuleBuilder رنگ فونت را برای قالب قاعده قالب شرطی تنظیم می کند.
setGradientMaxpoint(color) ConditionalFormatRuleBuilder مقدار حداکثر گرادیان قانون قالب شرطی را پاک می کند و در عوض از حداکثر مقدار در محدوده های قانون استفاده می کند.
setGradientMaxpointObject(color) ConditionalFormatRuleBuilder مقدار حداکثر گرادیان قانون قالب شرطی را پاک می کند و در عوض از حداکثر مقدار در محدوده های قانون استفاده می کند.
setGradientMaxpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای ماکزیمم گرادیان قانون قالب شرطی را تنظیم می کند.
setGradientMaxpointWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای ماکزیمم گرادیان قانون قالب شرطی را تنظیم می کند.
setGradientMidpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای نقطه میانی گرادیان قانون قالب شرطی را تنظیم می کند.
setGradientMidpointWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای نقطه میانی گرادیان قانون قالب شرطی را تنظیم می کند.
setGradientMinpoint(color) ConditionalFormatRuleBuilder مقدار حداقل گرادیان قانون قالب شرطی را پاک می‌کند و در عوض از حداقل مقدار در محدوده‌های قانون استفاده می‌کند.
setGradientMinpointObject(color) ConditionalFormatRuleBuilder مقدار حداقل گرادیان قانون قالب شرطی را پاک می‌کند و در عوض از حداقل مقدار در محدوده‌های قانون استفاده می‌کند.
setGradientMinpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای نقطه گرادیان قانون قالب شرطی را تنظیم می کند.
setGradientMinpointWithValue(color, type, value) ConditionalFormatRuleBuilder فیلدهای نقطه گرادیان قانون قالب شرطی را تنظیم می کند.
setItalic(italic) ConditionalFormatRuleBuilder حالت مورب متن را برای قالب قاعده قالب شرطی تنظیم می کند.
setRanges(ranges) ConditionalFormatRuleBuilder یک یا چند محدوده را تنظیم می کند که این قانون قالب شرطی برای آنها اعمال می شود.
setStrikethrough(strikethrough) ConditionalFormatRuleBuilder خط خطی متن را برای قالب قاعده قالب شرطی تنظیم می کند.
setUnderline(underline) ConditionalFormatRuleBuilder زیرخط متن را برای قالب قاعده قالب شرطی تنظیم می کند.
whenCellEmpty() ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که سلول خالی است راه اندازی شود.
whenCellNotEmpty() ConditionalFormatRuleBuilder قانون قالب مشروط را به گونه ای تنظیم می کند که وقتی سلول خالی نیست راه اندازی شود.
whenDateAfter(date) ConditionalFormatRuleBuilder قاعده قالب شرطی را تنظیم می کند تا زمانی که تاریخ بعد از مقدار داده شده است، راه اندازی شود.
whenDateAfter(date) ConditionalFormatRuleBuilder قاعده قالب شرطی را تنظیم می کند تا زمانی که یک تاریخ بعد از تاریخ نسبی داده شده است، راه اندازی شود.
whenDateBefore(date) ConditionalFormatRuleBuilder قاعده قالب شرطی را تنظیم می کند تا زمانی که تاریخ قبل از تاریخ معین است، راه اندازی شود.
whenDateBefore(date) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که تاریخ قبل از تاریخ نسبی داده شده باشد، راه اندازی شود.
whenDateEqualTo(date) ConditionalFormatRuleBuilder قاعده قالب شرطی را تنظیم می کند تا زمانی که تاریخ برابر با تاریخ معین است، راه اندازی شود.
whenDateEqualTo(date) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که یک تاریخ با تاریخ نسبی داده شده برابر است، راه اندازی شود.
whenFormulaSatisfied(formula) ConditionalFormatRuleBuilder زمانی که فرمول داده شده به true ارزیابی می شود، قانون قالب شرطی را تنظیم می کند تا راه اندازی شود.
whenNumberBetween(start, end) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که یک عدد بین دو مقدار مشخص شده قرار می گیرد یا یکی از آن ها باشد، راه اندازی شود.
whenNumberEqualTo(number) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که یک عدد با مقدار داده شده برابر است، راه اندازی شود.
whenNumberGreaterThan(number) ConditionalFormatRuleBuilder قاعده قالب شرطی را طوری تنظیم می کند که وقتی عددی بزرگتر از مقدار داده شده است، راه اندازی شود.
whenNumberGreaterThanOrEqualTo(number) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که یک عدد بزرگتر یا مساوی با مقدار داده شده باشد، راه اندازی شود.
whenNumberLessThan(number) ConditionalFormatRuleBuilder قاعده قالب شرطی شرطی را تنظیم می کند تا زمانی که عددی کمتر از مقدار داده شده باشد، راه اندازی شود.
whenNumberLessThanOrEqualTo(number) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که عددی کمتر یا مساوی با مقدار داده شده باشد، راه اندازی شود.
whenNumberNotBetween(start, end) ConditionalFormatRuleBuilder زمانی که عددی بین دو مقدار مشخص شده قرار نمی‌گیرد و هیچ کدام از آن‌ها نیست، قانون قالب شرطی را تنظیم می‌کند.
whenNumberNotEqualTo(number) ConditionalFormatRuleBuilder زمانی که عددی با مقدار داده شده برابر نیست، قانون قالب شرطی را تنظیم می کند.
whenTextContains(text) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که ورودی حاوی مقدار داده شده باشد، راه اندازی شود.
whenTextDoesNotContain(text) ConditionalFormatRuleBuilder قانون قالب شرطی را زمانی تنظیم می کند که ورودی حاوی مقدار داده شده نباشد.
whenTextEndsWith(text) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که ورودی با مقدار داده شده به پایان می رسد، راه اندازی شود.
whenTextEqualTo(text) ConditionalFormatRuleBuilder قانون قالب شرطی را تنظیم می کند تا زمانی که ورودی با مقدار داده شده برابر است، راه اندازی شود.
whenTextStartsWith(text) ConditionalFormatRuleBuilder زمانی که ورودی با مقدار داده شده شروع می شود، قانون قالب شرطی را تنظیم می کند.
withCriteria(criteria, args) ConditionalFormatRuleBuilder قانون قالب شرطی را بر روی معیارهای تعریف شده توسط مقادیر BooleanCriteria تنظیم می کند که معمولاً از criteria و arguments یک قانون موجود گرفته می شود.

ContainerInfo

مواد و روش ها

روش نوع برگشت توضیح مختصر
getAnchorColumn() Integer سمت چپ نمودار در این ستون لنگر انداخته است.
getAnchorRow() Integer سمت بالای نمودار در این ردیف لنگر انداخته است.
getOffsetX() Integer گوشه سمت چپ بالای نمودار با این تعداد پیکسل از ستون لنگر منحرف شده است.
getOffsetY() Integer گوشه سمت چپ بالای نمودار با این تعداد پیکسل از ردیف لنگر منحرف شده است.

CopyPasteType

خواص

ویژگی تایپ کنید شرح
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 فقط عرض ستون ها را جایگذاری کنید.

DataExecutionErrorCode

خواص

ویژگی تایپ کنید شرح
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 کاربر به پایگاه داده ارجاع شده توسط منبع داده دسترسی ندارد.

DataExecutionState

خواص

ویژگی تایپ کنید شرح
DATA_EXECUTION_STATE_UNSUPPORTED Enum وضعیت اجرای داده در Apps Script پشتیبانی نمی‌شود.
RUNNING Enum اجرای داده ها شروع شده و در حال اجراست.
SUCCESS Enum اجرای داده ها تکمیل و با موفقیت انجام شد.
ERROR Enum اجرای داده ها تکمیل شده و دارای خطا است.
NOT_STARTED Enum اجرای داده ها شروع نشده است.

DataExecutionStatus

مواد و روش ها

روش نوع برگشت توضیح مختصر
getErrorCode() DataExecutionErrorCode کد خطای اجرای داده را دریافت می کند.
getErrorMessage() String پیغام خطای اجرای داده ها را دریافت می کند.
getExecutionState() DataExecutionState وضعیت اجرای داده ها را دریافت می کند.
getLastExecutionTime() Date زمان آخرین اجرای داده را بدون توجه به وضعیت اجرا دریافت می کند.
getLastRefreshedTime() Date زمان آخرین بارگیری با موفقیت داده ها را دریافت می کند.
isTruncated() Boolean اگر داده‌های آخرین اجرای موفقیت‌آمیز کوتاه شده باشد، true را برمی‌گرداند، یا در غیر این صورت false .

DataSource

مواد و روش ها

روش نوع برگشت توضیح مختصر
createCalculatedColumn(name, formula) DataSourceColumn یک ستون محاسبه شده ایجاد می کند.
createDataSourcePivotTableOnNewSheet() DataSourcePivotTable یک جدول محوری منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند.
createDataSourceTableOnNewSheet() DataSourceTable یک جدول منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند.
getCalculatedColumnByName(columnName) DataSourceColumn ستون محاسبه شده را در منبع داده که با نام ستون مطابقت دارد برمی‌گرداند.
getCalculatedColumns() DataSourceColumn[] تمام ستون های محاسبه شده در منبع داده را برمی گرداند.
getColumns() DataSourceColumn[] تمام ستون های منبع داده را برمی گرداند.
getDataSourceSheets() DataSourceSheet[] برگه های منبع داده مرتبط با این منبع داده را برمی گرداند.
getSpec() DataSourceSpec مشخصات منبع داده را دریافت می کند.
refreshAllLinkedDataSourceObjects() void همه اشیاء منبع داده مرتبط با منبع داده را تازه می کند.
updateSpec(spec) DataSource مشخصات منبع داده را به روز می کند و اشیاء منبع داده مرتبط با این منبع داده را با مشخصات جدید تازه می کند.
updateSpec(spec, refreshAllLinkedObjects) DataSource مشخصات منبع داده را به روز می کند و data source sheets مرتبط را با مشخصات جدید تازه می کند.
waitForAllDataExecutionsCompletion(timeoutInSeconds) void صبر می کند تا تمام اجرای فعلی اشیاء منبع داده پیوند شده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceChart

مواد و روش ها

روش نوع برگشت توضیح مختصر
forceRefreshData() DataSourceChart داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
refreshData() DataSourceChart داده های شی را تازه می کند.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceColumn

مواد و روش ها

روش نوع برگشت توضیح مختصر
getDataSource() DataSource منبع داده مرتبط با ستون منبع داده را دریافت می کند.
getFormula() String فرمول ستون منبع داده را دریافت می کند.
getName() String نام ستون منبع داده را دریافت می کند.
hasArrayDependency() Boolean نشان می دهد که آیا ستون وابستگی به آرایه دارد یا خیر.
isCalculatedColumn() Boolean نشان می دهد که آیا ستون یک ستون محاسبه شده است یا خیر.
remove() void ستون منبع داده را حذف می کند.
setFormula(formula) DataSourceColumn فرمول ستون منبع داده را تنظیم می کند.
setName(name) DataSourceColumn نام ستون منبع داده را تنظیم می کند.

DataSourceFormula

مواد و روش ها

روش نوع برگشت توضیح مختصر
forceRefreshData() DataSourceFormula داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getAnchorCell() Range Range ای را نشان می دهد که نشان دهنده سلولی است که این فرمول منبع داده لنگر است.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getDisplayValue() String مقدار نمایش فرمول منبع داده را برمی گرداند.
getFormula() String فرمول این فرمول منبع داده را برمی گرداند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
refreshData() DataSourceFormula داده های شی را تازه می کند.
setFormula(formula) DataSourceFormula فرمول را به روز می کند.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceParameter

مواد و روش ها

روش نوع برگشت توضیح مختصر
getName() String نام پارامتر را دریافت می کند.
getSourceCell() String سلول منبعی را که پارامتر بر اساس آن ارزش گذاری شده است را دریافت می کند، یا اگر نوع پارامتر DataSourceParameterType.CELL نباشد، null .
getType() DataSourceParameterType نوع پارامتر را دریافت می کند.

DataSourceParameterType

خواص

ویژگی تایپ کنید شرح
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED Enum یک نوع پارامتر منبع داده که در Apps Script پشتیبانی نمی‌شود.
CELL Enum پارامتر منبع داده بر اساس یک سلول ارزش گذاری می شود.

DataSourcePivotTable

مواد و روش ها

روش نوع برگشت توضیح مختصر
addColumnGroup(columnName) PivotGroup یک گروه ستون محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می کند.
addFilter(columnName, filterCriteria) PivotFilter یک فیلتر جدید بر اساس ستون منبع داده مشخص شده با معیارهای فیلتر مشخص شده اضافه می کند.
addPivotValue(columnName, summarizeFunction) PivotValue یک مقدار محوری جدید بر اساس ستون منبع داده مشخص شده با تابع خلاصه مشخص شده اضافه می کند.
addRowGroup(columnName) PivotGroup یک گروه ردیف محوری جدید بر اساس ستون منبع داده مشخص شده اضافه می کند.
asPivotTable() PivotTable جدول محوری منبع داده را به عنوان یک شیء جدول محوری معمولی برمی‌گرداند.
forceRefreshData() DataSourcePivotTable داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
refreshData() DataSourcePivotTable داده های شی را تازه می کند.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceRefreshSchedule

مواد و روش ها

روش نوع برگشت توضیح مختصر
getFrequency() DataSourceRefreshScheduleFrequency فرکانس برنامه زمان‌بندی به‌روزرسانی را دریافت می‌کند، که مشخص می‌کند چند وقت یک‌بار و چه زمانی بازخوانی شود.
getScope() DataSourceRefreshScope دامنه این زمان‌بندی به‌روزرسانی را دریافت می‌کند.
getTimeIntervalOfNextRun() TimeInterval پنجره زمانی اجرای بعدی این برنامه به‌روزرسانی را دریافت می‌کند.
isEnabled() Boolean تعیین می‌کند که آیا این زمان‌بندی به‌روزرسانی فعال است یا خیر.

DataSourceRefreshScheduleFrequency

مواد و روش ها

روش نوع برگشت توضیح مختصر
getDaysOfTheMonth() Integer[] روزهای ماه را به‌عنوان اعداد (1-28) دریافت می‌کند تا منبع داده را به‌روز کند.
getDaysOfTheWeek() Weekday[] روزهای هفته را دریافت می کند که در آن منبع داده را تازه می کند.
getFrequencyType() FrequencyType نوع فرکانس را دریافت می کند.
getStartHour() Integer ساعت شروع (به عنوان یک عدد 0-23) بازه زمانی که در طی آن برنامه به روز رسانی اجرا می شود را دریافت می کند.

DataSourceRefreshScope

خواص

ویژگی تایپ کنید شرح
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED Enum محدوده تجدید منبع داده پشتیبانی نمی شود.
ALL_DATA_SOURCES Enum تازه سازی برای همه منابع داده در صفحه گسترده اعمال می شود.

DataSourceSheet

مواد و روش ها

روش نوع برگشت توضیح مختصر
addFilter(columnName, filterCriteria) DataSourceSheet یک فیلتر اعمال شده به برگه منبع داده اضافه می کند.
asSheet() Sheet برگه منبع داده را به عنوان یک شی برگ معمولی برمی گرداند.
autoResizeColumn(columnName) DataSourceSheet اندازه خودکار عرض ستون مشخص شده را تغییر می دهد.
autoResizeColumns(columnNames) DataSourceSheet اندازه خودکار عرض ستون های مشخص شده را تغییر می دهد.
forceRefreshData() DataSourceSheet داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getColumnWidth(columnName) Integer عرض ستون مشخص شده را برمی گرداند.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getFilters() DataSourceSheetFilter[] تمام فیلترهای اعمال شده به برگه منبع داده را برمی گرداند.
getSheetValues(columnName) Object[] تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده برمی گرداند.
getSheetValues(columnName, startRow, numRows) Object[] تمام مقادیر برگه منبع داده را برای نام ستون ارائه شده از سطر شروع ارائه شده (بر اساس-1) و تا numRows ارائه شده برمی گرداند.
getSortSpecs() SortSpec[] تمام مشخصات مرتب سازی را در برگه منبع داده دریافت می کند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
refreshData() DataSourceSheet داده های شی را تازه می کند.
removeFilters(columnName) DataSourceSheet تمام فیلترهای اعمال شده در ستون برگه منبع داده را حذف می کند.
removeSortSpec(columnName) DataSourceSheet مشخصات مرتب‌سازی در یک ستون در برگه منبع داده را حذف می‌کند.
setColumnWidth(columnName, width) DataSourceSheet عرض ستون مشخص شده را تنظیم می کند.
setColumnWidths(columnNames, width) DataSourceSheet عرض ستون های مشخص شده را تنظیم می کند.
setSortSpec(columnName, ascending) DataSourceSheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
setSortSpec(columnName, sortOrder) DataSourceSheet مشخصات مرتب سازی را بر روی یک ستون در برگه منبع داده تنظیم می کند.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceSheetFilter

مواد و روش ها

روش نوع برگشت توضیح مختصر
getDataSourceColumn() DataSourceColumn ستون منبع داده را برمی‌گرداند که این فیلتر روی آن اعمال می‌شود.
getDataSourceSheet() DataSourceSheet DataSourceSheet را که این فیلتر به آن تعلق دارد برمی گرداند.
getFilterCriteria() FilterCriteria معیارهای فیلتر را برای این فیلتر برمی گرداند.
remove() void این فیلتر را از شی منبع داده حذف می کند.
setFilterCriteria(filterCriteria) DataSourceSheetFilter معیارهای فیلتر را برای این فیلتر تنظیم می کند.

DataSourceSpec

مواد و روش ها

روش نوع برگشت توضیح مختصر
asBigQuery() BigQueryDataSourceSpec مشخصات منبع داده BigQuery را دریافت می کند.
copy() DataSourceSpecBuilder یک DataSourceSpecBuilder بر اساس تنظیمات این منبع داده ایجاد می کند.
getParameters() DataSourceParameter[] پارامترهای منبع داده را دریافت می کند.
getType() DataSourceType نوع منبع داده را دریافت می کند.

DataSourceSpecBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
asBigQuery() BigQueryDataSourceSpecBuilder سازنده منبع داده BigQuery را دریافت می کند.
build() DataSourceSpec مشخصات منبع داده را از تنظیمات این سازنده می سازد.
copy() DataSourceSpecBuilder یک DataSourceSpecBuilder بر اساس تنظیمات این منبع داده ایجاد می کند.
getParameters() DataSourceParameter[] پارامترهای منبع داده را دریافت می کند.
getType() DataSourceType نوع منبع داده را دریافت می کند.
removeAllParameters() DataSourceSpecBuilder تمام پارامترها را حذف می کند.
removeParameter(parameterName) DataSourceSpecBuilder پارامتر مشخص شده را حذف می کند.
setParameterFromCell(parameterName, sourceCell) DataSourceSpecBuilder پارامتری را اضافه می کند، یا اگر پارامتری با نام وجود داشته باشد، سلول منبع آن را به روز می کند.

DataSourceTable

مواد و روش ها

روش نوع برگشت توضیح مختصر
addColumns(columnNames) DataSourceTable ستون هایی را به جدول منبع داده اضافه می کند.
addFilter(columnName, filterCriteria) DataSourceTable یک فیلتر اعمال شده به جدول منبع داده اضافه می کند.
addSortSpec(columnName, ascending) DataSourceTable مشخصات مرتب سازی را بر روی یک ستون در جدول منبع داده اضافه می کند.
addSortSpec(columnName, sortOrder) DataSourceTable مشخصات مرتب سازی را بر روی یک ستون در جدول منبع داده اضافه می کند.
forceRefreshData() DataSourceTable داده های این شی را بدون در نظر گرفتن وضعیت فعلی تازه می کند.
getColumns() DataSourceTableColumn[] تمام ستون های منبع داده اضافه شده به جدول منبع داده را دریافت می کند.
getDataSource() DataSource منبع داده ای را که شی به آن پیوند دارد را دریافت می کند.
getFilters() DataSourceTableFilter[] همه فیلترهای اعمال شده به جدول منبع داده را برمی گرداند.
getRange() Range Range این جدول منبع داده را در بر می گیرد.
getRowLimit() Integer محدودیت ردیف را برای جدول منبع داده برمی‌گرداند.
getSortSpecs() SortSpec[] تمام مشخصات مرتب سازی را در جدول منبع داده دریافت می کند.
getStatus() DataExecutionStatus وضعیت اجرای داده شی را دریافت می کند.
isSyncingAllColumns() Boolean نشان می دهد که آیا جدول منبع داده همه ستون ها را در منبع داده مرتبط همگام می کند یا خیر.
refreshData() DataSourceTable داده های شی را تازه می کند.
removeAllColumns() DataSourceTable تمام ستون های جدول منبع داده را حذف می کند.
removeAllSortSpecs() DataSourceTable تمام مشخصات مرتب سازی در جدول منبع داده را حذف می کند.
setRowLimit(rowLimit) DataSourceTable محدودیت ردیف را برای جدول منبع داده به روز می کند.
syncAllColumns() DataSourceTable همه ستون‌های فعلی و آینده در منبع داده مرتبط را با جدول منبع داده همگام‌سازی کنید.
waitForCompletion(timeoutInSeconds) DataExecutionStatus منتظر می ماند تا اجرای فعلی کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

DataSourceTableColumn

مواد و روش ها

روش نوع برگشت توضیح مختصر
getDataSourceColumn() DataSourceColumn ستون منبع داده را دریافت می کند.
remove() void ستون را از DataSourceTable حذف می کند.

DataSourceTableFilter

مواد و روش ها

روش نوع برگشت توضیح مختصر
getDataSourceColumn() DataSourceColumn ستون منبع داده را برمی‌گرداند که این فیلتر روی آن اعمال می‌شود.
getDataSourceTable() DataSourceTable DataSourceTable را که این فیلتر به آن تعلق دارد برمی گرداند.
getFilterCriteria() FilterCriteria معیارهای فیلتر را برای این فیلتر برمی گرداند.
remove() void این فیلتر را از شی منبع داده حذف می کند.
setFilterCriteria(filterCriteria) DataSourceTableFilter معیارهای فیلتر را برای این فیلتر تنظیم می کند.

DataSourceType

خواص

ویژگی تایپ کنید شرح
DATA_SOURCE_TYPE_UNSUPPORTED Enum یک نوع منبع داده که در Apps Script پشتیبانی نمی‌شود.
BIGQUERY Enum منبع داده BigQuery.

DataValidation

مواد و روش ها

روش نوع برگشت توضیح مختصر
copy() DataValidationBuilder بر اساس تنظیمات این قانون یک سازنده برای یک قانون اعتبارسنجی داده ایجاد می کند.
getAllowInvalid() Boolean در صورتی که این قانون یک هشدار true در زمانی که ورودی اعتبارسنجی داده را با شکست مواجه می‌کند، نشان می‌دهد، یا اگر ورودی را به طور کامل رد کند، false .
getCriteriaType() DataValidationCriteria نوع معیار قانون را همانطور که در فهرست DataValidationCriteria تعریف شده است دریافت می کند.
getCriteriaValues() Object[] آرایه ای از آرگومان ها را برای معیارهای قاعده دریافت می کند.
getHelpText() String متن راهنمای قانون را دریافت می کند، یا اگر متن راهنما تنظیم نشده باشد null .

DataValidationBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
build() DataValidation یک قانون اعتبارسنجی داده را از تنظیمات اعمال شده برای سازنده می سازد.
copy() DataValidationBuilder بر اساس تنظیمات این قانون یک سازنده برای یک قانون اعتبارسنجی داده ایجاد می کند.
getAllowInvalid() Boolean در صورتی که این قانون یک هشدار true در زمانی که ورودی اعتبارسنجی داده را با شکست مواجه می‌کند، نشان می‌دهد، یا اگر ورودی را به طور کامل رد کند، false .
getCriteriaType() DataValidationCriteria نوع معیار قانون را همانطور که در فهرست DataValidationCriteria تعریف شده است دریافت می کند.
getCriteriaValues() Object[] آرایه ای از آرگومان ها را برای معیارهای قاعده دریافت می کند.
getHelpText() String متن راهنمای قانون را دریافت می کند، یا اگر متن راهنما تنظیم نشده باشد null .
requireCheckbox() DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی یک مقدار بولی باشد. این مقدار به عنوان یک چک باکس ارائه می شود.
requireCheckbox(checkedValue) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی مقدار مشخص شده یا خالی باشد.
requireCheckbox(checkedValue, uncheckedValue) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی یکی از مقادیر مشخص شده باشد.
requireDate() DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که تاریخ لازم باشد.
requireDateAfter(date) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که تاریخ بعد از مقدار داده شده را بخواهد.
requireDateBefore(date) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که تاریخ قبل از مقدار داده شده را بخواهد.
requireDateBetween(start, end) DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که تاریخی بین دو تاریخ مشخص شده یا یکی از آنها باشد.
requireDateEqualTo(date) DataValidationBuilder قانون اعتبارسنجی داده ها را طوری تنظیم می کند که به تاریخی برابر با مقدار داده شده نیاز دارد.
requireDateNotBetween(start, end) DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که به تاریخی نیاز دارد که بین دو تاریخ مشخص قرار نگیرد و هیچ کدام از آنها نباشد.
requireDateOnOrAfter(date) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که تاریخ روی یا بعد از مقدار داده شده را بخواهد.
requireDateOnOrBefore(date) DataValidationBuilder قانون اعتبارسنجی داده ها را طوری تنظیم می کند که تاریخ را روی مقدار داده شده یا قبل از آن نیاز دارد.
requireFormulaSatisfied(formula) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که فرمول داده شده را به true ارزیابی کند.
requireNumberBetween(start, end) DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که به عددی نیاز دارد که بین دو عدد مشخص قرار می گیرد یا یکی از آنها باشد.
requireNumberEqualTo(number) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که به عددی برابر با مقدار داده شده نیاز داشته باشد.
requireNumberGreaterThan(number) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که به عددی بیشتر از مقدار داده شده نیاز دارد.
requireNumberGreaterThanOrEqualTo(number) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که به عددی بزرگتر یا مساوی با مقدار داده شده نیاز داشته باشد.
requireNumberLessThan(number) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که به عددی کمتر از مقدار داده شده نیاز داشته باشد.
requireNumberLessThanOrEqualTo(number) DataValidationBuilder قانون اعتبارسنجی داده را طوری تنظیم می کند که به عددی کمتر یا مساوی با مقدار داده شده نیاز داشته باشد.
requireNumberNotBetween(start, end) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که به عددی نیاز داشته باشد که بین دو عدد مشخص قرار نگیرد و هیچ کدام از آن ها نباشد.
requireNumberNotEqualTo(number) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که به عددی نیاز داشته باشد که با مقدار داده شده برابر نباشد.
requireTextContains(text) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی حاوی مقدار داده شده باشد.
requireTextDoesNotContain(text) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی حاوی مقدار داده شده نباشد.
requireTextEqualTo(text) DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که ورودی برابر با مقدار داده شده باشد.
requireTextIsEmail() DataValidationBuilder قانون اعتبارسنجی داده ها را به گونه ای تنظیم می کند که ورودی به شکل آدرس ایمیل باشد.
requireTextIsUrl() DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی به شکل URL باشد.
requireValueInList(values) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی برابر با یکی از مقادیر داده شده باشد.
requireValueInList(values, showDropdown) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی برابر با یکی از مقادیر داده شده باشد، با گزینه ای برای پنهان کردن منوی کشویی.
requireValueInRange(range) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی برابر با مقداری در محدوده داده شده باشد.
requireValueInRange(range, showDropdown) DataValidationBuilder قانون اعتبارسنجی داده را به گونه ای تنظیم می کند که ورودی با یک مقدار در محدوده داده شده برابر باشد، با گزینه ای برای پنهان کردن منوی کشویی.
setAllowInvalid(allowInvalidData) DataValidationBuilder تنظیم می کند که آیا در صورت عدم موفقیت ورودی اعتبارسنجی داده ها، هشدار نشان داده شود یا اینکه ورودی به طور کامل رد شود.
setHelpText(helpText) DataValidationBuilder متن راهنما را تنظیم می کند که وقتی کاربر روی سلولی که اعتبار داده روی آن تنظیم شده است نشان داده می شود.
withCriteria(criteria, args) DataValidationBuilder قانون اعتبارسنجی داده ها را بر روی معیارهای تعریف شده توسط مقادیر DataValidationCriteria تنظیم می کند که معمولاً از criteria و arguments یک قانون موجود گرفته می شود.

DataValidationCriteria

خواص

ویژگی تایپ کنید شرح
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 به عددی نیاز دارد که بزرگتر یا مساوی با مقدار داده شده باشد.
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_IS_VALID_EMAIL Enum نیاز دارد که ورودی به صورت آدرس ایمیل باشد.
TEXT_IS_VALID_URL Enum نیاز دارد که ورودی به صورت URL باشد.
VALUE_IN_LIST Enum نیاز دارد که ورودی برابر با یکی از مقادیر داده شده باشد.
VALUE_IN_RANGE Enum مستلزم آن است که ورودی برابر با یک مقدار در محدوده داده شده باشد.
CUSTOM_FORMULA Enum نیاز دارد که ورودی فرمول داده شده را به true ارزیابی کند.
CHECKBOX Enum نیاز دارد که ورودی یک مقدار سفارشی یا بولی باشد. به عنوان کادر انتخاب ارائه شده است.

DateTimeGroupingRule

مواد و روش ها

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

DateTimeGroupingRuleType

خواص

ویژگی تایپ کنید شرح
UNSUPPORTED Enum یک نوع قانون گروه بندی تاریخ که پشتیبانی نمی شود.
SECOND Enum تاریخ گروه تا دوم ، از 0 تا 59.
MINUTE Enum تاریخ گروه به ساعت به دقیقه ، از 0 تا 59.
HOUR Enum تاریخ گروه به ساعت به ساعت با استفاده از یک سیستم 24 ساعته ، از 0 تا 23.
HOUR_MINUTE Enum تاریخ گروه به ساعت و دقیقه با استفاده از یک سیستم 24 ساعته ، به عنوان مثال 19:45 .
HOUR_MINUTE_AMPM Enum تاریخ گروه به ساعت و دقیقه با استفاده از یک سیستم 12 ساعته ، به عنوان مثال 7:45 PM .
DAY_OF_WEEK Enum تاریخ گروه تا روز هفته ، به عنوان مثال Sunday .
DAY_OF_YEAR Enum تاریخ گروه تا روز سال ، از 1 تا 366.
DAY_OF_MONTH Enum تاریخ گروه تا روز ماه ، از 1 تا 31.
DAY_MONTH Enum تاریخ گروه به روز و ماه ، به عنوان مثال 22-Nov .
MONTH Enum تاریخ گروه به ماه ، به عنوان مثال Nov
QUARTER Enum تاریخ گروه در سه ماهه ، به عنوان مثال Q1 (که نمایانگر جان مارس است).
YEAR Enum تاریخ گروه به سال ، به عنوان مثال 2008.
YEAR_MONTH Enum تاریخ گروه به سال و ماه ، به عنوان مثال 2008-Nov .
YEAR_QUARTER Enum تاریخ گروه به سال و سه ماهه ، به عنوان مثال 2008 Q4 .
YEAR_MONTH_DAY Enum تاریخ گروه در سال ، ماه و روز ، به عنوان مثال 2008-11-22 .

DeveloperMetadata

مواد و روش ها

روش نوع بازگشت توضیح مختصر
getId() Integer شناسه منحصر به فرد مرتبط با این ابرداده توسعه دهنده را برمی گرداند.
getKey() String کلید مرتبط با این ابرداده توسعه دهنده را برمی گرداند.
getLocation() DeveloperMetadataLocation مکان این ابرداده توسعه دهنده را برمی گرداند.
getValue() String اگر این ابرداده هیچ ارزشی نداشته باشد ، مقدار مرتبط با این ابرداده توسعه دهنده یا null برمی گرداند.
getVisibility() DeveloperMetadataVisibility دید این ابرداده توسعه دهنده را برمی گرداند.
moveToColumn(column) DeveloperMetadata این ابرداده توسعه دهنده را به ستون مشخص شده منتقل می کند.
moveToRow(row) DeveloperMetadata این ابرداده توسعه دهنده را به ردیف مشخص شده منتقل می کند.
moveToSheet(sheet) DeveloperMetadata این ابرداده توسعه دهنده را به برگه مشخص شده منتقل می کند.
moveToSpreadsheet() DeveloperMetadata این ابرداده توسعه دهنده را به صفحه گسترده سطح بالا منتقل می کند.
remove() void این ابرداده را حذف می کند.
setKey(key) DeveloperMetadata کلید این ابرداده توسعه دهنده را به مقدار مشخص شده تنظیم می کند.
setValue(value) DeveloperMetadata مقدار مرتبط با این ابرداده توسعه دهنده را به مقدار مشخص شده تنظیم می کند.
setVisibility(visibility) DeveloperMetadata دید این ابرداده توسعه دهنده را به دید مشخص می کند.

DeveloperMetadataFinder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
find() DeveloperMetadata[] این جستجو را اجرا می کند و ابرداده تطبیق را برمی گرداند.
onIntersectingLocations() DeveloperMetadataFinder جستجو را پیکربندی می کند تا مکانهای متقاطع دارای ابرداده را در نظر بگیرد.
withId(id) DeveloperMetadataFinder این جستجو را محدود می کند تا فقط ابرداده ای را که با شناسه مشخص شده مطابقت دارد در نظر بگیرید.
withKey(key) DeveloperMetadataFinder این جستجو را محدود می کند تا فقط ابرداده ای را که با کلید مشخص شده مطابقت دارد در نظر بگیرید.
withLocationType(locationType) DeveloperMetadataFinder این جستجو را محدود می کند تا فقط ابرداده ای را که با نوع مکان مشخص شده مطابقت دارد در نظر بگیرید.
withValue(value) DeveloperMetadataFinder این جستجو را محدود می کند تا فقط ابرداده هایی را که با مقدار مشخص شده مطابقت دارند ، در نظر بگیرند.
withVisibility(visibility) DeveloperMetadataFinder این جستجو را محدود می کند تا فقط ابرداده ای را که مطابق با دید مشخص است ، در نظر بگیریم.

DeveloperMetadataLocation

مواد و روش ها

روش نوع بازگشت توضیح مختصر
getColumn() Range Range محل ستون این ابرداده را برمی گرداند ، یا اگر نوع موقعیت مکانی DeveloperMetadataLocationType.COLUMN null است.
getLocationType() DeveloperMetadataLocationType نوع مکان را دریافت می کند.
getRow() Range Range محل ردیف این ابرداده را برمی گرداند ، null اگر نوع موقعیت مکانی DeveloperMetadataLocationType.ROW نیافته است.
getSheet() Sheet اگر نوع موقعیت مکانی DeveloperMetadataLocationType.SHEET null ، محل Sheet این ابرداده را برمی گرداند.
getSpreadsheet() Spreadsheet اگر نوع موقعیت مکانی DeveloperMetadataLocationType.SPREADSHEET null ، محل Spreadsheet این ابرداده را برمی گرداند.

DeveloperMetadataLocationType

خواص

ویژگی تایپ کنید شرح
SPREADSHEET Enum نوع موقعیت مکانی برای ابرداده توسعه دهنده مرتبط با صفحه گسترده سطح بالا.
SHEET Enum نوع موقعیت مکانی برای ابرداده توسعه دهنده مرتبط با یک برگه کامل.
ROW Enum نوع موقعیت مکانی برای ابرداده توسعه دهنده مرتبط با یک ردیف.
COLUMN Enum نوع موقعیت مکانی برای ابرداده توسعه دهنده مرتبط با یک ستون.

DeveloperMetadataVisibility

خواص

ویژگی تایپ کنید شرح
DOCUMENT Enum ابرداده قابل مشاهده با اسناد از هر پروژه توسعه دهنده با دسترسی به سند در دسترس است.
PROJECT Enum ابرداده قابل مشاهده پروژه فقط توسط پروژه توسعه دهنده ای که ابرداده را ایجاد کرده است قابل مشاهده و در دسترس است.

Dimension

خواص

ویژگی تایپ کنید شرح
COLUMNS Enum بعد ستون (عمودی).
ROWS Enum بعد ردیف (افقی).

Direction

خواص

ویژگی تایپ کنید شرح
UP Enum جهت کاهش شاخص های ردیف.
DOWN Enum جهت افزایش شاخص های ردیف.
PREVIOUS Enum جهت کاهش شاخص های ستون.
NEXT Enum جهت افزایش شاخص های ستون.

Drawing

مواد و روش ها

روش نوع بازگشت توضیح مختصر
getContainerInfo() ContainerInfo اطلاعاتی در مورد مکان قرار دادن نقاشی در ورق دریافت می کند.
getHeight() Integer ارتفاع واقعی این نقاشی را در پیکسل ها برمی گرداند.
getOnAction() String نام کلان ضمیمه شده به این نقاشی را برمی گرداند.
getSheet() Sheet برگه ای را که این نقاشی روی آن ظاهر می شود ، برمی گرداند.
getWidth() Integer عرض واقعی این نقاشی را در پیکسل ها برمی گرداند.
getZIndex() Number Z-Index این نقاشی را برمی گرداند.
remove() void این نقاشی را از صفحه گسترده حذف می کند.
setHeight(height) Drawing ارتفاع واقعی این نقاشی را در پیکسل ها تنظیم می کند.
setOnAction(macroName) Drawing یک عملکرد کلان را به این نقاشی اختصاص می دهد.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) Drawing موقعیتی را که نقاشی روی ورق ظاهر می شود تنظیم می کند.
setWidth(width) Drawing عرض واقعی این نقاشی را در پیکسل ها تنظیم می کند.
setZIndex(zIndex) Drawing Z-Index این نقاشی را تنظیم می کند.

EmbeddedAreaChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedAreaChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
setBackgroundColor(cssValue) EmbeddedAreaChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedAreaChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedAreaChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPointStyle(style) EmbeddedAreaChartBuilder سبک را برای امتیاز در خط تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedAreaChartBuilder دامنه نمودار را تعیین می کند.
setStacked() EmbeddedAreaChartBuilder از خطوط انباشته استفاده می شود ، به این معنی که مقادیر خط و نوار انباشته می شوند (انباشته می شوند).
setTitle(chartTitle) EmbeddedAreaChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedAreaChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedAreaChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedAreaChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedBarChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedBarChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
reverseDirection() EmbeddedBarChartBuilder جهت رشد میله ها در محور افقی را معکوس می کند.
setBackgroundColor(cssValue) EmbeddedBarChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedBarChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedBarChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedBarChartBuilder دامنه نمودار را تعیین می کند.
setStacked() EmbeddedBarChartBuilder از خطوط انباشته استفاده می شود ، به این معنی که مقادیر خط و نوار انباشته می شوند (انباشته می شوند).
setTitle(chartTitle) EmbeddedBarChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedBarChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedBarChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedBarChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedChart

مواد و روش ها

روش نوع بازگشت توضیح مختصر
asDataSourceChart() DataSourceChart اگر نمودار نمودار منبع داده باشد یا در غیر این صورت null به یک نمودار منبع داده می پردازد.
getAs(contentType) Blob داده های موجود در این شی را به عنوان حباب تبدیل شده به نوع محتوای مشخص شده برگردانید.
getBlob() Blob داده های داخل این شی را به عنوان حباب برگردانید.
getChartId() Integer اگر نمودار در صفحه گسترده نباشد ، یک شناسه پایدار را برای نمودار منحصر به فرد در صفحه گسترده حاوی نمودار یا null برمی گرداند.
getContainerInfo() ContainerInfo اطلاعات مربوط به محل قرار گرفتن در نمودار در یک برگه را برمی گرداند.
getHiddenDimensionStrategy() ChartHiddenDimensionStrategy این استراتژی را برای استفاده برای استفاده از ردیف ها و ستون های پنهان برمی گرداند.
getMergeStrategy() ChartMergeStrategy استراتژی ادغام مورد استفاده در هنگام وجود بیش از یک محدوده را برمی گرداند.
getNumHeaders() Integer تعداد ردیف ها یا ستون ها را محدوده ای که به عنوان هدر رفتار می شود ، برمی گرداند.
getOptions() ChartOptions گزینه های این نمودار مانند ارتفاع ، رنگ و محورها را برمی گرداند.
getRanges() Range[] دامنه هایی را که این نمودار از آن به عنوان منبع داده استفاده می کند ، برمی گرداند.
getTransposeRowsAndColumns() Boolean در صورت true ، ردیف ها و ستون های مورد استفاده برای جمع آوری نمودار تغییر می کنند.
modify() EmbeddedChartBuilder یک EmbeddedChartBuilder را برمی گرداند که می تواند برای اصلاح این نمودار استفاده شود.

EmbeddedChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.

EmbeddedColumnChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedColumnChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
setBackgroundColor(cssValue) EmbeddedColumnChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedColumnChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedColumnChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedColumnChartBuilder دامنه نمودار را تعیین می کند.
setStacked() EmbeddedColumnChartBuilder از خطوط انباشته استفاده می شود ، به این معنی که مقادیر خط و نوار انباشته می شوند (انباشته می شوند).
setTitle(chartTitle) EmbeddedColumnChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedColumnChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedColumnChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedColumnChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedComboChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedComboChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
setBackgroundColor(cssValue) EmbeddedComboChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedComboChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedComboChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedComboChartBuilder دامنه نمودار را تعیین می کند.
setStacked() EmbeddedComboChartBuilder از خطوط انباشته استفاده می شود ، به این معنی که مقادیر خط و نوار انباشته می شوند (انباشته می شوند).
setTitle(chartTitle) EmbeddedComboChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedComboChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedComboChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedComboChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedHistogramChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedHistogramChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
setBackgroundColor(cssValue) EmbeddedHistogramChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedHistogramChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedHistogramChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedHistogramChartBuilder دامنه نمودار را تعیین می کند.
setStacked() EmbeddedHistogramChartBuilder از خطوط انباشته استفاده می شود ، به این معنی که مقادیر خط و نوار انباشته می شوند (انباشته می شوند).
setTitle(chartTitle) EmbeddedHistogramChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedHistogramChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedHistogramChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedHistogramChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedLineChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedLineChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
setBackgroundColor(cssValue) EmbeddedLineChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedLineChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setCurveStyle(style) EmbeddedLineChartBuilder سبک را برای استفاده برای منحنی ها در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedLineChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPointStyle(style) EmbeddedLineChartBuilder سبک را برای امتیاز در خط تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setRange(start, end) EmbeddedLineChartBuilder دامنه نمودار را تعیین می کند.
setTitle(chartTitle) EmbeddedLineChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedLineChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedLineChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.
useLogScale() EmbeddedLineChartBuilder محور دامنه را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).

EmbeddedPieChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
reverseCategories() EmbeddedPieChartBuilder نقاشی سری را در محور دامنه معکوس می کند.
set3D() EmbeddedPieChartBuilder نمودار را به صورت سه بعدی تنظیم می کند.
setBackgroundColor(cssValue) EmbeddedPieChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedPieChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedPieChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedPieChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setTitle(chartTitle) EmbeddedPieChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedPieChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.

EmbeddedScatterChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
setBackgroundColor(cssValue) EmbeddedScatterChartBuilder رنگ پس زمینه را برای نمودار تنظیم می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setColors(cssValues) EmbeddedScatterChartBuilder رنگها را برای خطوط موجود در نمودار تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setLegendPosition(position) EmbeddedScatterChartBuilder موقعیت افسانه را با توجه به نمودار تعیین می کند.
setLegendTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن افسانه نمودار را تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPointStyle(style) EmbeddedScatterChartBuilder سبک را برای امتیاز در خط تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setTitle(chartTitle) EmbeddedScatterChartBuilder عنوان نمودار را تنظیم می کند.
setTitleTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن عنوان نمودار را تنظیم می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
setXAxisLogScale() EmbeddedScatterChartBuilder محور افقی را به یک مقیاس لگاریتمی تبدیل می کند (نیاز به مثبت بودن همه مقادیر دارد).
setXAxisRange(start, end) EmbeddedScatterChartBuilder دامنه محور افقی نمودار را تعیین می کند.
setXAxisTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن محور افقی را تنظیم می کند.
setXAxisTitle(title) EmbeddedScatterChartBuilder عنوانی را به محور افقی اضافه می کند.
setXAxisTitleTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن متن افقی محور را تنظیم می کند.
setYAxisLogScale() EmbeddedScatterChartBuilder محور عمودی را به مقیاس لگاریتمی تبدیل می کند (به همه مقادیر مثبت نیاز دارد).
setYAxisRange(start, end) EmbeddedScatterChartBuilder دامنه محور عمودی نمودار را تعیین می کند.
setYAxisTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن محور عمودی را تنظیم می کند.
setYAxisTitle(title) EmbeddedScatterChartBuilder عنوانی را به محور عمودی اضافه می کند.
setYAxisTitleTextStyle(textStyle) EmbeddedScatterChartBuilder سبک متن عنوان محور عمودی را تنظیم می کند.

EmbeddedTableChartBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
addRange(range) EmbeddedChartBuilder دامنه ای را به نمودار این سازنده اصلاح می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را به Areachart تنظیم می کند و یک EmbeddedAreaChartBuilder باز می گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را به Barchart تنظیم می کند و یک EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را به ColumnChart تنظیم می کند و یک EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را به Combochart تنظیم می کند و یک EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را به HistogramChart تنظیم می کند و یک EmbeddedHistogramChartBuilder تعبیه می کند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را به LineChart تنظیم می کند و یک EmbeddedLineChartBuilder برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را به PieChart تنظیم می کند و یک EmbeddedPieChartBuilder برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را به ScatterChart تنظیم می کند و یک EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را به TableChart تنظیم می کند و یک EmbeddedTableChartBuilder تعبیه می کند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده ها را از نمودار این سازنده اصلاح می کند.
enablePaging(enablePaging) EmbeddedTableChartBuilder تنظیم می کند که آیا می توان صفحه بندی را از طریق داده ها فعال کرد.
enablePaging(pageSize) EmbeddedTableChartBuilder صفحه بندی را فعال می کند و تعداد ردیف ها را در هر صفحه تنظیم می کند.
enablePaging(pageSize, startPage) EmbeddedTableChartBuilder صفحه بندی را فعال می کند ، تعداد ردیف ها را در هر صفحه تنظیم می کند و صفحه اول جدول را نمایش می دهد (شماره صفحه مبتنی بر صفر است).
enableRtlTable(rtlEnabled) EmbeddedTableChartBuilder با معکوس کردن ترتیب ستون جدول ، پشتیبانی اساسی را برای زبانهای راست به چپ (مانند عربی یا عبری) اضافه می کند ، به طوری که ستون صفر ستون سمت راست است و ستون آخر ستون سمت چپ است.
enableSorting(enableSorting) EmbeddedTableChartBuilder وقتی کاربر روی عنوان ستون کلیک می کند ، ستون ها را مرتب می کند.
getChartType() ChartType نوع نمودار فعلی را برمی گرداند.
getContainer() ContainerInfo ContainerInfo نمودار را برگردانید ، که در آن نمودار روی صفحه ظاهر می شود.
getRanges() Range[] نسخه ای از لیست محدوده هایی را که در حال حاضر داده ها را برای این نمودار ارائه می دهد ، برمی گرداند.
removeRange(range) EmbeddedChartBuilder دامنه مشخص شده را از نمودار این سازنده اصلاح می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setFirstRowNumber(number) EmbeddedTableChartBuilder شماره ردیف را برای ردیف اول در جدول داده ها تنظیم می کند.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی استفاده را برای ردیف ها و ستون های پنهان تنظیم می کند.
setInitialSortingAscending(column) EmbeddedTableChartBuilder شاخص ستون را تنظیم می کند که طبق آن جدول باید در ابتدا مرتب شود (صعودی).
setInitialSortingDescending(column) EmbeddedTableChartBuilder شاخص ستون را تنظیم می کند که طبق آن جدول باید در ابتدا مرتب شود (نزولی).
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده در هنگام وجود بیش از یک محدوده تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف ها یا ستون های دامنه ای را که باید به عنوان هدر رفتار شود ، تنظیم می کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته ای را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند و در جایی که نمودار روی ورق ظاهر می شود تغییر می کند.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تنظیم می کند که آیا ردیف ها و ستون های نمودار منتقل می شوند.
showRowNumberColumn(showRowNumber) EmbeddedTableChartBuilder تنظیم می کند که آیا شماره ردیف را به عنوان اولین ستون جدول نشان می دهد.
useAlternatingRowStyle(alternate) EmbeddedTableChartBuilder تنظیم می کند که آیا سبک رنگ متناوب به ردیف های عجیب و غریب یک نمودار جدول اختصاص داده شده است.

Filter

مواد و روش ها

روش نوع بازگشت توضیح مختصر
getColumnFilterCriteria(columnPosition) FilterCriteria معیارهای فیلتر را در ستون مشخص شده دریافت می کند ، یا اگر ستون معیارهای فیلتر را روی آن اعمال نمی کند ، null .
getRange() Range دامنه این فیلتر را برای آن اعمال می کند.
remove() void این فیلتر را حذف می کند.
removeColumnFilterCriteria(columnPosition) Filter معیارهای فیلتر را از ستون مشخص شده حذف می کند.
setColumnFilterCriteria(columnPosition, filterCriteria) Filter معیارهای فیلتر را روی ستون مشخص شده تنظیم می کند.
sort(columnPosition, ascending) Filter محدوده فیلتر شده توسط ستون مشخص شده را مرتب می کند ، به استثنای ردیف اول (ردیف هدر) در محدوده این فیلتر برای آن اعمال می شود.

FilterCriteria

مواد و روش ها

روش نوع بازگشت توضیح مختصر
copy() FilterCriteriaBuilder این معیارهای فیلتر را کپی کرده و یک سازنده معیارهایی ایجاد می کند که می توانید برای فیلتر دیگری اعمال کنید.
getCriteriaType() BooleanCriteria نوع بولی معیارها را به عنوان مثال ، CELL_EMPTY باز می گرداند.
getCriteriaValues() Object[] مجموعه ای از استدلال ها را برای معیارهای بولی برمی گرداند.
getHiddenValues() String[] مقادیری را که فیلتر پنهان می کند برمی گرداند.
getVisibleBackgroundColor() Color رنگ پس زمینه مورد استفاده به عنوان معیارهای فیلتر را برمی گرداند.
getVisibleForegroundColor() Color رنگ پیش زمینه مورد استفاده به عنوان معیارهای فیلتر را برمی گرداند.
getVisibleValues() String[] مقادیری را که فیلتر جدول محوری نشان می دهد برمی گرداند.

FilterCriteriaBuilder

مواد و روش ها

روش نوع بازگشت توضیح مختصر
build() FilterCriteria معیارهای فیلتر را با استفاده از تنظیماتی که به سازنده معیارها اضافه می کنید ، مونتاژ می کند.
copy() FilterCriteriaBuilder این معیارهای فیلتر را کپی کرده و یک سازنده معیارهایی ایجاد می کند که می توانید برای فیلتر دیگری اعمال کنید.
getCriteriaType() BooleanCriteria نوع بولی معیارها را به عنوان مثال ، CELL_EMPTY باز می گرداند.
getCriteriaValues() Object[] مجموعه ای از استدلال ها را برای معیارهای بولی برمی گرداند.
getHiddenValues() String[] مقادیری را که فیلتر پنهان می کند برمی گرداند.
getVisibleBackgroundColor() Color رنگ پس زمینه مورد استفاده به عنوان معیارهای فیلتر را برمی گرداند.
getVisibleForegroundColor() Color رنگ پیش زمینه مورد استفاده به عنوان معیارهای فیلتر را برمی گرداند.
getVisibleValues() String[] مقادیری را که فیلتر جدول محوری نشان می دهد برمی گرداند.
setHiddenValues(values) FilterCriteriaBuilder مقادیر را برای پنهان کردن تنظیم می کند.
setVisibleBackgroundColor(visibleBackgroundColor) FilterCriteriaBuilder رنگ پس زمینه مورد استفاده به عنوان معیارهای فیلتر را تنظیم می کند.
setVisibleForegroundColor(visibleForegroundColor) FilterCriteriaBuilder رنگ پیش زمینه مورد استفاده به عنوان معیارهای فیلتر را تنظیم می کند.
setVisibleValues(values) FilterCriteriaBuilder مقادیر را برای نشان دادن در یک جدول محوری تنظیم می کند.
whenCellEmpty() FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلول های خالی تنظیم می کند.
whenCellNotEmpty() FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلولهایی که خالی نیستند تنظیم می کند.
whenDateAfter(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلول هایی را با تاریخ هایی که پس از تاریخ مشخص شده نشان می دهند ، نشان می دهد.
whenDateAfter(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلولهای دارای تاریخ هایی را نشان می دهد که پس از تاریخ نسبی مشخص شده هستند.
whenDateBefore(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلولهای دارای تاریخ هایی را نشان می دهد که قبل از تاریخ مشخص شده اند.
whenDateBefore(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلولهای دارای تاریخ هایی را نشان می دهد که قبل از تاریخ نسبی مشخص شده اند.
whenDateEqualTo(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلولهای دارای تاریخ هایی را نشان می دهد که برابر با تاریخ مشخص است.
whenDateEqualTo(date) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند که سلولهای دارای تاریخ هایی را نشان می دهد که برابر با تاریخ نسبی مشخص شده است.
whenDateEqualToAny(dates) FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلول ها با تاریخ هایی که برابر با هر یک از تاریخ های مشخص شده است ، تنظیم می کند.
whenDateNotEqualTo(date) FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلولهایی که برابر با تاریخ مشخص نیستند ، تنظیم می کند.
whenDateNotEqualToAny(dates) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با تاریخ هایی که برابر با هر یک از تاریخ های مشخص نیست ، نشان دهد.
whenFormulaSatisfied(formula) FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلولها با فرمول مشخص (مانند =B:B<C:C ) تنظیم می کند که به true ارزیابی می شود.
whenNumberBetween(start, end) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با عددی نشان دهد که بین 2 عدد مشخص شده یا از هر یک از آنها قرار دارد.
whenNumberEqualTo(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلول ها را با شماره ای برابر با شماره مشخص شده نشان دهد.
whenNumberEqualToAny(numbers) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلول ها را با شماره ای برابر با هر یک از شماره های مشخص شده نشان دهد.
whenNumberGreaterThan(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با تعداد بیشتری از تعداد مشخص شده نشان دهد
whenNumberGreaterThanOrEqualTo(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با یک عدد بیشتر از یا مساوی با شماره مشخص شده نشان دهد.
whenNumberLessThan(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلول هایی را با شماره ای که کمتر از شماره مشخص شده است نشان دهد.
whenNumberLessThanOrEqualTo(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلول هایی را با تعداد کمتر یا مساوی با شماره مشخص شده نشان دهد.
whenNumberNotBetween(start, end) FilterCriteriaBuilder معیارهای فیلتر را برای نشان دادن سلول ها با یک عدد تنظیم می کند ، بین 2 عدد مشخص نشده است.
whenNumberNotEqualTo(number) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با شماره ای نشان دهد که برابر با شماره مشخص نیست.
whenNumberNotEqualToAny(numbers) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با شماره ای نشان دهد که برابر با هیچ یک از شماره های مشخص نیست.
whenTextContains(text) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با متن حاوی متن مشخص شده نشان دهد.
whenTextDoesNotContain(text) FilterCriteriaBuilder معیارهای فیلتر را تنظیم می کند تا سلولهایی را با متن نشان دهد که حاوی متن مشخص نیست.
whenTextEndsWith(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that ends with the specified text.
whenTextEqualTo(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that's equal to the specified text.
whenTextEqualToAny(texts) FilterCriteriaBuilder Sets the filter criteria to show cells with text that's equal to any of the specified text values.
whenTextNotEqualTo(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that isn't equal to the specified text.
whenTextNotEqualToAny(texts) FilterCriteriaBuilder Sets the filter criteria to show cells with text that isn't equal to any of the specified values.
whenTextStartsWith(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that starts with the specified text.
withCriteria(criteria, args) FilterCriteriaBuilder Sets the filter criteria to a boolean condition defined by BooleanCriteria values, such as CELL_EMPTY or NUMBER_GREATER_THAN .

FrequencyType

خواص

ویژگی تایپ کنید شرح
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.

GradientCondition

مواد و روش ها

روش Return type توضیح مختصر
getMaxColorObject() Color Gets the color set for the maximum value of this gradient condition.
getMaxType() InterpolationType Gets the interpolation type for the maximum value of this gradient condition.
getMaxValue() String Gets the max value of this gradient condition.
getMidColorObject() Color Gets the color set for the midpoint value of this gradient condition.
getMidType() InterpolationType Gets the interpolation type for the mid-point value of this gradient condition.
getMidValue() String Gets the mid-point value of this gradient condition.
getMinColorObject() Color Gets the color set for the minimum value of this gradient condition.
getMinType() InterpolationType Gets the interpolation type for the minimum value of this gradient condition.
getMinValue() String Gets the minimum value of this gradient condition.

Group

مواد و روش ها

روش Return type توضیح مختصر
collapse() Group Collapses this group.
expand() Group Expands this group.
getControlIndex() Integer Returns the control toggle index of this group.
getDepth() Integer Returns the depth of this group.
getRange() Range Returns the range over which this group exists.
isCollapsed() 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.

GroupControlTogglePosition

خواص

ویژگی تایپ کنید شرح
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).

InterpolationType

خواص

ویژگی تایپ کنید شرح
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.

NamedRange

مواد و روش ها

روش Return type توضیح مختصر
getName() String Gets the name of this named range.
getRange() Range Gets the range referenced by this named range.
remove() void Deletes this named range.
setName(name) NamedRange Sets/updates the name of the named range.
setRange(range) NamedRange Sets/updates the range for this named range.

OverGridImage

مواد و روش ها

روش Return type توضیح مختصر
assignScript(functionName) OverGridImage Assigns the function with the specified function name to this image.
getAltTextDescription() String Returns the alt text description for this image.
getAltTextTitle() String Returns the alt text title for this image.
getAnchorCell() Range Returns the cell where an image is anchored.
getAnchorCellXOffset() Integer Returns the horizontal pixel offset from the anchor cell.
getAnchorCellYOffset() Integer Returns the vertical pixel offset from the anchor cell.
getHeight() Integer Returns the actual height of this image in pixels.
getInherentHeight() Integer Returns the inherent height of this image in pixels.
getInherentWidth() Integer Returns the inherent height of this image in pixels.
getScript() String Returns the name of the function assigned to this image.
getSheet() Sheet Returns the sheet this image appears on.
getUrl() String Gets the image's source URL; returns null if the URL is unavailable.
getWidth() Integer Returns the actual width of this image in pixels.
remove() void Deletes this image from the spreadsheet.
replace(blob) OverGridImage Replaces this image with the one specified by the provided BlobSource .
replace(url) OverGridImage Replaces this image with the one from the specified URL.
resetSize() OverGridImage Resets this image to its inherent dimensions.
setAltTextDescription(description) OverGridImage Sets the alt-text description for this image.
setAltTextTitle(title) OverGridImage Sets the alt text title for this image.
setAnchorCell(cell) OverGridImage Sets the cell where an image is anchored.
setAnchorCellXOffset(offset) OverGridImage Sets the horizontal pixel offset from the anchor cell.
setAnchorCellYOffset(offset) OverGridImage Sets the vertical pixel offset from the anchor cell.
setHeight(height) OverGridImage Sets the actual height of this image in pixels.
setWidth(width) OverGridImage Sets the actual width of this image in pixels.

PageProtection

PivotFilter

مواد و روش ها

روش Return type توضیح مختصر
getFilterCriteria() FilterCriteria Returns the filter criteria for this pivot filter.
getPivotTable() PivotTable Returns the PivotTable that this filter belongs to.
getSourceDataColumn() Integer Returns the number of the source data column this filter operates on.
getSourceDataSourceColumn() DataSourceColumn Returns the data source column the filter operates on.
remove() void Removes this pivot filter from the pivot table.
setFilterCriteria(filterCriteria) PivotFilter Sets the filter criteria for this pivot filter.

PivotGroup

مواد و روش ها

روش Return type توضیح مختصر
addManualGroupingRule(groupName, groupMembers) PivotGroup Adds a manual grouping rule for this pivot group.
areLabelsRepeated() Boolean Returns whether labels are displayed as repeated.
clearGroupingRule() PivotGroup Removes any grouping rules from this pivot group.
clearSort() PivotGroup Removes any sorting applied to this group.
getDateTimeGroupingRule() DateTimeGroupingRule Returns the date-time grouping rule on the pivot group, or null if no date-time grouping rule is set.
getDimension() Dimension Returns whether this is a row or column group.
getGroupLimit() PivotGroupLimit Returns the pivot group limit on the pivot group.
getIndex() Integer Returns the index of this pivot group in the current group order.
getPivotTable() PivotTable Returns the PivotTable which this grouping belongs to.
getSourceDataColumn() Integer Returns the number of the source data column this group summarizes.
getSourceDataSourceColumn() DataSourceColumn Returns the data source column the pivot group operates on.
hideRepeatedLabels() PivotGroup Hides repeated labels for this grouping.
isSortAscending() Boolean Returns true if the sort is ascending, returns false if the sort order is descending.
moveToIndex(index) PivotGroup 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.
removeManualGroupingRule(groupName) PivotGroup Removes the manual grouping rule with the specified groupName .
resetDisplayName() PivotGroup Resets the display name of this group in the pivot table to its default value.
setDateTimeGroupingRule(dateTimeGroupingRuleType) PivotGroup Sets the date-time grouping rule on the pivot group.
setDisplayName(name) PivotGroup Sets the display name of this group in the pivot table.
setGroupLimit(countLimit) PivotGroup Sets the pivot group limit on the pivot group.
setHistogramGroupingRule(minValue, maxValue, intervalSize) PivotGroup Sets a histogram grouping rule for this pivot group.
showRepeatedLabels() PivotGroup When there is more than one row or column grouping, this method displays this grouping's label for each entry of the subsequent grouping.
showTotals(showTotals) PivotGroup Sets whether to show total values for this pivot group in the table.
sortAscending() PivotGroup Sets the sort order to be ascending.
sortBy(value, oppositeGroupValues) PivotGroup Sorts this group by the specified PivotValue for the values from the oppositeGroupValues .
sortDescending() PivotGroup Sets the sort order to be descending.
totalsAreShown() Boolean Returns whether total values are currently shown for this pivot group.

PivotGroupLimit

مواد و روش ها

روش Return type توضیح مختصر
getCountLimit() Integer Gets the count limit on rows or columns in the pivot group.
getPivotGroup() PivotGroup Returns the pivot group the limit belongs to.
remove() void Removes the pivot group limit.
setCountLimit(countLimit) PivotGroupLimit Sets the count limit on rows or columns in the pivot group.

PivotTable

مواد و روش ها

روش Return type توضیح مختصر
addCalculatedPivotValue(name, formula) PivotValue Creates a new pivot value in the pivot table calculated from the specified formula with the specified name .
addColumnGroup(sourceDataColumn) PivotGroup Defines a new pivot column grouping in the pivot table.
addFilter(sourceDataColumn, filterCriteria) PivotFilter Creates a new pivot filter for the pivot table.
addPivotValue(sourceDataColumn, summarizeFunction) PivotValue Defines a new pivot value in the pivot table with the specified summarizeFunction .
addRowGroup(sourceDataColumn) PivotGroup Defines a new pivot row grouping in the pivot table.
asDataSourcePivotTable() DataSourcePivotTable Returns the pivot table as a data source pivot table if the pivot table is linked to a DataSource , or null otherwise.
getAnchorCell() Range Returns the Range representing the cell where this pivot table is anchored.
getColumnGroups() PivotGroup[] Returns an ordered list of the column groups in this pivot table.
getFilters() PivotFilter[] Returns an ordered list of the filters in this pivot table.
getPivotValues() PivotValue[] Returns an ordered list of the pivot values in this pivot table.
getRowGroups() PivotGroup[] Returns an ordered list of the row groups in this pivot table.
getSourceDataRange() Range Returns the source data range on which the pivot table is constructed.
getValuesDisplayOrientation() Dimension Returns whether values are displayed as rows or columns.
remove() void Deletes this pivot table.
setValuesDisplayOrientation(dimension) PivotTable Sets the layout of this pivot table to display values as columns or rows.

PivotTableSummarizeFunction

خواص

ویژگی تایپ کنید شرح
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

PivotValue

مواد و روش ها

روش Return type توضیح مختصر
getDisplayType() PivotValueDisplayType Returns the display type describing how this pivot value is currently displayed in the table.
getFormula() String Returns the formula used to calculate this value.
getPivotTable() PivotTable Returns the PivotTable which this value belongs to.
getSourceDataColumn() Integer Returns the number of the source data column the pivot value summarizes.
getSourceDataSourceColumn() DataSourceColumn Returns the data source column the pivot value summarizes.
getSummarizedBy() PivotTableSummarizeFunction Returns this group's summarization function.
remove() void Remove this value from the pivot table.
setDisplayName(name) PivotValue Sets the display name for this value in the pivot table.
setFormula(formula) PivotValue Sets the formula used to calculate this value.
showAs(displayType) PivotValue Displays this value in the pivot table as a function of another value.
summarizeBy(summarizeFunction) PivotValue Sets the summarization function.

PivotValueDisplayType

خواص

ویژگی تایپ کنید شرح
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

مواد و روش ها

روش Return type توضیح مختصر
addEditor(emailAddress) Protection Adds the given user to the list of editors for the protected sheet or range.
addEditor(user) Protection Adds the given user to the list of editors for the protected sheet or range.
addEditors(emailAddresses) Protection Adds the given array of users to the list of editors for the protected sheet or range.
addTargetAudience(audienceId) Protection Adds the specified target audience as an editor of the protected range.
canDomainEdit() Boolean Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.
canEdit() Boolean Determines whether the user has permission to edit the protected range or sheet.
getDescription() String Gets the description of the protected range or sheet.
getEditors() User[] Gets the list of editors for the protected range or sheet.
getProtectionType() ProtectionType Gets the type of the protected area, either RANGE or SHEET .
getRange() Range Gets the range that is being protected.
getRangeName() String Gets the name of the protected range if it is associated with a named range.
getTargetAudiences() TargetAudience[] Returns the IDs of the target audiences that can edit the protected range.
getUnprotectedRanges() Range[] Gets an array of unprotected ranges within a protected sheet.
isWarningOnly() Boolean Determines if the protected area is using "warning based" protection.
remove() void Unprotects the range or sheet.
removeEditor(emailAddress) Protection Removes the given user from the list of editors for the protected sheet or range.
removeEditor(user) Protection Removes the given user from the list of editors for the protected sheet or range.
removeEditors(emailAddresses) Protection Removes the given array of users from the list of editors for the protected sheet or range.
removeTargetAudience(audienceId) Protection Removes the specified target audience as an editor of the protected range.
setDescription(description) Protection Sets the description of the protected range or sheet.
setDomainEdit(editable) Protection Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.
setNamedRange(namedRange) Protection Associates the protected range with an existing named range.
setRange(range) Protection Adjusts the range that is being protected.
setRangeName(rangeName) Protection Associates the protected range with an existing named range.
setUnprotectedRanges(ranges) Protection Unprotects the given array of ranges within a protected sheet.
setWarningOnly(warningOnly) Protection Sets whether or not this protected range is using "warning based" protection.

ProtectionType

خواص

ویژگی تایپ کنید شرح
RANGE Enum Protection for a range.
SHEET Enum Protection for a sheet.

Range

مواد و روش ها

روش Return type توضیح مختصر
activate() Range Sets the specified range as the active range , with the top left cell in the range as the current cell .
activateAsCurrentCell() Range Sets the specified cell as the current cell .
addDeveloperMetadata(key) Range Adds developer metadata with the specified key to the range.
addDeveloperMetadata(key, visibility) Range Adds developer metadata with the specified key and visibility to the range.
addDeveloperMetadata(key, value) Range Adds developer metadata with the specified key and value to the range.
addDeveloperMetadata(key, value, visibility) Range Adds developer metadata with the specified key, value, and visibility to the range.
applyColumnBanding() Banding Applies a default column banding theme to the range.
applyColumnBanding(bandingTheme) Banding Applies a specified column banding theme to the range.
applyColumnBanding(bandingTheme, showHeader, showFooter) Banding Applies a specified column banding theme to the range with specified header and footer settings.
applyRowBanding() Banding Applies a default row banding theme to the range.
applyRowBanding(bandingTheme) Banding Applies a specified row banding theme to the range.
applyRowBanding(bandingTheme, showHeader, showFooter) Banding Applies a specified row banding theme to the range with specified header and footer settings.
autoFill(destination, series) void Fills the destinationRange with data based on the data in this range.
autoFillToNeighbor(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.
breakApart() Range Break any multi-column cells in the range into individual cells again.
canEdit() 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.
clearContent() Range Clears the content of the range, leaving the formatting intact.
clearDataValidations() Range Clears the data validation rules for the range.
clearFormat() Range Clears formatting for this range.
clearNote() Range Clears the note in the given cell or cells.
collapseGroups() Range Collapses all groups that are wholly contained within the range.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) void Copy the formatting of the range to the given location.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) void Copy the formatting of the range to the given location.
copyTo(destination) void Copies the data from a range of cells to another range of cells.
copyTo(destination, copyPasteType, transposed) void Copies the data from a range of cells to another range of cells.
copyTo(destination, options) void Copies the data from a range of cells to another range of cells.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) void Copy the content of the range to the given location.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) void Copy the content of the range to the given location.
createDataSourcePivotTable(dataSource) DataSourcePivotTable Creates an empty data source pivot table from the data source, anchored at the first cell in this range.
createDataSourceTable(dataSource) DataSourceTable Creates an empty data source table from the data source, anchored at the first cell in this range.
createDeveloperMetadataFinder() DeveloperMetadataFinder Returns a DeveloperMetadataFinderApi for finding developer metadata within the scope of this range.
createFilter() Filter Creates a filter and applies it to the specified range on the sheet.
createPivotTable(sourceData) PivotTable Creates an empty pivot table from the specified sourceData anchored at the first cell in this range.
createTextFinder(findText) TextFinder Creates a text finder for the range, which can find and replace text in this range.
deleteCells(shiftDimension) void Deletes this range of cells.
expandGroups() 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.
getBackground() String Returns the background color of the top-left cell in the range (for example, '#ffffff' ).
getBackgroundObject() Color Returns the background color of the top-left cell in the range.
getBackgroundObjects() Color[][] Returns the background colors of the cells in the range.
getBackgrounds() String[][] Returns the background colors of the cells in the range (for example, '#ffffff' ).
getBandings() Banding[] Returns all the bandings that are applied to any cells in this range.
getCell(row, column) Range Returns a given cell within a range.
getColumn() Integer Returns the starting column position for this range.
getDataRegion() Range Returns a copy of the range expanded in the four cardinal Direction s to cover all adjacent cells with data in them.
getDataRegion(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 .
getDataSourceFormula() DataSourceFormula Returns the DataSourceFormula for the first cell in the range, or null if the cell doesn't contain a data source formula.
getDataSourceFormulas() DataSourceFormula[] Returns the DataSourceFormula s for the cells in the range.
getDataSourcePivotTables() DataSourcePivotTable[] Gets all the data source pivot tables intersecting with the range.
getDataSourceTables() DataSourceTable[] Gets all the data source tables intersecting with the range.
getDataSourceUrl() String Returns a URL for the data in this range, which can be used to create charts and queries.
getDataTable() DataTable Return the data inside this object as a DataTable.
getDataTable(firstRowIsHeader) DataTable Return the data inside this range as a DataTable.
getDataValidation() DataValidation Returns the data validation rule for the top-left cell in the range.
getDataValidations() DataValidation[][] Returns the data validation rules for all cells in the range.
getDeveloperMetadata() DeveloperMetadata[] Gets the developer metadata associated with this range.
getDisplayValue() String Returns the displayed value of the top-left cell in the range.
getDisplayValues() String[][] Returns the rectangular grid of values for this range.
getFilter() Filter Returns the filter on the sheet this range belongs to, or null if there is no filter on the sheet.
getFontColorObject() Color Returns the font color of the cell in the top-left corner of the range.
getFontColorObjects() Color[][] Returns the font colors of the cells in the range.
getFontFamilies() String[][] Returns the font families of the cells in the range.
getFontFamily() String Returns the font family of the cell in the top-left corner of the range.
getFontLine() String Gets the line style of the cell in the top-left corner of the range ( 'underline' , 'line-through' , or 'none' ).
getFontLines() String[][] Gets the line style of the cells in the range ( 'underline' , 'line-through' , or 'none' ).
getFontSize() Integer Returns the font size in point size of the cell in the top-left corner of the range.
getFontSizes() Integer[][] Returns the font sizes of the cells in the range.
getFontStyle() String Returns the font style ( 'italic' or 'normal' ) of the cell in the top-left corner of the range.
getFontStyles() String[][] Returns the font styles of the cells in the range.
getFontWeight() String Returns the font weight (normal/bold) of the cell in the top-left corner of the range.
getFontWeights() String[][] Returns the font weights of the cells in the range.
getFormula() 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.
getFormulaR1C1() String Returns the formula (R1C1 notation) for a given cell, or null if none.
getFormulas() String[][] Returns the formulas (A1 notation) for the cells in the range.
getFormulasR1C1() String[][] Returns the formulas (R1C1 notation) for the cells in the range.
getGridId() Integer Returns the grid ID of the range's parent sheet.
getHeight() Integer Returns the height of the range.
getHorizontalAlignment() String Returns the horizontal alignment of the text (left/center/right) of the cell in the top-left corner of the range.
getHorizontalAlignments() String[][] Returns the horizontal alignments of the cells in the range.
getLastColumn() Integer Returns the end column position.
getLastRow() Integer Returns the end row position.
getMergedRanges() 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.
getNextDataCell(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.
getNote() String Returns the note associated with the given range.
getNotes() String[][] Returns the notes associated with the cells in the range.
getNumColumns() Integer Returns the number of columns in this range.
getNumRows() Integer Returns the number of rows in this range.
getNumberFormat() String Get the number or date formatting of the top-left cell of the given range.
getNumberFormats() String[][] Returns the number or date formats for the cells in the range.
getRichTextValue() RichTextValue Returns the Rich Text value for the top left cell of the range, or null if the cell value is not text.
getRichTextValues() RichTextValue[][] Returns the Rich Text values for the cells in the range.
getRow() Integer Returns the row position for this range.
getRowIndex() Integer Returns the row position for this range.
getSheet() Sheet Returns the sheet this range belongs to.
getTextDirection() TextDirection Returns the text direction for the top left cell of the range.
getTextDirections() TextDirection[][] Returns the text directions for the cells in the range.
getTextRotation() TextRotation Returns the text rotation settings for the top left cell of the range.
getTextRotations() TextRotation[][] Returns the text rotation settings for the cells in the range.
getTextStyle() TextStyle Returns the text style for the top left cell of the range.
getTextStyles() TextStyle[][] Returns the text styles for the cells in the range.
getValue() Object Returns the value of the top-left cell in the range.
getValues() Object[][] Returns the rectangular grid of values for this range.
getVerticalAlignment() String Returns the vertical alignment (top/middle/bottom) of the cell in the top-left corner of the range.
getVerticalAlignments() String[][] Returns the vertical alignments of the cells in the range.
getWidth() Integer Returns the width of the range in columns.
getWrap() Boolean Returns whether the text in the cell wraps.
getWrapStrategies() WrapStrategy[][] Returns the text wrapping strategies for the cells in the range.
getWrapStrategy() WrapStrategy Returns the text wrapping strategy for the top left cell of the range.
getWraps() Boolean[][] Returns whether the text in the cells wrap.
insertCells(shiftDimension) Range Inserts empty cells into this range.
insertCheckboxes() Range Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked.
insertCheckboxes(checkedValue) Range Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked.
insertCheckboxes(checkedValue, uncheckedValue) Range Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states.
isBlank() Boolean Returns true if the range is totally blank.
isChecked() Boolean Returns whether all cells in the range have their checkbox state as 'checked'.
isEndColumnBounded() Boolean Determines whether the end of the range is bound to a particular column.
isEndRowBounded() Boolean Determines whether the end of the range is bound to a particular row.
isPartOfMerge() Boolean Returns true if the cells in the current range overlap any merged cells.
isStartColumnBounded() Boolean Determines whether the start of the range is bound to a particular column.
isStartRowBounded() 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.
mergeAcross() Range Merge the cells in the range across the columns of the range.
mergeVertically() Range Merges the cells in the range together.
moveTo(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.
removeCheckboxes() Range Removes all checkboxes from the range.
removeDuplicates() Range Removes rows within this range that contain values that are duplicates of values in any previous row.
removeDuplicates(columnsToCompare) Range Removes rows within this range that contain values in the specified columns that are duplicates of values any previous row.
setBackground(color) Range Sets the background color of all cells in the range in CSS notation (such as '#ffffff' or 'white' ).
setBackgroundObject(color) Range Sets the background color of all cells in the range.
setBackgroundObjects(color) Range Sets a rectangular grid of background colors (must match dimensions of this range).
setBackgroundRGB(red, green, blue) Range Sets the background to the given color using RGB values (integers between 0 and 255 inclusive).
setBackgrounds(color) Range Sets a rectangular grid of background colors (must match dimensions of this range).
setBorder(top, left, bottom, right, vertical, horizontal) Range Sets the border property.
setBorder(top, left, bottom, right, vertical, horizontal, color, style) Range Sets the border property with color and/or style.
setDataValidation(rule) Range Sets one data validation rule for all cells in the range.
setDataValidations(rules) Range Sets the data validation rules for all cells in the range.
setFontColor(color) Range Sets the font color in CSS notation (such as '#ffffff' or 'white' ).
setFontColorObject(color) Range Sets the font color of the given range.
setFontColorObjects(colors) Range Sets a rectangular grid of font colors (must match dimensions of this range).
setFontColors(colors) Range Sets a rectangular grid of font colors (must match dimensions of this range).
setFontFamilies(fontFamilies) Range Sets a rectangular grid of font families (must match dimensions of this range).
setFontFamily(fontFamily) Range Sets the font family, such as "Arial" or "Helvetica".
setFontLine(fontLine) Range Sets the font line style of the given range ( 'underline' , 'line-through' , or 'none' ).
setFontLines(fontLines) Range Sets a rectangular grid of line styles (must match dimensions of this range).
setFontSize(size) Range Sets the font size, with the size being the point size to use.
setFontSizes(sizes) Range Sets a rectangular grid of font sizes (must match dimensions of this range).
setFontStyle(fontStyle) Range Set the font style for the given range ( 'italic' or 'normal' ).
setFontStyles(fontStyles) Range Sets a rectangular grid of font styles (must match dimensions of this range).
setFontWeight(fontWeight) Range Set the font weight for the given range (normal/bold).
setFontWeights(fontWeights) Range Sets a rectangular grid of font weights (must match dimensions of this range).
setFormula(formula) Range Updates the formula for this range.
setFormulaR1C1(formula) Range Updates the formula for this range.
setFormulas(formulas) Range Sets a rectangular grid of formulas (must match dimensions of this range).
setFormulasR1C1(formulas) Range Sets a rectangular grid of formulas (must match dimensions of this range).
setHorizontalAlignment(alignment) Range Set the horizontal (left to right) alignment for the given range (left/center/right).
setHorizontalAlignments(alignments) Range Sets a rectangular grid of horizontal alignments.
setNote(note) Range Sets the note to the given value.
setNotes(notes) Range Sets a rectangular grid of notes (must match dimensions of this range).
setNumberFormat(numberFormat) Range Sets the number or date format to the given formatting string.
setNumberFormats(numberFormats) Range Sets a rectangular grid of number or date formats (must match dimensions of this range).
setRichTextValue(value) Range Sets the Rich Text value for the cells in the range.
setRichTextValues(values) Range Sets a rectangular grid of Rich Text values.
setShowHyperlink(showHyperlink) Range Sets whether or not the range should show hyperlinks.
setTextDirection(direction) Range Sets the text direction for the cells in the range.
setTextDirections(directions) Range Sets a rectangular grid of text directions.
setTextRotation(degrees) Range Sets the text rotation settings for the cells in the range.
setTextRotation(rotation) Range Sets the text rotation settings for the cells in the range.
setTextRotations(rotations) Range Sets a rectangular grid of text rotations.
setTextStyle(style) Range Sets the text style for the cells in the range.
setTextStyles(styles) Range Sets a rectangular grid of text styles.
setValue(value) Range Sets the value of the range.
setValues(values) Range Sets a rectangular grid of values (must match dimensions of this range).
setVerticalAlignment(alignment) Range Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
setVerticalAlignments(alignments) Range Sets a rectangular grid of vertical alignments (must match dimensions of this range).
setVerticalText(isVertical) Range Sets whether or not to stack the text for the cells in the range.
setWrap(isWrapEnabled) Range Set the cell wrap of the given range.
setWrapStrategies(strategies) Range Sets a rectangular grid of wrap strategies.
setWrapStrategy(strategy) Range Sets the text wrapping strategy for the cells in the range.
setWraps(isWrapEnabled) Range Sets a rectangular grid of word wrap policies (must match dimensions of this range).
shiftColumnGroupDepth(delta) Range Changes the column grouping depth of the range by the specified amount.
shiftRowGroupDepth(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.
splitTextToColumns() void Splits a column of text into multiple columns based on an auto-detected delimiter.
splitTextToColumns(delimiter) void Splits a column of text into multiple columns using the specified string as a custom delimiter.
splitTextToColumns(delimiter) void Splits a column of text into multiple columns based on the specified delimiter.
trimWhitespace() 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”.

RangeList

مواد و روش ها

روش Return type توضیح مختصر
activate() RangeList Selects the list of Range instances.
breakApart() RangeList Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
check() RangeList Changes the state of the checkboxes in the range to “checked”.
clear() RangeList Clears the range of contents, formats, and data validation rules for each Range in the range list.
clear(options) RangeList Clears the range of contents, format, data validation rules, and comments, as specified with the given options.
clearContent() RangeList Clears the content of each Range in the range list, leaving the formatting intact.
clearDataValidations() RangeList Clears the data validation rules for each Range in the range list.
clearFormat() RangeList Clears text formatting for each Range in the range list.
clearNote() RangeList Clears the note for each Range in the range list.
getRanges() Range[] Returns a list of one or more Range instances in the same sheet.
insertCheckboxes() RangeList Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked.
insertCheckboxes(checkedValue) RangeList Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked.
insertCheckboxes(checkedValue, uncheckedValue) RangeList Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states.
removeCheckboxes() RangeList Removes all checkboxes from the range.
setBackground(color) RangeList Sets the background color for each Range in the range list.
setBackgroundRGB(red, green, blue) RangeList Sets the background to the given RGB color.
setBorder(top, left, bottom, right, vertical, horizontal) RangeList Sets the border property for each Range in the range list.
setBorder(top, left, bottom, right, vertical, horizontal, color, style) RangeList Sets the border property with color and/or style for each Range in the range list.
setFontColor(color) RangeList Sets the font color for each Range in the range list.
setFontFamily(fontFamily) RangeList Sets the font family for each Range in the range list.
setFontLine(fontLine) RangeList Sets the font line style for each Range in the range list.
setFontSize(size) RangeList Sets the font size (in points) for each Range in the range list.
setFontStyle(fontStyle) RangeList Set the font style for each Range in the range list.
setFontWeight(fontWeight) RangeList Set the font weight for each Range in the range list.
setFormula(formula) RangeList Updates the formula for each Range in the range list.
setFormulaR1C1(formula) RangeList Updates the formula for each Range in the range list.
setHorizontalAlignment(alignment) RangeList Set the horizontal alignment for each Range in the range list.
setNote(note) RangeList Sets the note text for each Range in the range list.
setNumberFormat(numberFormat) RangeList Sets the number or date format for each Range in the range list.
setShowHyperlink(showHyperlink) RangeList Sets whether or not each Range in the range list should show hyperlinks.
setTextDirection(direction) RangeList Sets the text direction for the cells in each Range in the range list.
setTextRotation(degrees) RangeList Sets the text rotation settings for the cells in each Range in the range list.
setValue(value) RangeList Sets the value for each Range in the range list.
setVerticalAlignment(alignment) RangeList Set the vertical alignment for each Range in the range list.
setVerticalText(isVertical) RangeList Sets whether or not to stack the text for the cells for each Range in the range list.
setWrap(isWrapEnabled) RangeList Set text wrapping for each Range in the range list.
setWrapStrategy(strategy) RangeList Sets the text wrapping strategy for each Range in the range list.
trimWhitespace() RangeList Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range list.
uncheck() RangeList Changes the state of the checkboxes in the range to “unchecked”.

RecalculationInterval

خواص

ویژگی تایپ کنید شرح
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.

RelativeDate

خواص

ویژگی تایپ کنید شرح
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.

RichTextValue

مواد و روش ها

روش Return type توضیح مختصر
copy() RichTextValueBuilder Returns a builder for a Rich Text value initialized with the values of this Rich Text value.
getEndIndex() Integer Gets the end index of this value in the cell.
getLinkUrl() String Returns the link URL for this value.
getLinkUrl(startOffset, endOffset) String Returns the link URL for the text from startOffset to endOffset .
getRuns() RichTextValue[] Returns the Rich Text string split into an array of runs, wherein each run is the longest possible substring having a consistent text style.
getStartIndex() Integer Gets the start index of this value in the cell.
getText() String Returns the text of this value.
getTextStyle() TextStyle Returns the text style of this value.
getTextStyle(startOffset, endOffset) TextStyle Returns the text style of the text from startOffset to endOffset .

RichTextValueBuilder

مواد و روش ها

روش Return type توضیح مختصر
build() RichTextValue Creates a Rich Text value from this builder.
setLinkUrl(startOffset, endOffset, linkUrl) RichTextValueBuilder Sets the link URL for the given substring of this value, or clears it if linkUrl is null .
setLinkUrl(linkUrl) RichTextValueBuilder Sets the link URL for the entire value, or clears it if linkUrl is null .
setText(text) RichTextValueBuilder Sets the text for this value and clears any existing text style.
setTextStyle(startOffset, endOffset, textStyle) RichTextValueBuilder Applies a text style to the given substring of this value.
setTextStyle(textStyle) RichTextValueBuilder Applies a text style to the entire value.

Selection

مواد و روش ها

روش Return type توضیح مختصر
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no active ranges.
getActiveSheet() Sheet Returns the active sheet in the spreadsheet.
getCurrentCell() Range Returns the current (highlighted) cell that is selected in one of the active ranges or null if there is no current cell.
getNextDataRange(direction) Range 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

مواد و روش ها

روش Return type توضیح مختصر
activate() Sheet Activates this sheet.
addDeveloperMetadata(key) Sheet Adds developer metadata with the specified key to the sheet.
addDeveloperMetadata(key, visibility) Sheet Adds developer metadata with the specified key and visibility to the sheet.
addDeveloperMetadata(key, value) Sheet Adds developer metadata with the specified key and value to the sheet.
addDeveloperMetadata(key, value, visibility) Sheet Adds developer metadata with the specified key, value, and visibility to the sheet.
appendRow(rowContents) Sheet Appends a row to the bottom of the current data region in the sheet.
asDataSourceSheet() DataSourceSheet Returns the sheet as a DataSourceSheet if the sheet is of type SheetType.DATASOURCE , or null otherwise.
autoResizeColumn(columnPosition) Sheet Sets the width of the given column to fit its contents.
autoResizeColumns(startColumn, numColumns) Sheet Sets the width of all columns starting at the given column position to fit their contents.
autoResizeRows(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.
clearConditionalFormatRules() void Removes all conditional format rules from the sheet.
clearContents() Sheet Clears the sheet of contents, while preserving formatting information.
clearFormats() Sheet Clears the sheet of formatting, while preserving contents.
clearNotes() Sheet Clears the sheet of all notes.
collapseAllColumnGroups() Sheet Collapses all column groups on the sheet.
collapseAllRowGroups() Sheet Collapses all row groups on the sheet.
copyTo(spreadsheet) Sheet Copies the sheet to a given spreadsheet, which can be the same spreadsheet as the source.
createDeveloperMetadataFinder() DeveloperMetadataFinder Returns a DeveloperMetadataFinder for finding developer metadata within the scope of this sheet.
createTextFinder(findText) TextFinder Creates a text finder for the sheet, which can find and replace text within the sheet.
deleteColumn(columnPosition) Sheet Deletes the column at the given column position.
deleteColumns(columnPosition, howMany) void Deletes a number of columns starting at the given column position.
deleteRow(rowPosition) Sheet Deletes the row at the given row position.
deleteRows(rowPosition, howMany) void Deletes a number of rows starting at the given row position.
expandAllColumnGroups() Sheet Expands all column groups on the sheet.
expandAllRowGroups() Sheet Expands all row groups on the sheet.
expandColumnGroupsUpToDepth(groupDepth) Sheet Expands all column groups up to the given depth, and collapses all others.
expandRowGroupsUpToDepth(groupDepth) Sheet Expands all row groups up to the given depth, and collapses all others.
getActiveCell() Range Returns the active cell in this sheet.
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no active ranges.
getBandings() Banding[] Returns all the bandings in this sheet.
getCharts() EmbeddedChart[] Returns an array of charts on this sheet.
getColumnGroup(columnIndex, groupDepth) Group Returns the column group at the given index and group depth.
getColumnGroupControlPosition() GroupControlTogglePosition Returns the GroupControlTogglePosition for all column groups on the sheet.
getColumnGroupDepth(columnIndex) Integer Returns the group depth of the column at the given index.
getColumnWidth(columnPosition) Integer Gets the width in pixels of the given column.
getConditionalFormatRules() ConditionalFormatRule[] Get all conditional format rules in this sheet.
getCurrentCell() Range Returns the current cell in the active sheet or null if there is no current cell.
getDataRange() Range Returns a Range corresponding to the dimensions in which data is present.
getDataSourceFormulas() DataSourceFormula[] Gets all the data source formulas.
getDataSourcePivotTables() DataSourcePivotTable[] Gets all the data source pivot tables.
getDataSourceTables() DataSourceTable[] Gets all the data source tables.
getDeveloperMetadata() DeveloperMetadata[] Get all developer metadata associated with this sheet.
getDrawings() Drawing[] Returns an array of drawings on the sheet.
getFilter() Filter Returns the filter in this sheet, or null if there is no filter.
getFormUrl() String Returns the URL for the form that sends its responses to this sheet, or null if this sheet has no associated form.
getFrozenColumns() Integer Returns the number of frozen columns.
getFrozenRows() Integer Returns the number of frozen rows.
getImages() OverGridImage[] Returns all over-the-grid images on the sheet.
getIndex() Integer Gets the position of the sheet in its parent spreadsheet.
getLastColumn() Integer Returns the position of the last column that has content.
getLastRow() Integer Returns the position of the last row that has content.
getMaxColumns() Integer Returns the current number of columns in the sheet, regardless of content.
getMaxRows() Integer Returns the current number of rows in the sheet, regardless of content.
getName() String Returns the name of the sheet.
getNamedRanges() NamedRange[] Gets all the named ranges in this sheet.
getParent() Spreadsheet Returns the Spreadsheet that contains this sheet.
getPivotTables() PivotTable[] Returns all the pivot tables on this sheet.
getProtections(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.
getRange(row, column) Range Returns the range with the top left cell at the given coordinates.
getRange(row, column, numRows) Range Returns the range with the top left cell at the given coordinates, and with the given number of rows.
getRange(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.
getRange(a1Notation) Range Returns the range as specified in A1 notation or R1C1 notation.
getRangeList(a1Notations) RangeList Returns the RangeList collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
getRowGroup(rowIndex, groupDepth) Group Returns the row group at the given index and group depth.
getRowGroupControlPosition() GroupControlTogglePosition Returns the GroupControlTogglePosition for all row groups on the sheet.
getRowGroupDepth(rowIndex) Integer Returns the group depth of the row at the given index.
getRowHeight(rowPosition) Integer Gets the height in pixels of the given row.
getSelection() Selection Returns the current Selection in the spreadsheet.
getSheetId() Integer Returns the ID of the sheet represented by this object.
getSheetName() String Returns the sheet name.
getSheetValues(startRow, startColumn, numRows, numColumns) Object[][] Returns the rectangular grid of values for this range starting at the given coordinates.
getSlicers() Slicer[] Returns an array of slicers on the sheet.
getTabColorObject() Color Gets the sheet tab color, or null if the sheet tab has no color.
getType() SheetType Returns the type of the sheet.
hasHiddenGridlines() Boolean Returns true if the sheet's gridlines are hidden; otherwise returns false .
hideColumn(column) void Hides the column or columns in the given range.
hideColumns(columnIndex) void Hides a single column at the given index.
hideColumns(columnIndex, numColumns) void Hides one or more consecutive columns starting at the given index.
hideRow(row) void Hides the rows in the given range.
hideRows(rowIndex) void Hides the row at the given index.
hideRows(rowIndex, numRows) void Hides one or more consecutive rows starting at the given index.
hideSheet() Sheet Hides this sheet.
insertChart(chart) void Adds a new chart to this sheet.
insertColumnAfter(afterPosition) Sheet Inserts a column after the given column position.
insertColumnBefore(beforePosition) Sheet Inserts a column before the given column position.
insertColumns(columnIndex) void Inserts a blank column in a sheet at the specified location.
insertColumns(columnIndex, numColumns) void Inserts one or more consecutive blank columns in a sheet starting at the specified location.
insertColumnsAfter(afterPosition, howMany) Sheet Inserts a given number of columns after the given column position.
insertColumnsBefore(beforePosition, howMany) Sheet Inserts a number of columns before the given column position.
insertImage(blobSource, column, row) OverGridImage Inserts a BlobSource as an image in the document at a given row and column.
insertImage(blobSource, column, row, offsetX, offsetY) OverGridImage Inserts a BlobSource as an image in the document at a given row and column, with a pixel offset.
insertImage(url, column, row) OverGridImage Inserts an image in the document at a given row and column.
insertImage(url, column, row, offsetX, offsetY) OverGridImage Inserts an image in the document at a given row and column, with a pixel offset.
insertRowAfter(afterPosition) Sheet Inserts a row after the given row position.
insertRowBefore(beforePosition) Sheet Inserts a row before the given row position.
insertRows(rowIndex) void Inserts a blank row in a sheet at the specified location.
insertRows(rowIndex, numRows) void Inserts one or more consecutive blank rows in a sheet starting at the specified location.
insertRowsAfter(afterPosition, howMany) Sheet Inserts a number of rows after the given row position.
insertRowsBefore(beforePosition, howMany) Sheet Inserts a number of rows before the given row position.
insertSlicer(range, anchorRowPos, anchorColPos) Slicer Adds a new slicer to this sheet.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) Slicer Adds a new slicer to this sheet.
isColumnHiddenByUser(columnPosition) Boolean Returns whether the given column is hidden by the user.
isRightToLeft() Boolean Returns true if this sheet layout is right-to-left.
isRowHiddenByFilter(rowPosition) Boolean Returns whether the given row is hidden by a filter (not a filter view).
isRowHiddenByUser(rowPosition) Boolean Returns whether the given row is hidden by the user.
isSheetHidden() Boolean Returns true if the sheet is currently hidden.
moveColumns(columnSpec, destinationIndex) void Moves the columns selected by the given range to the position indicated by the destinationIndex .
moveRows(rowSpec, destinationIndex) void Moves the rows selected by the given range to the position indicated by the destinationIndex .
newChart() EmbeddedChartBuilder 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.
removeChart(chart) void Removes a chart from the parent sheet.
setActiveRange(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 .
setActiveRangeList(rangeList) RangeList Sets the specified list of ranges as the active ranges in the active sheet.
setActiveSelection(range) Range Sets the active selection region for this sheet.
setActiveSelection(a1Notation) Range Sets the active selection, as specified in A1 notation or R1C1 notation.
setColumnGroupControlPosition(position) Sheet Sets the position of the column group control toggle on the sheet.
setColumnWidth(columnPosition, width) Sheet Sets the width of the given column in pixels.
setColumnWidths(startColumn, numColumns, width) Sheet Sets the width of the given columns in pixels.
setConditionalFormatRules(rules) void Replaces all currently existing conditional format rules in the sheet with the input rules.
setCurrentCell(cell) Range Sets the specified cell as the current cell .
setFrozenColumns(columns) void Freezes the given number of columns.
setFrozenRows(rows) void Freezes the given number of rows.
setHiddenGridlines(hideGridlines) Sheet Hides or reveals the sheet gridlines.
setName(name) Sheet Sets the sheet name.
setRightToLeft(rightToLeft) Sheet Sets or unsets the sheet layout to right-to-left.
setRowGroupControlPosition(position) Sheet Sets the position of the row group control toggle on the sheet.
setRowHeight(rowPosition, height) Sheet Sets the row height of the given row in pixels.
setRowHeights(startRow, numRows, height) Sheet Sets the height of the given rows in pixels.
setRowHeightsForced(startRow, numRows, height) Sheet Sets the height of the given rows in pixels.
setTabColor(color) Sheet Sets the sheet tab color.
setTabColorObject(color) Sheet Sets the sheet tab color.
showColumns(columnIndex) void Unhides the column at the given index.
showColumns(columnIndex, numColumns) void Unhides one or more consecutive columns starting at the given index.
showRows(rowIndex) void Unhides the row at the given index.
showRows(rowIndex, numRows) void Unhides one or more consecutive rows starting at the given index.
showSheet() Sheet Makes the sheet visible.
sort(columnPosition) Sheet Sorts a sheet by column, ascending.
sort(columnPosition, ascending) Sheet Sorts a sheet by column.
unhideColumn(column) void Unhides the column in the given range.
unhideRow(row) void Unhides the row in the given range.
updateChart(chart) void Updates the chart on this sheet.

SheetType

خواص

ویژگی تایپ کنید شرح
GRID Enum A sheet containing a grid.
OBJECT Enum A sheet containing a single embedded object such as an EmbeddedChart .
DATASOURCE Enum A sheet containing a DataSource .

Slicer

مواد و روش ها

روش Return type توضیح مختصر
getBackgroundColorObject() Color Return the background Color of the slicer.
getColumnPosition() Integer 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.
getContainerInfo() ContainerInfo Gets information about where the slicer is positioned in the sheet.
getFilterCriteria() FilterCriteria Returns the filter criteria of the slicer, or null if the filter criteria is not set.
getRange() Range Gets the data range on which the slicer is applied to.
getTitle() String Returns the title of the slicer.
getTitleHorizontalAlignment() String Gets the horizontal alignment of the title.
getTitleTextStyle() TextStyle Returns the text style of the slicer's title.
isAppliedToPivotTables() Boolean Returns whether the given slicer is applied to pivot tables.
remove() void Deletes the slicer.
setApplyToPivotTables(applyToPivotTables) Slicer Sets if the given slicer should be applied to pivot tables in the worksheet.
setBackgroundColor(color) Slicer Sets the background color of the slicer.
setBackgroundColorObject(color) Slicer Sets the background Color of the slicer.
setColumnFilterCriteria(columnPosition, filterCriteria) Slicer Sets the column index and filtering criteria of the slicer.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) Slicer Sets the position where the slicer appears on the sheet.
setRange(rangeApi) Slicer Sets the data range on which the slicer is applied.
setTitle(title) Slicer Sets the title of the slicer.
setTitleHorizontalAlignment(horizontalAlignment) Slicer Sets the horizontal alignment of the title in the slicer.
setTitleTextStyle(textStyle) Slicer Sets the text style of the slicer.

SortOrder

خواص

ویژگی تایپ کنید شرح
ASCENDING Enum Ascending sort order.
DESCENDING Enum Descending sort order.

SortSpec

مواد و روش ها

روش Return type توضیح مختصر
getBackgroundColor() Color Returns the background color used for sorting, or null if absent.
getDataSourceColumn() DataSourceColumn Gets the data source column the sort spec acts on.
getDimensionIndex() Integer Returns the dimension index or null if not linked to a local filter.
getForegroundColor() Color Returns the foreground color used for sorting, or null if absent.
getSortOrder() SortOrder Returns the sort order.
isAscending() Boolean Returns whether the sort order is ascending.

Spreadsheet

مواد و روش ها

روش Return type توضیح مختصر
addDeveloperMetadata(key) Spreadsheet Adds developer metadata with the specified key to the top-level spreadsheet.
addDeveloperMetadata(key, visibility) Spreadsheet Adds developer metadata with the specified key and visibility to the spreadsheet.
addDeveloperMetadata(key, value) Spreadsheet Adds developer metadata with the specified key and value to the spreadsheet.
addDeveloperMetadata(key, value, visibility) Spreadsheet Adds developer metadata with the specified key, value, and visibility to the spreadsheet.
addEditor(emailAddress) Spreadsheet Adds the given user to the list of editors for the Spreadsheet .
addEditor(user) Spreadsheet Adds the given user to the list of editors for the Spreadsheet .
addEditors(emailAddresses) Spreadsheet Adds the given array of users to the list of editors for the Spreadsheet .
addMenu(name, subMenus) void Creates a new menu in the Spreadsheet UI.
addViewer(emailAddress) Spreadsheet Adds the given user to the list of viewers for the Spreadsheet .
addViewer(user) Spreadsheet Adds the given user to the list of viewers for the Spreadsheet .
addViewers(emailAddresses) Spreadsheet Adds the given array of users to the list of viewers for the Spreadsheet .
appendRow(rowContents) Sheet Appends a row to the bottom of the current data region in the sheet.
autoResizeColumn(columnPosition) Sheet Sets the width of the given column to fit its contents.
copy(name) Spreadsheet Copies the spreadsheet and returns the new one.
createDeveloperMetadataFinder() DeveloperMetadataFinder Returns a DeveloperMetadataFinder for finding developer metadata within the scope of this spreadsheet.
createTextFinder(findText) TextFinder Creates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet.
deleteActiveSheet() Sheet Deletes the currently active sheet.
deleteColumn(columnPosition) Sheet Deletes the column at the given column position.
deleteColumns(columnPosition, howMany) void Deletes a number of columns starting at the given column position.
deleteRow(rowPosition) Sheet Deletes the row at the given row position.
deleteRows(rowPosition, howMany) void Deletes a number of rows starting at the given row position.
deleteSheet(sheet) void Deletes the specified sheet.
duplicateActiveSheet() Sheet Duplicates the active sheet and makes it the active sheet.
getActiveCell() Range Returns the active cell in this sheet.
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no active ranges.
getActiveSheet() Sheet Gets the active sheet in a spreadsheet.
getAs(contentType) Blob Return the data inside this object as a blob converted to the specified content type.
getBandings() Banding[] Returns all the bandings in this spreadsheet.
getBlob() Blob Return the data inside this object as a blob.
getColumnWidth(columnPosition) Integer Gets the width in pixels of the given column.
getCurrentCell() Range Returns the current cell in the active sheet or null if there is no current cell.
getDataRange() Range Returns a Range corresponding to the dimensions in which data is present.
getDataSourceFormulas() DataSourceFormula[] Gets all the data source formulas.
getDataSourcePivotTables() DataSourcePivotTable[] Gets all the data source pivot tables.
getDataSourceRefreshSchedules() DataSourceRefreshSchedule[] Gets the refresh schedules of this spreadsheet.
getDataSourceSheets() DataSourceSheet[] Returns all the data source sheets in the spreadsheet.
getDataSourceTables() DataSourceTable[] Gets all the data source tables.
getDataSources() DataSource[] Returns all the data sources in the spreadsheet.
getDeveloperMetadata() DeveloperMetadata[] Gets the developer metadata associated with the top-level spreadsheet.
getEditors() User[] Gets the list of editors for this Spreadsheet .
getFormUrl() String Returns the URL for the form that sends its responses to this spreadsheet, or null if this spreadsheet has no associated form.
getFrozenColumns() Integer Returns the number of frozen columns.
getFrozenRows() Integer Returns the number of frozen rows.
getId() String Gets a unique identifier for this spreadsheet.
getImages() OverGridImage[] Returns all over-the-grid images on the sheet.
getIterativeCalculationConvergenceThreshold() Number Returns the threshold value used during iterative calculation.
getLastColumn() Integer Returns the position of the last column that has content.
getLastRow() Integer Returns the position of the last row that has content.
getMaxIterativeCalculationCycles() Integer Returns the maximum number of iterations to use during iterative calculation.
getName() String Gets the name of the document.
getNamedRanges() NamedRange[] Gets all the named ranges in this spreadsheet.
getNumSheets() Integer Returns the number of sheets in this spreadsheet.
getOwner() User Returns the owner of the document, or null for a document in a shared drive.
getPredefinedSpreadsheetThemes() SpreadsheetTheme[] Returns the list of predefined themes.
getProtections(type) Protection[] Gets an array of objects representing all protected ranges or sheets in the spreadsheet.
getRange(a1Notation) Range Returns the range as specified in A1 notation or R1C1 notation.
getRangeByName(name) Range Returns a named range, or null if no range with the given name is found.
getRangeList(a1Notations) RangeList Returns the RangeList collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
getRecalculationInterval() RecalculationInterval Returns the calculation interval for this spreadsheet.
getRowHeight(rowPosition) Integer Gets the height in pixels of the given row.
getSelection() Selection Returns the current Selection in the spreadsheet.
getSheetByName(name) Sheet Returns a sheet with the given name.
getSheetId() Integer Returns the ID of the sheet represented by this object.
getSheetName() String Returns the sheet name.
getSheetValues(startRow, startColumn, numRows, numColumns) Object[][] Returns the rectangular grid of values for this range starting at the given coordinates.
getSheets() Sheet[] Gets all the sheets in this spreadsheet.
getSpreadsheetLocale() String Gets the spreadsheet locale.
getSpreadsheetTheme() SpreadsheetTheme Returns the current theme of the spreadsheet, or null if no theme is applied.
getSpreadsheetTimeZone() String Gets the time zone for the spreadsheet.
getUrl() String Returns the URL for the given spreadsheet.
getViewers() User[] Gets the list of viewers and commenters for this Spreadsheet .
hideColumn(column) void Hides the column or columns in the given range.
hideRow(row) void Hides the rows in the given range.
insertColumnAfter(afterPosition) Sheet Inserts a column after the given column position.
insertColumnBefore(beforePosition) Sheet Inserts a column before the given column position.
insertColumnsAfter(afterPosition, howMany) Sheet Inserts a given number of columns after the given column position.
insertColumnsBefore(beforePosition, howMany) Sheet Inserts a number of columns before the given column position.
insertDataSourceSheet(spec) DataSourceSheet Inserts a new DataSourceSheet in the spreadsheet and starts data execution.
insertImage(blobSource, column, row) OverGridImage Inserts a Spreadsheet as an image in the document at a given row and column.
insertImage(blobSource, column, row, offsetX, offsetY) OverGridImage Inserts a Spreadsheet as an image in the document at a given row and column, with a pixel offset.
insertImage(url, column, row) OverGridImage Inserts an image in the document at a given row and column.
insertImage(url, column, row, offsetX, offsetY) OverGridImage Inserts an image in the document at a given row and column, with a pixel offset.
insertRowAfter(afterPosition) Sheet Inserts a row after the given row position.
insertRowBefore(beforePosition) Sheet Inserts a row before the given row position.
insertRowsAfter(afterPosition, howMany) Sheet Inserts a number of rows after the given row position.
insertRowsBefore(beforePosition, howMany) Sheet Inserts a number of rows before the given row position.
insertSheet() Sheet Inserts a new sheet into the spreadsheet, using a default sheet name.
insertSheet(sheetIndex) Sheet Inserts a new sheet into the spreadsheet at the given index.
insertSheet(sheetIndex, options) Sheet Inserts a new sheet into the spreadsheet at the given index and uses optional advanced arguments.
insertSheet(options) Sheet Inserts a new sheet into the spreadsheet, using a default sheet name and optional advanced arguments.
insertSheet(sheetName) Sheet Inserts a new sheet into the spreadsheet with the given name.
insertSheet(sheetName, sheetIndex) Sheet Inserts a new sheet into the spreadsheet with the given name at the given index.
insertSheet(sheetName, sheetIndex, options) Sheet Inserts a new sheet into the spreadsheet with the given name at the given index and uses optional advanced arguments.
insertSheet(sheetName, options) Sheet Inserts a new sheet into the spreadsheet with the given name and uses optional advanced arguments.
insertSheetWithDataSourceTable(spec) Sheet Inserts a new sheet in the spreadsheet, creates a DataSourceTable spanning the entire sheet with the given data source specification, and starts data execution.
isColumnHiddenByUser(columnPosition) Boolean Returns whether the given column is hidden by the user.
isIterativeCalculationEnabled() Boolean Returns whether iterative calculation is activated in this spreadsheet.
isRowHiddenByFilter(rowPosition) Boolean Returns whether the given row is hidden by a filter (not a filter view).
isRowHiddenByUser(rowPosition) Boolean Returns whether the given row is hidden by the user.
moveActiveSheet(pos) void Moves the active sheet to the given position in the list of sheets.
moveChartToObjectSheet(chart) Sheet Creates a new SheetType.OBJECT sheet and moves the provided chart to it.
refreshAllDataSources() void Refreshes all supported data sources and their linked data source objects, skipping invalid data source objects.
removeEditor(emailAddress) Spreadsheet Removes the given user from the list of editors for the Spreadsheet .
removeEditor(user) Spreadsheet Removes the given user from the list of editors for the Spreadsheet .
removeMenu(name) void Removes a menu that was added by addMenu(name, subMenus) .
removeNamedRange(name) void Deletes a named range with the given name.
removeViewer(emailAddress) Spreadsheet Removes the given user from the list of viewers and commenters for the Spreadsheet .
removeViewer(user) Spreadsheet Removes the given user from the list of viewers and commenters for the Spreadsheet .
rename(newName) void Renames the document.
renameActiveSheet(newName) void Renames the current active sheet to the given new name.
resetSpreadsheetTheme() SpreadsheetTheme Removes the applied theme and sets the default theme on the spreadsheet.
setActiveRange(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 .
setActiveRangeList(rangeList) RangeList Sets the specified list of ranges as the active ranges in the active sheet.
setActiveSelection(range) Range Sets the active selection region for this sheet.
setActiveSelection(a1Notation) Range Sets the active selection, as specified in A1 notation or R1C1 notation.
setActiveSheet(sheet) Sheet Sets the given sheet to be the active sheet in the spreadsheet.
setActiveSheet(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.
setColumnWidth(columnPosition, width) Sheet Sets the width of the given column in pixels.
setCurrentCell(cell) Range Sets the specified cell as the current cell .
setFrozenColumns(columns) void Freezes the given number of columns.
setFrozenRows(rows) void Freezes the given number of rows.
setIterativeCalculationConvergenceThreshold(minThreshold) Spreadsheet Sets the minimum threshold value for iterative calculation.
setIterativeCalculationEnabled(isEnabled) Spreadsheet Sets whether iterative calculation is activated in this spreadsheet.
setMaxIterativeCalculationCycles(maxIterations) Spreadsheet Sets the maximum number of calculation iterations that should be performed during iterative calculation.
setNamedRange(name, range) void Names a range.
setRecalculationInterval(recalculationInterval) Spreadsheet Sets how often this spreadsheet should recalculate.
setRowHeight(rowPosition, height) Sheet Sets the row height of the given row in pixels.
setSpreadsheetLocale(locale) void Sets the spreadsheet locale.
setSpreadsheetTheme(theme) SpreadsheetTheme Sets a theme on the spreadsheet.
setSpreadsheetTimeZone(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.
unhideColumn(column) void Unhides the column in the given range.
unhideRow(row) void Unhides the row in the given range.
updateMenu(name, subMenus) void Updates a menu that was added by addMenu(name, subMenus) .
waitForAllDataExecutionsCompletion(timeoutInSeconds) void Waits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds.

SpreadsheetApp

خواص

ویژگی تایپ کنید شرح
AutoFillSeries AutoFillSeries An enumeration of the types of series used to calculate auto-filled values.
BandingTheme BandingTheme An enumeration of the possible banding themes.
BooleanCriteria BooleanCriteria An enumeration of conditional formatting boolean criteria.
BorderStyle BorderStyle An enumeration of the valid styles for setting borders on a Range .
ColorType ColorType An enumeration of possible color types.
CopyPasteType CopyPasteType An enumeration of the possible paste types.
DataExecutionErrorCode DataExecutionErrorCode An enumeration of the possible data execution error codes.
DataExecutionState DataExecutionState An enumeration of the possible data execution states.
DataSourceParameterType DataSourceParameterType An enumeration of the possible data source parameter types.
DataSourceRefreshScope DataSourceRefreshScope An enumeration of possible data source refresh scopes.
DataSourceType DataSourceType An enumeration of the possible data source types.
DataValidationCriteria DataValidationCriteria An enumeration representing the data validation criteria that can be set on a range.
DateTimeGroupingRuleType DateTimeGroupingRuleType An enumeration of date time grouping rule.
DeveloperMetadataLocationType DeveloperMetadataLocationType An enumeration of possible developer metadata location types.
DeveloperMetadataVisibility DeveloperMetadataVisibility 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.
FrequencyType FrequencyType An enumeration of possible frequency types.
GroupControlTogglePosition GroupControlTogglePosition An enumeration of the positions that the group control toggle can be in.
InterpolationType InterpolationType An enumeration of conditional format gradient interpolation types.
PivotTableSummarizeFunction PivotTableSummarizeFunction An enumeration of the functions that may be used to summarize values in a pivot table.
PivotValueDisplayType PivotValueDisplayType An enumeration of the ways that a pivot value may be displayed.
ProtectionType ProtectionType An enumeration representing the parts of a spreadsheet that can be protected from edits.
RecalculationInterval RecalculationInterval An enumeration of the possible intervals that can be used in spreadsheet recalculation.
RelativeDate RelativeDate An enumeration of relative date options for calculating a value to be used in date-based BooleanCriteria .
SheetType SheetType An enumeration of the different types of sheets that can exist in a spreadsheet.
SortOrder SortOrder An enumeration of sort order.
TextDirection TextDirection An enumeration of valid text directions.
TextToColumnsDelimiter TextToColumnsDelimiter An enumeration of the preset delimiters for split text to columns.
ThemeColorType ThemeColorType An enumeration of possible theme color types.
ValueType ValueType An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service.
WrapStrategy WrapStrategy An enumeration of the strategies used for wrapping cells.

مواد و روش ها

روش Return type توضیح مختصر
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.
enableAllDataSourcesExecution() void Turns data execution on for all types of data sources.
enableBigQueryExecution() void Turns data execution on for BigQuery data sources.
flush() void Applies all pending Spreadsheet changes.
getActive() Spreadsheet Returns the currently active spreadsheet, or null if there is none.
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no ranges selected.
getActiveSheet() Sheet Gets the active sheet in a spreadsheet.
getActiveSpreadsheet() Spreadsheet Returns the currently active spreadsheet, or null if there is none.
getCurrentCell() Range 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.
getSelection() Selection Returns the current Selection in the spreadsheet.
getUi() Ui Returns an instance of the spreadsheet's user-interface environment that allows the script to add features like menus, dialogs, and sidebars.
newCellImage() CellImageBuilder Creates a builder for a CellImage .
newColor() ColorBuilder Creates a builder for a Color .
newConditionalFormatRule() ConditionalFormatRuleBuilder Creates a builder for a conditional formatting rule.
newDataSourceSpec() DataSourceSpecBuilder Creates a builder for a DataSourceSpec .
newDataValidation() DataValidationBuilder Creates a builder for a data validation rule.
newFilterCriteria() FilterCriteriaBuilder Creates a builder for a FilterCriteria .
newRichTextValue() RichTextValueBuilder Creates a builder for a Rich Text value.
newTextStyle() TextStyleBuilder Creates a builder for a text style.
open(file) Spreadsheet Opens the spreadsheet that corresponds to the given File object.
openById(id) Spreadsheet Opens the spreadsheet with the given ID.
openByUrl(url) Spreadsheet Opens the spreadsheet with the given URL.
setActiveRange(range) Range Sets the specified range as the active range , with the top left cell in the range as the current cell .
setActiveRangeList(rangeList) RangeList Sets the specified list of ranges as the active ranges .
setActiveSheet(sheet) Sheet Sets the active sheet in a spreadsheet.
setActiveSheet(sheet, restoreSelection) Sheet Sets the active sheet in a spreadsheet, with the option to restore the most recent selection within that sheet.
setActiveSpreadsheet(newActiveSpreadsheet) void Sets the active spreadsheet.
setCurrentCell(cell) Range Sets the specified cell as the current cell .

SpreadsheetTheme

مواد و روش ها

روش Return type توضیح مختصر
getConcreteColor(themeColorType) Color Returns the concrete Color for a valid theme color type.
getFontFamily() String Returns the font family of the theme, or null if it's a null theme.
getThemeColors() ThemeColorType[] Returns a list of all possible theme color types for the current theme.
setConcreteColor(themeColorType, color) SpreadsheetTheme Sets the concrete color associated with the ThemeColorType in this color scheme to the given color.
setConcreteColor(themeColorType, red, green, blue) SpreadsheetTheme Sets the concrete color associated with the ThemeColorType in this color scheme to the given color in RGB format.
setFontFamily(fontFamily) SpreadsheetTheme Sets the font family for the theme.

TextDirection

خواص

ویژگی تایپ کنید شرح
LEFT_TO_RIGHT Enum Left-to-right text direction.
RIGHT_TO_LEFT Enum Right-to-left text direction.

TextFinder

مواد و روش ها

روش Return type توضیح مختصر
findAll() Range[] Returns all cells matching the search criteria.
findNext() Range Returns the next cell matching the search criteria.
findPrevious() Range Returns the previous cell matching the search criteria.
getCurrentMatch() Range Returns the current cell matching the search criteria.
ignoreDiacritics(ignoreDiacritics) TextFinder If true , configures the search to ignore diacritics while matching; otherwise the search matches diacritics.
matchCase(matchCase) TextFinder If true , configures the search to match the search text's case exactly, otherwise the search defaults to case-insensitive matching.
matchEntireCell(matchEntireCell) TextFinder If true , configures the search to match the entire contents of a cell; otherwise, the search defaults to partial matching.
matchFormulaText(matchFormulaText) TextFinder If true , configures the search to return matches that appear within formula text; otherwise cells with formulas are considered based on their displayed value.
replaceAllWith(replaceText) Integer Replaces all matches with the specified text.
replaceWith(replaceText) Integer Replaces the search text in the currently matched cell with the specified text and returns the number of occurrences replaced.
startFrom(startRange) TextFinder Configures the search to start searching immediately after the specified cell range.
useRegularExpression(useRegEx) TextFinder If true , configures the search to interpret the search string as a regular expression; otherwise the search interprets the search string as normal text.

TextRotation

مواد و روش ها

روش Return type توضیح مختصر
getDegrees() Integer Gets the angle between standard text orientation and the current text orientation.
isVertical() Boolean Returns true if the text is stacked vertically; returns false otherwise.

TextStyle

مواد و روش ها

روش Return type توضیح مختصر
copy() TextStyleBuilder Creates a text style builder initialized with the values of this text style.
getFontFamily() String Gets the font family of the text.
getFontSize() Integer Gets the font size of the text in points.
getForegroundColorObject() Color Gets the font color of the text.
isBold() Boolean Gets whether or not the text is bold.
isItalic() Boolean Gets whether or not the cell is italic.
isStrikethrough() Boolean Gets whether or not the cell has strikethrough.
isUnderline() Boolean Gets whether or not the cell is underlined.

TextStyleBuilder

مواد و روش ها

روش Return type توضیح مختصر
build() TextStyle Creates a text style from this builder.
setBold(bold) TextStyleBuilder Sets whether or not the text is bold.
setFontFamily(fontFamily) TextStyleBuilder Sets the text font family, such as "Arial".
setFontSize(fontSize) TextStyleBuilder Sets the text font size in points.
setForegroundColor(cssString) TextStyleBuilder Sets the text font color.
setForegroundColorObject(color) TextStyleBuilder Sets the text font color.
setItalic(italic) TextStyleBuilder Sets whether or not the text is italic.
setStrikethrough(strikethrough) TextStyleBuilder Sets whether or not the text has strikethrough.
setUnderline(underline) TextStyleBuilder Sets whether or not the text is underlined.

TextToColumnsDelimiter

خواص

ویژگی تایپ کنید شرح
COMMA Enum "," حائل، جداکننده.
SEMICOLON Enum ";" حائل، جداکننده.
PERIOD Enum "." حائل، جداکننده.
SPACE Enum " " حائل، جداکننده.

ThemeColor

مواد و روش ها

روش Return type توضیح مختصر
getColorType() ColorType Get the type of this color.
getThemeColorType() ThemeColorType Gets the theme color type of this color.

ThemeColorType

خواص

ویژگی تایپ کنید شرح
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.

ValueType

خواص

ویژگی تایپ کنید شرح
IMAGE Enum The value type when the cell contains an image.

WrapStrategy

خواص

ویژگی تایپ کنید شرح
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.