Этот сервис позволяет сценариям создавать, получать доступ и изменять файлы 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 Таблиц. |
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 Sheets. |
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 службы электронных таблиц. |
Wrap Strategy | Перечень стратегий, используемых для обработки переноса текста в ячейках. |
Auto Fill Series
Характеристики
Свойство | Тип | Описание |
---|---|---|
DEFAULT_SERIES | Enum | По умолчанию. |
ALTERNATE_SERIES | Enum | Автозаполнение с помощью этого параметра приводит к тому, что пустые ячейки в расширенном диапазоне заполняются копиями существующих значений. |
Banding
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy To(range) | Banding | Копирует эту полосу в другой диапазон. |
get First Column Color Object() | Color | Возвращает первый чередующийся цвет столбца в полосе или null , если цвет не задан. |
get First Row Color Object() | Color | Возвращает цвет первой альтернативной строки или null , если цвет не задан. |
get Footer Column Color Object() | Color | Возвращает цвет последнего столбца в полосе или null , если цвет не задан. |
get Footer Row Color Object() | Color | Возвращает цвет последней строки в полосе или null , если цвет не задан. |
get Header Column Color Object() | Color | Возвращает цвет первого столбца в полосе или null , если цвет не задан. |
get Header Row Color Object() | Color | Возвращает цвет строки заголовка или null если цвет не задан. |
get Range() | Range | Возвращает диапазон для этого диапазона. |
get Second Column Color Object() | Color | Возвращает второй цвет переменного столбца в полосе или null , если цвет не задан. |
get Second Row Color Object() | Color | Возвращает второй цвет альтернативной строки или 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 | Получает цвет фона для этого логического условия. |
get Bold() | Boolean | Возвращает true , если это логическое условие выделяет текст жирным шрифтом, и возвращает false если это логическое условие удаляет выделение из текста. |
get Criteria Type() | Boolean Criteria | Получает тип критерия правила, определенный в перечислении Boolean Criteria . |
get Criteria Values() | Object[] | Получает массив аргументов для критериев правила. |
get Font Color Object() | Color | Получает цвет шрифта для этого логического условия. |
get Italic() | Boolean | Возвращает true , если это логическое условие выделяет текст курсивом, и возвращает false если это логическое условие удаляет курсив из текста. |
get Strikethrough() | Boolean | Возвращает true , если это логическое условие зачеркивает текст, и возвращает false если это логическое условие удаляет зачеркивание из текста. |
get Underline() | Boolean | Возвращает 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. |
get Url() | String | Получает исходный URL-адрес изображения; возвращает null если URL-адрес недоступен. |
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. |
get Url() | String | Получает исходный URL-адрес изображения; возвращает null если URL-адрес недоступен. |
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 | Извлекает информацию Boolean Condition правила, если это правило использует логические критерии условия. |
get Gradient Condition() | Gradient Condition | Извлекает информацию Gradient Condition правила, если это правило использует критерии условия градиента. |
get Ranges() | Range[] | Извлекает диапазоны, к которым применяется это правило условного форматирования. |
Conditional Format Rule Builder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | Conditional Format Rule | Создает правило условного форматирования на основе настроек, примененных к построителю. |
copy() | Conditional Format Rule Builder | Возвращает набор настроек построителя правил с настройками этого правила. |
get Boolean Condition() | Boolean Condition | Извлекает информацию Boolean Condition правила, если это правило использует логические критерии условия. |
get Gradient Condition() | Gradient Condition | Извлекает информацию 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 | Очищает значение максимальной точки градиента правила условного формата и вместо этого использует максимальное значение в диапазонах правила. |
set Gradient Maxpoint Object(color) | Conditional Format Rule Builder | Очищает значение максимальной точки градиента правила условного формата и вместо этого использует максимальное значение в диапазонах правила. |
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 | Устанавливает поля minpoint градиента правила условного формата. |
set Gradient Minpoint With Value(color, type, value) | Conditional Format Rule Builder | Устанавливает поля minpoint градиента правила условного формата. |
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 | Код ошибки выполнения данных, который не поддерживается в скрипте приложений. |
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 | Получает время завершения последнего выполнения данных независимо от состояния выполнения. |
get Last Refreshed Time() | Date | Получает время последнего успешного обновления данных. |
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 | Возвращает вычисляемый столбец в источнике данных, соответствующий имени столбца. |
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 , если тип параметра отличается от 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 | Возвращает ширину указанного столбца. |
get Data Source() | Data Source | Получает источник данных, с которым связан объект. |
get Filters() | Data Source Sheet Filter[] | Возвращает все фильтры, примененные к листу источника данных. |
get Sheet Values(columnName) | Object[] | Возвращает все значения листа источника данных для указанного имени столбца. |
get Sheet Values(columnName, startRow, numRows) | Object[] | Возвращает все значения для листа источника данных для указанного имени столбца, начиная с предоставленной начальной строки (на основе 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 | Возвращает ограничение на количество строк для таблицы источника данных. |
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 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 (который представляет Jan-Mar). |
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 | Возвращает Range для местоположения столбца этих метаданных или null , если тип местоположения не является Developer Metadata Location Type.COLUMN . Column. |
get Location Type() | Developer Metadata Location Type | Получает тип местоположения. |
get Row() | Range | Возвращает Range для расположения строки этих метаданных, или null , если тип местоположения не является Developer Metadata Location Type.ROW . |
get Sheet() | Sheet | Возвращает местоположение Sheet этих метаданных, или null , если тип местоположения не является Developer Metadata Location Type.SHEET . |
get Spreadsheet() | Spreadsheet | Возвращает местоположение 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 | Направление уменьшения индексов столбцов. |
NEXT | Enum | Направление увеличения индексов столбцов. |
Drawing
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
get Container Info() | Container Info | Получает информацию о том, где рисунок расположен в листе. |
get Height() | Integer | Возвращает фактическую высоту этого рисунка в пикселях. |
get On Action() | String | Возвращает название макроса, прикрепленного к этому рисунку. |
get Sheet() | Sheet | Возвращает лист, на этот рисунок появляется. |
get Width() | Integer | Возвращает фактическую ширину этого рисунка в пикселях. |
get ZIndex() | Number | Возвращает Z-индекс этого рисунка. |
remove() | void | Удаляет этот рисунок из электронной таблицы. |
set Height(height) | Drawing | Устанавливает фактическую высоту этого рисунка в пикселях. |
set On Action(macroName) | Drawing | Присваивает макрофункцию этому рисунку. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Устанавливает позицию, где на листе появляется чертеж. |
set Width(width) | Drawing | Устанавливает фактическую ширину этого рисунка в пикселях. |
set ZIndex(zIndex) | Drawing | Устанавливает Z-индекс этого рисунка. |
Embedded Area Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Area Chart Builder | Отправляет чертеж серии в доменной оси. |
set Background Color(cssValue) | Embedded Area Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Area Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Area Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Point Style(style) | Embedded Area Chart Builder | Устанавливает стиль для очков в линии. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Area Chart Builder | Устанавливает диапазон для диаграммы. |
set Stacked() | Embedded Area Chart Builder | Использует сложенные линии, что означает, что значения линий и шарниров сложены (накопленные). |
set Title(chartTitle) | Embedded Area Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Area Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Area Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Area Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Area Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Bar Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Bar Chart Builder | Отправляет чертеж серии в доменной оси. |
reverse Direction() | Embedded Bar Chart Builder | Обращает направление, в котором полосы растут вдоль горизонтальной оси. |
set Background Color(cssValue) | Embedded Bar Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Bar Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Bar Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Bar Chart Builder | Устанавливает диапазон для диаграммы. |
set Stacked() | Embedded Bar Chart Builder | Использует сложенные линии, что означает, что значения линий и шарниров сложены (накопленные). |
set Title(chartTitle) | Embedded Bar Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Bar Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Bar Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Bar Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Bar Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Chart
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
as Data Source Chart() | Data Source Chart | Приводит к экземпляру диаграммы источника данных, если диаграмма является диаграммой источника данных или в противном случае null . |
get As(contentType) | Blob | Верните данные внутри этого объекта в виде пятна, преобразованной в указанный тип контента. |
get Blob() | Blob | Верните данные внутри этого объекта в виде капли. |
get Chart Id() | Integer | Возвращает стабильный идентификатор для диаграммы, которая является уникальной в электронной таблице, содержащей диаграмму или null если диаграмма не находится в электронной таблице. |
get Container Info() | Container Info | Возвращает информацию о том, где диаграмма расположена в листе. |
get Hidden Dimension Strategy() | Chart Hidden Dimension Strategy | Возвращает стратегию для использования для обработки скрытых рядов и столбцов. |
get Merge Strategy() | Chart Merge Strategy | Возвращает стратегию слияния, используемой, когда существует более одного диапазона. |
get Num Headers() | Integer | Возвращает количество строк или столбцов, диапазон, которые рассматриваются как заголовки. |
get Options() | Chart Options | Возвращает варианты для этой таблицы, таких как высота, цвета и топоры. |
get Ranges() | Range[] | Возвращает диапазоны, которые эта диаграмма использует в качестве источника данных. |
get Transpose Rows And Columns() | Boolean | Если true , строки и столбцы, используемые для заполнения диаграммы, переключаются. |
modify() | Embedded Chart Builder | Возвращает Embedded Chart Builder , который можно использовать для изменения этой диаграммы. |
Embedded Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
Embedded Column Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Column Chart Builder | Отправляет чертеж серии в доменной оси. |
set Background Color(cssValue) | Embedded Column Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Column Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Column Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Column Chart Builder | Устанавливает диапазон для диаграммы. |
set Stacked() | Embedded Column Chart Builder | Использует сложенные линии, что означает, что значения линий и шарниров сложены (накопленные). |
set Title(chartTitle) | Embedded Column Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Column Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Column Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Column Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Column Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Combo Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Combo Chart Builder | Отправляет чертеж серии в доменной оси. |
set Background Color(cssValue) | Embedded Combo Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Combo Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Combo Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Combo Chart Builder | Устанавливает диапазон для диаграммы. |
set Stacked() | Embedded Combo Chart Builder | Использует сложенные линии, что означает, что значения линий и шарниров сложены (накопленные). |
set Title(chartTitle) | Embedded Combo Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Combo Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Combo Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Combo Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Combo Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Histogram Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Histogram Chart Builder | Отправляет чертеж серии в доменной оси. |
set Background Color(cssValue) | Embedded Histogram Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Histogram Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Histogram Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Histogram Chart Builder | Устанавливает диапазон для диаграммы. |
set Stacked() | Embedded Histogram Chart Builder | Использует сложенные линии, что означает, что значения линий и шарниров сложены (накопленные). |
set Title(chartTitle) | Embedded Histogram Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Histogram Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Histogram Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Histogram Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Histogram Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Line Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Line Chart Builder | Отправляет чертеж серии в доменной оси. |
set Background Color(cssValue) | Embedded Line Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Line Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Curve Style(style) | Embedded Line Chart Builder | Устанавливает стиль для использования для кривых в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Line Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Point Style(style) | Embedded Line Chart Builder | Устанавливает стиль для очков в линии. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Range(start, end) | Embedded Line Chart Builder | Устанавливает диапазон для диаграммы. |
set Title(chartTitle) | Embedded Line Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Line Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Line Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Line Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
use Log Scale() | Embedded Line Chart Builder | Делает ось диапазона в логарифмическую шкалу (требует, чтобы все значения были положительными). |
Embedded Pie Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
reverse Categories() | Embedded Pie Chart Builder | Отправляет чертеж серии в доменной оси. |
set3D() | Embedded Pie Chart Builder | Устанавливает диаграмму трехмерной. |
set Background Color(cssValue) | Embedded Pie Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Pie Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Pie Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Pie Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Title(chartTitle) | Embedded Pie Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Pie Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
Embedded Scatter Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
set Background Color(cssValue) | Embedded Scatter Chart Builder | Устанавливает цвет фона для диаграммы. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set Colors(cssValues) | Embedded Scatter Chart Builder | Устанавливает цвета для линий в диаграмме. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Legend Position(position) | Embedded Scatter Chart Builder | Устанавливает позицию легенды относительно диаграммы. |
set Legend Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает текстовый стиль легенды диаграммы. |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Point Style(style) | Embedded Scatter Chart Builder | Устанавливает стиль для очков в линии. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Title(chartTitle) | Embedded Scatter Chart Builder | Устанавливает название диаграммы. |
set Title Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает текстовый стиль названия диаграммы. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
set XAxis Log Scale() | Embedded Scatter Chart Builder | Делает горизонтальную ось в логарифмическую шкалу (требует, чтобы все значения были положительными). |
set XAxis Range(start, end) | Embedded Scatter Chart Builder | Устанавливает диапазон для горизонтальной оси диаграммы. |
set XAxis Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает стиль текста горизонтальной оси. |
set XAxis Title(title) | Embedded Scatter Chart Builder | Добавляет заголовок к горизонтальной оси. |
set XAxis Title Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает стиль текста титула горизонтальной оси. |
set YAxis Log Scale() | Embedded Scatter Chart Builder | Делает вертикальную ось в логарифмическую шкалу (требует, чтобы все значения были положительными). |
set YAxis Range(start, end) | Embedded Scatter Chart Builder | Устанавливает диапазон для вертикальной оси диаграммы. |
set YAxis Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает стиль текста вертикальной оси. |
set YAxis Title(title) | Embedded Scatter Chart Builder | Добавляет заголовок к вертикальной оси. |
set YAxis Title Text Style(textStyle) | Embedded Scatter Chart Builder | Устанавливает стиль текста Text Text Vertical Axis. |
Embedded Table Chart Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
add Range(range) | Embedded Chart Builder | Добавляет диапазон в диаграмму, который модифицирует этот строитель. |
as Area Chart() | Embedded Area Chart Builder | Устанавливает тип диаграммы в Areachart и возвращает Embedded Area Chart Builder . |
as Bar Chart() | Embedded Bar Chart Builder | Устанавливает тип диаграммы в Барчарт и возвращает Embedded Bar Chart Builder . |
as Column Chart() | Embedded Column Chart Builder | Устанавливает тип диаграммы на ColumnThart и возвращает Embedded Column Chart Builder . |
as Combo Chart() | Embedded Combo Chart Builder | Устанавливает тип диаграммы в ComboChart и возвращает Embedded Combo Chart Builder . |
as Histogram Chart() | Embedded Histogram Chart Builder | Устанавливает тип диаграммы в HistogramChart и возвращает Embedded Histogram Chart Builder . |
as Line Chart() | Embedded Line Chart Builder | Устанавливает тип диаграммы в LineChart и возвращает Embedded Line Chart Builder . |
as Pie Chart() | Embedded Pie Chart Builder | Устанавливает тип диаграммы в PieChart и возвращает Embedded Pie Chart Builder . |
as Scatter Chart() | Embedded Scatter Chart Builder | Устанавливает тип диаграммы в ScatterChart и возвращает Embedded Scatter Chart Builder . |
as Table Chart() | Embedded Table Chart Builder | Устанавливает тип диаграммы в TableChart и возвращает Embedded Table Chart Builder . |
build() | Embedded Chart | Создает диаграмму, чтобы отразить все изменения, внесенные в нее. |
clear Ranges() | Embedded Chart Builder | Удаляет все диапазоны из диаграммы, который модифицирует этот строитель. |
enable Paging(enablePaging) | Embedded Table Chart Builder | Устанавливает, включает ли пейджин через данные. |
enable Paging(pageSize) | Embedded Table Chart Builder | Включает пейджинг и устанавливает количество строк на каждой странице. |
enable Paging(pageSize, startPage) | Embedded Table Chart Builder | Включает Paging, устанавливает количество строк на каждой странице и первой странице таблицы для отображения (номера страниц основаны на нулевом). |
enable Rtl Table(rtlEnabled) | Embedded Table Chart Builder | Добавляет основную поддержку языков с правым на леле (например, арабский или иврит) путем отмены порядка столбца таблицы, так что ноль столбец является самого столбца, а последний столбец-самый левый столбец. |
enable Sorting(enableSorting) | Embedded Table Chart Builder | Устанавливает, следует ли сортировать столбцы, когда пользователь нажимает заголовок столбца. |
get Chart Type() | Chart Type | Возвращает текущий тип диаграммы. |
get Container() | Container Info | Верните Container Info диаграммы, которая инкапсулирует, где на листе появляется диаграмма. |
get Ranges() | Range[] | Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. |
remove Range(range) | Embedded Chart Builder | Удаляет указанный диапазон из диаграммы, который модифицирует этот строитель. |
set Chart Type(type) | Embedded Chart Builder | Меняет тип диаграммы. |
set First Row Number(number) | Embedded Table Chart Builder | Устанавливает номер строки для первой строки в таблице данных. |
set Hidden Dimension Strategy(strategy) | Embedded Chart Builder | Устанавливает стратегию для использования для скрытых рядов и столбцов. |
set Initial Sorting Ascending(column) | Embedded Table Chart Builder | Устанавливает индекс столбца, в соответствии с которым таблица должна быть изначально отсортирована (восходящая). |
set Initial Sorting Descending(column) | Embedded Table Chart Builder | Устанавливает индекс столбца, в соответствии с которым таблица должна быть изначально отсортирована (спуск). |
set Merge Strategy(mergeStrategy) | Embedded Chart Builder | Устанавливает стратегию слияния для использования, когда существует более одного диапазона. |
set Num Headers(headers) | Embedded Chart Builder | Устанавливает количество строк или столбцов диапазона, которые следует рассматривать как заголовки. |
set Option(option, value) | Embedded Chart Builder | Устанавливает расширенные параметры для этой диаграммы. |
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) | Embedded Chart Builder | Устанавливает позицию, изменяя там, где на листе появляется диаграмма. |
set Transpose Rows And Columns(transpose) | Embedded Chart Builder | Устанавливает, транспонируются ли ряды и столбцы диаграммы. |
show Row Number Column(showRowNumber) | Embedded Table Chart Builder | Устанавливает, показывать ли номер строки в качестве первого столбца таблицы. |
use Alternating Row Style(alternate) | Embedded Table Chart Builder | Устанавливает, назначается ли чередующий стиль цвета для нечетных и даже рядов таблицы. |
Filter
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
get Column Filter Criteria(columnPosition) | Filter Criteria | Получает критерии фильтра на указанном столбце или null , если к нему не применяется критерии фильтра. |
get Range() | Range | Получает диапазон, к которому применяется этот фильтр. |
remove() | void | Удаляет этот фильтр. |
remove Column Filter Criteria(columnPosition) | Filter | Удаляет критерии фильтра из указанного столбца. |
set Column Filter Criteria(columnPosition, filterCriteria) | Filter | Устанавливает критерии фильтра в указанном столбце. |
sort(columnPosition, ascending) | Filter | Сортирует отфильтрованный диапазон по указанному столбцу, за исключением первой строки (строка заголовка) в диапазоне, к которому применяется этот фильтр. |
Filter Criteria
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
copy() | Filter Criteria Builder | Копирует эти критерии фильтра и создает строитель критериев, который вы можете применить к другому фильтру. |
get Criteria Type() | Boolean Criteria | Возвращает логический тип критериев, например, CELL_EMPTY . |
get Criteria Values() | Object[] | Возвращает множество аргументов для логических критериев. |
get Hidden Values() | String[] | Возвращает значения, которые скрывает фильтр. |
get Visible Background Color() | Color | Возвращает цвет фона, используемый в качестве критериев фильтра. |
get Visible Foreground Color() | Color | Возвращает цвет переднего плана, используемый в качестве критериев фильтра. |
get Visible Values() | String[] | Возвращает значения, которые показывает фильтр Table Pivot. |
Filter Criteria Builder
Методы
Метод | Возврат тип | Краткое описание |
---|---|---|
build() | Filter Criteria | Соберите критерии фильтра, используя настройки, которые вы добавляете в строитель критериев. |
copy() | Filter Criteria Builder | Копирует эти критерии фильтра и создает строитель критериев, который вы можете применить к другому фильтру. |
get Criteria Type() | Boolean Criteria | Возвращает логический тип критериев, например, CELL_EMPTY . |
get Criteria Values() | Object[] | Возвращает множество аргументов для логических критериев. |
get Hidden Values() | String[] | Возвращает значения, которые скрывает фильтр. |
get Visible Background Color() | Color | Возвращает цвет фона, используемый в качестве критериев фильтра. |
get Visible Foreground Color() | Color | Возвращает цвет переднего плана, используемый в качестве критериев фильтра. |
get Visible Values() | String[] | Возвращает значения, которые показывает фильтр Table Pivot. |
set Hidden Values(values) | Filter Criteria Builder | Устанавливает значения, чтобы скрыть. |
set Visible Background Color(visibleBackgroundColor) | Filter Criteria Builder | Устанавливает цвет фона, используемый в качестве критериев фильтра. |
set Visible Foreground Color(visibleForegroundColor) | Filter Criteria Builder | Устанавливает цвет переднего плана, используемый в качестве критериев фильтра. |
set Visible Values(values) | Filter Criteria Builder | Устанавливает значения для отображения на поворотной таблице. |
when Cell Empty() | Filter Criteria Builder | Устанавливает критерии фильтра, чтобы показать пустые ячейки. |
when Cell Not Empty() | Filter Criteria Builder | Устанавливает критерии фильтра, чтобы показать ячейки, которые не пустые. |
when Date After(date) | Filter Criteria Builder | Устанавливает критерии фильтра, которые показывают ячейки с датами, которые находятся после указанной даты. |
when Date After(date) | Filter Criteria Builder | Устанавливает критерии фильтра, которые показывают ячейки с датами, которые находятся после указанной относительной даты. |
when Date Before(date) | Filter Criteria Builder | Устанавливает критерии фильтра, которые показывают ячейки с датами, которые находятся до указанной даты. |
when Date Before(date) | Filter Criteria Builder | Устанавливает критерии фильтра, которые показывают ячейки с датами, которые находятся до указанной относительной даты. |
when Date Equal To(date) | Filter Criteria Builder | Устанавливает критерии фильтра, которые показывают ячейки с датами, равными указанной дате. |
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
get Max Color Object() | Color | Gets the color set for the maximum value of this gradient condition. |
get Max Type() | Interpolation Type | 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 | Gets the color set for the midpoint value of this gradient condition. |
get Mid Type() | Interpolation Type | Gets the interpolation type for the mid-point value of this gradient condition. |
get Mid Value() | String | Gets the mid-point value of this gradient condition. |
get Min Color Object() | Color | Gets the color set for the minimum value of this gradient condition. |
get Min Type() | Interpolation Type | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 Url() | String | Gets the image's source URL; returns null if the URL is unavailable. |
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | 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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | 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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | Returns the link URL for this value. |
get Link Url(startOffset, endOffset) | String | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | 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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | 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 | 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 | 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 | Returns the filter in this sheet, or null if there is no filter. |
get Form Url() | String | 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 | 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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
get Background Color Object() | Color | Return the background Color of the slicer. |
get Column Position() | Integer | Returns the column position (relative to the data range of the slicer) on which the filter is applied in the slicer, or null if the column position is not set. |
get Container Info() | Container Info | Gets information about where the slicer is positioned in the sheet. |
get Filter Criteria() | Filter Criteria | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
get Background Color() | Color | Returns the background color used for sorting, or null if absent. |
get Data Source Column() | Data Source Column | Gets the data source column the sort spec acts on. |
get Dimension Index() | Integer | Returns the dimension index or null if not linked to a local filter. |
get Foreground Color() | Color | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | Return the data inside this object as a blob converted to the specified content type. |
get Bandings() | Banding[] | Returns all the bandings in this spreadsheet. |
get Blob() | Blob | Return the data inside this object as a blob. |
get Column Width(columnPosition) | Integer | Gets the width in pixels of the given column. |
get Current Cell() | Range | 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 | 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 | 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. |
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
get Concrete Color(themeColorType) | Color | Returns the concrete Color for a valid theme color type. |
get Font Family() | String | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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 | 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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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
Методы
Метод | Return type | Краткое описание |
---|---|---|
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. |