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 Таблиц.
PivotFilter Доступ и изменение фильтров сводной таблицы.
PivotGroup Доступ и изменение секционных групп сводной таблицы.
PivotGroupLimit Доступ и изменение ограничения группы сводных таблиц.
PivotTable Доступ и изменение сводных таблиц.
PivotTableSummarizeFunction Перечисление функций, которые суммируют данные сводной таблицы.
PivotValue Доступ и изменение групп значений в сводных таблицах.
PivotValueDisplayType Перечень способов отображения опорного значения как функции другого значения.
Protection Доступ и изменение защищенных диапазонов и листов.
ProtectionType Перечисление, представляющее части электронной таблицы, которые можно защитить от изменений.
Range Доступ и изменение диапазонов электронных таблиц.
RangeList Коллекция из одного или нескольких экземпляров Range на одном листе.
RecalculationInterval Перечисление, представляющее возможные интервалы, используемые при пересчете электронной таблицы.
RelativeDate Перечисление, представляющее параметры относительной даты для вычисления значения, которое будет использоваться в BooleanCriteria на основе даты.
RichTextValue Стилизованная текстовая строка, используемая для представления текста ячейки.
RichTextValueBuilder Построитель значений форматированного текста.
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 если URL-адрес недоступен.
toBuilder() CellImageBuilder Создает построитель, который преобразует изображение в тип значения изображения, чтобы его можно было поместить в ячейку.

CellImageBuilder

Характеристики

Свойство Тип Описание
valueType ValueType Поле, которому присвоено значение ValueType.IMAGE , представляющее тип значения изображения.

Методы

Метод Тип возврата Краткое описание
build() CellImage Создает тип значения изображения, необходимый для добавления изображения в ячейку.
getAltTextDescription() String Возвращает альтернативное текстовое описание для этого изображения.
getAltTextTitle() String Возвращает замещающий текстовый заголовок для этого изображения.
getContentUrl() String Возвращает URL-адрес изображения, размещенный в Google.
getUrl() String Получает исходный URL-адрес изображения; возвращает значение null если URL-адрес недоступен.
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 Устанавливает поля minpoint градиента правила условного формата.
setGradientMinpointWithValue(color, type, value) ConditionalFormatRuleBuilder Устанавливает поля minpoint градиента правила условного формата.
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 Код ошибки выполнения данных, который не поддерживается в скрипте приложений.
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 Получает исходную ячейку, на основе которой оценивается параметр, или null , если тип параметра отличается от DataSourceParameterType.CELL .
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 (который представляет Jan-Mar).
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 для местоположения столбца этих метаданных, или null , если тип местоположения не является DeveloperMetadataLocationType.COLUMN .
getLocationType() DeveloperMetadataLocationType Получает тип местоположения.
getRow() Range Возвращает Range для расположения строки этих метаданных, или null , если тип местоположения не является DeveloperMetadataLocationType.ROW .
getSheet() Sheet Возвращает местоположение Sheet этих метаданных, или null если тип местоположения не является DeveloperMetadataLocationType.SHEET .
getSpreadsheet() Spreadsheet Возвращает местоположение Spreadsheet этих метаданных, или null если тип местоположения не является DeveloperMetadataLocationType.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-индекс этого рисунка.
remove() void Удаляет этот рисунок из электронной таблицы.
setHeight(height) Drawing Устанавливает фактическую высоту этого рисунка в пикселях.
setOnAction(macroName) Drawing Присваивает макрофункцию этому рисунку.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) Drawing Устанавливает позицию, где на листе появляется чертеж.
setWidth(width) Drawing Устанавливает фактическую ширину этого рисунка в пикселях.
setZIndex(zIndex) Drawing Устанавливает Z-индекс этого рисунка.

EmbeddedAreaChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
useLogScale() EmbeddedAreaChartBuilder Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными).

EmbeddedBarChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
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 Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
useLogScale() EmbeddedColumnChartBuilder Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными).

EmbeddedComboChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
useLogScale() EmbeddedComboChartBuilder Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными).

EmbeddedHistogramChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
useLogScale() EmbeddedHistogramChartBuilder Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными).

EmbeddedLineChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.
useLogScale() EmbeddedLineChartBuilder Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными).

EmbeddedPieChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Устанавливает стиль текста Text Text Vertical Axis.

EmbeddedTableChartBuilder

Методы

Метод Возврат тип Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон в диаграмму, который модифицирует этот строитель.
asAreaChart() EmbeddedAreaChartBuilder Устанавливает тип диаграммы в Areachart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Устанавливает тип диаграммы в Барчарт и возвращает встроенный EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Устанавливает тип диаграммы на ColumnThart и возвращает 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 Включает Paging, устанавливает количество строк на каждой странице и первой странице таблицы для отображения (номера страниц основаны на нулевом).
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[] Возвращает значения, которые показывает фильтр Table Pivot.

FilterCriteriaBuilder

Методы

Метод Возврат тип Краткое описание
build() FilterCriteria Соберите критерии фильтра, используя настройки, которые вы добавляете в строитель критериев.
copy() FilterCriteriaBuilder Копирует эти критерии фильтра и создает строитель критериев, который вы можете применить к другому фильтру.
getCriteriaType() BooleanCriteria Возвращает логический тип критериев, например, CELL_EMPTY .
getCriteriaValues() Object[] Возвращает множество аргументов для логических критериев.
getHiddenValues() String[] Возвращает значения, которые скрывает фильтр.
getVisibleBackgroundColor() Color Возвращает цвет фона, используемый в качестве критериев фильтра.
getVisibleForegroundColor() Color Возвращает цвет переднего плана, используемый в качестве критериев фильтра.
getVisibleValues() String[] Возвращает значения, которые показывает фильтр Table Pivot.
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 Устанавливает критерии фильтра, чтобы показать ячейки с текстом, который заканчивается указанным текстом.
whenTextEqualTo(text) FilterCriteriaBuilder Устанавливает критерии фильтра, чтобы показать ячейки с текстом, равным указанному тексту.
whenTextEqualToAny(texts) FilterCriteriaBuilder Устанавливает критерии фильтра, чтобы показать ячейки с текстом, равным любому из указанных текстовых значений.
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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.

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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

Методы

Метод Возврат тип Краткое описание
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 "," delimiter.
SEMICOLON Enum ";" delimiter.
PERIOD Enum "." delimiter.
SPACE Enum " " delimiter.

ThemeColor

Методы

Метод Возврат тип Краткое описание
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.