ورق
یک برگه در یک صفحه گسترده.
نمایندگی JSON |
---|
{ "properties": { object ( |
فیلدها | |
---|---|
properties | خواص ورق. |
data[] | داده ها در شبکه، اگر این یک صفحه شبکه است. تعداد اشیاء GridData برگردانده شده به تعداد محدوده های درخواست شده در این برگه بستگی دارد. به عنوان مثال، اگر صفحهگسترده نشاندهنده برای یک برگه |
merges[] | محدوده هایی که با هم ادغام می شوند. |
conditionalFormats[] | قوانین قالب مشروط در این برگه. |
filterViews[] | فیلتر در این برگه مشاهده می شود. |
protectedRanges[] | محدوده های محافظت شده در این برگه |
basicFilter | فیلتر موجود در این برگه، در صورت وجود. |
charts[] | مشخصات هر نمودار در این برگه. |
bandedRanges[] | محدوده نواری (رنگ های متناوب) در این برگه است. |
developerMetadata[] | ابرداده توسعهدهنده مرتبط با یک برگه. |
rowGroups[] | همه گروههای ردیف در این برگه، با افزایش شاخص شروع محدوده، سپس بر اساس عمق گروه مرتب شدهاند. |
columnGroups[] | همه گروههای ستون در این برگه، با افزایش شاخص شروع محدوده، سپس بر اساس عمق گروه مرتب شدهاند. |
slicers[] | برش های موجود در این برگه |
SheetProperties
خواص یک ورق
نمایندگی JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
فیلدها | |
---|---|
sheetId | شناسه برگه. باید غیر منفی باشد. این فیلد پس از تنظیم قابل تغییر نیست. |
title | نام برگه. |
index | نمایه ورق در صفحه گسترده. هنگام افزودن یا بهروزرسانی ویژگیهای برگه، اگر این قسمت حذف شود، برگه اضافه یا به انتهای فهرست برگه منتقل میشود. هنگام بهروزرسانی شاخصهای برگه یا درج برگهها، حرکت در شاخصهای «قبل از حرکت» در نظر گرفته میشود. برای مثال، اگر سه صفحه (S1، S2، S3) وجود داشته باشد تا S1 جلوتر از S2 حرکت کند، شاخص باید روی 2 تنظیم شود. اگر نمایه درخواستی با برگههای فعلی یکسان باشد، درخواست بهروزرسانی فهرست برگه نادیده گرفته میشود. ایندکس یا اگر نمایه جدید درخواستی برابر با شاخص صفحه فعلی + 1 باشد. |
sheetType | نوع ورق. پیش فرض |
gridProperties | خواص اضافی ورق اگر این ورق شبکه ای باشد. (اگر برگه یک شیت شیت است که حاوی نمودار یا تصویر است، این فیلد وجود ندارد.) هنگام نوشتن، تنظیم هر گونه ویژگی شبکه در برگه های غیرشبکه ای خطا است. اگر این برگه یک برگه |
tabColor | رنگ برگه در UI. منسوخ شده: از |
tabColorStyle | رنگ برگه در UI. اگر |
rightToLeft | اگر برگه به جای برگه LTR یک ورق RTL باشد درست است. |
dataSourceSheetProperties | فقط خروجی در صورت وجود، فیلد حاوی ویژگیهای خاص برگه |
نوع برگه
نوع ورق.
Enums | |
---|---|
SHEET_TYPE_UNSPECIFIED | مقدار پیش فرض، استفاده نکنید. |
GRID | ورق یک شبکه است. |
OBJECT | ورق شبکه ای ندارد و در عوض دارای یک شی مانند نمودار یا تصویر است. |
DATA_SOURCE | برگه با یک DataSource خارجی متصل می شود و پیش نمایش داده ها را نشان می دهد. |
GridProperties
ویژگی های یک شبکه
نمایندگی JSON |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
فیلدها | |
---|---|
rowCount | تعداد ردیف ها در شبکه. |
columnCount | تعداد ستون ها در شبکه |
frozenRowCount | تعداد ردیف هایی که در شبکه ثابت شده اند. |
frozenColumnCount | تعداد ستون هایی که در شبکه ثابت شده اند. |
hideGridlines | درست است اگر شبکه خطوط شبکه را در رابط کاربری نشان ندهد. |
rowGroupControlAfter | درست است اگر کلید کنترل گروه بندی ردیف بعد از گروه نشان داده شود. |
columnGroupControlAfter | درست است اگر کلید کنترل گروه بندی ستون بعد از گروه نشان داده شود. |
DataSourceSheetProperties
ویژگی های اضافی یک برگه DATA_SOURCE
.
نمایندگی JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
فیلدها | |
---|---|
dataSourceId | شناسه |
columns[] | ستون های نمایش داده شده بر روی صفحه، مربوط به مقادیر در |
dataExecutionStatus | وضعیت اجرای داده ها |
GridData
داده ها در شبکه، و همچنین ابرداده در مورد ابعاد.
نمایندگی JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
فیلدها | |
---|---|
startRow | اولین ردیفی که این GridData به آن اشاره دارد، مبتنی بر صفر است. |
startColumn | اولین ستونی که این GridData به آن اشاره دارد، مبتنی بر صفر است. |
rowData[] | داده های شبکه، یک ورودی در هر ردیف، با ردیف در startRow شروع می شود. مقادیر در RowData با ستون هایی که از |
rowMetadata[] | ابرداده در مورد ردیف های درخواستی در شبکه، که با ردیف در |
columnMetadata[] | ابرداده در مورد ستون های درخواستی در شبکه، که با ستون در |
RowData
داده های مربوط به هر سلول در یک ردیف.
نمایندگی JSON |
---|
{
"values": [
{
object ( |
فیلدها | |
---|---|
values[] | مقادیر در سطر، یک در هر ستون. |
ویژگی های ابعاد
خواص در مورد یک بعد
نمایندگی JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
فیلدها | |
---|---|
pixelSize | ارتفاع (اگر یک ردیف) یا عرض (اگر یک ستون) ابعاد بر حسب پیکسل. |
developerMetadata[] | ابرداده توسعهدهنده مرتبط با یک ردیف یا ستون. |
dataSourceColumnReference | فقط خروجی اگر تنظیم شود، این یک ستون در برگه منبع داده است. |
ConditionalFormatRule
قاعده ای که یک قالب مشروط را توصیف می کند.
نمایندگی JSON |
---|
{ "ranges": [ { object ( |
فیلدها | |
---|---|
ranges[] | محدوده هایی که در صورت درست بودن شرط فرمت می شوند. همه محدوده ها باید در یک شبکه باشند. |
rule میدان اتحادیه قانون کنترل کننده این قالب شرطی، دقیقاً باید یکی تنظیم شود. rule فقط می تواند یکی از موارد زیر باشد: | |
booleanRule | قالب بندی طبق قانون یا "روشن" یا "خاموش" است. |
gradientRule | قالب بندی بر اساس گرادیان در قانون متفاوت خواهد بود. |
قانون بولی
قانونی که بسته به شرایط ممکن است مطابقت داشته باشد یا نباشد.
نمایندگی JSON |
---|
{ "condition": { object ( |
فیلدها | |
---|---|
condition | شرط قاعده. اگر شرط به درستی ارزیابی شود، قالب اعمال می شود. |
format | فرمت برای اعمال قالببندی شرطی فقط میتواند زیرمجموعهای از قالببندی را اعمال کند: |
GradientRule
قاعده ای که یک قالب مقیاس رنگی گرادیان را بر اساس نقاط درونیابی فهرست شده اعمال می کند. قالب یک سلول بر اساس محتوای آن در مقایسه با مقادیر نقاط درونیابی متفاوت خواهد بود.
نمایندگی JSON |
---|
{ "minpoint": { object ( |
فیلدها | |
---|---|
minpoint | نقطه شروع درون یابی |
midpoint | یک نقطه میان یابی اختیاری. |
maxpoint | نقطه درونیابی نهایی |
نقطه درون یابی
یک نقطه درونیابی منفرد در قالب شرطی گرادیان. اینها مقیاس رنگ گرادیان را با توجه به رنگ، نوع و مقدار انتخاب شده پین می کنند.
نمایندگی JSON |
---|
{ "color": { object ( |
فیلدها | |
---|---|
color | رنگی که این نقطه درونیابی باید استفاده کند. منسوخ شده: از |
colorStyle | رنگی که این نقطه درونیابی باید استفاده کند. اگر |
type | ارزش چگونه باید تفسیر شود. |
value | مقداری که این نقطه درونیابی استفاده می کند. ممکن است یک فرمول باشد. اگر |
InterpolationPointType
نوع نقطه درونیابی.
Enums | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED | مقدار پیش فرض، استفاده نکنید. |
MIN | نقطه درونیابی از حداقل مقدار در سلول ها در محدوده قالب شرطی استفاده می کند. |
MAX | نقطه درونیابی از حداکثر مقدار در سلول ها در محدوده قالب شرطی استفاده می کند. |
NUMBER | نقطه درونیابی دقیقاً از مقدار InterpolationPoint.value استفاده می کند. |
PERCENT | نقطه درون یابی درصد داده شده در تمام سلول ها در محدوده قالب شرطی است. این معادل |
PERCENTILE | نقطه درون یابی صدک داده شده در تمام سلول ها در محدوده قالب شرطی است. اگر این مقدار برابر با NUMBER است: =PERCENTILE(FLATTEN(range), value / 100) (که در آن خطاهای محدوده هنگام صاف کردن نادیده گرفته می شوند). |
FilterView
نمای فیلتر
نمایندگی JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
فیلدها | |
---|---|
filterViewId | شناسه نمای فیلتر. |
title | نام نمای فیلتر. |
range | محدوده ای که این نمای فیلتر پوشش می دهد. هنگام نوشتن، فقط یکی از |
namedRangeId | محدوده نامگذاریشده این نمای فیلتر، در صورت وجود، توسط آن پشتیبانی میشود. هنگام نوشتن، فقط یکی از |
sortSpecs[] | ترتیب مرتب سازی در هر ستون. مشخصات بعدی زمانی استفاده می شود که مقادیر در مشخصات قبلی برابر باشد. |
criteria | معیارهای نمایش / پنهان کردن مقادیر در هر ستون. کلید نقشه، نمایه ستون است و مقدار، معیار آن ستون است. این فیلد به نفع |
filterSpecs[] | معیارهای فیلتر برای نمایش/پنهان کردن مقادیر در هر ستون. هم |
محدوده محافظت شده
یک محدوده محافظت شده
نمایندگی JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
فیلدها | |
---|---|
protectedRangeId | شناسه محدوده حفاظت شده این فیلد فقط خواندنی است. |
range | محدوده ای که محافظت می شود. محدوده ممکن است کاملاً نامحدود باشد، در این صورت این یک صفحه محافظت شده در نظر گرفته می شود. هنگام نوشتن، فقط یکی از |
namedRangeId | محدوده نامگذاری شده این محدوده محافظت شده در صورت وجود، توسط آن پشتیبانی می شود. هنگام نوشتن، فقط یکی از |
description | شرح این محدوده حفاظت شده |
warningOnly | درست است اگر این محدوده محافظت شده هنگام ویرایش یک هشدار نشان دهد. حفاظت مبتنی بر هشدار به این معنی است که هر کاربر می تواند داده ها را در محدوده محافظت شده ویرایش کند، به جز ویرایش، هشداری را از کاربر درخواست می کند که ویرایش را تأیید کند. هنگام نوشتن: اگر این فیلد درست باشد، |
requestingUserCanEdit | درست است اگر کاربری که این محدوده محافظت شده را درخواست کرده است بتواند منطقه محافظت شده را ویرایش کند. این فیلد فقط خواندنی است. |
unprotectedRanges[] | لیست محدوده های محافظت نشده در یک صفحه محافظت شده. محدوده های محافظت نشده فقط در برگه های محافظت شده پشتیبانی می شوند. |
editors | کاربران و گروه هایی با دسترسی ویرایش به محدوده محافظت شده. این قسمت فقط برای کاربرانی که دسترسی ویرایش به محدوده محافظت شده و سند دارند قابل مشاهده است. ویرایشگرها با حفاظت |
ویراستاران
ویرایشگرهای یک محدوده محافظت شده
نمایندگی JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
فیلدها | |
---|---|
users[] | آدرس ایمیل کاربران با دسترسی ویرایش به محدوده محافظت شده. |
groups[] | آدرسهای ایمیل گروههایی که دسترسی ویرایش به محدوده محافظت شده دارند. |
domainUsersCanEdit | اگر کسی در دامنه سند دسترسی ویرایش به محدوده محافظت شده داشته باشد درست است. حفاظت از دامنه فقط در اسناد داخل یک دامنه پشتیبانی می شود. |
BasicFilter
فیلتر پیش فرض مرتبط با یک برگه.
نمایندگی JSON |
---|
{ "range": { object ( |
فیلدها | |
---|---|
range | محدوده ای که فیلتر پوشش می دهد. |
sortSpecs[] | ترتیب مرتب سازی در هر ستون. مشخصات بعدی زمانی استفاده می شود که مقادیر در مشخصات قبلی برابر باشد. |
criteria | معیارهای نمایش / پنهان کردن مقادیر در هر ستون. کلید نقشه، نمایه ستون است و مقدار، معیار آن ستون است. این فیلد به نفع |
filterSpecs[] | معیارهای فیلتر در هر ستون هم |
BandedRange
محدوده نواری (رنگ های متناوب) در یک صفحه.
نمایندگی JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
فیلدها | |
---|---|
bandedRangeId | شناسه محدوده نواری. |
range | محدوده ای که این ویژگی ها در آن اعمال می شوند. |
rowProperties | خواص برای نوارهای ردیف. این ویژگی ها به صورت ردیف به ردیف در تمام ردیف های محدوده اعمال می شوند. حداقل یکی از |
columnProperties | ویژگی های باندهای ستون. این ویژگی ها بر اساس ستون به ستون در تمام ستون های محدوده اعمال می شوند. حداقل یکی از |
BandingProperties
ویژگی هایی که به یک بعد منفرد (اعم از ردیف یا ستون) اشاره می کنند. اگر هر دو BandedRange.row_properties
و BandedRange.column_properties
تنظیم شده باشند، رنگ های پر بر اساس قوانین زیر به سلول ها اعمال می شود:
-
headerColor
وfooterColor
نسبت به رنگ های باند اولویت دارند. -
firstBandColor
نسبت بهsecondBandColor
اولویت دارد. -
rowProperties
برcolumnProperties
اولویت دارد.
به عنوان مثال، رنگ ردیف اول بر رنگ ستون اول اولویت دارد، اما رنگ ستون اول بر رنگ ردیف دوم اولویت دارد. به طور مشابه، سرصفحه سطر بر سر ستون در سلول بالا سمت چپ اولویت دارد، اما اگر سرصفحه سطر تنظیم نشده باشد، سرصفحه ستون بر رنگ سطر اول اولویت دارد.
نمایندگی JSON |
---|
{ "headerColor": { object ( |
فیلدها | |
---|---|
headerColor | رنگ سطر یا ستون اول. اگر این فیلد تنظیم شده باشد، سطر یا ستون اول با این رنگ پر می شود و رنگ ها از ردیف یا ستون دوم به طور متناوب بین |
headerColorStyle | رنگ سطر یا ستون اول. اگر این فیلد تنظیم شده باشد، سطر یا ستون اول با این رنگ پر می شود و رنگ ها از ردیف یا ستون دوم به طور متناوب بین |
firstBandColor | اولین رنگی که متناوب است. (الزامی) منسوخ شده: از |
firstBandColorStyle | اولین رنگی که متناوب است. (الزامی) اگر |
secondBandColor | رنگ دوم که متناوب است. (الزامی) منسوخ شده: از |
secondBandColorStyle | رنگ دوم که متناوب است. (الزامی) اگر |
footerColor | رنگ آخرین سطر یا ستون. اگر این فیلد تنظیم نشده باشد، بسته به رنگ سطر یا ستون قبلی، آخرین سطر یا ستون با |
footerColorStyle | رنگ آخرین سطر یا ستون. اگر این فیلد تنظیم نشده باشد، بسته به رنگ سطر یا ستون قبلی، آخرین سطر یا ستون با |
DimensionGroup
گروهی در فاصلهای از ردیفها یا ستونها در یک صفحه، که میتواند شامل یا در داخل گروههای دیگر باشد. یک گروه را می توان به عنوان یک واحد روی صفحه جمع کرد یا گسترش داد.
نمایندگی JSON |
---|
{
"range": {
object ( |
فیلدها | |
---|---|
range | محدوده ای که این گروه در آن وجود دارد. |
depth | عمق گروه، نشاندهنده تعداد گروههایی است که محدودهای دارند که به طور کامل شامل محدوده این گروه است. |
collapsed | اگر این گروه جمع شود، این فیلد درست است. اگر یک گروه همپوشانی در عمق کمتر منبسط شود، یک گروه فروپاشی شده فرو میماند. یک مقدار واقعی به این معنی نیست که همه ابعاد در گروه پنهان هستند، زیرا نمایان بودن یک بعد می تواند مستقل از این ویژگی گروه تغییر کند. با این حال، هنگامی که این ویژگی به روز می شود، تمام ابعاد درون آن در صورت درست بودن این فیلد مخفی و در صورت نادرست بودن این فیلد روی قابل مشاهده تنظیم می شود. |
برش دهنده
یک برش در یک ورق.
نمایندگی JSON |
---|
{ "slicerId": integer, "spec": { object ( |
فیلدها | |
---|---|
slicerId | شناسه اسلایسر. |
spec | مشخصات برش دهنده. |
position | موقعیت برش دهنده. توجه داشته باشید که اسلایسر را می توان فقط روی ورق موجود قرار داد. همچنین، عرض و ارتفاع اسلایسر را می توان به طور خودکار تنظیم کرد تا آن را در محدوده های مجاز نگه دارد. |
SlicerSpec
مشخصات دستگاه اسلایسر.
نمایندگی JSON |
---|
{ "dataRange": { object ( |
فیلدها | |
---|---|
dataRange | محدوده داده های برش دهنده. |
filterCriteria | معیارهای فیلترینگ اسلایسر. |
columnIndex | شاخص ستون مبتنی بر صفر در جدول داده ای که فیلتر روی آن اعمال می شود. |
applyToPivotTables | درست است اگر فیلتر باید برای جداول محوری اعمال شود. اگر تنظیم نشد، پیشفرض |
title | عنوان برش دهنده. |
textFormat | قالب متن عنوان در اسلایسر. فیلد پیوند پشتیبانی نمی شود. |
backgroundColor | رنگ پس زمینه اسلایسر. منسوخ شده: از |
backgroundColorStyle | رنگ پس زمینه اسلایسر. اگر |
horizontalAlignment | تراز افقی عنوان در برش دهنده. اگر مشخص نشده باشد، پیشفرض روی |