Spreadsheet Service

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Электронная таблица

Эта служба позволяет сценариям создавать, получать доступ и изменять файлы Google Sheets. См. также руководство по хранению данных в электронных таблицах .

Иногда операции с электронными таблицами объединяются для повышения производительности, например, при выполнении нескольких вызовов метода. Если вы хотите убедиться, что все ожидающие изменения внесены сразу же, например, чтобы показать пользователям информацию во время выполнения скрипта, вызовите SpreadsheetApp.flush() .

Классы

Имя Краткое описание
AutoFillSeries Перечисление типов рядов, используемых для вычисления автоматически заполняемых значений.
Banding Доступ и изменение полос, цветовых шаблонов, применяемых к строкам или столбцам диапазона.
BandingTheme Перечень тем бандинга.
BigQueryDataSourceSpec Получите доступ к существующей спецификации источника данных BigQuery.
BigQueryDataSourceSpecBuilder Построитель для BigQueryDataSourceSpecBuilder .
BooleanCondition Доступ к логическим условиям в ConditionalFormatRules .
BooleanCriteria Перечисление, представляющее логические критерии, которые можно использовать в условном формате или фильтре.
BorderStyle Стили, которые можно задать для диапазона с помощью Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) .
CellImage Представляет изображение для добавления в ячейку.
CellImageBuilder Конструктор для CellImage .
Color Представление для цвета.
ColorBuilder Конструктор для ColorBuilder .
ConditionalFormatRule Доступ к правилам условного форматирования.
ConditionalFormatRuleBuilder Построитель правил условного форматирования.
ContainerInfo Доступ к положению диаграммы на листе.
CopyPasteType Перечень возможных типов специальных паст.
DataExecutionErrorCode Перечисление кодов ошибок выполнения данных.
DataExecutionState Перечисление состояний выполнения данных.
DataExecutionStatus Статус выполнения данных.
DataSource Доступ и изменение существующего источника данных.
DataSourceChart Получите доступ к существующей диаграмме источника данных и измените ее.
DataSourceColumn Доступ и изменение столбца источника данных.
DataSourceFormula Доступ и изменение существующих формул источника данных.
DataSourceParameter Доступ к существующим параметрам источника данных.
DataSourceParameterType Перечисление типов параметров источника данных.
DataSourcePivotTable Доступ и изменение существующей сводной таблицы источника данных.
DataSourceRefreshSchedule Получите доступ к существующему расписанию обновления и измените его.
DataSourceRefreshScheduleFrequency Получите доступ к частоте обновления расписания, которая указывает, как часто и когда обновлять.
DataSourceRefreshScope Перечисление областей для обновлений.
DataSourceSheet Получите доступ к существующему листу источника данных и измените его.
DataSourceSheetFilter Получите доступ к существующему фильтру листа источника данных и измените его.
DataSourceSpec Доступ к общим настройкам существующей спецификации источника данных.
DataSourceSpecBuilder Построитель для DataSourceSpec .
DataSourceTable Доступ и изменение существующей таблицы источника данных.
DataSourceTableColumn Получите доступ к существующему столбцу в DataSourceTable и измените его.
DataSourceTableFilter Получите доступ к существующему фильтру таблицы источника данных и измените его.
DataSourceType Перечисление типов источников данных.
DataValidation Доступ к правилам проверки данных.
DataValidationBuilder Построитель правил проверки данных.
DataValidationCriteria Перечисление, представляющее критерии проверки данных, которые можно задать для диапазона.
DateTimeGroupingRule Доступ к существующему правилу группировки даты и времени.
DateTimeGroupingRuleType Типы правил группировки даты и времени.
DeveloperMetadata Доступ и изменение метаданных разработчика.
DeveloperMetadataFinder Найдите метаданные разработчика в электронной таблице.
DeveloperMetadataLocation Получите доступ к информации о расположении метаданных разработчика.
DeveloperMetadataLocationType Перечисление типов расположения метаданных разработчика.
DeveloperMetadataVisibility Перечисление типов видимости метаданных разработчика.
Dimension Перечисление возможных направлений, по которым данные могут храниться в электронной таблице.
Direction Перечисление, представляющее возможные направления, в которых можно перемещаться в электронной таблице с помощью клавиш со стрелками.
Drawing Представляет рисунок на листе электронной таблицы.
EmbeddedAreaChartBuilder Построитель диаграмм с областями.
EmbeddedBarChartBuilder Построитель гистограмм.
EmbeddedChart Представляет диаграмму, встроенную в электронную таблицу.
EmbeddedChartBuilder Builder, используемый для редактирования EmbeddedChart .
EmbeddedColumnChartBuilder Построитель для столбчатых диаграмм.
EmbeddedComboChartBuilder Построитель комбинированных диаграмм.
EmbeddedHistogramChartBuilder Построитель гистограмм.
EmbeddedLineChartBuilder Построитель линейных диаграмм.
EmbeddedPieChartBuilder Построитель круговых диаграмм.
EmbeddedScatterChartBuilder Построитель точечных диаграмм.
EmbeddedTableChartBuilder Построитель табличных диаграмм.
Filter Используйте этот класс для изменения существующих фильтров на листах Grid , типе листа по умолчанию.
FilterCriteria Используйте этот класс, чтобы получить информацию или скопировать критерии существующих фильтров.
FilterCriteriaBuilder Чтобы добавить критерии к фильтру, необходимо сделать следующее:
  1. Создайте построитель критериев с помощью SpreadsheetApp.newFilterCriteria() .
  2. Добавьте настройки в билдер, используя методы из этого класса.
  3. Используйте build() , чтобы собрать критерии с указанными вами настройками.
