Этот сервис позволяет скриптам создавать, получать доступ и изменять файлы Google Sheets. См. также руководство по хранению данных в электронных таблицах .
Иногда операции с электронными таблицами объединяются для повышения производительности, например, при выполнении нескольких вызовов метода. Если вы хотите убедиться, что все ожидающие изменения вносятся немедленно, например, чтобы отображать пользователям информацию во время выполнения скрипта, вызовите Spreadsheet App.flush() .
Классы
| Имя | Краткое описание |
|---|---|
Auto Fill Series | Перечень типов рядов, используемых для расчета значений, заполняемых автоматически. |
Banding | Доступ к полосам — цветовым схемам, применяемым к строкам или столбцам диапазона, — и их изменение. |
Banding Theme | Перечень тем группировки. |
Big Query Data Source Spec | Получите доступ к существующей спецификации источника данных BigQuery. |
Big Query Data Source Spec Builder | Конструктор Big Query Data Source Spec Builder . |
Boolean Condition | Доступ к логическим условиям в Conditional Format Rules . |
Boolean Criteria | Перечисление, представляющее логические критерии, которые можно использовать в условном формате или фильтре. |
Border Style | Стили, которые можно задать для диапазона с помощью Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) . |
Cell Image | Представляет значение изображения в ячейке. |
Cell Image Builder | Конструктор для Cell Image . |
Color | Изображение цвета. |
Color Builder | Конструктор для Color Builder . |
Conditional Format Rule | Доступ к правилам условного форматирования. |
Conditional Format Rule Builder | Конструктор правил условного форматирования. |
Container Info | Получите доступ к положению диаграммы на листе. |
Copy Paste Type | Перечень возможных типов специальных паст. |
Data Execution Error Code | Перечень кодов ошибок выполнения данных. |
Data Execution State | Перечень состояний выполнения данных. |
Data Execution Status | Статус выполнения данных. |
Data Source | Получение доступа к существующему источнику данных и его изменение. |
Data Source Chart | Получите доступ к существующей диаграмме источника данных и внесите в нее изменения. |
Data Source Column | Получение доступа к столбцу источника данных и его изменение. |
Data Source Formula | Получайте доступ к существующим формулам источников данных и изменяйте их. |
Data Source Parameter | Получите доступ к существующим параметрам источника данных. |
Data Source Parameter Type | Перечень типов параметров источника данных. |
Data Source Pivot Table | Получите доступ к сводной таблице существующего источника данных и внесите в нее изменения. |
Data Source Refresh Schedule | Получите доступ к существующему расписанию обновления и внесите в него изменения. |
Data Source Refresh Schedule Frequency | Получите доступ к частоте обновления расписания, которая определяет, как часто и когда следует обновлять информацию. |
Data Source Refresh Scope | Перечень областей применения для обновления. |
Data Source Sheet | Получите доступ к существующей таблице источников данных и внесите в нее изменения. |
Data Source Sheet Filter | Получите доступ к существующему фильтру листа источника данных и измените его. |
Data Source Spec | Получите доступ к общим настройкам существующей спецификации источника данных. |
Data Source Spec Builder | Конструктор Data Source Spec . |
Data Source Table | Получите доступ к существующей таблице источника данных и внесите в нее изменения. |
Data Source Table Column | Доступ к существующему столбцу в Data Source Table и его изменение. |
Data Source Table Filter | Получите доступ к существующему фильтру таблицы источника данных и внесите в него изменения. |
Data Source Type | Перечень типов источников данных. |
Data Validation | Доступ к правилам проверки данных. |
Data Validation Builder | Конструктор правил проверки данных. |
Data Validation Criteria | Перечисление, представляющее критерии проверки данных, которые можно установить для заданного диапазона. |
Date Time Grouping Rule | Получите доступ к существующему правилу группировки по дате и времени. |
Date Time Grouping Rule Type | Типы правил группировки по дате и времени. |
Developer Metadata | Получение и изменение метаданных разработчика. |
Developer Metadata Finder | Найдите метаданные разработчика в электронной таблице. |
Developer Metadata Location | Получите доступ к информации о местоположении метаданных разработчика. |
Developer Metadata Location Type | Перечень типов местоположений метаданных для разработчиков. |
Developer Metadata Visibility | Перечень типов видимости метаданных разработчиков. |
Dimension | Перечень возможных направлений, в которых данные могут храниться в электронной таблице. |
Direction | Перечисление возможных направлений перемещения по электронной таблице с помощью клавиш со стрелками. |
Drawing | Отображает рисунок на листе в электронной таблице. |
Embedded Area Chart Builder | Конструктор для построения площадных диаграмм. |
Embedded Bar Chart Builder | Конструктор столбчатых диаграмм. |
Embedded Chart | Представляет собой диаграмму, встроенную в электронную таблицу. |
Embedded Chart Builder | Конструктор используется для редактирования Embedded Chart . |
Embedded Column Chart Builder | Конструктор столбчатых диаграмм. |
Embedded Combo Chart Builder | Конструктор комбинированных диаграмм. |
Embedded Histogram Chart Builder | Конструктор гистограмм. |
Embedded Line Chart Builder | Конструктор линейных графиков. |
Embedded Pie Chart Builder | Конструктор круговых диаграмм. |
Embedded Scatter Chart Builder | Конструктор для точечных диаграмм. |
Embedded Table Chart Builder | Конструктор табличных диаграмм. |
Filter | Используйте этот класс для изменения существующих фильтров на листах типа Grid , которые являются типом листов по умолчанию. |
Filter Criteria | Используйте этот класс, чтобы получить информацию о существующих фильтрах или скопировать критерии из них. |
Filter Criteria Builder | Конструктор критериев фильтрации. |
Frequency Type | Перечень типов частоты. |
Gradient Condition | Доступ к условиям градиента (цвета) в Conditional Format Rule Apis . |
Group | Доступ к группам электронных таблиц и их изменение. |
Group Control Toggle Position | Перечисление возможных положений переключателя группового управления. |
Interpolation Type | Перечисление, представляющее варианты интерполяции для вычисления значения, используемого в Gradient Condition в Conditional Format Rule . |
Looker Data Source Spec | Data Source Spec , используемая для доступа к существующим спецификациям источников данных Looker. |
Looker Data Source Spec Builder | Конструктор Looker Data Source Spec Builder . |
Named Range | Создавайте, получайте доступ и изменяйте именованные диапазоны в электронной таблице. |
Over Grid Image | Отображает изображение поверх сетки в электронной таблице. |
| Доступ к защищенным листам и их изменение в старых версиях Google Sheets. |
Pivot Filter | Доступ к фильтрам сводных таблиц и их изменение. |
Pivot Group | Доступ к группам разбиений сводных таблиц и их изменение. |
Pivot Group Limit | Доступ к ограничению количества групп сводных таблиц и его изменение. |
Pivot Table | Доступ к сводным таблицам и их изменение. |
Pivot Table Summarize Function | Перечень функций, которые обобщают данные сводных таблиц. |
Pivot Value | Доступ к группам значений в сводных таблицах и их изменение. |
Pivot Value Display Type | Перечень способов отображения опорного значения как функции другого значения. |
Protection | Получайте доступ к защищенным диапазонам и листам и изменяйте их. |
Protection Type | Перечисление частей электронной таблицы, которые можно защитить от редактирования. |
Range | Доступ к диапазонам электронных таблиц и их изменение. |
Range List | Набор из одного или нескольких экземпляров Range на одном листе. |
Recalculation Interval | Перечисление возможных интервалов, используемых при перерасчете в электронных таблицах. |
Relative Date | Перечисление, представляющее собой варианты относительной даты для вычисления значения, используемого в Boolean Criteria основанных на датах. |
Rich Text Value | Стилизованная текстовая строка, используемая для представления текста в ячейке. |
Rich Text Value Builder | Конструктор для форматированных текстовых значений. |
Selection | Получите доступ к текущему активному выделению на активном листе. |
Sheet | Получайте доступ к электронным таблицам и редактируйте их. |
Sheet Type | Различные типы листов, которые могут существовать в электронной таблице. |
Slicer | Представляет собой фильтр , используемый для фильтрации диапазонов, диаграмм и сводных таблиц в несовместном режиме. |
Sort Order | Перечисление, представляющее порядок сортировки. |
Sort Spec | Спецификация сортировки. |
Spreadsheet | Получайте доступ к файлам Google Таблиц и изменяйте их. |
Spreadsheet App | Получайте доступ к файлам Google Sheets и создавайте их. |
Spreadsheet Theme | Получайте доступ к существующим темам и изменяйте их. |
Text Direction | Перечень текстовых указаний. |
Text Finder | Найти или заменить текст в диапазоне, на листе или в электронной таблице. |
Text Rotation | Получите доступ к настройкам поворота текста в ячейке. |
Text Style | Стиль отображения текста в ячейке. |
Text Style Builder | Конструктор стилей текста. |
Text To Columns Delimiter | Перечень типов предустановленных разделителей, позволяющих разделить столбец текста на несколько столбцов. |
Theme Color | Пример цветового обозначения темы. |
Theme Color Type | Перечисление, описывающее различные цветовые варианты, поддерживаемые в темах оформления. |
Value Type | Перечисление типов значений, возвращаемых методами Range.getValue() и Range.getValues() из класса Range службы Spreadsheet. |
Wrap Strategy | Перечисление стратегий, используемых для обработки переноса текста в ячейках. |
Auto Fill Series
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DEFAULT_SERIES | Enum | По умолчанию. |
ALTERNATE_SERIES | Enum | При использовании этой настройки автоматическое заполнение приводит к тому, что пустые ячейки в расширенном диапазоне заполняются копиями существующих значений. |
Banding
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy To(range) | Banding | Копирует эту полосатую структуру в другой диапазон. |
get First Column Color Object() | Color |null | Возвращает цвет первого чередующегося столбца в полосе или null , если цвет не задан. |
get First Row Color Object() | Color |null | Возвращает цвет первой чередующейся строки или null , если цвет не задан. |
get Footer Column Color Object() | Color |null | Возвращает цвет последнего столбца в полосе или null , если цвет не задан. |
get Footer Row Color Object() | Color |null | Возвращает цвет последней строки в полосе или null , если цвет не задан. |
get Header Column Color Object() | Color |null | Возвращает цвет первого столбца в полосе или null , если цвет не задан. |
get Header Row Color Object() | Color |null | Возвращает цвет строки заголовка или null , если цвет не задан. |
get Range() | Range | Возвращает диапазон для данной полосы частот. |
get Second Column Color Object() | Color |null | Возвращает цвет второго чередующегося столбца в полосе или null , если цвет не задан. |
get Second Row Color Object() | Color |null | Возвращает цвет второй чередующейся строки или null , если цвет не задан. |
remove() | void | Удаляет эту полосатость. |
set First Column Color(color) | Banding | Задает цвет первого столбца, который будет чередоваться. |
set First Column Color Object(color) | Banding | Задает цвет первого чередующегося столбца в полосе. |
set First Row Color(color) | Banding | Задает цвет первой строки, который будет чередоваться. |
set First Row Color Object(color) | Banding | Задает цвет первого чередующегося ряда в полосе. |
set Footer Column Color(color) | Banding | Задает цвет последнего столбца. |
set Footer Column Color Object(color) | Banding | Задает цвет последнего столбца в полосе. |
set Footer Row Color(color) | Banding | Задает цвет последней строки. |
set Footer Row Color Object(color) | Banding | Задает цвет строки нижнего колонтитула в полосе. |
set Header Column Color(color) | Banding | Задает цвет заголовка колонки. |
set Header Column Color Object(color) | Banding | Задает цвет заголовка колонки. |
set Header Row Color(color) | Banding | Задает цвет строки заголовка. |
set Header Row Color Object(color) | Banding | Задает цвет строки заголовка. |
set Range(range) | Banding | Задает диапазон для этой полосы. |
set Second Column Color(color) | Banding | Задает цвет второго столбца, который будет чередоваться. |
set Second Column Color Object(color) | Banding | Задает цвет второго чередующегося столбца в полосе. |
set Second Row Color(color) | Banding | Задает цвет второго ряда, который будет чередоваться. |
set Second Row Color Object(color) | Banding | Задает второй чередующийся цвет в полосе. |
Banding Theme
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 | Тема розовых полос. |
Big Query Data Source Spec
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Data Source Spec Builder | Создает Data Source Spec Builder на основе настроек этого источника данных. |
get Dataset Id() | String | Получает идентификатор набора данных BigQuery. |
get Parameters() | Data Source Parameter[] | Получает параметры источника данных. |
get Project Id() | String | Получает идентификатор проекта выставления счетов. |
get Raw Query() | String | Получает исходную строку запроса. |
get Table Id() | String | Получает идентификатор таблицы BigQuery. |
get Table Project Id() | String | Получает идентификатор проекта BigQuery для таблицы. |
get Type() | Data Source Type | Получает тип источника данных. |
Big Query Data Source Spec Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Data Source Spec | Создает спецификацию источника данных на основе настроек этого конструктора. |
copy() | Data Source Spec Builder | Создает Data Source Spec Builder на основе настроек этого источника данных. |
get Dataset Id() | String | Получает идентификатор набора данных BigQuery. |
get Parameters() | Data Source Parameter[] | Получает параметры источника данных. |
get Project Id() | String | Получает идентификатор проекта выставления счетов. |
get Raw Query() | String | Получает исходную строку запроса. |
get Table Id() | String | Получает идентификатор таблицы BigQuery. |
get Table Project Id() | String | Получает идентификатор проекта BigQuery для таблицы. |
get Type() | Data Source Type | Получает тип источника данных. |
remove All Parameters() | Big Query Data Source Spec Builder | Удаляет все параметры. |
remove Parameter(parameterName) | Big Query Data Source Spec Builder | Удаляет указанный параметр. |
set Dataset Id(datasetId) | Big Query Data Source Spec Builder | Задает идентификатор набора данных BigQuery. |
set Parameter From Cell(parameterName, sourceCell) | Big Query Data Source Spec Builder | Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для конструкторов спецификаций источников данных типа Data Source Type.BIGQUERY . |
set Project Id(projectId) | Big Query Data Source Spec Builder | Устанавливает идентификатор проекта BigQuery для выставления счетов. |
set Raw Query(rawQuery) | Big Query Data Source Spec Builder | Задает исходную строку запроса. |
set Table Id(tableId) | Big Query Data Source Spec Builder | Задает идентификатор таблицы BigQuery. |
set Table Project Id(projectId) | Big Query Data Source Spec Builder | Задает идентификатор проекта BigQuery для таблицы. |
Boolean Condition
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Background Object() | Color |null | Получает цвет фона для этого логического условия. |
get Bold() | Boolean|null | Возвращает true , если это логическое условие выделяет текст жирным шрифтом, и false если это логическое условие снимает выделение жирным шрифтом. |
get Criteria Type() | Boolean Criteria | Получает тип критериев правила, определенный в перечислении Boolean Criteria . |
get Criteria Values() | Object[] | Получает массив аргументов для критериев правила. |
get Font Color Object() | Color |null | Получает цвет шрифта для данного логического условия. |
get Italic() | Boolean|null | Возвращает true , если это логическое условие выделяет текст курсивом, и false если это логическое условие удаляет курсив из текста. |
get Strikethrough() | Boolean|null | Возвращает true если это логическое условие зачеркивает текст, и false если это логическое условие удаляет зачеркивание из текста. |
get Underline() | Boolean|null | Возвращает true если это логическое условие подчеркивает текст, и false если это логическое условие удаляет подчеркивание из текста. |
Boolean Criteria
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 значение. |
Border Style
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DOTTED | Enum | Границы, обозначенные пунктирными линиями. |
DASHED | Enum | Границы обозначены пунктирными линиями. |
SOLID | Enum | Тонкие сплошные линии по краям. |
SOLID_MEDIUM | Enum | Границы сплошными линиями среднего размера. |
SOLID_THICK | Enum | Границы толстыми сплошными линиями. |
DOUBLE | Enum | Две сплошные линии границы. |
Cell Image
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
value Type | Value Type | Тип значения изображения ячейки — Value Type.IMAGE . |
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Alt Text Description() | String | Возвращает альтернативный текст описания для этого изображения. |
get Alt Text Title() | String | Возвращает альтернативный текст заголовка для этого изображения. |
get Content Url() | String | Возвращает URL-адрес изображения, размещенный на сервере Google. |
to Builder() | Cell Image Builder | Создает конструктор изображений ячеек на основе текущих свойств изображения. |
Cell Image Builder
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
value Type | Value Type | Тип значения изображения ячейки — Value Type.IMAGE . |
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Cell Image | Создает тип значения изображения, необходимый для добавления изображения в ячейку. |
get Alt Text Description() | String | Возвращает альтернативный текст описания для этого изображения. |
get Alt Text Title() | String | Возвращает альтернативный текст заголовка для этого изображения. |
get Content Url() | String | Возвращает URL-адрес изображения, размещенный на сервере Google. |
set Alt Text Description(description) | Cell Image | Задает альтернативный текст для описания этого изображения. |
set Alt Text Title(title) | Cell Image | Задает альтернативный текст для этого изображения. |
set Source Url(url) | Cell Image Builder | Задает URL-адрес источника изображения. |
to Builder() | Cell Image Builder | Создает конструктор изображений ячеек на основе текущих свойств изображения. |
Color
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
as Rgb Color() | Rgb Color | Преобразует этот цвет в Rgb Color . |
as Theme Color() | Theme Color | Преобразует этот цвет в Theme Color . |
get Color Type() | Color Type | Выберите оттенок этого цвета. |
Color Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
as Rgb Color() | Rgb Color | Преобразует этот цвет в Rgb Color . |
as Theme Color() | Theme Color | Преобразует этот цвет в Theme Color . |
build() | Color | Создает цветовой объект на основе настроек, предоставленных конструктору. |
get Color Type() | Color Type | Выберите оттенок этого цвета. |
set Rgb Color(cssString) | Color Builder | Задает цвет в формате RGB. |
set Theme Color(themeColorType) | Color Builder | Задает цвет темы. |
Conditional Format Rule
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Conditional Format Rule Builder | Возвращает построитель правил с предустановленными настройками данного правила. |
get Boolean Condition() | Boolean Condition |null | Получает информацию Boolean Condition правила, если это правило использует логические критерии. |
get Gradient Condition() | Gradient Condition |null | Получает информацию Gradient Condition для правила, если это правило использует критерии условий градиента. |
get Ranges() | Range[] | Извлекает диапазоны, к которым применяется это правило условного форматирования. |
Conditional Format Rule Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Conditional Format Rule | Создает правило условного форматирования на основе настроек, примененных к конструктору. |
copy() | Conditional Format Rule Builder | Возвращает построитель правил с предустановленными настройками данного правила. |
get Boolean Condition() | Boolean Condition |null | Получает информацию Boolean Condition правила, если это правило использует логические критерии. |
get Gradient Condition() | Gradient Condition |null | Получает информацию Gradient Condition для правила, если это правило использует критерии условий градиента. |
get Ranges() | Range[] | Извлекает диапазоны, к которым применяется это правило условного форматирования. |
set Background(color) | Conditional Format Rule Builder | Задает цвет фона для формата правила условного форматирования. |
set Background Object(color) | Conditional Format Rule Builder | Задает цвет фона для формата правила условного форматирования. |
set Bold(bold) | Conditional Format Rule Builder | Задает выделение текста жирным шрифтом для правила условного форматирования. |
set Font Color(color) | Conditional Format Rule Builder | Задает цвет шрифта для формата правила условного форматирования. |
set Font Color Object(color) | Conditional Format Rule Builder | Задает цвет шрифта для формата правила условного форматирования. |
set Gradient Maxpoint(color) | Conditional Format Rule Builder | Сбрасывает значение параметра gradient maxpoint правила условного форматирования и вместо него использует максимальное значение в диапазонах правила. |
set Gradient Maxpoint Object(color) | Conditional Format Rule Builder | Сбрасывает значение параметра gradient maxpoint правила условного форматирования и вместо него использует максимальное значение в диапазонах правила. |
set Gradient Maxpoint Object With Value(color, type, value) | Conditional Format Rule Builder | Задает поля максимального значения градиента правила условного форматирования. |
set Gradient Maxpoint With Value(color, type, value) | Conditional Format Rule Builder | Задает поля максимального значения градиента правила условного форматирования. |
set Gradient Midpoint Object With Value(color, type, value) | Conditional Format Rule Builder | Задает поля для определения средней точки градиента в правиле условного форматирования. |
set Gradient Midpoint With Value(color, type, value) | Conditional Format Rule Builder | Задает поля для определения средней точки градиента в правиле условного форматирования. |
set Gradient Minpoint(color) | Conditional Format Rule Builder | Сбрасывает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила. |
set Gradient Minpoint Object(color) | Conditional Format Rule Builder | Сбрасывает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила. |
set Gradient Minpoint Object With Value(color, type, value) | Conditional Format Rule Builder | Задает поля минимальной точки градиента правила условного форматирования. |
set Gradient Minpoint With Value(color, type, value) | Conditional Format Rule Builder | Задает поля минимальной точки градиента правила условного форматирования. |
set Italic(italic) | Conditional Format Rule Builder | Задает курсивный шрифт для форматирования правила условного форматирования. |
set Ranges(ranges) | Conditional Format Rule Builder | Задает один или несколько диапазонов, к которым применяется это правило условного форматирования. |
set Strikethrough(strikethrough) | Conditional Format Rule Builder | Задает зачеркивание текста для форматирования правила условного форматирования. |
set Underline(underline) | Conditional Format Rule Builder | Задает подчеркивание текста для правила условного форматирования. |
when Cell Empty() | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда ячейка пуста. |
when Cell Not Empty() | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда ячейка не пуста. |
when Date After(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата находится после заданного значения. |
when Date After(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата находится после указанной относительной даты. |
when Date Before(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата предшествует заданной дате. |
when Date Before(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата предшествует заданной относительной дате. |
when Date Equal To(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата равна заданной дате. |
when Date Equal To(date) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда дата равна заданной относительной дате. |
when Formula Satisfied(formula) | Conditional Format Rule Builder | Устанавливает правило условного форматирования, которое срабатывает, когда заданная формула принимает значение true . |
when Number Between(start, end) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число находится между двумя указанными значениями или принимает одно из них. |
when Number Equal To(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число равно заданному значению. |
when Number Greater Than(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число превышает заданное значение. |
when Number Greater Than Or Equal To(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число больше или равно заданному значению. |
when Number Less Than(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число меньше заданного значения. |
when Number Less Than Or Equal To(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число меньше или равно заданному значению. |
when Number Not Between(start, end) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число не находится между двумя указанными значениями и не является ни одним из них. |
when Number Not Equal To(number) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда число не равно заданному значению. |
when Text Contains(text) | Conditional Format Rule Builder | Устанавливает правило условного форматирования, которое срабатывает, когда входные данные содержат заданное значение. |
when Text Does Not Contain(text) | Conditional Format Rule Builder | Устанавливает правило условного форматирования, которое срабатывает, когда входные данные не содержат заданного значения. |
when Text Ends With(text) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда ввод заканчивается заданным значением. |
when Text Equal To(text) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда входные данные равны заданному значению. |
when Text Starts With(text) | Conditional Format Rule Builder | Задает правило условного форматирования, которое срабатывает, когда ввод начинается с заданного значения. |
with Criteria(criteria, args) | Conditional Format Rule Builder | Устанавливает правило условного форматирования в соответствии с критериями, определенными Boolean Criteria , обычно берущимися из criteria и arguments существующего правила. |
Container Info
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Anchor Column() | Integer | Левая часть диаграммы закреплена в этом столбце. |
get Anchor Row() | Integer | Верхняя часть диаграммы закреплена в этой строке. |
get Offset X() | Integer | Верхний левый угол диаграммы смещен относительно опорного столбца на указанное количество пикселей. |
get Offset Y() | Integer | Верхний левый угол диаграммы смещен относительно опорной строки на указанное количество пикселей. |
Copy Paste Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 | Вставляйте только ширину столбцов. |
Data Execution Error Code
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 | Пользователь не имеет доступа к базе данных, на которую ссылается источник данных. |
Data Execution State
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | В Apps Script не поддерживается сохранение состояния выполнения данных. |
RUNNING | Enum | Обработка данных началась и продолжается. |
SUCCESS | Enum | Обработка данных завершена и прошла успешно. |
ERROR | Enum | Обработка данных завершена, но обнаружены ошибки. |
NOT_STARTED | Enum | Выполнение обработки данных еще не началось. |
Data Execution Status
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Error Code() | Data Execution Error Code | Получает код ошибки выполнения данных. |
get Error Message() | String | Получает сообщение об ошибке выполнения данных. |
get Execution State() | Data Execution State | Получает состояние выполнения данных. |
get Last Execution Time() | Date|null | Получает время завершения последнего выполнения обработки данных независимо от состояния выполнения. |
get Last Refreshed Time() | Date|null | Получает время последнего успешного обновления данных. |
is Truncated() | Boolean | Возвращает true если данные последнего успешного выполнения усечены, или false в противном случае. |
Data Source
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
cancel All Linked Data Source Object Refreshes() | void | Отменяет все текущие обновления объектов источника данных, связанных с этим источником данных. |
create Calculated Column(name, formula) | Data Source Column | Создает вычисляемый столбец. |
create Data Source Pivot Table On New Sheet() | Data Source Pivot Table | Создает сводную таблицу на основе этого источника данных в первой ячейке нового листа. |
create Data Source Table On New Sheet() | Data Source Table | Создает таблицу-источник данных на основе этого источника данных в первой ячейке нового листа. |
get Calculated Column By Name(columnName) | Data Source Column |null | Возвращает вычисляемый столбец в источнике данных, соответствующий имени столбца. |
get Calculated Columns() | Data Source Column[] | Возвращает все вычисляемые столбцы в источнике данных. |
get Columns() | Data Source Column[] | Возвращает все столбцы в источнике данных. |
get Data Source Sheets() | Data Source Sheet[] | Возвращает листы источника данных, связанные с данным источником данных. |
get Spec() | Data Source Spec | Получает спецификацию источника данных. |
refresh All Linked Data Source Objects() | void | Обновляет все объекты источника данных, связанные с данным источником данных. |
update Spec(spec) | Data Source | Обновляет спецификацию источника данных и обновляет объекты источника данных, связанные с этим источником данных, в соответствии с новой спецификацией. |
update Spec(spec, refreshAllLinkedObjects) | Data Source | Обновляет спецификацию источника данных и обновляет связанные data source sheets в соответствии с новой спецификацией. |
wait For All Data Executions Completion(timeoutInSeconds) | void | Ожидает завершения всех текущих выполнений объектов связанных источников данных, истекая по истечении заданного количества секунд. |
Data Source Chart
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
cancel Data Refresh() | Data Source Chart | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Chart | Обновляет данные этого объекта независимо от его текущего состояния. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
refresh Data() | Data Source Chart | Обновляет данные объекта. |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Data Source Column
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Data Source() | Data Source | Получает источник данных, связанный со столбцом источника данных. |
get Formula() | String | Получает формулу для столбца источника данных. |
get Name() | String | Получает имя для столбца источника данных. |
has Array Dependency() | Boolean | Возвращает значение, указывающее, имеет ли столбец зависимость от массива. |
is Calculated Column() | Boolean | Возвращает значение, указывающее, является ли столбец вычисляемым. |
remove() | void | Удаляет столбец источника данных. |
set Formula(formula) | Data Source Column | Задает формулу для столбца источника данных. |
set Name(name) | Data Source Column | Задает имя столбца источника данных. |
Data Source Formula
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
cancel Data Refresh() | Data Source Formula | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Formula | Обновляет данные этого объекта независимо от его текущего состояния. |
get Anchor Cell() | Range | Возвращает Range , представляющий ячейку, в которой закреплена формула этого источника данных. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Display Value() | String | Возвращает отображаемое значение формулы источника данных. |
get Formula() | String | Возвращает формулу для данного источника данных. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
refresh Data() | Data Source Formula | Обновляет данные объекта. |
set Formula(formula) | Data Source Formula | Обновляет формулу. |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Data Source Parameter
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Name() | String | Получает имя параметра. |
get Source Cell() | String|null | Получает ячейку-источник, на основе которой определяется значение параметра, или null если тип параметра не Data Source Parameter Type.CELL . |
get Type() | Data Source Parameter Type | Получает тип параметра. |
Data Source Parameter Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Тип параметра источника данных, не поддерживаемый в Apps Script. |
CELL | Enum | Параметр «Источник данных» задается на основе значения ячейки. |
Data Source Pivot Table
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Column Group(columnName) | Pivot Group | Добавляет новую группу столбцов сводной таблицы на основе указанного столбца источника данных. |
add Filter(columnName, filterCriteria) | Pivot Filter | Добавляет новый фильтр на основе указанного столбца источника данных с заданными критериями фильтрации. |
add Pivot Value(columnName) | Pivot Value | Добавляет новое значение сводной таблицы на основе указанного столбца источника данных без использования функции суммирования. |
add Pivot Value(columnName, summarizeFunction) | Pivot Value | Добавляет новое значение сводной таблицы на основе указанного столбца источника данных с использованием указанной функции суммирования. |
add Row Group(columnName) | Pivot Group | Добавляет новую группу строк сводной таблицы на основе указанного столбца источника данных. |
as Pivot Table() | Pivot Table | Возвращает сводную таблицу источника данных в виде обычного объекта сводной таблицы. |
cancel Data Refresh() | Data Source Pivot Table | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Pivot Table | Обновляет данные этого объекта независимо от его текущего состояния. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
refresh Data() | Data Source Pivot Table | Обновляет данные объекта. |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Data Source Refresh Schedule
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Frequency() | Data Source Refresh Schedule Frequency | Получает частоту обновления расписания, которая определяет, как часто и когда следует обновлять информацию. |
get Scope() | Data Source Refresh Scope | Получает представление о масштабе данного графика обновления. |
get Time Interval Of Next Run() | Time Interval | Получает временной интервал следующего запуска данного расписания обновления. |
is Enabled() | Boolean | Определяет, включено ли это расписание обновления. |
Data Source Refresh Schedule Frequency
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Days Of The Month() | Integer[] | Получает дни месяца в виде чисел (от 1 до 28), в соответствии с которыми необходимо обновить источник данных. |
get Days Of The Week() | Weekday[] | Получает дни недели, в которые следует обновлять источник данных. |
get Frequency Type() | Frequency Type | Получает тип частоты. |
get Start Hour() | Integer | Получает начальный час (в виде числа от 0 до 23) временного интервала, в течение которого выполняется расписание обновления. |
Data Source Refresh Scope
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | Область обновления источника данных не поддерживается. |
ALL_DATA_SOURCES | Enum | Обновление применяется ко всем источникам данных в электронной таблице. |
Data Source Sheet
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Filter(columnName, filterCriteria) | Data Source Sheet | Добавляет фильтр, применяемый к листу с источником данных. |
as Sheet() | Sheet | Возвращает лист источника данных в виде обычного листа. |
auto Resize Column(columnName) | Data Source Sheet | Автоматически изменяет ширину указанного столбца. |
auto Resize Columns(columnNames) | Data Source Sheet | Автоматически изменяет ширину указанных столбцов. |
cancel Data Refresh() | Data Source Sheet | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Sheet | Обновляет данные этого объекта независимо от его текущего состояния. |
get Column Width(columnName) | Integer|null | Возвращает ширину указанного столбца. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Filters() | Data Source Sheet Filter[] | Возвращает все фильтры, примененные к листу с исходными данными. |
get Sheet Values(columnName) | Object[] | Возвращает все значения из листа источника данных для указанного имени столбца. |
get Sheet Values(columnName, startRow, numRows) | Object[] | Возвращает все значения для листа источника данных по указанному имени столбца, начиная с указанной начальной строки (based-1) и до указанного num Rows . |
get Sort Specs() | Sort Spec[] | Получает все параметры сортировки из таблицы источников данных. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
refresh Data() | Data Source Sheet | Обновляет данные объекта. |
remove Filters(columnName) | Data Source Sheet | Удаляет все фильтры, примененные к столбцу листа источника данных. |
remove Sort Spec(columnName) | Data Source Sheet | Удаляет спецификацию сортировки для столбца в листе источника данных. |
set Column Width(columnName, width) | Data Source Sheet | Задает ширину указанного столбца. |
set Column Widths(columnNames, width) | Data Source Sheet | Задает ширину указанных столбцов. |
set Sort Spec(columnName, ascending) | Data Source Sheet | Задает параметры сортировки для столбца в листе «Источник данных». |
set Sort Spec(columnName, sortOrder) | Data Source Sheet | Задает параметры сортировки для столбца в листе «Источник данных». |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Data Source Sheet Filter
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Data Source Column() | Data Source Column | Возвращает столбец источника данных, к которому применяется данный фильтр. |
get Data Source Sheet() | Data Source Sheet | Возвращает Data Source Sheet , к которому относится данный фильтр. |
get Filter Criteria() | Filter Criteria | Возвращает критерии фильтрации для данного фильтра. |
remove() | void | Удаляет этот фильтр из объекта источника данных. |
set Filter Criteria(filterCriteria) | Data Source Sheet Filter | Задает критерии фильтрации для данного фильтра. |
Data Source Spec
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
as Big Query() | Big Query Data Source Spec | Получает спецификацию источника данных BigQuery. |
as Looker() | Looker Data Source Spec | Получает спецификацию источника данных Looker. |
copy() | Data Source Spec Builder | Создает Data Source Spec Builder на основе настроек этого источника данных. |
get Parameters() | Data Source Parameter[] | Получает параметры источника данных. |
get Type() | Data Source Type | Получает тип источника данных. |
Data Source Spec Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
as Big Query() | Big Query Data Source Spec Builder | Получает конструктор для источника данных BigQuery. |
as Looker() | Looker Data Source Spec Builder | Получает конструктор для источника данных Looker. |
build() | Data Source Spec | Создает спецификацию источника данных на основе настроек этого конструктора. |
copy() | Data Source Spec Builder | Создает Data Source Spec Builder на основе настроек этого источника данных. |
get Parameters() | Data Source Parameter[] | Получает параметры источника данных. |
get Type() | Data Source Type | Получает тип источника данных. |
remove All Parameters() | Data Source Spec Builder | Удаляет все параметры. |
remove Parameter(parameterName) | Data Source Spec Builder | Удаляет указанный параметр. |
set Parameter From Cell(parameterName, sourceCell) | Data Source Spec Builder | Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для конструкторов спецификаций источников данных типа Data Source Type.BIGQUERY . |
Data Source Table
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Columns(columnNames) | Data Source Table | Добавляет столбцы в таблицу источника данных. |
add Filter(columnName, filterCriteria) | Data Source Table | Добавляет фильтр, применяемый к таблице источника данных. |
add Sort Spec(columnName, ascending) | Data Source Table | Добавляет спецификацию сортировки для столбца в таблице источника данных. |
add Sort Spec(columnName, sortOrder) | Data Source Table | Добавляет спецификацию сортировки для столбца в таблице источника данных. |
cancel Data Refresh() | Data Source Table | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
force Refresh Data() | Data Source Table | Обновляет данные этого объекта независимо от его текущего состояния. |
get Columns() | Data Source Table Column[] | Добавляет все столбцы источника данных в таблицу источника данных. |
get Data Source() | Data Source | Получает источник данных, к которому привязан объект. |
get Filters() | Data Source Table Filter[] | Возвращает все фильтры, примененные к таблице-источнику данных. |
get Range() | Range | Получает Range , охватываемый таблицей источника данных. |
get Row Limit() | Integer|null | Возвращает ограничение на количество строк в таблице источника данных. |
get Sort Specs() | Sort Spec[] | Получает все параметры сортировки из таблицы источника данных. |
get Status() | Data Execution Status | Получает статус выполнения данных объекта. |
is Syncing All Columns() | Boolean | Возвращает значение, указывающее, синхронизирует ли таблица источника данных все столбцы в связанном источнике данных. |
refresh Data() | Data Source Table | Обновляет данные объекта. |
remove All Columns() | Data Source Table | Удаляет все столбцы из таблицы источника данных. |
remove All Sort Specs() | Data Source Table | Удаляет все параметры сортировки из таблицы источника данных. |
set Row Limit(rowLimit) | Data Source Table | Обновляет ограничение на количество строк в таблице-источнике данных. |
sync All Columns() | Data Source Table | Синхронизируйте все текущие и будущие столбцы в связанном источнике данных с таблицей источника данных. |
wait For Completion(timeoutInSeconds) | Data Execution Status | Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд. |
Data Source Table Column
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Data Source Column() | Data Source Column | Получает столбец источника данных. |
remove() | void | Удаляет столбец из Data Source Table . |
Data Source Table Filter
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Data Source Column() | Data Source Column | Возвращает столбец источника данных, к которому применяется данный фильтр. |
get Data Source Table() | Data Source Table | Возвращает Data Source Table , к которой относится данный фильтр. |
get Filter Criteria() | Filter Criteria | Возвращает критерии фильтрации для данного фильтра. |
remove() | void | Удаляет этот фильтр из объекта источника данных. |
set Filter Criteria(filterCriteria) | Data Source Table Filter | Задает критерии фильтрации для данного фильтра. |
Data Source Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Тип источника данных, не поддерживаемый в Apps Script. |
BIGQUERY | Enum | Источник данных BigQuery. |
LOOKER | Enum | Источник данных Looker. |
Data Validation
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Data Validation Builder | Создает конструктор для правила проверки данных на основе настроек этого правила. |
get Allow Invalid() | Boolean | Возвращает true если правило выдает предупреждение при непрохождении проверки входных данных, или false если оно полностью отклоняет входные данные. |
get Criteria Type() | Data Validation Criteria | Получает тип критериев правила, определенный в перечислении « Data Validation Criteria . |
get Criteria Values() | Object[] | Получает массив аргументов для критериев правила. |
get Help Text() | String | Получает текст справки к правилу или null , если текст справки не задан. |
Data Validation Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Data Validation | Создает правило проверки данных на основе настроек, примененных к конструктору. |
copy() | Data Validation Builder | Создает конструктор для правила проверки данных на основе настроек этого правила. |
get Allow Invalid() | Boolean | Возвращает true если правило выдает предупреждение при непрохождении проверки входных данных, или false если оно полностью отклоняет входные данные. |
get Criteria Type() | Data Validation Criteria | Получает тип критериев правила, определенный в перечислении « Data Validation Criteria . |
get Criteria Values() | Object[] | Получает массив аргументов для критериев правила. |
get Help Text() | String | Получает текст справки к правилу или null , если текст справки не задан. |
require Checkbox() | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы ввод был логическим значением; это значение отображается в виде флажка. |
require Checkbox(checkedValue) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы введенное значение соответствовало указанному значению или было пустым. |
require Checkbox(checkedValue, uncheckedValue) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные соответствовали одному из указанных значений. |
require Date() | Data Validation Builder | Устанавливает правило проверки данных, требующее указания даты. |
require Date After(date) | Data Validation Builder | Устанавливает правило проверки данных, требующее указания даты, следующей за заданным значением. |
require Date Before(date) | Data Validation Builder | Устанавливает правило проверки данных, требующее указания даты, предшествующей заданному значению. |
require Date Between(start, end) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы дата находилась между двумя указанными датами или являлась одной из них. |
require Date Equal To(date) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы дата была равна заданному значению. |
require Date Not Between(start, end) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы дата не находилась между двумя указанными датами и не являлась ни одной из них. |
require Date On Or After(date) | Data Validation Builder | Устанавливает правило проверки данных, требующее указания даты, которая не превышает заданное значение. |
require Date On Or Before(date) | Data Validation Builder | Устанавливает правило проверки данных, требующее указания даты, которая не превышает заданное значение. |
require Formula Satisfied(formula) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы заданная формула имела значение true . |
require Number Between(start, end) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число находилось между двумя указанными числами или являлось одним из них. |
require Number Equal To(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число было равно заданному значению. |
require Number Greater Than(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число было больше заданного значения. |
require Number Greater Than Or Equal To(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число было больше или равно заданному значению. |
require Number Less Than(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число было меньше заданного значения. |
require Number Less Than Or Equal To(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число было меньше или равно заданному значению. |
require Number Not Between(start, end) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число не находилось между двумя указанными числами и не являлось ни одним из них. |
require Number Not Equal To(number) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы число не равнялось заданному значению. |
require Text Contains(text) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные содержали заданное значение. |
require Text Does Not Contain(text) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные не содержали заданное значение. |
require Text Equal To(text) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные были равны заданному значению. |
require Text Is Email() | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы ввод осуществлялся в виде адреса электронной почты. |
require Text Is Url() | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы ввод осуществлялся в формате URL. |
require Value In List(values) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные были равны одному из заданных значений. |
require Value In List(values, showDropdown) | Data Validation Builder | Задает правило проверки данных, требующее, чтобы введенные данные были равны одному из заданных значений, с возможностью скрыть выпадающее меню. |
require Value In Range(range) | Data Validation Builder | Устанавливает правило проверки данных, требующее, чтобы входные данные были равны значению в заданном диапазоне. |
require Value In Range(range, showDropdown) | Data Validation Builder | Задает правило проверки данных, требующее, чтобы введенные данные были равны значению в заданном диапазоне, с возможностью скрыть выпадающее меню. |
set Allow Invalid(allowInvalidData) | Data Validation Builder | Определяет, следует ли отображать предупреждение при непрохождении проверки данных или полностью отклонять введенные данные. |
set Help Text(helpText) | Data Validation Builder | Задает текст справки, который появляется при наведении курсора на ячейку, для которой настроена проверка данных. |
with Criteria(criteria, args) | Data Validation Builder | Устанавливает правило проверки данных в соответствии с критериями, определенными значениями Data Validation Criteria , которые обычно берутся из criteria и arguments существующего правила. |
Data Validation Criteria
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DATE_AFTER | Enum | Требуется указать дату, которая будет позже заданного значения. |
DATE_BEFORE | Enum | Требуется указать дату, предшествующую заданному значению. |
DATE_BETWEEN | Enum | Требуется дата, находящаяся в пределах заданного диапазона. |
DATE_EQUAL_TO | Enum | Требуется дата, равная заданному значению. |
DATE_IS_VALID_DATE | Enum | Требуется указать дату. |
DATE_NOT_BETWEEN | Enum | Требуется указать дату, которая не находится в диапазоне заданных значений. |
DATE_ON_OR_AFTER | Enum | Требуется дата, которая приходится на указанное значение или позже. |
DATE_ON_OR_BEFORE | Enum | Требуется указать дату, которая не превышает заданное значение. |
NUMBER_BETWEEN | Enum | Требуется число, находящееся в пределах заданных значений. |
NUMBER_EQUAL_TO | Enum | Требуется число, равное заданному значению. |
NUMBER_GREATER_THAN | Enum | Требуется число, превышающее заданное значение. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | Требуется число, большее или равное заданному значению. |
NUMBER_LESS_THAN | Enum | Требуется число, меньшее заданного значения. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | Требуется число, меньшее или равное заданному значению. |
NUMBER_NOT_BETWEEN | Enum | Требуется число, которое не находится в диапазоне заданных значений. |
NUMBER_NOT_EQUAL_TO | Enum | Требуется число, не равное заданному значению. |
TEXT_CONTAINS | Enum | Требуется, чтобы входные данные содержали заданное значение. |
TEXT_DOES_NOT_CONTAIN | Enum | Требуется, чтобы входные данные не содержали заданного значения. |
TEXT_EQUAL_TO | Enum | Требуется, чтобы входные данные были равны заданному значению. |
TEXT_IS_VALID_EMAIL | Enum | Требуется ввод адреса электронной почты. |
TEXT_IS_VALID_URL | Enum | Требуется, чтобы входные данные были в формате URL. |
VALUE_IN_LIST | Enum | Требуется, чтобы входные данные были равны одному из заданных значений. |
VALUE_IN_RANGE | Enum | Требуется, чтобы входные данные были равны значению в заданном диапазоне. |
CUSTOM_FORMULA | Enum | Требуется, чтобы входные данные приводили к true значению данной формулы. |
CHECKBOX | Enum | Требуется, чтобы ввод представлял собой пользовательское значение или логическое значение; отображается в виде флажка. |
DATE_AFTER_RELATIVE | Enum | Требуется дата, которая следует за значением относительной даты. |
DATE_BEFORE_RELATIVE | Enum | Требуется дата, предшествующая значению относительной даты. |
DATE_EQUAL_TO_RELATIVE | Enum | Требуется дата, равная значению относительной даты. |
Date Time Grouping Rule
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Rule Type() | Date Time Grouping Rule Type | Получает тип правила группировки по дате и времени. |
Date Time Grouping Rule Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Тип правила группировки по дате и времени, который не поддерживается. |
SECOND | Enum | Группировка даты и времени по секундам, от 0 до 59. |
MINUTE | Enum | Группировка даты и времени по минутам, от 0 до 59. |
HOUR | Enum | Группируйте дату и время по часам, используя 24-часовую систему, от 0 до 23. |
HOUR_MINUTE | Enum | Группируйте дату и время по часам и минутам, используя 24-часовую систему, например, 19:45 . |
HOUR_MINUTE_AMPM | Enum | Группируйте дату и время по часам и минутам, используя 12-часовую систему, например, 7:45 PM . |
DAY_OF_WEEK | Enum | Сгруппируйте дату и время по дням недели, например, Sunday . |
DAY_OF_YEAR | Enum | Сгруппируйте дату и время по дням года, от 1 до 366. |
DAY_OF_MONTH | Enum | Сгруппируйте дату и время по дням месяца, от 1 до 31. |
DAY_MONTH | Enum | Сгруппируйте дату и время по дням и месяцам, например, 22-Nov . |
MONTH | Enum | Сгруппируйте дату и время по месяцам, например, Nov . |
QUARTER | Enum | Сгруппируйте дату и время по кварталам, например, Q1 (что соответствует периоду с января по март). |
YEAR | Enum | Сгруппируйте дату и время по годам, например, по 2008 году. |
YEAR_MONTH | Enum | Сгруппируйте дату и время по году и месяцу, например, 2008-Nov . |
YEAR_QUARTER | Enum | Сгруппируйте дату и время по году и кварталу, например, 2008 Q4 . |
YEAR_MONTH_DAY | Enum | Сгруппируйте дату и время по году, месяцу и дню, например, 2008-11-22 . |
Developer Metadata
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Id() | Integer | Возвращает уникальный идентификатор, связанный с метаданными этого разработчика. |
get Key() | String | Возвращает ключ, связанный с метаданными этого разработчика. |
get Location() | Developer Metadata Location | Возвращает местоположение метаданных разработчика. |
get Value() | String | Возвращает значение, связанное с этими метаданными разработчика, или null если эти метаданные не имеют значения. |
get Visibility() | Developer Metadata Visibility | Возвращает видимость метаданных этого разработчика. |
move To Column(column) | Developer Metadata | Перемещает эти метаданные разработчика в указанный столбец. |
move To Row(row) | Developer Metadata | Перемещает эти метаданные разработчика в указанную строку. |
move To Sheet(sheet) | Developer Metadata | Перемещает эти метаданные разработчика на указанный лист. |
move To Spreadsheet() | Developer Metadata | Перемещает эти метаданные разработчика в электронную таблицу верхнего уровня. |
remove() | void | Удаляет эти метаданные. |
set Key(key) | Developer Metadata | Устанавливает ключ этих метаданных разработчика в указанное значение. |
set Value(value) | Developer Metadata | Устанавливает значение, связанное с этими метаданными разработчика, на указанное значение. |
set Visibility(visibility) | Developer Metadata | Устанавливает видимость этих метаданных разработчика на указанный уровень. |
Developer Metadata Finder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
find() | Developer Metadata[] | Выполняет поиск и возвращает соответствующие метаданные. |
on Intersecting Locations() | Developer Metadata Finder | Настраивает поиск таким образом, чтобы он учитывал пересекающиеся местоположения, содержащие метаданные. |
with Id(id) | Developer Metadata Finder | Ограничивает поиск только метаданными, соответствующими указанному идентификатору. |
with Key(key) | Developer Metadata Finder | Ограничивает поиск только метаданными, соответствующими указанному ключу. |
with Location Type(locationType) | Developer Metadata Finder | Ограничивает поиск только метаданными, соответствующими указанному типу местоположения. |
with Value(value) | Developer Metadata Finder | Ограничивает поиск только теми метаданными, которые соответствуют указанному значению. |
with Visibility(visibility) | Developer Metadata Finder | Ограничивает поиск только метаданными, соответствующими указанной видимости. |
Developer Metadata Location
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Column() | Range |null | Возвращает Range для расположения столбца этих метаданных или null , если тип расположения не соответствует Developer Metadata Location Type.COLUMN . |
get Location Type() | Developer Metadata Location Type | Определяет тип местоположения. |
get Row() | Range |null | Возвращает Range для местоположения строки этих метаданных или null , если тип местоположения не соответствует Developer Metadata Location Type.ROW . |
get Sheet() | Sheet |null | Возвращает местоположение этих метаданных Sheet или null , если тип местоположения не соответствует Developer Metadata Location Type.SHEET . |
get Spreadsheet() | Spreadsheet |null | Возвращает местоположение этих метаданных Spreadsheet или null , если тип местоположения не соответствует Developer Metadata Location Type.SPREADSHEET . |
Developer Metadata Location Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
SPREADSHEET | Enum | Тип расположения метаданных разработчика, связанных с электронной таблицей верхнего уровня. |
SHEET | Enum | Тип расположения метаданных разработчика, связанных со всем листом. |
ROW | Enum | Тип местоположения для метаданных разработчика, связанных со строкой. |
COLUMN | Enum | Тип местоположения для метаданных разработчика, связанных со столбцом. |
Developer Metadata Visibility
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DOCUMENT | Enum | Метаданные, видимые в документе, доступны из любого проекта разработчика, имеющего доступ к документу. |
PROJECT | Enum | Метаданные, видимые проекту, доступны только проекту разработчика, который их создал. |
Dimension
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
COLUMNS | Enum | Размер колонны (по вертикали). |
ROWS | Enum | Размер строки (горизонтальный). |
Direction
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UP | Enum | Направление убывания индексов строк. |
DOWN | Enum | Направление возрастания индексов строк. |
PREVIOUS | Enum | The direction of decreasing column indices. |
NEXT | Enum | The direction of increasing column indices. |
Drawing
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Container Info() | Container Info | Gets information about where the drawing is positioned in the sheet. |
get Height() | Integer | Returns the actual height of this drawing in pixels. |
get On Action() | String|null | Returns the name of the macro attached to this drawing. |
get Sheet() | Sheet | Returns the sheet this drawing appears on. |
get Width() | Integer | Returns the actual width of this drawing in pixels. |
get ZIndex() | Number | Returns the z-index of this drawing. |
remove() | void | Deletes this drawing from the spreadsheet. |
set Height(height) | Drawing | Sets the actual height of this drawing in pixels. |
set On Action(macroName) | Drawing | Assigns a macro function to this drawing. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Sets the position where the drawing appears on the sheet. |
set Width(width) | Drawing | Sets the actual width of this drawing in pixels. |
set ZIndex(zIndex) | Drawing | Sets the z-index of this drawing. |
Embedded Area Chart Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
reverse Categories() | Embedded Area Chart Builder | Reverses the drawing of series in the domain axis. |
set Background Color(cssValue) | Embedded Area Chart Builder | Sets the background color for the chart. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Colors(cssValues) | Embedded Area Chart Builder | Sets the colors for the lines in the chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Legend Position(position) | Embedded Area Chart Builder | Sets the position of the legend with respect to the chart. |
set Legend Text Style(textStyle) | Embedded Area Chart Builder | Sets the text style of the chart legend. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Point Style(style) | Embedded Area Chart Builder | Sets the style for points in the line. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Range(start, end) | Embedded Area Chart Builder | Sets the range for the chart. |
set Stacked() | Embedded Area Chart Builder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
set Title(chartTitle) | Embedded Area Chart Builder | Sets the title of the chart. |
set Title Text Style(textStyle) | Embedded Area Chart Builder | Sets the text style of the chart title. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
set XAxis Text Style(textStyle) | Embedded Area Chart Builder | Sets the horizontal axis text style. |
set XAxis Title(title) | Embedded Area Chart Builder | Adds a title to the horizontal axis. |
set XAxis Title Text Style(textStyle) | Embedded Area Chart Builder | Sets the horizontal axis title text style. |
set YAxis Text Style(textStyle) | Embedded Area Chart Builder | Sets the vertical axis text style. |
set YAxis Title(title) | Embedded Area Chart Builder | Adds a title to the vertical axis. |
set YAxis Title Text Style(textStyle) | Embedded Area Chart Builder | Sets the vertical axis title text style. |
use Log Scale() | Embedded Area Chart Builder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
Embedded Bar Chart Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
reverse Categories() | Embedded Bar Chart Builder | Reverses the drawing of series in the domain axis. |
reverse Direction() | Embedded Bar Chart Builder | Reverses the direction in which the bars grow along the horizontal axis. |
set Background Color(cssValue) | Embedded Bar Chart Builder | Sets the background color for the chart. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Colors(cssValues) | Embedded Bar Chart Builder | Sets the colors for the lines in the chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Legend Position(position) | Embedded Bar Chart Builder | Sets the position of the legend with respect to the chart. |
set Legend Text Style(textStyle) | Embedded Bar Chart Builder | Sets the text style of the chart legend. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Range(start, end) | Embedded Bar Chart Builder | Sets the range for the chart. |
set Stacked() | Embedded Bar Chart Builder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
set Title(chartTitle) | Embedded Bar Chart Builder | Sets the title of the chart. |
set Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the text style of the chart title. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
set XAxis Text Style(textStyle) | Embedded Bar Chart Builder | Sets the horizontal axis text style. |
set XAxis Title(title) | Embedded Bar Chart Builder | Adds a title to the horizontal axis. |
set XAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the horizontal axis title text style. |
set YAxis Text Style(textStyle) | Embedded Bar Chart Builder | Sets the vertical axis text style. |
set YAxis Title(title) | Embedded Bar Chart Builder | Adds a title to the vertical axis. |
set YAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Sets the vertical axis title text style. |
use Log Scale() | Embedded Bar Chart Builder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
Embedded Chart
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
as Data Source Chart() | Data Source Chart |null | Casts to a data source chart instance if the chart is a data source chart, or null otherwise. |
get As(contentType) | Blob | Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого. |
get Blob() | Blob | Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob). |
get Chart Id() | Integer|null | 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. |
get Container Info() | Container Info | Returns information about where the chart is positioned within a sheet. |
get Hidden Dimension Strategy() | Chart Hidden Dimension Strategy | Returns the strategy to use for handling hidden rows and columns. |
get Merge Strategy() | Chart Merge Strategy | Returns the merge strategy used when more than one range exists. |
get Num Headers() | Integer | Returns the number of rows or columns the range that are treated as headers. |
get Options() | Chart Options | Returns the options for this chart, such as height, colors, and axes. |
get Ranges() | Range[] | Returns the ranges that this chart uses as a data source. |
get Transpose Rows And Columns() | Boolean | If true , the rows and columns used to populate the chart are switched. |
modify() | Embedded Chart Builder | Returns an Embedded Chart Builder that can be used to modify this chart. |
Embedded Chart Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
Embedded Column Chart Builder
Методы
Embedded Combo Chart Builder
Методы
Embedded Histogram Chart Builder
Методы
Embedded Line Chart Builder
Методы
Embedded Pie Chart Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
reverse Categories() | Embedded Pie Chart Builder | Reverses the drawing of series in the domain axis. |
set3D() | Embedded Pie Chart Builder | Sets the chart to be three-dimensional. |
set Background Color(cssValue) | Embedded Pie Chart Builder | Sets the background color for the chart. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set Colors(cssValues) | Embedded Pie Chart Builder | Sets the colors for the lines in the chart. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Legend Position(position) | Embedded Pie Chart Builder | Sets the position of the legend with respect to the chart. |
set Legend Text Style(textStyle) | Embedded Pie Chart Builder | Sets the text style of the chart legend. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Title(chartTitle) | Embedded Pie Chart Builder | Sets the title of the chart. |
set Title Text Style(textStyle) | Embedded Pie Chart Builder | Sets the text style of the chart title. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
Embedded Scatter Chart Builder
Методы
Embedded Table Chart Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Range(range) | Embedded Chart Builder | Adds a range to the chart this builder modifies. |
as Area Chart() | Embedded Area Chart Builder | Sets the chart type to AreaChart and returns an Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Sets the chart type to BarChart and returns an Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Sets the chart type to ColumnChart and returns an Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Sets the chart type to ComboChart and returns an Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Sets the chart type to HistogramChart and returns an Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Sets the chart type to LineChart and returns an Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Sets the chart type to PieChart and returns an Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Sets the chart type to ScatterChart and returns an Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Sets the chart type to TableChart and returns an Embedded Table Chart Builder . |
build() | Embedded Chart | Builds the chart to reflect all changes made to it. |
clear Ranges() | Embedded Chart Builder | Removes all ranges from the chart this builder modifies. |
enable Paging(enablePaging) | Embedded Table Chart Builder | Sets whether to enable paging through the data. |
enable Paging(pageSize) | Embedded Table Chart Builder | Enables paging and sets the number of rows in each page. |
enable Paging(pageSize, startPage) | Embedded Table Chart Builder | Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based). |
enable Rtl Table(rtlEnabled) | Embedded Table Chart Builder | 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. |
enable Sorting(enableSorting) | Embedded Table Chart Builder | Sets whether to sort columns when the user clicks a column heading. |
get Chart Type() | Chart Type | Returns the current chart type. |
get Container() | Container Info | Return the chart Container Info , which encapsulates where the chart appears on the sheet. |
get Ranges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove Range(range) | Embedded Chart Builder | Removes the specified range from the chart this builder modifies. |
set Chart Type(type) | Embedded Chart Builder | Changes the type of chart. |
set First Row Number(number) | Embedded Table Chart Builder | Sets the row number for the first row in the data table. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Sets the strategy to use for hidden rows and columns. |
set Initial Sorting Ascending(column) | Embedded Table Chart Builder | Sets the index of the column according to which the table should be initially sorted (ascending). |
set Initial Sorting Descending(column) | Embedded Table Chart Builder | Sets the index of the column according to which the table should be initially sorted (descending). |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Sets the merge strategy to use when more than one range exists. |
set Num Headers(headers) | Embedded Chart Builder | Sets the number of rows or columns of the range that should be treated as headers. |
set Option(option, value) | Embedded Chart Builder | Sets advanced options for this chart. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Sets the position, changing where the chart appears on the sheet. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Sets whether the chart's rows and columns are transposed. |
show Row Number Column(showRowNumber) | Embedded Table Chart Builder | Sets whether to show the row number as the first column of the table. |
use Alternating Row Style(alternate) | Embedded Table Chart Builder | Sets whether alternating color style is assigned to odd and even rows of a table chart. |
Filter
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Column Filter Criteria(columnPosition) | Filter Criteria |null | Gets the filter criteria on the specified column, or null if the column doesn't have filter criteria applied to it. |
get Range() | Range | Gets the range this filter applies to. |
remove() | void | Removes this filter. |
remove Column Filter Criteria(columnPosition) | Filter | Removes the filter criteria from the specified column. |
set Column Filter Criteria(columnPosition, filterCriteria) | Filter | Sets the filter criteria on the specified column. |
sort(columnPosition, ascending) | Filter | Sorts the filtered range by the specified column, excluding the first row (the header row) in the range this filter applies to. |
Filter Criteria
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Filter Criteria Builder | Копирует эти критерии фильтра и создает конструктор критериев, который можно применить к другому фильтру. |
get Criteria Type() | Boolean Criteria |null | Возвращает логический тип критерия, например, CELL_EMPTY . |
get Criteria Values() | Object[] | Возвращает массив аргументов для логических критериев. |
get Hidden Values() | String[] | Возвращает значения, которые скрывает фильтр. |
get Visible Background Color() | Color |null | Возвращает цвет фона, используемый в качестве критерия фильтра. |
get Visible Foreground Color() | Color |null | Возвращает цвет переднего плана, используемый в качестве критерия фильтра. |
get Visible Values() | String[] | Возвращает значения, отображаемые фильтром сводной таблицы. |
Filter Criteria Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Filter Criteria | Assembles the filter criteria using the settings you add to the criteria builder. |
copy() | Filter Criteria Builder | Копирует эти критерии фильтра и создает конструктор критериев, который можно применить к другому фильтру. |
get Criteria Type() | Boolean Criteria |null | Возвращает логический тип критерия, например, CELL_EMPTY . |
get Criteria Values() | Object[] | Возвращает массив аргументов для логических критериев. |
get Hidden Values() | String[] | Возвращает значения, которые скрывает фильтр. |
get Visible Background Color() | Color |null | Возвращает цвет фона, используемый в качестве критерия фильтра. |
get Visible Foreground Color() | Color |null | Возвращает цвет переднего плана, используемый в качестве критерия фильтра. |
get Visible Values() | String[] | Возвращает значения, отображаемые фильтром сводной таблицы. |
set Hidden Values(values) | Filter Criteria Builder | Sets the values to hide. |
set Visible Background Color(visibleBackgroundColor) | Filter Criteria Builder | Sets the background color used as filter criteria. |
set Visible Foreground Color(visibleForegroundColor) | Filter Criteria Builder | Sets the foreground color used as filter criteria. |
set Visible Values(values) | Filter Criteria Builder | Sets the values to show on a pivot table. |
when Cell Empty() | Filter Criteria Builder | Sets the filter criteria to show empty cells. |
when Cell Not Empty() | Filter Criteria Builder | Sets the filter criteria to show cells that aren't empty. |
when Date After(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are after the specified date. |
when Date After(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are after the specified relative date. |
when Date Before(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are before the specified date. |
when Date Before(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are before the specified relative date. |
when Date Equal To(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are equal to the specified date. |
when Date Equal To(date) | Filter Criteria Builder | Sets filter criteria that shows cells with dates that are equal to the specified relative date. |
when Date Equal To Any(dates) | Filter Criteria Builder | Sets the filter criteria to show cells with dates that are equal to any of the specified dates. |
when Date Not Equal To(date) | Filter Criteria Builder | Sets the filter criteria to show cells that aren't equal to the specified date. |
when Date Not Equal To Any(dates) | Filter Criteria Builder | Sets the filter criteria to show cells with dates that aren't equal to any of the specified dates. |
when Formula Satisfied(formula) | Filter Criteria Builder | Sets the filter criteria to show cells with a specified formula (such as =B:B<C:C ) that evaluates to true . |
when Number Between(start, end) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that falls between, or is either of, 2 specified numbers. |
when Number Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's equal to the specified number. |
when Number Equal To Any(numbers) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's equal to any of the specified numbers. |
when Number Greater Than(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number greater than the specified number |
when Number Greater Than Or Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number greater than or equal to the specified number. |
when Number Less Than(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that's less than the specified number. |
when Number Less Than Or Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number less than or equal to the specified number. |
when Number Not Between(start, end) | Filter Criteria Builder | Sets the filter criteria to show cells with a number doesn't fall between, and is neither of, 2 specified numbers. |
when Number Not Equal To(number) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that isn't equal to the specified number. |
when Number Not Equal To Any(numbers) | Filter Criteria Builder | Sets the filter criteria to show cells with a number that isn't equal to any of the specified numbers. |
when Text Contains(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that contains the specified text. |
when Text Does Not Contain(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that doesn't contain the specified text. |
when Text Ends With(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that ends with the specified text. |
when Text Equal To(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that's equal to the specified text. |
when Text Equal To Any(texts) | Filter Criteria Builder | Sets the filter criteria to show cells with text that's equal to any of the specified text values. |
when Text Not Equal To(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that isn't equal to the specified text. |
when Text Not Equal To Any(texts) | Filter Criteria Builder | Sets the filter criteria to show cells with text that isn't equal to any of the specified values. |
when Text Starts With(text) | Filter Criteria Builder | Sets the filter criteria to show cells with text that starts with the specified text. |
with Criteria(criteria, args) | Filter Criteria Builder | Sets the filter criteria to a boolean condition defined by Boolean Criteria values, such as CELL_EMPTY or NUMBER_GREATER_THAN . |
Frequency Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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. |
Gradient Condition
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Max Color Object() | Color |null | Gets the color set for the maximum value of this gradient condition. |
get Max Type() | Interpolation Type |null | Gets the interpolation type for the maximum value of this gradient condition. |
get Max Value() | String | Gets the max value of this gradient condition. |
get Mid Color Object() | Color |null | Gets the color set for the midpoint value of this gradient condition. |
get Mid Type() | Interpolation Type |null | Gets the interpolation type for the midpoint value of this gradient condition. |
get Mid Value() | String | Gets the midpoint value of this gradient condition. |
get Min Color Object() | Color |null | Gets the color set for the minimum value of this gradient condition. |
get Min Type() | Interpolation Type |null | Gets the interpolation type for the minimum value of this gradient condition. |
get Min Value() | String | Gets the minimum value of this gradient condition. |
Group
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
collapse() | Group | Collapses this group. |
expand() | Group | Expands this group. |
get Control Index() | Integer | Returns the control toggle index of this group. |
get Depth() | Integer | Returns the depth of this group. |
get Range() | Range | Returns the range over which this group exists. |
is Collapsed() | 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. |
Group Control Toggle Position
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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). |
Interpolation Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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. |
Looker Data Source Spec
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Data Source Spec Builder | Creates a Data Source Spec Builder based on this data source's settings. |
get Explore Name() | String | Gets the name of the Looker explore in the model. |
get Instance Url() | String | Gets the URL of the Looker instance. |
get Model Name() | String | Gets the name of the Looker model in the instance. |
get Parameters() | Data Source Parameter[] | Gets the parameters of the data source. |
get Type() | Data Source Type | Gets the type of the data source. |
Looker Data Source Spec Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Data Source Spec | Builds a data source specification from the settings in this builder. |
copy() | Data Source Spec Builder | Creates a Data Source Spec Builder based on this data source's settings. |
get Explore Name() | String | Gets the name of the Looker explore in the model. |
get Instance Url() | String | Gets the URL of the Looker instance. |
get Model Name() | String | Gets the name of the Looker model in the instance. |
get Parameters() | Data Source Parameter[] | Gets the parameters of the data source. |
get Type() | Data Source Type | Gets the type of the data source. |
remove All Parameters() | Looker Data Source Spec Builder | Removes all the parameters. |
remove Parameter(parameterName) | Looker Data Source Spec Builder | Removes the specified parameter. |
set Explore Name(exploreName) | Looker Data Source Spec Builder | Sets the explore name in the Looker model. |
set Instance Url(instanceUrl) | Looker Data Source Spec Builder | Sets the instance URL for Looker. |
set Model Name(modelName) | Looker Data Source Spec Builder | Sets the Looker model name in the Looker instance. |
set Parameter From Cell(parameterName, sourceCell) | Looker Data Source Spec Builder | Adds a parameter, or if the parameter with the name exists, updates its source cell for data source spec builders of type Data Source Type.BIGQUERY . |
Named Range
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Name() | String | Gets the name of this named range. |
get Range() | Range | Gets the range referenced by this named range. |
remove() | void | Deletes this named range. |
set Name(name) | Named Range | Sets/updates the name of the named range. |
set Range(range) | Named Range | Sets/updates the range for this named range. |
Over Grid Image
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
assign Script(functionName) | Over Grid Image | Assigns the function with the specified function name to this image. |
get Alt Text Description() | String | Returns the alt text description for this image. |
get Alt Text Title() | String | Returns the alt text title for this image. |
get Anchor Cell() | Range | Returns the cell where an image is anchored. |
get Anchor Cell XOffset() | Integer | Returns the horizontal pixel offset from the anchor cell. |
get Anchor Cell YOffset() | Integer | Returns the vertical pixel offset from the anchor cell. |
get Height() | Integer | Returns the actual height of this image in pixels. |
get Inherent Height() | Integer | Returns the inherent height of this image in pixels. |
get Inherent Width() | Integer | Returns the inherent height of this image in pixels. |
get Script() | String | Returns the name of the function assigned to this image. |
get Sheet() | Sheet | Returns the sheet this image appears on. |
get Width() | Integer | Returns the actual width of this image in pixels. |
remove() | void | Deletes this image from the spreadsheet. |
replace(blob) | Over Grid Image | Replaces this image with the one specified by the provided Blob Source . |
replace(url) | Over Grid Image | Replaces this image with the one from the specified URL. |
reset Size() | Over Grid Image | Resets this image to its inherent dimensions. |
set Alt Text Description(description) | Over Grid Image | Sets the alt-text description for this image. |
set Alt Text Title(title) | Over Grid Image | Sets the alt text title for this image. |
set Anchor Cell(cell) | Over Grid Image | Sets the cell where an image is anchored. |
set Anchor Cell XOffset(offset) | Over Grid Image | Sets the horizontal pixel offset from the anchor cell. |
set Anchor Cell YOffset(offset) | Over Grid Image | Sets the vertical pixel offset from the anchor cell. |
set Height(height) | Over Grid Image | Sets the actual height of this image in pixels. |
set Width(width) | Over Grid Image | Sets the actual width of this image in pixels. |
Page Protection
Pivot Filter
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Filter Criteria() | Filter Criteria | Returns the filter criteria for this pivot filter. |
get Pivot Table() | Pivot Table | Returns the Pivot Table that this filter belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column this filter operates on. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the filter operates on. |
remove() | void | Removes this pivot filter from the pivot table. |
set Filter Criteria(filterCriteria) | Pivot Filter | Sets the filter criteria for this pivot filter. |
Pivot Group
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Manual Grouping Rule(groupName, groupMembers) | Pivot Group | Adds a manual grouping rule for this pivot group. |
are Labels Repeated() | Boolean | Returns whether labels are displayed as repeated. |
clear Grouping Rule() | Pivot Group | Removes any grouping rules from this pivot group. |
clear Sort() | Pivot Group | Removes any sorting applied to this group. |
get Date Time Grouping Rule() | Date Time Grouping Rule |null | Returns the date-time grouping rule on the pivot group, or null if no date-time grouping rule is set. |
get Dimension() | Dimension | Returns whether this is a row or column group. |
get Group Limit() | Pivot Group Limit |null | Returns the pivot group limit on the pivot group. |
get Index() | Integer | Returns the index of this pivot group in the current group order. |
get Pivot Table() | Pivot Table | Returns the Pivot Table which this grouping belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column this group summarizes. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the pivot group operates on. |
hide Repeated Labels() | Pivot Group | Hides repeated labels for this grouping. |
is Sort Ascending() | Boolean | Returns true if the sort is ascending, returns false if the sort order is descending. |
move To Index(index) | Pivot Group | 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. |
remove Manual Grouping Rule(groupName) | Pivot Group | Removes the manual grouping rule with the specified group Name . |
reset Display Name() | Pivot Group | Resets the display name of this group in the pivot table to its default value. |
set Date Time Grouping Rule(dateTimeGroupingRuleType) | Pivot Group | Sets the date-time grouping rule on the pivot group. |
set Display Name(name) | Pivot Group | Sets the display name of this group in the pivot table. |
set Group Limit(countLimit) | Pivot Group | Sets the pivot group limit on the pivot group. |
set Histogram Grouping Rule(minValue, maxValue, intervalSize) | Pivot Group | Sets a histogram grouping rule for this pivot group. |
show Repeated Labels() | Pivot Group | When there is more than one row or column grouping, this method displays this grouping's label for each entry of the subsequent grouping. |
show Totals(showTotals) | Pivot Group | Sets whether to show total values for this pivot group in the table. |
sort Ascending() | Pivot Group | Sets the sort order to be ascending. |
sort By(value, oppositeGroupValues) | Pivot Group | Sorts this group by the specified Pivot Value for the values from the opposite Group Values . |
sort Descending() | Pivot Group | Sets the sort order to be descending. |
totals Are Shown() | Boolean | Returns whether total values are currently shown for this pivot group. |
Pivot Group Limit
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Count Limit() | Integer | Gets the count limit on rows or columns in the pivot group. |
get Pivot Group() | Pivot Group | Returns the pivot group the limit belongs to. |
remove() | void | Removes the pivot group limit. |
set Count Limit(countLimit) | Pivot Group Limit | Sets the count limit on rows or columns in the pivot group. |
Pivot Table
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Calculated Pivot Value(name, formula) | Pivot Value | Creates a new pivot value in the pivot table calculated from the specified formula with the specified name . |
add Column Group(sourceDataColumn) | Pivot Group | Defines a new pivot column grouping in the pivot table. |
add Filter(sourceDataColumn, filterCriteria) | Pivot Filter | Creates a new pivot filter for the pivot table. |
add Pivot Value(sourceDataColumn, summarizeFunction) | Pivot Value | Defines a new pivot value in the pivot table with the specified summarize Function . |
add Row Group(sourceDataColumn) | Pivot Group | Defines a new pivot row grouping in the pivot table. |
as Data Source Pivot Table() | Data Source Pivot Table |null | Returns the pivot table as a data source pivot table if the pivot table is linked to a Data Source , or null otherwise. |
get Anchor Cell() | Range | Returns the Range representing the cell where this pivot table is anchored. |
get Column Groups() | Pivot Group[] | Returns an ordered list of the column groups in this pivot table. |
get Filters() | Pivot Filter[] | Returns an ordered list of the filters in this pivot table. |
get Pivot Values() | Pivot Value[] | Returns an ordered list of the pivot values in this pivot table. |
get Row Groups() | Pivot Group[] | Returns an ordered list of the row groups in this pivot table. |
get Source Data Range() | Range | Returns the source data range on which the pivot table is constructed. |
get Values Display Orientation() | Dimension | Returns whether values are displayed as rows or columns. |
remove() | void | Deletes this pivot table. |
set Values Display Orientation(dimension) | Pivot Table | Sets the layout of this pivot table to display values as columns or rows. |
Pivot Table Summarize Function
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 |
Pivot Value
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Display Type() | Pivot Value Display Type | Returns the display type describing how this pivot value is currently displayed in the table. |
get Formula() | String | Returns the formula used to calculate this value. |
get Pivot Table() | Pivot Table | Returns the Pivot Table which this value belongs to. |
get Source Data Column() | Integer | Returns the number of the source data column the pivot value summarizes. |
get Source Data Source Column() | Data Source Column |null | Returns the data source column the pivot value summarizes. |
get Summarized By() | Pivot Table Summarize Function | Returns this group's summarization function. |
remove() | void | Remove this value from the pivot table. |
set Display Name(name) | Pivot Value | Sets the display name for this value in the pivot table. |
set Formula(formula) | Pivot Value | Sets the formula used to calculate this value. |
show As(displayType) | Pivot Value | Displays this value in the pivot table as a function of another value. |
summarize By(summarizeFunction) | Pivot Value | Sets the summarization function. |
Pivot Value Display Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DEFAULT | Enum | По умолчанию. |
PERCENT_OF_ROW_TOTAL | Enum | Displays pivot values as a percent of the total for that row. |
PERCENT_OF_COLUMN_TOTAL | Enum | Displays pivot values as a percent of the total for that column. |
PERCENT_OF_GRAND_TOTAL | Enum | Displays pivot values as a percent of the grand total. |
Protection
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Editor(emailAddress) | Protection | Adds the given user to the list of editors for the protected sheet or range. |
add Editor(user) | Protection | Adds the given user to the list of editors for the protected sheet or range. |
add Editors(emailAddresses) | Protection | Adds the given array of users to the list of editors for the protected sheet or range. |
add Target Audience(audienceId) | Protection | Adds the specified target audience as an editor of the protected range. |
can Domain Edit() | Boolean | Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. |
can Edit() | Boolean | Determines whether the user has permission to edit the protected range or sheet. |
get Description() | String | Gets the description of the protected range or sheet. |
get Editors() | User[] | Gets the list of editors for the protected range or sheet. |
get Protection Type() | Protection Type | Gets the type of the protected area, either RANGE or SHEET . |
get Range() | Range | Gets the range that is being protected. |
get Range Name() | String|null | Gets the name of the protected range if it is associated with a named range. |
get Target Audiences() | Target Audience[] | Returns the IDs of the target audiences that can edit the protected range. |
get Unprotected Ranges() | Range[] | Gets an array of unprotected ranges within a protected sheet. |
is Warning Only() | Boolean | Determines if the protected area is using "warning based" protection. |
remove() | void | Unprotects the range or sheet. |
remove Editor(emailAddress) | Protection | Removes the given user from the list of editors for the protected sheet or range. |
remove Editor(user) | Protection | Removes the given user from the list of editors for the protected sheet or range. |
remove Editors(emailAddresses) | Protection | Removes the given array of users from the list of editors for the protected sheet or range. |
remove Target Audience(audienceId) | Protection | Removes the specified target audience as an editor of the protected range. |
set Description(description) | Protection | Sets the description of the protected range or sheet. |
set Domain Edit(editable) | Protection | Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. |
set Named Range(namedRange) | Protection | Associates the protected range with an existing named range. |
set Range(range) | Protection | Adjusts the range that is being protected. |
set Range Name(rangeName) | Protection | Associates the protected range with an existing named range. |
set Unprotected Ranges(ranges) | Protection | Unprotects the given array of ranges within a protected sheet. |
set Warning Only(warningOnly) | Protection | Sets whether or not this protected range is using "warning based" protection. |
Protection Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 . |
activate As Current Cell() | Range | Sets the specified cell as the current cell . |
add Developer Metadata(key) | Range | Adds developer metadata with the specified key to the range. |
add Developer Metadata(key, visibility) | Range | Adds developer metadata with the specified key and visibility to the range. |
add Developer Metadata(key, value) | Range | Adds developer metadata with the specified key and value to the range. |
add Developer Metadata(key, value, visibility) | Range | Adds developer metadata with the specified key, value, and visibility to the range. |
apply Column Banding() | Banding | Applies a default column banding theme to the range. |
apply Column Banding(bandingTheme) | Banding | Applies a specified column banding theme to the range. |
apply Column Banding(bandingTheme, showHeader, showFooter) | Banding | Applies a specified column banding theme to the range with specified header and footer settings. |
apply Row Banding() | Banding | Applies a default row banding theme to the range. |
apply Row Banding(bandingTheme) | Banding | Applies a specified row banding theme to the range. |
apply Row Banding(bandingTheme, showHeader, showFooter) | Banding | Applies a specified row banding theme to the range with specified header and footer settings. |
auto Fill(destination, series) | void | Fills the destination Range with data based on the data in this range. |
auto Fill To Neighbor(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. |
break Apart() | Range | Break any multi-column cells in the range into individual cells again. |
can Edit() | Boolean | Determines whether the user has permission to edit every cell in the range. |
check() | Range | Changes the state of the checkboxes in the range to “checked”. |
clear() | Range | Clears the range of contents and formats. |
clear(options) | Range | Clears the range of contents, format, data validation rules, and/or comments, as specified with the given advanced options. |
clear Content() | Range | Clears the content of the range, leaving the formatting intact. |
clear Data Validations() | Range | Clears the data validation rules for the range. |
clear Format() | Range | Clears formatting for this range. |
clear Note() | Range | Clears the note in the given cell or cells. |
collapse Groups() | Range | Collapses all groups that are wholly contained within the range. |
copy Format To Range(gridId, column, columnEnd, row, rowEnd) | void | Copy the formatting of the range to the given location. |
copy Format To Range(sheet, column, columnEnd, row, rowEnd) | void | Copy the formatting of the range to the given location. |
copy To(destination) | void | Copies the data from a range of cells to another range of cells. |
copy To(destination, copyPasteType, transposed) | void | Copies the data from a range of cells to another range of cells. |
copy To(destination, options) | void | Copies the data from a range of cells to another range of cells. |
copy Values To Range(gridId, column, columnEnd, row, rowEnd) | void | Copy the content of the range to the given location. |
copy Values To Range(sheet, column, columnEnd, row, rowEnd) | void | Copy the content of the range to the given location. |
create Data Source Pivot Table(dataSource) | Data Source Pivot Table | Creates an empty data source pivot table from the data source, anchored at the first cell in this range. |
create Data Source Table(dataSource) | Data Source Table | Creates an empty data source table from the data source, anchored at the first cell in this range. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a DeveloperMetadataFinderApi for finding developer metadata within the scope of this range. |
create Filter() | Filter | Creates a filter and applies it to the specified range on the sheet. |
create Pivot Table(sourceData) | Pivot Table | Creates an empty pivot table from the specified source Data anchored at the first cell in this range. |
create Text Finder(findText) | Text Finder | Creates a text finder for the range, which can find and replace text in this range. |
delete Cells(shiftDimension) | void | Deletes this range of cells. |
expand Groups() | 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. |
get Background() | String | Returns the background color of the top-left cell in the range (for example, '#ffffff' ). |
get Background Object() | Color | Returns the background color of the top-left cell in the range. |
get Background Objects() | Color[][] | Returns the background colors of the cells in the range. |
get Backgrounds() | String[][] | Returns the background colors of the cells in the range (for example, '#ffffff' ). |
get Bandings() | Banding[] | Returns all the bandings that are applied to any cells in this range. |
get Cell(row, column) | Range | Returns a given cell within a range. |
get Column() | Integer | Returns the starting column position for this range. |
get Data Region() | Range | Returns a copy of the range expanded in the four cardinal Direction s to cover all adjacent cells with data in them. |
get Data Region(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 . |
get Data Source Formula() | Data Source Formula |null | Returns the Data Source Formula for the first cell in the range, or null if the cell doesn't contain a data source formula. |
get Data Source Formulas() | Data Source Formula[] | Returns the Data Source Formula s for the cells in the range. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables intersecting with the range. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables intersecting with the range. |
get Data Source Url() | String | Returns a URL for the data in this range, which can be used to create charts and queries. |
get Data Table() | Data Table | Return the data inside this object as a DataTable. |
get Data Table(firstRowIsHeader) | Data Table | Return the data inside this range as a DataTable. |
get Data Validation() | Data Validation | Returns the data validation rule for the top-left cell in the range. |
get Data Validations() | Data Validation[][] | Returns the data validation rules for all cells in the range. |
get Developer Metadata() | Developer Metadata[] | Gets the developer metadata associated with this range. |
get Display Value() | String | Returns the displayed value of the top-left cell in the range. |
get Display Values() | String[][] | Returns the rectangular grid of values for this range. |
get Filter() | Filter |null | Returns the filter on the sheet this range belongs to, or null if there is no filter on the sheet. |
get Font Color Object() | Color | Returns the font color of the cell in the top-left corner of the range. |
get Font Color Objects() | Color[][] | Returns the font colors of the cells in the range. |
get Font Families() | String[][] | Returns the font families of the cells in the range. |
get Font Family() | String | Returns the font family of the cell in the top-left corner of the range. |
get Font Line() | String | Gets the line style of the cell in the top-left corner of the range ( 'underline' , 'line-through' , or 'none' ). |
get Font Lines() | String[][] | Gets the line style of the cells in the range ( 'underline' , 'line-through' , or 'none' ). |
get Font Size() | Integer | Returns the font size in point size of the cell in the top-left corner of the range. |
get Font Sizes() | Integer[][] | Returns the font sizes of the cells in the range. |
get Font Style() | String | Returns the font style ( 'italic' or 'normal' ) of the cell in the top-left corner of the range. |
get Font Styles() | String[][] | Returns the font styles of the cells in the range. |
get Font Weight() | String | Returns the font weight (normal/bold) of the cell in the top-left corner of the range. |
get Font Weights() | String[][] | Returns the font weights of the cells in the range. |
get Formula() | 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. |
get Formula R1C1() | String | Returns the formula (R1C1 notation) for a given cell, or null if none. |
get Formulas() | String[][] | Returns the formulas (A1 notation) for the cells in the range. |
get Formulas R1C1() | String[][] | Returns the formulas (R1C1 notation) for the cells in the range. |
get Grid Id() | Integer | Returns the grid ID of the range's parent sheet. |
get Height() | Integer | Returns the height of the range. |
get Horizontal Alignment() | String | Returns the horizontal alignment of the text (left/center/right) of the cell in the top-left corner of the range. |
get Horizontal Alignments() | String[][] | Returns the horizontal alignments of the cells in the range. |
get Last Column() | Integer | Returns the end column position. |
get Last Row() | Integer | Returns the end row position. |
get Merged Ranges() | 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. |
get Next Data Cell(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. |
get Note() | String | Returns the note associated with the given range. |
get Notes() | String[][] | Returns the notes associated with the cells in the range. |
get Num Columns() | Integer | Returns the number of columns in this range. |
get Num Rows() | Integer | Returns the number of rows in this range. |
get Number Format() | String | Get the number or date formatting of the top-left cell of the given range. |
get Number Formats() | String[][] | Returns the number or date formats for the cells in the range. |
get Rich Text Value() | Rich Text Value |null | Returns the Rich Text value for the top left cell of the range, or null if the cell value is not text. |
get Rich Text Values() | Rich Text Value[][] | Returns the Rich Text values for the cells in the range. |
get Row() | Integer | Returns the row position for this range. |
get Row Index() | Integer | Returns the row position for this range. |
get Sheet() | Sheet | Returns the sheet this range belongs to. |
get Text Direction() | Text Direction | Returns the text direction for the top left cell of the range. |
get Text Directions() | Text Direction[][] | Returns the text directions for the cells in the range. |
get Text Rotation() | Text Rotation | Returns the text rotation settings for the top left cell of the range. |
get Text Rotations() | Text Rotation[][] | Returns the text rotation settings for the cells in the range. |
get Text Style() | Text Style | Returns the text style for the top left cell of the range. |
get Text Styles() | Text Style[][] | Returns the text styles for the cells in the range. |
get Value() | Object | Returns the value of the top-left cell in the range. |
get Values() | Object[][] | Returns the rectangular grid of values for this range. |
get Vertical Alignment() | String | Returns the vertical alignment (top/middle/bottom) of the cell in the top-left corner of the range. |
get Vertical Alignments() | String[][] | Returns the vertical alignments of the cells in the range. |
get Width() | Integer | Returns the width of the range in columns. |
get Wrap() | Boolean | Returns whether the text in the cell wraps. |
get Wrap Strategies() | Wrap Strategy[][] | Returns the text wrapping strategies for the cells in the range. |
get Wrap Strategy() | Wrap Strategy | Returns the text wrapping strategy for the top left cell of the range. |
get Wraps() | Boolean[][] | Returns whether the text in the cells wrap. |
insert Cells(shiftDimension) | Range | Inserts empty cells into this range. |
insert Checkboxes() | Range | Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked. |
insert Checkboxes(checkedValue) | Range | Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked. |
insert Checkboxes(checkedValue, uncheckedValue) | Range | Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states. |
is Blank() | Boolean | Returns true if the range is totally blank. |
is Checked() | Boolean | Returns whether all cells in the range have their checkbox state as 'checked'. |
is End Column Bounded() | Boolean | Determines whether the end of the range is bound to a particular column. |
is End Row Bounded() | Boolean | Determines whether the end of the range is bound to a particular row. |
is Part Of Merge() | Boolean | Returns true if the cells in the current range overlap any merged cells. |
is Start Column Bounded() | Boolean | Determines whether the start of the range is bound to a particular column. |
is Start Row Bounded() | 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. |
merge Across() | Range | Merge the cells in the range across the columns of the range. |
merge Vertically() | Range | Merges the cells in the range together. |
move To(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. |
remove Checkboxes() | Range | Removes all checkboxes from the range. |
remove Duplicates() | Range | Removes rows within this range that contain values that are duplicates of values in any previous row. |
remove Duplicates(columnsToCompare) | Range | Removes rows within this range that contain values in the specified columns that are duplicates of values any previous row. |
set Background(color) | Range | Sets the background color of all cells in the range in CSS notation (such as '#ffffff' or 'white' ). |
set Background Object(color) | Range | Sets the background color of all cells in the range. |
set Background Objects(color) | Range | Sets a rectangular grid of background colors (must match dimensions of this range). |
set Background RGB(red, green, blue) | Range | Sets the background to the given color using RGB values (integers between 0 and 255 inclusive). |
set Backgrounds(color) | Range | Sets a rectangular grid of background colors (must match dimensions of this range). |
set Border(top, left, bottom, right, vertical, horizontal) | Range | Sets the border property. |
set Border(top, left, bottom, right, vertical, horizontal, color, style) | Range | Sets the border property with color and/or style. |
set Data Validation(rule) | Range | Sets one data validation rule for all cells in the range. |
set Data Validations(rules) | Range | Sets the data validation rules for all cells in the range. |
set Font Color(color) | Range | Sets the font color in CSS notation (such as '#ffffff' or 'white' ). |
set Font Color Object(color) | Range | Sets the font color of the given range. |
set Font Color Objects(colors) | Range | Sets a rectangular grid of font colors (must match dimensions of this range). |
set Font Colors(colors) | Range | Sets a rectangular grid of font colors (must match dimensions of this range). |
set Font Families(fontFamilies) | Range | Sets a rectangular grid of font families (must match dimensions of this range). |
set Font Family(fontFamily) | Range | Sets the font family, such as "Arial" or "Helvetica". |
set Font Line(fontLine) | Range | Sets the font line style of the given range ( 'underline' , 'line-through' , or 'none' ). |
set Font Lines(fontLines) | Range | Sets a rectangular grid of line styles (must match dimensions of this range). |
set Font Size(size) | Range | Sets the font size, with the size being the point size to use. |
set Font Sizes(sizes) | Range | Sets a rectangular grid of font sizes (must match dimensions of this range). |
set Font Style(fontStyle) | Range | Set the font style for the given range ( 'italic' or 'normal' ). |
set Font Styles(fontStyles) | Range | Sets a rectangular grid of font styles (must match dimensions of this range). |
set Font Weight(fontWeight) | Range | Set the font weight for the given range (normal/bold). |
set Font Weights(fontWeights) | Range | Sets a rectangular grid of font weights (must match dimensions of this range). |
set Formula(formula) | Range | Updates the formula for this range. |
set Formula R1C1(formula) | Range | Updates the formula for this range. |
set Formulas(formulas) | Range | Sets a rectangular grid of formulas (must match dimensions of this range). |
set Formulas R1C1(formulas) | Range | Sets a rectangular grid of formulas (must match dimensions of this range). |
set Horizontal Alignment(alignment) | Range | Set the horizontal (left to right) alignment for the given range (left/center/right). |
set Horizontal Alignments(alignments) | Range | Sets a rectangular grid of horizontal alignments. |
set Note(note) | Range | Sets the note to the given value. |
set Notes(notes) | Range | Sets a rectangular grid of notes (must match dimensions of this range). |
set Number Format(numberFormat) | Range | Sets the number or date format to the given formatting string. |
set Number Formats(numberFormats) | Range | Sets a rectangular grid of number or date formats (must match dimensions of this range). |
set Rich Text Value(value) | Range | Sets the Rich Text value for the cells in the range. |
set Rich Text Values(values) | Range | Sets a rectangular grid of Rich Text values. |
set Show Hyperlink(showHyperlink) | Range | Sets whether or not the range should show hyperlinks. |
set Text Direction(direction) | Range | Sets the text direction for the cells in the range. |
set Text Directions(directions) | Range | Sets a rectangular grid of text directions. |
set Text Rotation(degrees) | Range | Sets the text rotation settings for the cells in the range. |
set Text Rotation(rotation) | Range | Sets the text rotation settings for the cells in the range. |
set Text Rotations(rotations) | Range | Sets a rectangular grid of text rotations. |
set Text Style(style) | Range | Sets the text style for the cells in the range. |
set Text Styles(styles) | Range | Sets a rectangular grid of text styles. |
set Value(value) | Range | Sets the value of the range. |
set Values(values) | Range | Sets a rectangular grid of values (must match dimensions of this range). |
set Vertical Alignment(alignment) | Range | Set the vertical (top to bottom) alignment for the given range (top/middle/bottom). |
set Vertical Alignments(alignments) | Range | Sets a rectangular grid of vertical alignments (must match dimensions of this range). |
set Vertical Text(isVertical) | Range | Sets whether or not to stack the text for the cells in the range. |
set Wrap(isWrapEnabled) | Range | Set the cell wrap of the given range. |
set Wrap Strategies(strategies) | Range | Sets a rectangular grid of wrap strategies. |
set Wrap Strategy(strategy) | Range | Sets the text wrapping strategy for the cells in the range. |
set Wraps(isWrapEnabled) | Range | Sets a rectangular grid of word wrap policies (must match dimensions of this range). |
shift Column Group Depth(delta) | Range | Changes the column grouping depth of the range by the specified amount. |
shift Row Group Depth(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. |
split Text To Columns() | void | Splits a column of text into multiple columns based on an auto-detected delimiter. |
split Text To Columns(delimiter) | void | Splits a column of text into multiple columns using the specified string as a custom delimiter. |
split Text To Columns(delimiter) | void | Splits a column of text into multiple columns based on the specified delimiter. |
trim Whitespace() | 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”. |
Range List
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
activate() | Range List | Selects the list of Range instances. |
break Apart() | Range List | Break all horizontally- or vertically-merged cells contained within the range list into individual cells again. |
check() | Range List | Changes the state of the checkboxes in the range to “checked”. |
clear() | Range List | Clears the range of contents, formats, and data validation rules for each Range in the range list. |
clear(options) | Range List | Clears the range of contents, format, data validation rules, and comments, as specified with the given options. |
clear Content() | Range List | Clears the content of each Range in the range list, leaving the formatting intact. |
clear Data Validations() | Range List | Clears the data validation rules for each Range in the range list. |
clear Format() | Range List | Clears text formatting for each Range in the range list. |
clear Note() | Range List | Clears the note for each Range in the range list. |
get Ranges() | Range[] | Returns a list of one or more Range instances in the same sheet. |
insert Checkboxes() | Range List | Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked. |
insert Checkboxes(checkedValue) | Range List | Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked. |
insert Checkboxes(checkedValue, uncheckedValue) | Range List | Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states. |
remove Checkboxes() | Range List | Removes all checkboxes from the range. |
set Background(color) | Range List | Sets the background color for each Range in the range list. |
set Background RGB(red, green, blue) | Range List | Sets the background to the given RGB color. |
set Border(top, left, bottom, right, vertical, horizontal) | Range List | Sets the border property for each Range in the range list. |
set Border(top, left, bottom, right, vertical, horizontal, color, style) | Range List | Sets the border property with color and/or style for each Range in the range list. |
set Font Color(color) | Range List | Sets the font color for each Range in the range list. |
set Font Family(fontFamily) | Range List | Sets the font family for each Range in the range list. |
set Font Line(fontLine) | Range List | Sets the font line style for each Range in the range list. |
set Font Size(size) | Range List | Sets the font size (in points) for each Range in the range list. |
set Font Style(fontStyle) | Range List | Set the font style for each Range in the range list. |
set Font Weight(fontWeight) | Range List | Set the font weight for each Range in the range list. |
set Formula(formula) | Range List | Updates the formula for each Range in the range list. |
set Formula R1C1(formula) | Range List | Updates the formula for each Range in the range list. |
set Horizontal Alignment(alignment) | Range List | Set the horizontal alignment for each Range in the range list. |
set Note(note) | Range List | Sets the note text for each Range in the range list. |
set Number Format(numberFormat) | Range List | Sets the number or date format for each Range in the range list. |
set Show Hyperlink(showHyperlink) | Range List | Sets whether or not each Range in the range list should show hyperlinks. |
set Text Direction(direction) | Range List | Sets the text direction for the cells in each Range in the range list. |
set Text Rotation(degrees) | Range List | Sets the text rotation settings for the cells in each Range in the range list. |
set Value(value) | Range List | Sets the value for each Range in the range list. |
set Vertical Alignment(alignment) | Range List | Set the vertical alignment for each Range in the range list. |
set Vertical Text(isVertical) | Range List | Sets whether or not to stack the text for the cells for each Range in the range list. |
set Wrap(isWrapEnabled) | Range List | Set text wrapping for each Range in the range list. |
set Wrap Strategy(strategy) | Range List | Sets the text wrapping strategy for each Range in the range list. |
trim Whitespace() | Range List | Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range list. |
uncheck() | Range List | Changes the state of the checkboxes in the range to “unchecked”. |
Recalculation Interval
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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. |
Relative Date
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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. |
Rich Text Value
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Rich Text Value Builder | Returns a builder for a Rich Text value initialized with the values of this Rich Text value. |
get End Index() | Integer | Gets the end index of this value in the cell. |
get Link Url() | String|null | Returns the link URL for this value. |
get Link Url(startOffset, endOffset) | String|null | Returns the link URL for the text from start Offset to end Offset . |
get Runs() | Rich Text Value[] | Returns the Rich Text string split into an array of runs, wherein each run is the longest possible substring having a consistent text style. |
get Start Index() | Integer | Gets the start index of this value in the cell. |
get Text() | String | Returns the text of this value. |
get Text Style() | Text Style | Returns the text style of this value. |
get Text Style(startOffset, endOffset) | Text Style | Returns the text style of the text from start Offset to end Offset . |
Rich Text Value Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Rich Text Value | Creates a Rich Text value from this builder. |
set Link Url(startOffset, endOffset, linkUrl) | Rich Text Value Builder | Sets the link URL for the given substring of this value, or clears it if link Url is null . |
set Link Url(linkUrl) | Rich Text Value Builder | Sets the link URL for the entire value, or clears it if link Url is null . |
set Text(text) | Rich Text Value Builder | Sets the text for this value and clears any existing text style. |
set Text Style(startOffset, endOffset, textStyle) | Rich Text Value Builder | Applies a text style to the given substring of this value. |
set Text Style(textStyle) | Rich Text Value Builder | Applies a text style to the entire value. |
Selection
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Active Range() | Range |null | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Active Sheet() | Sheet | Returns the active sheet in the spreadsheet. |
get Current Cell() | Range |null | Returns the current (highlighted) cell that is selected in one of the active ranges or null if there is no current cell. |
get Next Data Range(direction) | Range |null | 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. |
add Developer Metadata(key) | Sheet | Adds developer metadata with the specified key to the sheet. |
add Developer Metadata(key, visibility) | Sheet | Adds developer metadata with the specified key and visibility to the sheet. |
add Developer Metadata(key, value) | Sheet | Adds developer metadata with the specified key and value to the sheet. |
add Developer Metadata(key, value, visibility) | Sheet | Adds developer metadata with the specified key, value, and visibility to the sheet. |
append Row(rowContents) | Sheet | Appends a row to the bottom of the current data region in the sheet. |
as Data Source Sheet() | Data Source Sheet |null | Returns the sheet as a Data Source Sheet if the sheet is of type Sheet Type.DATASOURCE , or null otherwise. |
auto Resize Column(columnPosition) | Sheet | Sets the width of the given column to fit its contents. |
auto Resize Columns(startColumn, numColumns) | Sheet | Sets the width of all columns starting at the given column position to fit their contents. |
auto Resize Rows(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. |
clear Conditional Format Rules() | void | Removes all conditional format rules from the sheet. |
clear Contents() | Sheet | Clears the sheet of contents, while preserving formatting information. |
clear Formats() | Sheet | Clears the sheet of formatting, while preserving contents. |
clear Notes() | Sheet | Clears the sheet of all notes. |
collapse All Column Groups() | Sheet | Collapses all column groups on the sheet. |
collapse All Row Groups() | Sheet | Collapses all row groups on the sheet. |
copy To(spreadsheet) | Sheet | Copies the sheet to a given spreadsheet, which can be the same spreadsheet as the source. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a Developer Metadata Finder for finding developer metadata within the scope of this sheet. |
create Text Finder(findText) | Text Finder | Creates a text finder for the sheet, which can find and replace text within the sheet. |
delete Column(columnPosition) | Sheet | Deletes the column at the given column position. |
delete Columns(columnPosition, howMany) | void | Deletes a number of columns starting at the given column position. |
delete Row(rowPosition) | Sheet | Deletes the row at the given row position. |
delete Rows(rowPosition, howMany) | void | Deletes a number of rows starting at the given row position. |
expand All Column Groups() | Sheet | Expands all column groups on the sheet. |
expand All Row Groups() | Sheet | Expands all row groups on the sheet. |
expand Column Groups Up To Depth(groupDepth) | Sheet | Expands all column groups up to the given depth, and collapses all others. |
expand Row Groups Up To Depth(groupDepth) | Sheet | Expands all row groups up to the given depth, and collapses all others. |
get Active Cell() | Range | Returns the active cell in this sheet. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Bandings() | Banding[] | Returns all the bandings in this sheet. |
get Charts() | Embedded Chart[] | Returns an array of charts on this sheet. |
get Column Group(columnIndex, groupDepth) | Group |null | Returns the column group at the given index and group depth. |
get Column Group Control Position() | Group Control Toggle Position | Returns the Group Control Toggle Position for all column groups on the sheet. |
get Column Group Depth(columnIndex) | Integer | Returns the group depth of the column at the given index. |
get Column Width(columnPosition) | Integer | Gets the width in pixels of the given column. |
get Conditional Format Rules() | Conditional Format Rule[] | Get all conditional format rules in this sheet. |
get Current Cell() | Range |null | Returns the current cell in the active sheet or null if there is no current cell. |
get Data Range() | Range | Returns a Range corresponding to the dimensions in which data is present. |
get Data Source Formulas() | Data Source Formula[] | Gets all the data source formulas. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables. |
get Developer Metadata() | Developer Metadata[] | Get all developer metadata associated with this sheet. |
get Drawings() | Drawing[] | Returns an array of drawings on the sheet. |
get Filter() | Filter |null | Returns the filter in this sheet, or null if there is no filter. |
get Form Url() | String|null | Returns the URL for the form that sends its responses to this sheet, or null if this sheet has no associated form. |
get Frozen Columns() | Integer | Returns the number of frozen columns. |
get Frozen Rows() | Integer | Returns the number of frozen rows. |
get Images() | Over Grid Image[] | Returns all over-the-grid images on the sheet. |
get Index() | Integer | Gets the position of the sheet in its parent spreadsheet. |
get Last Column() | Integer | Returns the position of the last column that has content. |
get Last Row() | Integer | Returns the position of the last row that has content. |
get Max Columns() | Integer | Returns the current number of columns in the sheet, regardless of content. |
get Max Rows() | Integer | Returns the current number of rows in the sheet, regardless of content. |
get Name() | String | Returns the name of the sheet. |
get Named Ranges() | Named Range[] | Gets all the named ranges in this sheet. |
get Parent() | Spreadsheet | Returns the Spreadsheet that contains this sheet. |
get Pivot Tables() | Pivot Table[] | Returns all the pivot tables on this sheet. |
get Protections(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. |
get Range(row, column) | Range | Returns the range with the top left cell at the given coordinates. |
get Range(row, column, numRows) | Range | Returns the range with the top left cell at the given coordinates, and with the given number of rows. |
get Range(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. |
get Range(a1Notation) | Range | Returns the range as specified in A1 notation or R1C1 notation. |
get Range List(a1Notations) | Range List | Returns the Range List collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations. |
get Row Group(rowIndex, groupDepth) | Group |null | Returns the row group at the given index and group depth. |
get Row Group Control Position() | Group Control Toggle Position | Returns the Group Control Toggle Position for all row groups on the sheet. |
get Row Group Depth(rowIndex) | Integer | Returns the group depth of the row at the given index. |
get Row Height(rowPosition) | Integer | Gets the height in pixels of the given row. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Sheet Id() | Integer | Returns the ID of the sheet represented by this object. |
get Sheet Name() | String | Returns the sheet name. |
get Sheet Values(startRow, startColumn, numRows, numColumns) | Object[][] | Returns the rectangular grid of values for this range starting at the given coordinates. |
get Slicers() | Slicer[] | Returns an array of slicers on the sheet. |
get Tab Color Object() | Color |null | Gets the sheet tab color, or null if the sheet tab has no color. |
get Type() | Sheet Type | Returns the type of the sheet. |
has Hidden Gridlines() | Boolean | Returns true if the sheet's gridlines are hidden; otherwise returns false . |
hide Column(column) | void | Hides the column or columns in the given range. |
hide Columns(columnIndex) | void | Hides a single column at the given index. |
hide Columns(columnIndex, numColumns) | void | Hides one or more consecutive columns starting at the given index. |
hide Row(row) | void | Hides the rows in the given range. |
hide Rows(rowIndex) | void | Hides the row at the given index. |
hide Rows(rowIndex, numRows) | void | Hides one or more consecutive rows starting at the given index. |
hide Sheet() | Sheet | Hides this sheet. |
insert Chart(chart) | void | Adds a new chart to this sheet. |
insert Column After(afterPosition) | Sheet | Inserts a column after the given column position. |
insert Column Before(beforePosition) | Sheet | Inserts a column before the given column position. |
insert Columns(columnIndex) | void | Inserts a blank column in a sheet at the specified location. |
insert Columns(columnIndex, numColumns) | void | Inserts one or more consecutive blank columns in a sheet starting at the specified location. |
insert Columns After(afterPosition, howMany) | Sheet | Inserts a given number of columns after the given column position. |
insert Columns Before(beforePosition, howMany) | Sheet | Inserts a number of columns before the given column position. |
insert Image(blobSource, column, row) | Over Grid Image | Inserts a Blob Source as an image in the document at a given row and column. |
insert Image(blobSource, column, row, offsetX, offsetY) | Over Grid Image | Inserts a Blob Source as an image in the document at a given row and column, with a pixel offset. |
insert Image(url, column, row) | Over Grid Image | Inserts an image in the document at a given row and column. |
insert Image(url, column, row, offsetX, offsetY) | Over Grid Image | Inserts an image in the document at a given row and column, with a pixel offset. |
insert Row After(afterPosition) | Sheet | Inserts a row after the given row position. |
insert Row Before(beforePosition) | Sheet | Inserts a row before the given row position. |
insert Rows(rowIndex) | void | Inserts a blank row in a sheet at the specified location. |
insert Rows(rowIndex, numRows) | void | Inserts one or more consecutive blank rows in a sheet starting at the specified location. |
insert Rows After(afterPosition, howMany) | Sheet | Inserts a number of rows after the given row position. |
insert Rows Before(beforePosition, howMany) | Sheet | Inserts a number of rows before the given row position. |
insert Slicer(range, anchorRowPos, anchorColPos) | Slicer | Adds a new slicer to this sheet. |
insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Adds a new slicer to this sheet. |
is Column Hidden By User(columnPosition) | Boolean | Returns whether the given column is hidden by the user. |
is Right To Left() | Boolean | Returns true if this sheet layout is right-to-left. |
is Row Hidden By Filter(rowPosition) | Boolean | Returns whether the given row is hidden by a filter (not a filter view). |
is Row Hidden By User(rowPosition) | Boolean | Returns whether the given row is hidden by the user. |
is Sheet Hidden() | Boolean | Returns true if the sheet is currently hidden. |
move Columns(columnSpec, destinationIndex) | void | Moves the columns selected by the given range to the position indicated by the destination Index . |
move Rows(rowSpec, destinationIndex) | void | Moves the rows selected by the given range to the position indicated by the destination Index . |
new Chart() | Embedded Chart Builder | 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. |
remove Chart(chart) | void | Removes a chart from the parent sheet. |
set Active Range(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 . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges in the active sheet. |
set Active Selection(range) | Range | Sets the active selection region for this sheet. |
set Active Selection(a1Notation) | Range | Sets the active selection, as specified in A1 notation or R1C1 notation. |
set Column Group Control Position(position) | Sheet | Sets the position of the column group control toggle on the sheet. |
set Column Width(columnPosition, width) | Sheet | Sets the width of the given column in pixels. |
set Column Widths(startColumn, numColumns, width) | Sheet | Sets the width of the given columns in pixels. |
set Conditional Format Rules(rules) | void | Replaces all currently existing conditional format rules in the sheet with the input rules. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
set Frozen Columns(columns) | void | Freezes the given number of columns. |
set Frozen Rows(rows) | void | Freezes the given number of rows. |
set Hidden Gridlines(hideGridlines) | Sheet | Hides or reveals the sheet gridlines. |
set Name(name) | Sheet | Sets the sheet name. |
set Right To Left(rightToLeft) | Sheet | Sets or unsets the sheet layout to right-to-left. |
set Row Group Control Position(position) | Sheet | Sets the position of the row group control toggle on the sheet. |
set Row Height(rowPosition, height) | Sheet | Sets the row height of the given row in pixels. |
set Row Heights(startRow, numRows, height) | Sheet | Sets the height of the given rows in pixels. |
set Row Heights Forced(startRow, numRows, height) | Sheet | Sets the height of the given rows in pixels. |
set Tab Color(color) | Sheet | Sets the sheet tab color. |
set Tab Color Object(color) | Sheet | Sets the sheet tab color. |
show Columns(columnIndex) | void | Unhides the column at the given index. |
show Columns(columnIndex, numColumns) | void | Unhides one or more consecutive columns starting at the given index. |
show Rows(rowIndex) | void | Unhides the row at the given index. |
show Rows(rowIndex, numRows) | void | Unhides one or more consecutive rows starting at the given index. |
show Sheet() | Sheet | Makes the sheet visible. |
sort(columnPosition) | Sheet | Sorts a sheet by column, ascending. |
sort(columnPosition, ascending) | Sheet | Sorts a sheet by column. |
unhide Column(column) | void | Unhides the column in the given range. |
unhide Row(row) | void | Unhides the row in the given range. |
update Chart(chart) | void | Updates the chart on this sheet. |
Sheet Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
GRID | Enum | A sheet containing a grid. |
OBJECT | Enum | A sheet containing a single embedded object such as an Embedded Chart . |
DATASOURCE | Enum | A sheet containing a Data Source . |
Slicer
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Background Color Object() | Color |null | Return the background Color of the slicer. |
get Column Position() | Integer|null | 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. |
get Container Info() | Container Info | Gets information about where the slicer is positioned in the sheet. |
get Filter Criteria() | Filter Criteria |null | Returns the filter criteria of the slicer, or null if the filter criteria is not set. |
get Range() | Range | Gets the data range on which the slicer is applied to. |
get Title() | String | Returns the title of the slicer. |
get Title Horizontal Alignment() | String | Gets the horizontal alignment of the title. |
get Title Text Style() | Text Style | Returns the text style of the slicer's title. |
is Applied To Pivot Tables() | Boolean | Returns whether the given slicer is applied to pivot tables. |
remove() | void | Deletes the slicer. |
set Apply To Pivot Tables(applyToPivotTables) | Slicer | Sets if the given slicer should be applied to pivot tables in the worksheet. |
set Background Color(color) | Slicer | Sets the background color of the slicer. |
set Background Color Object(color) | Slicer | Sets the background Color of the slicer. |
set Column Filter Criteria(columnPosition, filterCriteria) | Slicer | Sets the column index and filtering criteria of the slicer. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Sets the position where the slicer appears on the sheet. |
set Range(rangeApi) | Slicer | Sets the data range on which the slicer is applied. |
set Title(title) | Slicer | Sets the title of the slicer. |
set Title Horizontal Alignment(horizontalAlignment) | Slicer | Sets the horizontal alignment of the title in the slicer. |
set Title Text Style(textStyle) | Slicer | Sets the text style of the slicer. |
Sort Order
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
ASCENDING | Enum | Ascending sort order. |
DESCENDING | Enum | Descending sort order. |
Sort Spec
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Background Color() | Color |null | Returns the background color used for sorting, or null if absent. |
get Data Source Column() | Data Source Column |null | Gets the data source column the sort spec acts on. |
get Dimension Index() | Integer|null | Returns the dimension index or null if not linked to a local filter. |
get Foreground Color() | Color |null | Returns the foreground color used for sorting, or null if absent. |
get Sort Order() | Sort Order | Returns the sort order. |
is Ascending() | Boolean | Returns whether the sort order is ascending. |
Spreadsheet
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
add Developer Metadata(key) | Spreadsheet | Adds developer metadata with the specified key to the top-level spreadsheet. |
add Developer Metadata(key, visibility) | Spreadsheet | Adds developer metadata with the specified key and visibility to the spreadsheet. |
add Developer Metadata(key, value) | Spreadsheet | Adds developer metadata with the specified key and value to the spreadsheet. |
add Developer Metadata(key, value, visibility) | Spreadsheet | Adds developer metadata with the specified key, value, and visibility to the spreadsheet. |
add Editor(emailAddress) | Spreadsheet | Adds the given user to the list of editors for the Spreadsheet . |
add Editor(user) | Spreadsheet | Adds the given user to the list of editors for the Spreadsheet . |
add Editors(emailAddresses) | Spreadsheet | Adds the given array of users to the list of editors for the Spreadsheet . |
add Menu(name, subMenus) | void | Creates a new menu in the Spreadsheet UI. |
add Viewer(emailAddress) | Spreadsheet | Adds the given user to the list of viewers for the Spreadsheet . |
add Viewer(user) | Spreadsheet | Adds the given user to the list of viewers for the Spreadsheet . |
add Viewers(emailAddresses) | Spreadsheet | Adds the given array of users to the list of viewers for the Spreadsheet . |
append Row(rowContents) | Sheet | Appends a row to the bottom of the current data region in the sheet. |
auto Resize Column(columnPosition) | Sheet | Sets the width of the given column to fit its contents. |
copy(name) | Spreadsheet | Copies the spreadsheet and returns the new one. |
create Developer Metadata Finder() | Developer Metadata Finder | Returns a Developer Metadata Finder for finding developer metadata within the scope of this spreadsheet. |
create Text Finder(findText) | Text Finder | Creates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet. |
delete Active Sheet() | Sheet | Deletes the currently active sheet. |
delete Column(columnPosition) | Sheet | Deletes the column at the given column position. |
delete Columns(columnPosition, howMany) | void | Deletes a number of columns starting at the given column position. |
delete Row(rowPosition) | Sheet | Deletes the row at the given row position. |
delete Rows(rowPosition, howMany) | void | Deletes a number of rows starting at the given row position. |
delete Sheet(sheet) | void | Deletes the specified sheet. |
duplicate Active Sheet() | Sheet | Duplicates the active sheet and makes it the active sheet. |
get Active Cell() | Range | Returns the active cell in this sheet. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no active ranges. |
get Active Sheet() | Sheet | Gets the active sheet in a spreadsheet. |
get As(contentType) | Blob | Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого. |
get Bandings() | Banding[] | Returns all the bandings in this spreadsheet. |
get Blob() | Blob | Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob). |
get Column Width(columnPosition) | Integer | Gets the width in pixels of the given column. |
get Current Cell() | Range |null | Returns the current cell in the active sheet or null if there is no current cell. |
get Data Range() | Range | Returns a Range corresponding to the dimensions in which data is present. |
get Data Source Formulas() | Data Source Formula[] | Gets all the data source formulas. |
get Data Source Pivot Tables() | Data Source Pivot Table[] | Gets all the data source pivot tables. |
get Data Source Refresh Schedules() | Data Source Refresh Schedule[] | Gets the refresh schedules of this spreadsheet. |
get Data Source Sheets() | Data Source Sheet[] | Returns all the data source sheets in the spreadsheet. |
get Data Source Tables() | Data Source Table[] | Gets all the data source tables. |
get Data Sources() | Data Source[] | Returns all the data sources in the spreadsheet. |
get Developer Metadata() | Developer Metadata[] | Gets the developer metadata associated with the top-level spreadsheet. |
get Editors() | User[] | Gets the list of editors for this Spreadsheet . |
get Form Url() | String | Returns the URL for the form that sends its responses to this spreadsheet, or null if this spreadsheet has no associated form. |
get Frozen Columns() | Integer | Returns the number of frozen columns. |
get Frozen Rows() | Integer | Returns the number of frozen rows. |
get Id() | String | Gets a unique identifier for this spreadsheet. |
get Images() | Over Grid Image[] | Returns all over-the-grid images on the sheet. |
get Iterative Calculation Convergence Threshold() | Number | Returns the threshold value used during iterative calculation. |
get Last Column() | Integer | Returns the position of the last column that has content. |
get Last Row() | Integer | Returns the position of the last row that has content. |
get Max Iterative Calculation Cycles() | Integer | Returns the maximum number of iterations to use during iterative calculation. |
get Name() | String | Gets the name of the document. |
get Named Ranges() | Named Range[] | Gets all the named ranges in this spreadsheet. |
get Num Sheets() | Integer | Returns the number of sheets in this spreadsheet. |
get Owner() | User | Returns the owner of the document, or null for a document in a shared drive. |
get Predefined Spreadsheet Themes() | Spreadsheet Theme[] | Returns the list of predefined themes. |
get Protections(type) | Protection[] | Gets an array of objects representing all protected ranges or sheets in the spreadsheet. |
get Range(a1Notation) | Range | Returns the range as specified in A1 notation or R1C1 notation. |
get Range By Name(name) | Range | Returns a named range, or null if no range with the given name is found. |
get Range List(a1Notations) | Range List | Returns the Range List collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations. |
get Recalculation Interval() | Recalculation Interval | Returns the calculation interval for this spreadsheet. |
get Row Height(rowPosition) | Integer | Gets the height in pixels of the given row. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Sheet By Id(id) | Sheet |null | Gets the sheet with the given ID. |
get Sheet By Name(name) | Sheet | Returns a sheet with the given name. |
get Sheet Id() | Integer | Returns the ID of the sheet represented by this object. |
get Sheet Name() | String | Returns the sheet name. |
get Sheet Values(startRow, startColumn, numRows, numColumns) | Object[][] | Returns the rectangular grid of values for this range starting at the given coordinates. |
get Sheets() | Sheet[] | Gets all the sheets in this spreadsheet. |
get Spreadsheet Locale() | String | Gets the spreadsheet locale. |
get Spreadsheet Theme() | Spreadsheet Theme |null | Returns the current theme of the spreadsheet, or null if no theme is applied. |
get Spreadsheet Time Zone() | String | Gets the time zone for the spreadsheet. |
get Url() | String | Returns the URL for the given spreadsheet. |
get Viewers() | User[] | Gets the list of viewers and commenters for this Spreadsheet . |
hide Column(column) | void | Hides the column or columns in the given range. |
hide Row(row) | void | Hides the rows in the given range. |
insert Column After(afterPosition) | Sheet | Inserts a column after the given column position. |
insert Column Before(beforePosition) | Sheet | Inserts a column before the given column position. |
insert Columns After(afterPosition, howMany) | Sheet | Inserts a given number of columns after the given column position. |
insert Columns Before(beforePosition, howMany) | Sheet | Inserts a number of columns before the given column position. |
insert Data Source Sheet(spec) | Data Source Sheet | Inserts a new Data Source Sheet in the spreadsheet and starts data execution. |
insert Image(blobSource, column, row) | Over Grid Image | Inserts a Spreadsheet as an image in the document at a given row and column. |
insert Image(blobSource, column, row, offsetX, offsetY) | Over Grid Image | Inserts a Spreadsheet as an image in the document at a given row and column, with a pixel offset. |
insert Image(url, column, row) | Over Grid Image | Inserts an image in the document at a given row and column. |
insert Image(url, column, row, offsetX, offsetY) | Over Grid Image | Inserts an image in the document at a given row and column, with a pixel offset. |
insert Row After(afterPosition) | Sheet | Inserts a row after the given row position. |
insert Row Before(beforePosition) | Sheet | Inserts a row before the given row position. |
insert Rows After(afterPosition, howMany) | Sheet | Inserts a number of rows after the given row position. |
insert Rows Before(beforePosition, howMany) | Sheet | Inserts a number of rows before the given row position. |
insert Sheet() | Sheet | Inserts a new sheet into the spreadsheet, using a default sheet name. |
insert Sheet(sheetIndex) | Sheet | Inserts a new sheet into the spreadsheet at the given index. |
insert Sheet(sheetIndex, options) | Sheet | Inserts a new sheet into the spreadsheet at the given index and uses optional advanced arguments. |
insert Sheet(options) | Sheet | Inserts a new sheet into the spreadsheet, using a default sheet name and optional advanced arguments. |
insert Sheet(sheetName) | Sheet | Inserts a new sheet into the spreadsheet with the given name. |
insert Sheet(sheetName, sheetIndex) | Sheet | Inserts a new sheet into the spreadsheet with the given name at the given index. |
insert Sheet(sheetName, sheetIndex, options) | Sheet | Inserts a new sheet into the spreadsheet with the given name at the given index and uses optional advanced arguments. |
insert Sheet(sheetName, options) | Sheet | Inserts a new sheet into the spreadsheet with the given name and uses optional advanced arguments. |
insert Sheet With Data Source Table(spec) | Sheet | Inserts a new sheet in the spreadsheet, creates a Data Source Table spanning the entire sheet with the given data source specification, and starts data execution. |
is Column Hidden By User(columnPosition) | Boolean | Returns whether the given column is hidden by the user. |
is Iterative Calculation Enabled() | Boolean | Returns whether iterative calculation is activated in this spreadsheet. |
is Row Hidden By Filter(rowPosition) | Boolean | Returns whether the given row is hidden by a filter (not a filter view). |
is Row Hidden By User(rowPosition) | Boolean | Returns whether the given row is hidden by the user. |
move Active Sheet(pos) | void | Moves the active sheet to the given position in the list of sheets. |
move Chart To Object Sheet(chart) | Sheet | Creates a new Sheet Type.OBJECT sheet and moves the provided chart to it. |
refresh All Data Sources() | void | Refreshes all supported data sources and their linked data source objects, skipping invalid data source objects. |
remove Editor(emailAddress) | Spreadsheet | Removes the given user from the list of editors for the Spreadsheet . |
remove Editor(user) | Spreadsheet | Removes the given user from the list of editors for the Spreadsheet . |
remove Menu(name) | void | Removes a menu that was added by add Menu(name, subMenus) . |
remove Named Range(name) | void | Deletes a named range with the given name. |
remove Viewer(emailAddress) | Spreadsheet | Removes the given user from the list of viewers and commenters for the Spreadsheet . |
remove Viewer(user) | Spreadsheet | Removes the given user from the list of viewers and commenters for the Spreadsheet . |
rename(newName) | void | Renames the document. |
rename Active Sheet(newName) | void | Renames the current active sheet to the given new name. |
reset Spreadsheet Theme() | Spreadsheet Theme | Removes the applied theme and sets the default theme on the spreadsheet. |
set Active Range(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 . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges in the active sheet. |
set Active Selection(range) | Range | Sets the active selection region for this sheet. |
set Active Selection(a1Notation) | Range | Sets the active selection, as specified in A1 notation or R1C1 notation. |
set Active Sheet(sheet) | Sheet | Sets the given sheet to be the active sheet in the spreadsheet. |
set Active Sheet(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. |
set Column Width(columnPosition, width) | Sheet | Sets the width of the given column in pixels. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
set Frozen Columns(columns) | void | Freezes the given number of columns. |
set Frozen Rows(rows) | void | Freezes the given number of rows. |
set Iterative Calculation Convergence Threshold(minThreshold) | Spreadsheet | Sets the minimum threshold value for iterative calculation. |
set Iterative Calculation Enabled(isEnabled) | Spreadsheet | Sets whether iterative calculation is activated in this spreadsheet. |
set Max Iterative Calculation Cycles(maxIterations) | Spreadsheet | Sets the maximum number of calculation iterations that should be performed during iterative calculation. |
set Named Range(name, range) | void | Names a range. |
set Recalculation Interval(recalculationInterval) | Spreadsheet | Sets how often this spreadsheet should recalculate. |
set Row Height(rowPosition, height) | Sheet | Sets the row height of the given row in pixels. |
set Spreadsheet Locale(locale) | void | Sets the spreadsheet locale. |
set Spreadsheet Theme(theme) | Spreadsheet Theme | Sets a theme on the spreadsheet. |
set Spreadsheet Time Zone(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. |
unhide Column(column) | void | Unhides the column in the given range. |
unhide Row(row) | void | Unhides the row in the given range. |
update Menu(name, subMenus) | void | Updates a menu that was added by add Menu(name, subMenus) . |
wait For All Data Executions Completion(timeoutInSeconds) | void | Waits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds. |
Spreadsheet App
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
Auto Fill Series | Auto Fill Series | An enumeration of the types of series used to calculate auto-filled values. |
Banding Theme | Banding Theme | An enumeration of the possible banding themes. |
Boolean Criteria | Boolean Criteria | An enumeration of conditional formatting boolean criteria. |
Border Style | Border Style | An enumeration of the valid styles for setting borders on a Range . |
Color Type | Color Type | An enumeration of possible color types. |
Copy Paste Type | Copy Paste Type | An enumeration of the possible paste types. |
Data Execution Error Code | Data Execution Error Code | An enumeration of the possible data execution error codes. |
Data Execution State | Data Execution State | An enumeration of the possible data execution states. |
Data Source Parameter Type | Data Source Parameter Type | An enumeration of the possible data source parameter types. |
Data Source Refresh Scope | Data Source Refresh Scope | An enumeration of possible data source refresh scopes. |
Data Source Type | Data Source Type | An enumeration of the possible data source types. |
Data Validation Criteria | Data Validation Criteria | An enumeration representing the data validation criteria that can be set on a range. |
Date Time Grouping Rule Type | Date Time Grouping Rule Type | An enumeration of date time grouping rule. |
Developer Metadata Location Type | Developer Metadata Location Type | An enumeration of possible developer metadata location types. |
Developer Metadata Visibility | Developer Metadata Visibility | An enumeration of the possible developer metadata visibilities. |
Dimension | Dimension | An enumeration of the possible dimensions of a spreadsheet. |
Direction | Direction | A enumeration of the possible directions that one can move within a spreadsheet using the arrow keys. |
Frequency Type | Frequency Type | An enumeration of possible frequency types. |
Group Control Toggle Position | Group Control Toggle Position | An enumeration of the positions that the group control toggle can be in. |
Interpolation Type | Interpolation Type | An enumeration of conditional format gradient interpolation types. |
Pivot Table Summarize Function | Pivot Table Summarize Function | An enumeration of the functions that may be used to summarize values in a pivot table. |
Pivot Value Display Type | Pivot Value Display Type | An enumeration of the ways that a pivot value may be displayed. |
Protection Type | Protection Type | An enumeration representing the parts of a spreadsheet that can be protected from edits. |
Recalculation Interval | Recalculation Interval | An enumeration of the possible intervals that can be used in spreadsheet recalculation. |
Relative Date | Relative Date | An enumeration of relative date options for calculating a value to be used in date-based Boolean Criteria . |
Sheet Type | Sheet Type | An enumeration of the different types of sheets that can exist in a spreadsheet. |
Sort Order | Sort Order | An enumeration of sort order. |
Text Direction | Text Direction | An enumeration of valid text directions. |
Text To Columns Delimiter | Text To Columns Delimiter | An enumeration of the preset delimiters for split text to columns. |
Theme Color Type | Theme Color Type | An enumeration of possible theme color types. |
Value Type | Value Type | An enumeration of value types returned by Range.getValue() and Range.getValues() from the Range class of the Spreadsheet service. |
Wrap Strategy | Wrap Strategy | An enumeration of the strategies used for wrapping cells. |
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
create(name) | Spreadsheet | Creates a new spreadsheet with the given name. |
create(name, rows, columns) | Spreadsheet | Creates a new spreadsheet with the given name and the specified number of rows and columns. |
enable All Data Sources Execution() | void | Turns data execution on for all types of data sources. |
enable Big Query Execution() | void | Turns data execution on for BigQuery data sources. |
enable Looker Execution() | void | Turns data execution on for Looker data sources. |
flush() | void | Applies all pending Spreadsheet changes. |
get Active() | Spreadsheet | Returns the currently active spreadsheet, or null if there is none. |
get Active Range() | Range | Returns the selected range in the active sheet, or null if there is no active range. |
get Active Range List() | Range List |null | Returns the list of active ranges in the active sheet or null if there are no ranges selected. |
get Active Sheet() | Sheet | Gets the active sheet in a spreadsheet. |
get Active Spreadsheet() | Spreadsheet | Returns the currently active spreadsheet, or null if there is none. |
get Current Cell() | Range |null | Returns the current (highlighted) cell that is selected in one of the active ranges in the active sheet or null if there is no current cell. |
get Selection() | Selection | Returns the current Selection in the spreadsheet. |
get Ui() | Ui | Returns an instance of the spreadsheet's user-interface environment that allows the script to add features like menus, dialogs, and sidebars. |
new Cell Image() | Cell Image Builder | Creates a builder for a Cell Image . |
new Color() | Color Builder | Creates a builder for a Color . |
new Conditional Format Rule() | Conditional Format Rule Builder | Creates a builder for a conditional formatting rule. |
new Data Source Spec() | Data Source Spec Builder | Creates a builder for a Data Source Spec . |
new Data Validation() | Data Validation Builder | Creates a builder for a data validation rule. |
new Filter Criteria() | Filter Criteria Builder | Creates a builder for a Filter Criteria . |
new Rich Text Value() | Rich Text Value Builder | Creates a builder for a Rich Text value. |
new Text Style() | Text Style Builder | Creates a builder for a text style. |
open(file) | Spreadsheet | Opens the spreadsheet that corresponds to the given File object. |
open By Id(id) | Spreadsheet | Opens the spreadsheet with the given ID. |
open By Url(url) | Spreadsheet | Opens the spreadsheet with the given URL. |
set Active Range(range) | Range | Sets the specified range as the active range , with the top left cell in the range as the current cell . |
set Active Range List(rangeList) | Range List | Sets the specified list of ranges as the active ranges . |
set Active Sheet(sheet) | Sheet | Sets the active sheet in a spreadsheet. |
set Active Sheet(sheet, restoreSelection) | Sheet | Sets the active sheet in a spreadsheet, with the option to restore the most recent selection within that sheet. |
set Active Spreadsheet(newActiveSpreadsheet) | void | Sets the active spreadsheet. |
set Current Cell(cell) | Range | Sets the specified cell as the current cell . |
Spreadsheet Theme
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Concrete Color(themeColorType) | Color | Returns the concrete Color for a valid theme color type. |
get Font Family() | String|null | Returns the font family of the theme, or null if it's a null theme. |
get Theme Colors() | Theme Color Type[] | Returns a list of all possible theme color types for the current theme. |
set Concrete Color(themeColorType, color) | Spreadsheet Theme | Sets the concrete color associated with the Theme Color Type in this color scheme to the given color. |
set Concrete Color(themeColorType, red, green, blue) | Spreadsheet Theme | Sets the concrete color associated with the Theme Color Type in this color scheme to the given color in RGB format. |
set Font Family(fontFamily) | Spreadsheet Theme | Sets the font family for the theme. |
Text Direction
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
LEFT_TO_RIGHT | Enum | Left-to-right text direction. |
RIGHT_TO_LEFT | Enum | Right-to-left text direction. |
Text Finder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
find All() | Range[] | Returns all cells matching the search criteria. |
find Next() | Range | Returns the next cell matching the search criteria. |
find Previous() | Range | Returns the previous cell matching the search criteria. |
get Current Match() | Range | Returns the current cell matching the search criteria. |
ignore Diacritics(ignoreDiacritics) | Text Finder | If true , configures the search to ignore diacritics while matching; otherwise the search matches diacritics. |
match Case(matchCase) | Text Finder | If true , configures the search to match the search text's case exactly, otherwise the search defaults to case-insensitive matching. |
match Entire Cell(matchEntireCell) | Text Finder | If true , configures the search to match the entire contents of a cell; otherwise, the search defaults to partial matching. |
match Formula Text(matchFormulaText) | Text Finder | If true , configures the search to return matches that appear within formula text; otherwise cells with formulas are considered based on their displayed value. |
replace All With(replaceText) | Integer | Replaces all matches with the specified text. |
replace With(replaceText) | Integer | Replaces the search text in the currently matched cell with the specified text and returns the number of occurrences replaced. |
start From(startRange) | Text Finder | Configures the search to start searching immediately after the specified cell range. |
use Regular Expression(useRegEx) | Text Finder | If true , configures the search to interpret the search string as a regular expression; otherwise the search interprets the search string as normal text. |
Text Rotation
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Degrees() | Integer | Gets the angle between standard text orientation and the current text orientation. |
is Vertical() | Boolean | Returns true if the text is stacked vertically; returns false otherwise. |
Text Style
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Text Style Builder | Creates a text style builder initialized with the values of this text style. |
get Font Family() | String | Gets the font family of the text. |
get Font Size() | Integer | Gets the font size of the text in points. |
get Foreground Color Object() | Color |null | Gets the font color of the text. |
is Bold() | Boolean | Gets whether or not the text is bold. |
is Italic() | Boolean | Gets whether or not the cell is italic. |
is Strikethrough() | Boolean | Gets whether or not the cell has strikethrough. |
is Underline() | Boolean | Gets whether or not the cell is underlined. |
Text Style Builder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Text Style | Creates a text style from this builder. |
set Bold(bold) | Text Style Builder | Sets whether or not the text is bold. |
set Font Family(fontFamily) | Text Style Builder | Sets the text font family, such as "Arial". |
set Font Size(fontSize) | Text Style Builder | Sets the text font size in points. |
set Foreground Color(cssString) | Text Style Builder | Sets the text font color. |
set Foreground Color Object(color) | Text Style Builder | Sets the text font color. |
set Italic(italic) | Text Style Builder | Sets whether or not the text is italic. |
set Strikethrough(strikethrough) | Text Style Builder | Sets whether or not the text has strikethrough. |
set Underline(underline) | Text Style Builder | Sets whether or not the text is underlined. |
Text To Columns Delimiter
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
COMMA | Enum | "," delimiter. |
SEMICOLON | Enum | ";" delimiter. |
PERIOD | Enum | "." delimiter. |
SPACE | Enum | " " delimiter. |
Theme Color
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
get Color Type() | Color Type | Get the type of this color. |
get Theme Color Type() | Theme Color Type | Gets the theme color type of this color. |
Theme Color Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Represents a theme color that is not supported. |
TEXT | Enum | Represents the text color. |
BACKGROUND | Enum | Represents the color to use for chart's background. |
ACCENT1 | Enum | Represents the first accent color. |
ACCENT2 | Enum | Represents the second accent color. |
ACCENT3 | Enum | Represents the third accent color. |
ACCENT4 | Enum | Represents the fourth accent color. |
ACCENT5 | Enum | Represents the fifth accent color. |
ACCENT6 | Enum | Represents the sixth accent color. |
HYPERLINK | Enum | Represents the color to use for hyperlinks. |
Value Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
IMAGE | Enum | The value type when the cell contains an image. |
Wrap Strategy
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
WRAP | Enum | Wrap lines that are longer than the cell width onto a new line. |
OVERFLOW | Enum | Overflow lines into the next cell, so long as that cell is empty. |
CLIP | Enum | Clip lines that are longer than the cell width. |