Sheets

ورق

یک برگه در یک صفحه گسترده.

نمایش JSON 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ],
  "tables": [
    {
      object (Table)
    }
  ]
}
فیلدها
properties

object ( SheetProperties )

خواص ورق.

data[]

object ( GridData )

داده‌ها در شبکه، اگر این یک برگه شبکه‌ای باشد.

تعداد اشیاء GridData برگردانده شده به تعداد محدوده‌های درخواستی در این برگه بستگی دارد. برای مثال، اگر این نشان‌دهنده Sheet1 باشد و صفحه گسترده با محدوده‌های Sheet1!A1:C10 و Sheet1!D15:E20 درخواست شده باشد، اولین GridData دارای startRow / startColumn برابر با 0 خواهد بود، در حالی که دومی startRow 14 (سطر 15 مبتنی بر صفر) و startColumn 3 (ستون D مبتنی بر صفر) خواهد داشت.

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

merges[]

object ( GridRange )

محدوده‌هایی که با هم ادغام شده‌اند.

conditionalFormats[]

object ( ConditionalFormatRule )

قوانین قالب‌بندی شرطی در این برگه.

filterViews[]

object ( FilterView )

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

protectedRanges[]

object ( ProtectedRange )

محدوده‌های حفاظت‌شده در این برگه.

basicFilter

object ( BasicFilter )

فیلتر موجود در این برگه، در صورت وجود.

charts[]

object ( EmbeddedChart )

مشخصات هر نمودار در این برگه.

bandedRanges[]

object ( BandedRange )

محدوده‌های نواری (رنگ‌های متناوب) روی این برگه قرار دارند.

developerMetadata[]

object ( DeveloperMetadata )

فراداده توسعه‌دهنده مرتبط با یک برگه.

rowGroups[]

object ( DimensionGroup )

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

columnGroups[]

object ( DimensionGroup )

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

slicers[]

object ( Slicer )

برش‌دهنده‌های روی این برگه.

tables[]

object ( Table )

جداول موجود در این برگه.

خواص ورق

خواص یک ورق.

نمایش JSON 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
فیلدها
sheetId

integer

شناسه برگه. باید غیر منفی باشد. این فیلد پس از تنظیم، قابل تغییر نیست.

title

string

نام برگه.

index

integer

شاخص برگه در صفحه گسترده. هنگام اضافه کردن یا به‌روزرسانی ویژگی‌های برگه، اگر این فیلد حذف شود، برگه به ​​انتهای لیست برگه اضافه یا منتقل می‌شود. هنگام به‌روزرسانی شاخص‌های برگه یا درج برگه‌ها، جابجایی در شاخص‌های "قبل از جابجایی" در نظر گرفته می‌شود. به عنوان مثال، اگر سه برگه (S1، S2، S3) وجود داشته باشد تا S1 از S2 جلوتر برود، شاخص باید روی ۲ تنظیم شود. اگر شاخص درخواستی با شاخص فعلی برگه‌ها یکسان باشد یا اگر شاخص جدید درخواستی برابر با شاخص فعلی برگه + ۱ باشد، درخواست به‌روزرسانی شاخص برگه نادیده گرفته می‌شود.

sheetType

enum ( SheetType )

نوع برگه. پیش‌فرض GRID است. این فیلد پس از تنظیم، قابل تغییر نیست.

gridProperties

object ( GridProperties )

ویژگی‌های اضافی برگه اگر این برگه یک شبکه باشد. (اگر برگه یک برگه شیء باشد که حاوی نمودار یا تصویر باشد، این فیلد وجود نخواهد داشت.) هنگام نوشتن، تنظیم هرگونه ویژگی شبکه‌ای روی برگه‌های غیر شبکه‌ای خطا است.

اگر این برگه یک برگه DATA_SOURCE باشد، این فیلد فقط در خروجی نمایش داده می‌شود اما شامل ویژگی‌هایی است که نحوه رندر شدن یک برگه منبع داده در رابط کاربری را نشان می‌دهند، مثلاً rowCount .

hidden

boolean

اگر برگه در رابط کاربری پنهان باشد، مقدار True و اگر قابل مشاهده باشد، مقدار False برمی‌گرداند.

tabColor
(deprecated)

object ( Color )

رنگ تب در رابط کاربری. منسوخ شده: از tabColorStyle استفاده کنید.

tabColorStyle

object ( ColorStyle )

رنگ تب در رابط کاربری. اگر tabColor نیز تنظیم شده باشد، این فیلد اولویت دارد.