FrequencyType Перечень частотных типов.
GradientCondition Доступ к условиям градиента (цвета) в ConditionalFormatRuleApis .
Group Доступ и изменение групп электронных таблиц.
GroupControlTogglePosition Перечисление, представляющее возможные позиции, которые может иметь переключатель управления группой.
InterpolationType Перечисление, представляющее параметры интерполяции для вычисления значения, используемого в GradientCondition в ConditionalFormatRule .
NamedRange Создавайте, получайте доступ и изменяйте именованные диапазоны в электронной таблице.
OverGridImage Представляет изображение над сеткой в ​​электронной таблице.
PageProtection Доступ и изменение защищенных листов в старой версии Google Sheets.
PivotFilter Доступ и изменение фильтров сводной таблицы.
PivotGroup Доступ и изменение секционных групп сводной таблицы.
PivotGroupLimit Доступ и изменение ограничения группы сводной таблицы.
PivotTable Доступ и изменение сводных таблиц.
PivotTableSummarizeFunction Перечисление функций, обобщающих данные сводной таблицы.
PivotValue Доступ и изменение групп значений в сводных таблицах.
PivotValueDisplayType Перечисление способов отображения сводного значения как функции другого значения.
Protection Доступ и изменение защищенных диапазонов и листов.
ProtectionType Перечисление, представляющее части электронной таблицы, которые можно защитить от редактирования.
Range Доступ и изменение диапазонов электронных таблиц.
RangeList Коллекция из одного или нескольких экземпляров Range на одном листе.
RecalculationInterval Перечисление, представляющее возможные интервалы, используемые при пересчете электронной таблицы.
RelativeDate Перечисление, представляющее параметры относительной даты для вычисления значения, которое будет использоваться в BooleanCriteria на основе даты.
RichTextValue Стилизованная текстовая строка, используемая для представления текста ячейки.
RichTextValueBuilder Конструктор значений форматированного текста.
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 Возвращает размещенный в Google URL-адрес изображения.
getUrl() String Получает URL-адрес источника изображения; возвращает null , если URL-адрес недоступен.
toBuilder() CellImageBuilder Создает построитель, который превращает изображение в тип значения изображения, чтобы его можно было поместить в ячейку.

CellImageBuilder

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

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

Методы

