Лист
Лист в электронной таблице.
Представление JSON |
---|
{ "properties": { object ( |
Поля | |
---|---|
properties | Свойства листа. |
data[] | Данные в сетке, если это лист сетки. Количество возвращаемых объектов GridData зависит от количества диапазонов, запрошенных на этом листе. Например, если это представляет Для листа |
merges[] | Объединенные диапазоны. |
conditionalFormats[] | Правила условного формата на этом листе. |
filterViews[] | Представления фильтра на этом листе. |
protectedRanges[] | Защищенные диапазоны на этом листе. |
basicFilter | Фильтр на этом листе, если есть. |
charts[] | Спецификации каждой диаграммы на этом листе. |
bandedRanges[] | На этом листе диапазоны полос (чередующиеся цвета). |
developerMetadata[] | Метаданные разработчика, связанные с листом. |
rowGroups[] | Все группы строк на этом листе упорядочены по возрастанию начального индекса диапазона, а затем по глубине группы. |
columnGroups[] | Все группы столбцов на этом листе, упорядоченные по возрастанию начального индекса диапазона, а затем по глубине группы. |
slicers[] | Слайсеры на этом листе. |
Свойства листа
Свойства листа.
Представление JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Поля | |
---|---|
sheetId | Идентификатор листа. Должен быть неотрицательным. Это поле нельзя изменить после установки. |
title | Имя листа. |
index | Индекс листа в электронной таблице. При добавлении или обновлении свойств листа, если это поле исключено, лист добавляется или перемещается в конец списка листов. При обновлении индексов листов или вставке листов перемещение учитывается в индексах «до перемещения». Например, если было три листа (S1, S2, S3), чтобы переместить S1 впереди S2, индекс должен быть установлен на 2. Запрос на обновление индекса листа игнорируется, если запрошенный индекс идентичен текущему листу. index или если запрошенный новый индекс равен текущему индексу листа 1. |
sheetType | Тип листа. По умолчанию |
gridProperties | Дополнительные свойства листа, если этот лист является сеткой. (Если лист является объектным листом, содержащим диаграмму или изображение, то это поле будет отсутствовать.) При записи будет ошибкой устанавливать какие-либо свойства сетки на листах без сетки. Если этот лист является листом |
tabColor | Цвет вкладки в пользовательском интерфейсе. Устарело: используйте |
tabColorStyle | Цвет вкладки в пользовательском интерфейсе. Если |
rightToLeft | Истинно, если лист является листом RTL, а не листом LTR. |
dataSourceSheetProperties | Только вывод. Поле, если оно присутствует, содержит определенные свойства листа |
Тип листа
Вид листа.
перечисления | |
---|---|
SHEET_TYPE_UNSPECIFIED | Значение по умолчанию, не использовать. |
GRID | Лист представляет собой сетку. |
OBJECT | На листе нет сетки, а вместо этого есть объект, например диаграмма или изображение. |
DATA_SOURCE | Лист подключается к внешнему DataSource и показывает предварительный просмотр данных. |
свойства сетки
Свойства сетки.
Представление JSON |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
Поля | |
---|---|
rowCount | Количество строк в сетке. |
columnCount | Количество столбцов в сетке. |
frozenRowCount | Количество строк, замороженных в сетке. |
frozenColumnCount | Количество столбцов, зафиксированных в сетке. |
hideGridlines | Значение true, если сетка не отображает линии сетки в пользовательском интерфейсе. |
rowGroupControlAfter | Значение true, если переключатель управления группировкой строк отображается после группы. |
columnGroupControlAfter | Значение true, если переключатель управления группировкой столбцов отображается после группы. |
DataSourceSheetProperties
Дополнительные свойства листа DATA_SOURCE
.
Представление JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Поля | |
---|---|
dataSourceId | ID |
columns[] | Столбцы, отображаемые на листе, соответствуют значениям в |
dataExecutionStatus | Статус выполнения данных. |
GridData
Данные в сетке, а также метаданные об измерениях.
Представление JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Поля | |
---|---|
startRow | Первая строка, на которую ссылается этот GridData, отсчитывается от нуля. |
startColumn | Первый столбец, на который ссылается этот GridData, отсчитывается от нуля. |
rowData[] | Данные в сетке, по одной записи в строке, начиная со строки в startRow. Значения в RowData будут соответствовать столбцам, начинающимся с |
rowMetadata[] | Метаданные о запрошенных строках в сетке, начиная со строки в |
columnMetadata[] | Метаданные о запрошенных столбцах в сетке, начиная со столбца в |
Данные ряда
Данные о каждой ячейке в строке.
Представление JSON |
---|
{
"values": [
{
object ( |
Поля | |
---|---|
values[] | Значения в строке, по одному на столбец. |
DimensionProperties
Свойства измерения.
Представление JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
Поля | |
---|---|
pixelSize | Высота (если строка) или ширина (если столбец) измерения в пикселях. |
developerMetadata[] | Метаданные разработчика, связанные с одной строкой или столбцом. |
dataSourceColumnReference | Только вывод. Если установлено, это столбец на листе источника данных. |
УсловноеФорматПравило
Правило, описывающее условный формат.
Представление JSON |
---|
{ "ranges": [ { object ( |
Поля | |
---|---|
ranges[] | Диапазоны, которые форматируются, если условие истинно. Все диапазоны должны быть в одной сетке. |
rule союзного поля. Правило, управляющее этим условным форматом, должно быть установлено ровно одно. rule может быть только одним из следующих: | |
booleanRule | Форматирование либо «включено», либо «выключено» в соответствии с правилом. |
gradientRule | Форматирование будет варьироваться в зависимости от градиентов в правиле. |
логическое правило
Правило, которое может совпадать или не совпадать в зависимости от условия.
Представление JSON |
---|
{ "condition": { object ( |
Поля | |
---|---|
condition | Условие правила. Если условие оценивается как истинное, формат применяется. |
format | Формат для применения. Условное форматирование может применять только подмножество форматирования: |
ГрадиентПравило
Правило, которое применяет формат цветовой шкалы градиента на основе перечисленных точек интерполяции. Формат ячейки будет варьироваться в зависимости от ее содержимого по сравнению со значениями точек интерполяции.
Представление JSON |
---|
{ "minpoint": { object ( |
Поля | |
---|---|
minpoint | Начальная точка интерполяции. |
midpoint | Необязательная промежуточная точка интерполяции. |
maxpoint | Конечная точка интерполяции. |
точка интерполяции
Одна точка интерполяции в условном формате градиента. Они закрепляют цветовую шкалу градиента в соответствии с выбранным цветом, типом и значением.
Представление JSON |
---|
{ "color": { object ( |
Поля | |
---|---|
color | Цвет, который должна использовать эта точка интерполяции. Устарело: используйте |
colorStyle | Цвет, который должна использовать эта точка интерполяции. Если также задан |
type | Как следует интерпретировать значение. |
value | Значение, которое использует эта точка интерполяции. Может формула. Не используется, если |
InterpolationPointType
Тип точки интерполяции.
перечисления | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED | Значение по умолчанию, не использовать. |
MIN | Точка интерполяции использует минимальное значение в ячейках в диапазоне условного формата. |
MAX | Точка интерполяции использует максимальное значение в ячейках в диапазоне условного формата. |
NUMBER | Точка интерполяции точно использует значение в InterpolationPoint.value . |
PERCENT | Точка интерполяции — это заданный процент по всем ячейкам в диапазоне условного формата. Это эквивалентно |
PERCENTILE | Точкой интерполяции является заданный процентиль по всем ячейкам в диапазоне условного формата. Это эквивалентно NUMBER , если значение было: =PERCENTILE(FLATTEN(range), value / 100) (где ошибки в диапазоне игнорируются при выравнивании). |
Вид фильтра
Представление фильтра.
Представление 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 | Истинно, если кто-либо в домене документа имеет доступ к редактированию защищенного диапазона. Защита домена поддерживается только для документов внутри домена. |
Базовый фильтр
Фильтр по умолчанию, связанный с листом.
Представление JSON |
---|
{ "range": { object ( |
Поля | |
---|---|
range | Диапазон, покрываемый фильтром. |
sortSpecs[] | Порядок сортировки по столбцу. Более поздние спецификации используются, когда значения равны в более ранних спецификациях. |
criteria | Критерии отображения/скрытия значений для каждого столбца. Ключ карты — это индекс столбца, а значение — критерий для этого столбца. Это поле устарело в пользу |
filterSpecs[] | Критерии фильтрации для каждого столбца. И |
Полосатый диапазон
Полосатый (чередующийся цвет) диапазон на листе.
Представление JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Поля | |
---|---|
bandedRangeId | Идентификатор объединенного диапазона. |
range | Диапазон, в котором применяются эти свойства. |
rowProperties | Свойства полос строк. Эти свойства применяются построчно во всех строках диапазона. Необходимо указать хотя бы одно из |
columnProperties | Свойства полос столбцов. Эти свойства применяются для каждого столбца во всех столбцах диапазона. Необходимо указать хотя бы одно из |
БандингСвойства
Свойства, относящиеся к одному измерению (строке или столбцу). Если установлены оба 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 | Это поле имеет значение true, если эта группа свернута. Свернутая группа остается свернутой, если расширяется перекрывающаяся группа на меньшей глубине. Значение true не означает, что все измерения внутри группы скрыты, поскольку видимость измерения может меняться независимо от этого свойства группы. Однако при обновлении этого свойства все измерения внутри него становятся скрытыми, если это поле имеет значение true, или видимыми, если это поле имеет значение false. |
Слайсер
Слайсер в листе.
Представление JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Поля | |
---|---|
slicerId | Идентификатор слайсера. |
spec | Спецификация слайсера. |
position | Положение слайсера. Обратите внимание, что слайсер можно расположить только на существующем листе. Кроме того, ширина и высота слайсера могут автоматически регулироваться, чтобы оставаться в допустимых пределах. |
SlicerSpec
Характеристики слайсера.
Представление JSON |
---|
{ "dataRange": { object ( |
Поля | |
---|---|
dataRange | Диапазон данных слайсера. |
filterCriteria | Критерии фильтрации слайсера. |
columnIndex | Отсчитываемый от нуля индекс столбца в таблице данных, к которой применяется фильтр. |
applyToPivotTables | Истинно, если фильтр должен применяться к сводным таблицам. Если не установлено, по умолчанию |
title | Название слайсера. |
textFormat | Текстовый формат заголовка в слайсере. Поле ссылки не поддерживается. |
backgroundColor | Цвет фона слайсера. Устарело: используйте |
backgroundColorStyle | Цвет фона слайсера. Если также установлен |
horizontalAlignment | Горизонтальное выравнивание заголовка в слайсере. Если не указано, по умолчанию |