rightToLeft

boolean

اگر برگه به ​​جای برگه LTR، یک برگه RTL باشد، صحیح است.

dataSourceSheetProperties

object ( DataSourceSheetProperties )

فقط خروجی. در صورت وجود، این فیلد حاوی ویژگی‌های خاص برگه DATA_SOURCE است.

نوع ورق

نوع ورق.

انوم‌ها
SHEET_TYPE_UNSPECIFIED مقدار پیش‌فرض، استفاده نکنید.
GRID ورق به صورت شبکه ای است.
OBJECT این برگه هیچ شبکه‌ای ندارد و در عوض یک شیء مانند نمودار یا تصویر دارد.
DATA_SOURCE این برگه به ​​یک DataSource خارجی متصل می‌شود و پیش‌نمایشی از داده‌ها را نشان می‌دهد.

ویژگی‌های شبکه

ویژگی‌های یک شبکه.

نمایش JSON 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
فیلدها
rowCount

integer

تعداد ردیف‌ها در شبکه.

columnCount

integer

تعداد ستون‌ها در شبکه.

frozenRowCount

integer

تعداد ردیف‌هایی که در شبکه ثابت (فریز) شده‌اند.

frozenColumnCount

integer

تعداد ستون‌هایی که در شبکه ثابت (فریز) شده‌اند.

hideGridlines

boolean

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

rowGroupControlAfter

boolean

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

columnGroupControlAfter

boolean

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

ویژگی‌های DataSourceSheet

ویژگی‌های اضافی یک برگه DATA_SOURCE .

نمایش JSON 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
فیلدها
dataSourceId

string

شناسه‌ی DataSource برگه به ​​آن متصل است.

columns[]

object ( DataSourceColumn )

ستون‌های نمایش داده شده در صفحه، مربوط به مقادیر موجود در RowData .

dataExecutionStatus

object ( DataExecutionStatus )

وضعیت اجرای داده‌ها

گرید دیتا

داده‌ها در شبکه، و همچنین فراداده‌هایی در مورد ابعاد.

نمایش JSON 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
فیلدها
startRow

integer

اولین ردیفی که این GridData به آن اشاره می‌کند، مبتنی بر صفر است.

startColumn

integer

اولین ستونی که این GridData به آن اشاره می‌کند، مبتنی بر صفر است.

rowData[]

object ( RowData )

داده‌های موجود در جدول، یک ورودی در هر ردیف، که از ردیف startRow شروع می‌شوند. مقادیر موجود در RowData با ستون‌هایی که از startColumn شروع می‌شوند، مطابقت دارند.

rowMetadata[]

object ( DimensionProperties )

متادیتای مربوط به ردیف‌های درخواستی در جدول، که از ردیف موجود در startRow شروع می‌شود.

columnMetadata[]

object ( DimensionProperties )

متادیتای مربوط به ستون‌های درخواستی در جدول، که از ستون موجود در startColumn شروع می‌شود.

داده‌های ردیفی

داده‌های مربوط به هر سلول در یک ردیف.

نمایش JSON 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
فیلدها
values[]

object ( CellData )

مقادیر در سطر، یکی در هر ستون.

ویژگی‌های ابعادی

ویژگی‌های مربوط به یک بعد.

نمایش JSON 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
فیلدها
hiddenByFilter

boolean

اگر این بُعد فیلتر شود، صحیح است. این فیلد فقط خواندنی است.

hiddenByUser

boolean

اگر این بُعد به صراحت پنهان باشد، درست است.

pixelSize

integer

ارتفاع (اگر سطر باشد) یا عرض (اگر ستون باشد) بُعد بر حسب پیکسل.

developerMetadata[]

object ( DeveloperMetadata )

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

dataSourceColumnReference

object ( DataSourceColumnReference )

فقط خروجی. در صورت تنظیم، این یک ستون در یک برگه منبع داده است.

قانون قالب شرطی

قاعده‌ای که یک قالب شرطی را توصیف می‌کند.

نمایش JSON 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
فیلدها
ranges[]

object ( GridRange )

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

rule فیلد اتحادیه. قاعده‌ای که این قالب شرطی را کنترل می‌کند، دقیقاً باید یکی باشد. rule می‌تواند فقط یکی از موارد زیر باشد:
booleanRule

object ( BooleanRule )

طبق قاعده، قالب‌بندی یا «روشن» است یا «خاموش».

gradientRule

object ( GradientRule )

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