Метод Тип возврата Краткое описание
build() CellImage Создает тип значения изображения, необходимый для добавления изображения в ячейку.
getAltTextDescription() String Возвращает описание замещающего текста для этого изображения.
getAltTextTitle() String Возвращает заголовок альтернативного текста для этого изображения.
getContentUrl() String Возвращает размещенный в Google URL-адрес изображения.
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 Задает поля maxpoint градиента правила условного форматирования.
setGradientMaxpointWithValue(color, type, value) ConditionalFormatRuleBuilder Задает поля maxpoint градиента правила условного форматирования.
setGradientMidpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder Задает поля средней точки градиента правила условного формата.
setGradientMidpointWithValue(color, type, value) ConditionalFormatRuleBuilder Задает поля средней точки градиента правила условного формата.
setGradientMinpoint(color) ConditionalFormatRuleBuilder Очищает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила.
setGradientMinpointObject(color) ConditionalFormatRuleBuilder Очищает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила.
setGradientMinpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder Задает поля минимальной точки градиента правила условного форматирования.
setGradientMinpointWithValue(color, type, value) ConditionalFormatRuleBuilder Задает поля минимальной точки градиента правила условного форматирования.
setItalic(italic) ConditionalFormatRuleBuilder Устанавливает курсив текста для формата правила условного форматирования.
setRanges(ranges) ConditionalFormatRuleBuilder Задает один или несколько диапазонов, к которым применяется это правило условного форматирования.
setStrikethrough(strikethrough) ConditionalFormatRuleBuilder Устанавливает зачеркивание текста для формата правила условного форматирования.
setUnderline(underline) ConditionalFormatRuleBuilder Устанавливает подчеркивание текста для формата правила условного форматирования.
whenCellEmpty() ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда ячейка пуста.
whenCellNotEmpty() ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда ячейка не пуста.
whenDateAfter(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата находится после заданного значения.
whenDateAfter(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата находится после заданной относительной даты.
whenDateBefore(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата предшествует заданной дате.
whenDateBefore(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата предшествует заданной относительной дате.
whenDateEqualTo(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата равна заданной дате.
whenDateEqualTo(date) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда дата равна заданной относительной дате.
whenFormulaSatisfied(formula) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда данная формула оценивается как true .
whenNumberBetween(start, end) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число попадает между двумя указанными значениями или является одним из них.
whenNumberEqualTo(number) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число равно заданному значению.
whenNumberGreaterThan(number) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число больше заданного значения.
whenNumberGreaterThanOrEqualTo(number) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число больше или равно заданному значению.
whenNumberLessThan(number) ConditionalFormatRuleBuilder Устанавливает правило условного условного формата для срабатывания, когда число меньше заданного значения.
whenNumberLessThanOrEqualTo(number) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число меньше или равно заданному значению.
whenNumberNotBetween(start, end) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число не попадает между двумя указанными значениями и не является ни одним из них.
whenNumberNotEqualTo(number) ConditionalFormatRuleBuilder Устанавливает правило условного форматирования для срабатывания, когда число не равно заданному значению.
whenTextContains(text) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда ввод содержит заданное значение.
whenTextDoesNotContain(text) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда ввод не содержит заданного значения.
whenTextEndsWith(text) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда ввод заканчивается заданным значением.
whenTextEqualTo(text) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда ввод равен заданному значению.
whenTextStartsWith(text) ConditionalFormatRuleBuilder Устанавливает правило условного формата для срабатывания, когда ввод начинается с заданного значения.
withCriteria(criteria, args) ConditionalFormatRuleBuilder Задает для правила условного форматирования критерии, определенные значениями BooleanCriteria , которые обычно берутся из criteria и arguments существующего правила.

ContainerInfo

Методы

Метод Тип возврата Краткое описание
getAnchorColumn() Integer Левая сторона диаграммы привязана к этому столбцу.
getAnchorRow() Integer Верхняя сторона диаграммы привязана к этой строке.
getOffsetX() Integer Верхний левый угол диаграммы смещен от столбца привязки на указанное количество пикселей.
getOffsetY() Integer Верхний левый угол диаграммы смещен от строки привязки на указанное количество пикселей.

CopyPasteType

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

Имущество Тип Описание
PASTE_NORMAL Enum Вставка значений, формул, форматов и слияний.
PASTE_NO_BORDERS Enum Вставляйте значения, формулы, форматы и слияния, но без границ.
PASTE_FORMAT Enum Вставьте только формат и проверку данных.
PASTE_FORMULA Enum Вставьте только формулы.
PASTE_DATA_VALIDATION Enum Вставьте только проверку данных.
PASTE_VALUES Enum Вставляйте значения ТОЛЬКО без форматов, формул или слияний.
PASTE_CONDITIONAL_FORMATTING Enum Вставьте только правила цвета.
PASTE_COLUMN_WIDTHS Enum Вставьте только ширину столбца.

DataExecutionErrorCode

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

Имущество Тип Описание
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED Enum Код ошибки выполнения данных, который не поддерживается в Apps Script.
NONE Enum Выполнение данных не имеет ошибок.
TIME_OUT Enum Время выполнения данных истекло.
TOO_MANY_ROWS Enum Выполнение данных возвращает больше строк, чем ограничение.
TOO_MANY_COLUMNS Enum Выполнение данных возвращает больше столбцов, чем ограничение.
TOO_MANY_CELLS Enum Выполнение данных возвращает больше ячеек, чем предел.
ENGINE Enum Ошибка механизма выполнения данных.
PARAMETER_INVALID Enum Недопустимый параметр выполнения данных.
UNSUPPORTED_DATA_TYPE Enum Выполнение данных возвращает неподдерживаемый тип данных.
DUPLICATE_COLUMN_NAMES Enum Выполнение данных возвращает повторяющиеся имена столбцов.
INTERRUPTED Enum Выполнение данных прерывается.
OTHER Enum Другие ошибки.
TOO_MANY_CHARS_PER_CELL Enum Выполнение данных возвращает значения, которые превышают максимально допустимое количество символов в одной ячейке.
DATA_NOT_FOUND Enum База данных, на которую ссылается источник данных, не найдена.
PERMISSION_DENIED Enum У пользователя нет доступа к базе данных, на которую ссылается источник данных.

DataExecutionState

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

Имущество Тип Описание
DATA_EXECUTION_STATE_UNSUPPORTED Enum Состояние выполнения данных не поддерживается в Apps Script.
RUNNING Enum Выполнение данных началось и выполняется.
SUCCESS Enum Выполнение данных завершено и успешно.
ERROR Enum Выполнение данных завершено и имеет ошибки.
NOT_STARTED Enum Выполнение данных не началось.

DataExecutionStatus

Методы

Метод Тип возврата Краткое описание
getErrorCode() DataExecutionErrorCode Получает код ошибки выполнения данных.
getErrorMessage() String Получает сообщение об ошибке выполнения данных.
getExecutionState() DataExecutionState Получает состояние выполнения данных.
getLastExecutionTime() Date Получает время последнего выполнения данных независимо от состояния выполнения.
getLastRefreshedTime() Date Получает время последнего успешного обновления данных.
isTruncated() Boolean Возвращает true , если данные последнего успешного выполнения усекаются, или false в противном случае.

DataSource

Методы

Метод Тип возврата Краткое описание
createCalculatedColumn(name, formula) DataSourceColumn Создает вычисляемый столбец.
createDataSourcePivotTableOnNewSheet() DataSourcePivotTable Создает сводную таблицу источника данных из этого источника данных в первой ячейке нового листа.
createDataSourceTableOnNewSheet() DataSourceTable Создает таблицу источника данных из этого источника данных в первой ячейке нового листа.
getCalculatedColumnByName(columnName) DataSourceColumn Возвращает вычисляемый столбец в источнике данных, который соответствует имени столбца.
getCalculatedColumns() DataSourceColumn[] Возвращает все вычисляемые столбцы в источнике данных.
getColumns() DataSourceColumn[] Возвращает все столбцы в источнике данных.
getDataSourceSheets() DataSourceSheet[] Возвращает листы источника данных, связанные с этим источником данных.
getSpec() DataSourceSpec Получает спецификацию источника данных.
refreshAllLinkedDataSourceObjects() void Обновляет все объекты источника данных, связанные с источником данных.
updateSpec(spec) DataSource Обновляет спецификацию источника данных и обновляет объекты источников данных, связанные с этим источником данных, с новой спецификацией.
updateSpec(spec, refreshAllLinkedObjects) DataSource Обновляет спецификацию источника данных и обновляет связанные data source sheets новой спецификацией.
waitForAllDataExecutionsCompletion(timeoutInSeconds) void Ожидает завершения всех текущих выполнений связанных объектов источника данных, время ожидания истекает через указанное количество секунд.

DataSourceChart

Методы

Метод Тип возврата Краткое описание
forceRefreshData() DataSourceChart Обновляет данные этого объекта независимо от текущего состояния.
getDataSource() DataSource Получает источник данных, с которым связан объект.
getStatus() DataExecutionStatus Получает состояние выполнения данных объекта.
refreshData() DataSourceChart Обновляет данные объекта.
waitForCompletion(timeoutInSeconds) DataExecutionStatus Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд.

DataSourceColumn

Методы

Метод Тип возврата Краткое описание
getDataSource() DataSource Получает источник данных, связанный со столбцом источника данных.
getFormula() String Получает формулу для столбца источника данных.
getName() String Получает имя столбца источника данных.
hasArrayDependency() Boolean Возвращает, имеет ли столбец зависимость от массива.
isCalculatedColumn() Boolean Возвращает, является ли столбец вычисляемым столбцом.
remove() void Удаляет столбец источника данных.
setFormula(formula) DataSourceColumn Задает формулу для столбца источника данных.
setName(name) DataSourceColumn Задает имя столбца источника данных.

DataSourceFormula

Методы

Метод Тип возврата Краткое описание
forceRefreshData() DataSourceFormula Обновляет данные этого объекта независимо от текущего состояния.
getAnchorCell() Range Возвращает Range , представляющий ячейку, к которой привязана эта формула источника данных.
getDataSource() DataSource Получает источник данных, с которым связан объект.
getDisplayValue() String Возвращает отображаемое значение формулы источника данных.
getFormula() String Возвращает формулу для этой формулы источника данных.
getStatus() DataExecutionStatus Получает состояние выполнения данных объекта.
refreshData() DataSourceFormula Обновляет данные объекта.
setFormula(formula) DataSourceFormula Обновляет формулу.
waitForCompletion(timeoutInSeconds) DataExecutionStatus Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд.

DataSourceParameter

Методы

Метод Тип возврата Краткое описание
getName() String Получает имя параметра.
getSourceCell() String Получает исходную ячейку, на основе которой оценивается параметр, или 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 Requires that the input is equal to a value in the given range.
CUSTOM_FORMULA Enum Requires that the input makes the given formula evaluate to true .
CHECKBOX Enum Requires that the input is a custom value or a boolean; rendered as a checkbox.

DateTimeGroupingRule

Методы

Метод Тип возврата Краткое описание
getRuleType() DateTimeGroupingRuleType Gets the type of the date-time grouping rule.

DateTimeGroupingRuleType

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

Имущество Тип Описание
UNSUPPORTED Enum A date-time grouping rule type that is not supported.
SECOND Enum Group date-time by second, from 0 to 59.
MINUTE Enum Group date-time by minute, from 0 to 59.
HOUR Enum Group date-time by hour using a 24-hour system, from 0 to 23.
HOUR_MINUTE Enum Group date-time by hour and minute using a 24-hour system, for example 19:45 .
HOUR_MINUTE_AMPM Enum Group date-time by hour and minute using a 12-hour system, for example 7:45 PM .
DAY_OF_WEEK Enum Group date-time by day of week, for example Sunday .
DAY_OF_YEAR Enum Group date-time by day of year, from 1 to 366.
DAY_OF_MONTH Enum Group date-time by day of month, from 1 to 31.
DAY_MONTH Enum Group date-time by day and month, for example 22-Nov .
MONTH Enum Group date-time by month, for example Nov .
QUARTER Enum Group date-time by quarter, for example Q1 (which represents Jan-Mar).
YEAR Enum Group date-time by year, for example 2008.
YEAR_MONTH Enum Group date-time by year and month, for example 2008-Nov .
YEAR_QUARTER Enum Group date-time by year and quarter, for example 2008 Q4 .
YEAR_MONTH_DAY Enum Group date-time by year, month, and day, for example 2008-11-22 .

DeveloperMetadata

Методы

Метод Тип возврата Краткое описание
getId() Integer Returns the unique ID associated with this developer metadata.
getKey() String Returns the key associated with this developer metadata.
getLocation() DeveloperMetadataLocation Returns the location of this developer metadata.
getValue() String Returns the value associated with this developer metadata, or null if this metadata has no value.
getVisibility() DeveloperMetadataVisibility Returns the visibility of this developer metadata.
moveToColumn(column) DeveloperMetadata Moves this developer metadata to the specified column.
moveToRow(row) DeveloperMetadata Moves this developer metadata to the specified row.
moveToSheet(sheet) DeveloperMetadata Moves this developer metadata to the specified sheet.
moveToSpreadsheet() DeveloperMetadata Moves this developer metadata to the top-level spreadsheet.
remove() void Deletes this metadata.
setKey(key) DeveloperMetadata Sets the key of this developer metadata to the specified value.
setValue(value) DeveloperMetadata Sets the value associated with this developer metadata to the specified value.
setVisibility(visibility) DeveloperMetadata Sets the visibility of this developer metadata to the specified visibility.

DeveloperMetadataFinder

Методы

Метод Тип возврата Краткое описание
find() DeveloperMetadata[] Executes this search and returns the matching metadata.
onIntersectingLocations() DeveloperMetadataFinder Configures the search to consider intersecting locations that have metadata.
withId(id) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified ID.
withKey(key) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified key.
withLocationType(locationType) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified location type.
withValue(value) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified value.
withVisibility(visibility) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified visibility.

DeveloperMetadataLocation

Методы

Метод Тип возврата Краткое описание
getColumn() Range Returns the Range for the column location of this metadata, or null if the location type is not DeveloperMetadataLocationType.COLUMN .
getLocationType() DeveloperMetadataLocationType Gets the type of location.
getRow() Range Returns the Range for the row location of this metadata, or null if the location type is not DeveloperMetadataLocationType.ROW .
getSheet() Sheet Returns the Sheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SHEET .
getSpreadsheet() Spreadsheet Returns the Spreadsheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SPREADSHEET .

DeveloperMetadataLocationType

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

Имущество Тип Описание
SPREADSHEET Enum The location type for developer metadata associated with the top-level spreadsheet.
SHEET Enum The location type for developer metadata associated with a whole sheet.
ROW Enum The location type for developer metadata associated with a row.
COLUMN Enum The location type for developer metadata associated with a column.

DeveloperMetadataVisibility

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

Имущество Тип Описание
DOCUMENT Enum Document-visible metadata is accessible from any developer project with access to the document.
PROJECT Enum Project-visible metadata is only visible to and accessible by the developer project that created the metadata.

Dimension

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

Имущество Тип Описание
COLUMNS Enum The column (vertical) dimension.
ROWS Enum The row (horizontal) dimension.

Direction

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

Имущество Тип Описание
UP Enum The direction of decreasing row indices.
DOWN Enum The direction of increasing row indices.
PREVIOUS Enum The direction of decreasing column indices.
NEXT Enum The direction of increasing column indices.

Drawing

Методы

Метод Тип возврата Краткое описание
getContainerInfo() ContainerInfo Gets information about where the drawing is positioned in the sheet.
getHeight() Integer Returns the actual height of this drawing in pixels.
getOnAction() String Returns the name of the macro attached to this drawing.
getSheet() Sheet Returns the sheet this drawing appears on.
getWidth() Integer Returns the actual width of this drawing in pixels.
getZIndex() Number Returns the z-index of this drawing.
remove() void Deletes this drawing from the spreadsheet.
setHeight(height) Drawing Sets the actual height of this drawing in pixels.
setOnAction(macroName) Drawing Assigns a macro function to this drawing.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) Drawing Sets the position where the drawing appears on the sheet.
setWidth(width) Drawing Sets the actual width of this drawing in pixels.
setZIndex(zIndex) Drawing Sets the z-index of this drawing.

EmbeddedAreaChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedAreaChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedAreaChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedAreaChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedAreaChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedAreaChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedAreaChartBuilder Sets the range for the chart.
setStacked() EmbeddedAreaChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedAreaChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedAreaChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedAreaChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedAreaChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedBarChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedBarChartBuilder Reverses the drawing of series in the domain axis.
reverseDirection() EmbeddedBarChartBuilder Reverses the direction in which the bars grow along the horizontal axis.
setBackgroundColor(cssValue) EmbeddedBarChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedBarChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedBarChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedBarChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedBarChartBuilder Sets the range for the chart.
setStacked() EmbeddedBarChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedBarChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedBarChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedBarChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedBarChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedBarChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedBarChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedChart

Методы

Метод Тип возврата Краткое описание
asDataSourceChart() DataSourceChart Casts to a data source chart instance if the chart is a data source chart, or null otherwise.
getAs(contentType) Blob Return the data inside this object as a blob converted to the specified content type.
getBlob() Blob Return the data inside this object as a blob.
getChartId() Integer Returns a stable identifier for the chart that is unique across the spreadsheet containing the chart or null if the chart is not in a spreadsheet.
getContainerInfo() ContainerInfo Returns information about where the chart is positioned within a sheet.
getHiddenDimensionStrategy() ChartHiddenDimensionStrategy Returns the strategy to use for handling hidden rows and columns.
getMergeStrategy() ChartMergeStrategy Returns the merge strategy used when more than one range exists.
getNumHeaders() Integer Returns the number of rows or columns the range that are treated as headers.
getOptions() ChartOptions Returns the options for this chart, such as height, colors, and axes.
getRanges() Range[] Returns the ranges that this chart uses as a data source.
getTransposeRowsAndColumns() Boolean If true , the rows and columns used to populate the chart are switched.
modify() EmbeddedChartBuilder Returns an EmbeddedChartBuilder that can be used to modify this chart.

EmbeddedChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.

EmbeddedColumnChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedColumnChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedColumnChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedColumnChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedColumnChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedColumnChartBuilder Sets the range for the chart.
setStacked() EmbeddedColumnChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedColumnChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedColumnChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedColumnChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedColumnChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedComboChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedComboChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedComboChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedComboChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedComboChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedComboChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedComboChartBuilder Sets the range for the chart.
setStacked() EmbeddedComboChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedComboChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedComboChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedComboChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedComboChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedComboChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedComboChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedComboChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedHistogramChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedHistogramChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedHistogramChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedHistogramChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedHistogramChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedHistogramChartBuilder Sets the range for the chart.
setStacked() EmbeddedHistogramChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedHistogramChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedHistogramChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedHistogramChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedHistogramChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedLineChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedLineChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedLineChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedLineChartBuilder Sets the colors for the lines in the chart.
setCurveStyle(style) EmbeddedLineChartBuilder Sets the style to use for curves in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedLineChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedLineChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedLineChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedLineChartBuilder Sets the range for the chart.
setTitle(chartTitle) EmbeddedLineChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedLineChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedLineChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedLineChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedLineChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedLineChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedPieChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedPieChartBuilder Reverses the drawing of series in the domain axis.
set3D() EmbeddedPieChartBuilder Sets the chart to be three-dimensional.
setBackgroundColor(cssValue) EmbeddedPieChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedPieChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedPieChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedPieChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTitle(chartTitle) EmbeddedPieChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedPieChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.

EmbeddedScatterChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setBackgroundColor(cssValue) EmbeddedScatterChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedScatterChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedScatterChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedScatterChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTitle(chartTitle) EmbeddedScatterChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisLogScale() EmbeddedScatterChartBuilder Makes the horizontal axis into a logarithmic scale (requires all values to be positive).
setXAxisRange(start, end) EmbeddedScatterChartBuilder Sets the range for the horizontal axis of the chart.
setXAxisTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedScatterChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the horizontal axis title text style.
setYAxisLogScale() EmbeddedScatterChartBuilder Makes the vertical axis into a logarithmic scale (requires all values to be positive).
setYAxisRange(start, end) EmbeddedScatterChartBuilder Sets the range for the vertical axis of the chart.
setYAxisTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedScatterChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the vertical axis title text style.

EmbeddedTableChartBuilder

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Adds a range to the chart this builder modifies.
asAreaChart() EmbeddedAreaChartBuilder Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder .
build() EmbeddedChart Builds the chart to reflect all changes made to it.
clearRanges() EmbeddedChartBuilder Removes all ranges from the chart this builder modifies.
enablePaging(enablePaging) EmbeddedTableChartBuilder Sets whether to enable paging through the data.
enablePaging(pageSize) EmbeddedTableChartBuilder Enables paging and sets the number of rows in each page.
enablePaging(pageSize, startPage) EmbeddedTableChartBuilder Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based).
enableRtlTable(rtlEnabled) EmbeddedTableChartBuilder Adds basic support for right-to-left languages (such as Arabic or Hebrew) by reversing the column order of the table, so that column zero is the right-most column, and the last column is the left-most column.
enableSorting(enableSorting) EmbeddedTableChartBuilder Sets whether to sort columns when the user clicks a column heading.
getChartType() ChartType Returns the current chart type.
getContainer() ContainerInfo Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet.
getRanges() Range[] Returns a copy of the list of ranges currently providing data for this chart.
removeRange(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setFirstRowNumber(number) EmbeddedTableChartBuilder Sets the row number for the first row in the data table.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setInitialSortingAscending(column) EmbeddedTableChartBuilder Sets the index of the column according to which the table should be initially sorted (ascending).
setInitialSortingDescending(column) EmbeddedTableChartBuilder Sets the index of the column according to which the table should be initially sorted (descending).
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
showRowNumberColumn(showRowNumber) EmbeddedTableChartBuilder Sets whether to show the row number as the first column of the table.
useAlternatingRowStyle(alternate) EmbeddedTableChartBuilder Sets whether alternating color style is assigned to odd and even rows of a table chart.

Filter

Методы

Метод Тип возврата Краткое описание
getColumnFilterCriteria(columnPosition) FilterCriteria Получает критерии фильтрации для указанного столбца или null , если к столбцу не применены критерии фильтрации.
getRange() Range Получает диапазон, к которому применяется этот фильтр.
remove() void Удаляет этот фильтр.
removeColumnFilterCriteria(columnPosition) Filter Удаляет критерии фильтра из указанного столбца.
setColumnFilterCriteria(columnPosition, filterCriteria) Filter Задает критерии фильтрации для указанного столбца.
sort(columnPosition, ascending) Filter Сортирует отфильтрованный диапазон по указанному столбцу, исключая первую строку (строку заголовка) в диапазоне, к которому применяется этот фильтр.

FilterCriteria

Методы

Метод Тип возврата Краткое описание
copy() FilterCriteriaBuilder Copies this filter criteria and creates a criteria builder that you can apply to another filter.
getCriteriaType() BooleanCriteria Returns the criteria's boolean type, for example, CELL_EMPTY .
getCriteriaValues() Object[] Returns an array of arguments for boolean criteria.
getHiddenValues() String[] Returns the values that the filter hides.
getVisibleBackgroundColor() Color Returns the background color used as filter criteria.
getVisibleForegroundColor() Color Returns the foreground color used as a filter criteria.
getVisibleValues() String[] Returns the values that the pivot table filter shows.

FilterCriteriaBuilder

Методы

Метод Тип возврата Краткое описание
build() FilterCriteria Assembles the filter criteria using the settings you add to the criteria builder.
copy() FilterCriteriaBuilder Copies this filter criteria and creates a criteria builder that you can apply to another filter.
getCriteriaType() BooleanCriteria Returns the criteria's boolean type, for example, CELL_EMPTY .
getCriteriaValues() Object[] Returns an array of arguments for boolean criteria.
getHiddenValues() String[] Returns the values that the filter hides.
getVisibleBackgroundColor() Color Returns the background color used as filter criteria.
getVisibleForegroundColor() Color Returns the foreground color used as a filter criteria.
getVisibleValues() String[] Returns the values that the pivot table filter shows.
setHiddenValues(values) FilterCriteriaBuilder Sets the values to hide.
setVisibleBackgroundColor(visibleBackgroundColor) FilterCriteriaBuilder Sets the background color used as filter criteria.
setVisibleForegroundColor(visibleForegroundColor) FilterCriteriaBuilder Sets the foreground color used as filter criteria.
setVisibleValues(values) FilterCriteriaBuilder Sets the values to show on a pivot table.
whenCellEmpty() FilterCriteriaBuilder Sets the filter criteria to show empty cells.
whenCellNotEmpty() FilterCriteriaBuilder Sets the filter criteria to show cells that aren't empty.
whenDateAfter(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are after the specified date.
whenDateAfter(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are after the specified relative date.
whenDateBefore(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are before the specified date.
whenDateBefore(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are before the specified relative date.
whenDateEqualTo(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are equal to the specified date.
whenDateEqualTo(date) FilterCriteriaBuilder Sets filter criteria that shows cells with dates that are equal to the specified relative date.
whenDateEqualToAny(dates) FilterCriteriaBuilder Sets the filter criteria to show cells with dates that are equal to any of the specified dates.
whenDateNotEqualTo(date) FilterCriteriaBuilder Sets the filter criteria to show cells that aren't equal to the specified date.
whenDateNotEqualToAny(dates) FilterCriteriaBuilder Sets the filter criteria to show cells with dates that aren't equal to any of the specified dates.
whenFormulaSatisfied(formula) FilterCriteriaBuilder Sets the filter criteria to show cells with a specified formula (such as =B:B<C:C ) that evaluates to true .
whenNumberBetween(start, end) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that falls between, or is either of, 2 specified numbers.
whenNumberEqualTo(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that's equal to the specified number.
whenNumberEqualToAny(numbers) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that's equal to any of the specified numbers.
whenNumberGreaterThan(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number greater than the specified number
whenNumberGreaterThanOrEqualTo(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number greater than or equal to the specified number.
whenNumberLessThan(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that's less than the specified number.
whenNumberLessThanOrEqualTo(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number less than or equal to the specified number.
whenNumberNotBetween(start, end) FilterCriteriaBuilder Sets the filter criteria to show cells with a number doesn't fall between, and is neither of, 2 specified numbers.
whenNumberNotEqualTo(number) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that isn't equal to the specified number.
whenNumberNotEqualToAny(numbers) FilterCriteriaBuilder Sets the filter criteria to show cells with a number that isn't equal to any of the specified numbers.
whenTextContains(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that contains the specified text.
whenTextDoesNotContain(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that doesn't contain the specified text.
whenTextEndsWith(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that ends with the specified text.
whenTextEqualTo(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that's equal to the specified text.
whenTextEqualToAny(texts) FilterCriteriaBuilder Sets the filter criteria to show cells with text that's equal to any of the specified text values.
whenTextNotEqualTo(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that isn't equal to the specified text.
whenTextNotEqualToAny(texts) FilterCriteriaBuilder Sets the filter criteria to show cells with text that isn't equal to any of the specified values.
whenTextStartsWith(text) FilterCriteriaBuilder Sets the filter criteria to show cells with text that starts with the specified text.
withCriteria(criteria, args) FilterCriteriaBuilder Sets the filter criteria to a boolean condition defined by BooleanCriteria values, such as CELL_EMPTY or NUMBER_GREATER_THAN .

FrequencyType

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

Имущество Тип Описание
FREQUENCY_TYPE_UNSUPPORTED Enum The frequency type is unsupported.
DAILY Enum Refresh daily.
WEEKLY Enum Refresh weekly, on given days of the week.
MONTHLY Enum Refresh monthly, on given days of the month.

GradientCondition

Методы

Метод Тип возврата Краткое описание
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 Default.
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, formats, and data validation rules.
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[] Get 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 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[] Get 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 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 enabled 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 enabled 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) .