بولین‌راول

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

نمایش JSON 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
فیلدها
condition

object ( BooleanCondition )

شرط قاعده. اگر شرط درست باشد، قالب اعمال می‌شود.

format

object ( CellFormat )

قالب‌بندی مورد نظر. قالب‌بندی شرطی فقط می‌تواند زیرمجموعه‌ای از قالب‌بندی‌ها را اعمال کند: bold ، italic ، strikethrough ، foreground color و background color .

گرادیان‌رول

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

نمایش JSON 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
فیلدها
minpoint

object ( InterpolationPoint )

نقطه شروع درون‌یابی.

midpoint

object ( InterpolationPoint )

یک نقطه درون‌یابی میانی اختیاری.

maxpoint

object ( InterpolationPoint )

نقطه نهایی درون‌یابی.

نقطه درون‌یابی

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

نمایش JSON 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
فیلدها
color
(deprecated)

object ( Color )

رنگی که این نقطه درون‌یابی باید استفاده کند. منسوخ شده: colorStyle استفاده کنید.

colorStyle

object ( ColorStyle )

رنگی که این نقطه درون‌یابی باید استفاده کند. اگر color نیز تنظیم شده باشد، این فیلد اولویت دارد.

type

enum ( InterpolationPointType )

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

value

string

مقداری که این نقطه درون‌یابی استفاده می‌کند. ممکن است یک فرمول باشد. اگر type MIN یا MAX باشد، استفاده نمی‌شود.

نوع نقطه‌ای درون‌یابی

نوع نقطه درون‌یابی.

انوم‌ها
INTERPOLATION_POINT_TYPE_UNSPECIFIED مقدار پیش‌فرض، استفاده نکنید.
MIN نقطه درون‌یابی از حداقل مقدار در سلول‌ها در محدوده قالب شرطی استفاده می‌کند.
MAX نقطه درون‌یابی از حداکثر مقدار موجود در سلول‌ها در محدوده قالب شرطی استفاده می‌کند.
NUMBER نقطه درون‌یابی دقیقاً از مقداری که در InterpolationPoint.value قرار دارد استفاده می‌کند.
PERCENT

نقطه درون‌یابی، درصد داده شده روی تمام سلول‌های موجود در محدوده قالب شرطی است. اگر مقدار به صورت زیر باشد، معادل NUMBER است: =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (که در آن خطاهای محدوده هنگام مسطح‌سازی نادیده گرفته می‌شوند).

PERCENTILE نقطه درون‌یابی، صدک داده شده روی تمام سلول‌های موجود در محدوده قالب شرطی است. اگر مقدار به صورت زیر باشد، معادل NUMBER است: =PERCENTILE(FLATTEN(range), value / 100) (که در آن خطاهای محدوده هنگام مسطح‌سازی نادیده گرفته می‌شوند).

فیلتر ویو

نمای فیلتر. برای اطلاعات بیشتر، به مدیریت قابلیت مشاهده داده‌ها با فیلترها مراجعه کنید.

نمایش JSON 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
فیلدها
filterViewId

integer

شناسه نمای فیلتر.

title

string

نام نمای فیلتر.

range

object ( GridRange )

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

هنگام نوشتن، فقط یکی از range ، namedRangeId یا tableId می‌تواند تنظیم شود.

namedRangeId

string

محدوده‌ی نامگذاری‌شده‌ای که این نمای فیلتر از آن پشتیبانی می‌کند، در صورت وجود.

هنگام نوشتن، فقط یکی از range ، namedRangeId یا tableId می‌تواند تنظیم شود.

tableId

string

جدولی که این نمای فیلتر توسط آن پشتیبانی می‌شود، در صورت وجود.

هنگام نوشتن، فقط یکی از range ، namedRangeId یا tableId می‌تواند تنظیم شود.

sortSpecs[]

object ( SortSpec )

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

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria ))

معیارهای نمایش/پنهان کردن مقادیر در هر ستون. کلید نقشه، اندیس ستون است و مقدار، معیارهای آن ستون است.

این فیلد به نفع filterSpecs منسوخ شده است.

filterSpecs[]

object ( FilterSpec )

معیارهای فیلتر برای نمایش یا پنهان کردن مقادیر در هر ستون.

هر دو criteria و filterSpecs در پاسخ‌ها وارد می‌شوند. اگر هر دو فیلد در یک درخواست به‌روزرسانی مشخص شوند، این فیلد اولویت دارد.

محدوده حفاظت‌شده

یک محدوده حفاظت‌شده.

نمایش JSON 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
فیلدها
protectedRangeId

integer

شناسه‌ی محدوده‌ی حفاظت‌شده. این فیلد فقط خواندنی است.

range

object ( GridRange )

محدوده‌ای که محافظت می‌شود. این محدوده ممکن است کاملاً نامحدود باشد، که در این صورت، این یک برگه محافظت شده محسوب می‌شود.

هنگام نوشتن، فقط می‌توان یکی از range یا namedRangeId یا tableId تنظیم کرد.

namedRangeId

string

محدوده نامگذاری شده‌ای که این محدوده حفاظت‌شده توسط آن پشتیبانی می‌شود، در صورت وجود.

هنگام نوشتن، فقط می‌توان یکی از range یا namedRangeId یا tableId تنظیم کرد.

tableId

string

جدولی که این محدوده محافظت‌شده توسط آن پشتیبانی می‌شود، در صورت وجود.

هنگام نوشتن، فقط می‌توان یکی از range یا namedRangeId یا tableId تنظیم کرد.

description

string

شرح این منطقه حفاظت شده.

warningOnly

boolean

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

هنگام نوشتن: اگر این فیلد برابر با true باشد، editors نادیده گرفته می‌شوند. علاوه بر این، اگر این فیلد از true به false تغییر کند و فیلد editors تنظیم نشده باشد (و در ماسک فیلد نیز گنجانده نشده باشد)، ویرایشگرها با تمام ویرایشگرهای موجود در سند تنظیم می‌شوند.

requestingUserCanEdit

boolean

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

unprotectedRanges[]

object ( GridRange )

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

editors

object ( Editors )

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

ویراستاران

ویراستاران یک محدوده حفاظت‌شده.

نمایش JSON 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
فیلدها
users[]

string

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

groups[]

string

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

domainUsersCanEdit

boolean

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

فیلتر پایه

فیلتر پیش‌فرض مرتبط با یک برگه. برای اطلاعات بیشتر، به مدیریت قابلیت مشاهده داده‌ها با فیلترها مراجعه کنید.

نمایش JSON 
{
  "range": {
    object (GridRange)
  },
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
فیلدها
range

object ( GridRange )

محدوده‌ای که فیلتر پوشش می‌دهد.

tableId

string

جدولی که این فیلتر از آن پشتیبانی می‌کند، در صورت وجود. هنگام نوشتن، فقط می‌توان یکی از range یا tableId را تنظیم کرد.

sortSpecs[]

object ( SortSpec )

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

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria ))

معیارهای نمایش/پنهان کردن مقادیر در هر ستون. کلید نقشه، اندیس ستون است و مقدار، معیارهای آن ستون است.

این فیلد به نفع filterSpecs منسوخ شده است.

filterSpecs[]

object ( FilterSpec )

معیارهای فیلتر در هر ستون.

هر دو criteria و filterSpecs در پاسخ‌ها وارد می‌شوند. اگر هر دو فیلد در یک درخواست به‌روزرسانی مشخص شوند، این فیلد اولویت دارد.

محدوده باند

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

نمایش JSON 
{
  "bandedRangeId": integer,
  "bandedRangeReference": string,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
فیلدها
bandedRangeId

integer

شناسه‌ی محدوده‌ی باند شده. اگر تنظیم نشده باشد، به bandedRangeReference مراجعه کنید.

bandedRangeReference

string

فقط خروجی. مرجع محدوده باند شده، که برای شناسایی شناسه‌ای که توسط bandedRangeId پشتیبانی نمی‌شود، استفاده می‌شود.

range

object ( GridRange )

محدوده‌ای که این ویژگی‌ها در آن اعمال می‌شوند.

rowProperties

object ( BandingProperties )

ویژگی‌هایی برای نوارهای ردیف. این ویژگی‌ها به صورت ردیف به ردیف در تمام ردیف‌های محدوده اعمال می‌شوند. حداقل یکی از rowProperties یا columnProperties باید مشخص شود.

columnProperties

object ( BandingProperties )

ویژگی‌هایی برای نوارهای ستون. این ویژگی‌ها به صورت ستون به ستون در تمام ستون‌های محدوده اعمال می‌شوند. حداقل یکی از rowProperties یا columnProperties باید مشخص شود.

خواص باندینگ

ویژگی‌هایی که به یک بُعد واحد (ردیف یا ستون) اشاره می‌کنند. اگر هر دو BandedRange.row_properties و BandedRange.column_properties تنظیم شده باشند، رنگ‌های پرکننده طبق قوانین زیر به سلول‌ها اعمال می‌شوند:

برای مثال، رنگ ردیف اول نسبت به رنگ ستون اول اولویت دارد، اما رنگ ستون اول نسبت به رنگ ردیف دوم اولویت دارد. به طور مشابه، سربرگ ردیف نسبت به سربرگ ستون در سلول بالا سمت چپ اولویت دارد، اما اگر سربرگ ردیف تنظیم نشده باشد، سربرگ ستون نسبت به رنگ ردیف اول اولویت دارد.

نمایش JSON 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
فیلدها
headerColor
(deprecated)

object ( Color )

رنگ سطر یا ستون اول. اگر این فیلد تنظیم شود، سطر یا ستون اول با این رنگ پر می‌شود و رنگ‌ها از سطر یا ستون دوم به طور متناوب بین firstBandColor و secondBandColor تغییر می‌کنند. در غیر این صورت، سطر یا ستون اول با firstBandColor پر می‌شود و رنگ‌ها طبق معمول به طور متناوب تغییر می‌کنند. منسوخ شده: headerColorStyle استفاده کنید.

headerColorStyle

object ( ColorStyle )

رنگ سطر یا ستون اول. اگر این فیلد تنظیم شده باشد، سطر یا ستون اول با این رنگ پر می‌شود و رنگ‌ها از سطر یا ستون دوم به ترتیب بین firstBandColor و secondBandColor تغییر می‌کنند. در غیر این صورت، سطر یا ستون اول با firstBandColor پر می‌شود و رنگ‌ها طبق معمول به طور متناوب تغییر می‌کنند. اگر headerColor نیز تنظیم شده باشد، این فیلد اولویت دارد.

firstBandColor
(deprecated)

object ( Color )

اولین رنگی که به صورت متناوب استفاده می‌شود. (الزامی) منسوخ شده: firstBandColorStyle استفاده کنید.

firstBandColorStyle

object ( ColorStyle )

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

secondBandColor
(deprecated)

object ( Color )

رنگ دوم که متناوب است. (الزامی) منسوخ شده: از secondBandColorStyle استفاده کنید.

secondBandColorStyle

object ( ColorStyle )

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

footerColor
(deprecated)

object ( Color )

رنگ آخرین ردیف یا ستون. اگر این فیلد تنظیم نشود، آخرین ردیف یا ستون با firstBandColor یا secondBandColor ، بسته به رنگ ردیف یا ستون قبلی، پر می‌شود. منسوخ شده: footerColorStyle استفاده کنید.

footerColorStyle

object ( ColorStyle )

رنگ آخرین ردیف یا ستون. اگر این فیلد تنظیم نشده باشد، آخرین ردیف یا ستون با firstBandColor یا secondBandColor ، بسته به رنگ ردیف یا ستون قبلی، پر می‌شود. اگر footerColor نیز تنظیم شده باشد، این فیلد اولویت دارد.

گروه ابعاد

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

نمایش JSON 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
فیلدها
range

object ( DimensionRange )

محدوده‌ای که این گروه در آن وجود دارد.

depth

integer

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

collapsed

boolean

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

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

برش دهنده

یک برش دهنده در یک ورق.

نمایش JSON 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
فیلدها
slicerId

integer

شناسه دستگاه برش.

spec

object ( SlicerSpec )

مشخصات دستگاه برش.

position

object ( EmbeddedObjectPosition )

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

مشخصات برش

مشخصات دستگاه برش.

نمایش JSON 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
فیلدها
dataRange

object ( GridRange )

محدوده‌ی داده‌های برش‌دهنده.

filterCriteria

object ( FilterCriteria )

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

columnIndex

integer

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

applyToPivotTables

boolean

اگر فیلتر باید روی جداول محوری اعمال شود، مقدار آن درست است. اگر تنظیم نشده باشد، مقدار پیش‌فرض آن True .

title

string

عنوان دستگاه برش.

textFormat

object ( TextFormat )

قالب متن عنوان در برش‌دهنده. فیلد لینک پشتیبانی نمی‌شود.

backgroundColor
(deprecated)

object ( Color )

رنگ پس‌زمینه‌ی برش‌دهنده. منسوخ شده: backgroundColorStyle استفاده کنید.

backgroundColorStyle

object ( ColorStyle )

رنگ پس‌زمینه‌ی برش‌دهنده. اگر backgroundColor نیز تنظیم شده باشد، این فیلد اولویت دارد.

horizontalAlignment

enum ( HorizontalAlign )

تراز افقی عنوان در برش‌دهنده. اگر مشخص نشود، پیش‌فرض روی LEFT است.

میز

یک میز.

نمایش JSON 
{
  "tableId": string,
  "name": string,
  "range": {
    object (GridRange)
  },
  "rowsProperties": {
    object (TableRowsProperties)
  },
  "columnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
فیلدها
tableId

string

شناسه جدول.

name

string

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

range

object ( GridRange )

محدوده جدول.

rowsProperties

object ( TableRowsProperties )

ویژگی‌های ردیف‌های جدول.

columnProperties[]

object ( TableColumnProperties )

ویژگی‌های ستون‌های جدول.

ویژگی‌های سطرهای جدول

ویژگی‌های سطرهای جدول.

نمایش JSON 
{
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
فیلدها
headerColorStyle

object ( ColorStyle )

رنگ ردیف سربرگ. اگر این فیلد تنظیم شود، ردیف سربرگ با رنگ مشخص شده پر می‌شود. در غیر این صورت، ردیف سربرگ با رنگ پیش‌فرض پر می‌شود.

firstBandColorStyle

object ( ColorStyle )

اولین رنگی که به صورت متناوب است. اگر این فیلد تنظیم شود، اولین ردیف نواری با رنگ مشخص شده پر می‌شود. در غیر این صورت، اولین ردیف نواری با رنگ پیش‌فرض پر می‌شود.

secondBandColorStyle

object ( ColorStyle )

رنگ دوم که متناوب است. اگر این فیلد تنظیم شود، ردیف دوم نواری با رنگ مشخص شده پر می‌شود. در غیر این صورت، ردیف دوم نواری با رنگ پیش‌فرض پر می‌شود.

footerColorStyle

object ( ColorStyle )

رنگ آخرین ردیف. اگر این فیلد تنظیم نشود، پاورقی اضافه نمی‌شود و ردیف آخر بسته به رنگ ردیف قبلی، با firstBandColorStyle یا secondBandColorStyle پر می‌شود. اگر جدول موجود بدون پاورقی به‌روزرسانی شود تا پاورقی داشته باشد، محدوده ۱ ردیف گسترش می‌یابد. اگر جدول موجود دارای پاورقی به‌روزرسانی شود و پاورقی حذف شود، محدوده ۱ ردیف کاهش می‌یابد.

ویژگی‌های ستون جدول

ستون جدول.

نمایش JSON 
{
  "columnIndex": integer,
  "columnName": string,
  "columnType": enum (ColumnType),
  "dataValidationRule": {
    object (TableColumnDataValidationRule)
  }
}
فیلدها
columnIndex

integer

شاخص ستون مبتنی بر 0. این شاخص نسبت به موقعیت آن در جدول است و لزوماً با شاخص ستون در برگه یکسان نیست.

columnName

string

نام ستون.

columnType

enum ( ColumnType )

نوع ستون.

dataValidationRule

object ( TableColumnDataValidationRule )

قانون اعتبارسنجی داده‌های ستون. فقط برای نوع ستون کشویی تنظیم شده است.

نوع ستون

نوع ستون برای یک ستون مشخص در یک جدول.

انوم‌ها
COLUMN_TYPE_UNSPECIFIED نوع ستون نامشخص.
DOUBLE نوع ستون عددی.
CURRENCY نوع ستون واحد پول.
PERCENT نوع ستون درصد.
DATE نوع ستون تاریخ.
TIME نوع ستون زمان.
DATE_TIME نوع ستون تاریخ و زمان.
TEXT نوع ستون متن.
BOOLEAN نوع ستون بولی.
DROPDOWN نوع ستون کشویی.
FILES_CHIP نوع ستون چیپ فایل‌ها
PEOPLE_CHIP نوع ستون تراشه افراد
FINANCE_CHIP نوع ستون چیپ مالی
PLACE_CHIP نوع ستون تراشه مکان
RATINGS_CHIP نوع ستون تراشه رتبه‌بندی

اعتبارسنجی جدول ستونی داده ها

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

نمایش JSON 
{
  "condition": {
    object (BooleanCondition)
  }
}
فیلدها
condition

object ( BooleanCondition )

شرطی که داده‌ها در سلول باید با آن مطابقت داشته باشند. فقط در صورتی معتبر است که [BooleanCondition.type] برابر با ONE_OF_LIST باشد.