Эта служба позволяет сценариям создавать, получать доступ и изменять файлы Google Sheets. См. также руководство по хранению данных в электронных таблицах .
Иногда операции с электронными таблицами объединяются для повышения производительности, например, при выполнении нескольких вызовов метода. Если вы хотите убедиться, что все ожидающие изменения внесены сразу же, например, чтобы показать пользователям информацию во время выполнения скрипта, вызовите SpreadsheetApp.flush()
.
Классы
Имя | Краткое описание |
---|---|
AutoFillSeries | Перечисление типов рядов, используемых для вычисления автоматически заполняемых значений. |
Banding | Доступ и изменение полос, цветовых шаблонов, применяемых к строкам или столбцам диапазона. |
BandingTheme | Перечень тем бандинга. |
BigQueryDataSourceSpec | Получите доступ к существующей спецификации источника данных BigQuery. |
BigQueryDataSourceSpecBuilder | Построитель для BigQueryDataSourceSpecBuilder . |
BooleanCondition | Доступ к логическим условиям в ConditionalFormatRules . |
BooleanCriteria | Перечисление, представляющее логические критерии, которые можно использовать в условном формате или фильтре. |
BorderStyle | Стили, которые можно задать для диапазона с помощью Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) . |
CellImage | Представляет изображение для добавления в ячейку. |
CellImageBuilder | Конструктор для CellImage . |
Color | Представление для цвета. |
ColorBuilder | Конструктор для ColorBuilder . |
ConditionalFormatRule | Доступ к правилам условного форматирования. |
ConditionalFormatRuleBuilder | Построитель правил условного форматирования. |
ContainerInfo | Доступ к положению диаграммы на листе. |
CopyPasteType | Перечень возможных типов специальных паст. |
DataExecutionErrorCode | Перечисление кодов ошибок выполнения данных. |
DataExecutionState | Перечисление состояний выполнения данных. |
DataExecutionStatus | Статус выполнения данных. |
DataSource | Доступ и изменение существующего источника данных. |
DataSourceChart | Получите доступ к существующей диаграмме источника данных и измените ее. |
DataSourceColumn | Доступ и изменение столбца источника данных. |
DataSourceFormula | Доступ и изменение существующих формул источника данных. |
DataSourceParameter | Получите доступ к существующим параметрам источника данных. |
DataSourceParameterType | Перечисление типов параметров источника данных. |
DataSourcePivotTable | Доступ и изменение существующей сводной таблицы источника данных. |
DataSourceRefreshSchedule | Получите доступ к существующему расписанию обновления и измените его. |
DataSourceRefreshScheduleFrequency | Получите доступ к частоте обновления расписания, которая указывает, как часто и когда обновлять. |
DataSourceRefreshScope | Перечисление областей для обновлений. |
DataSourceSheet | Получите доступ к существующему листу источника данных и измените его. |
DataSourceSheetFilter | Получите доступ к существующему фильтру листа источника данных и измените его. |
DataSourceSpec | Доступ к общим настройкам существующей спецификации источника данных. |
DataSourceSpecBuilder | Построитель для DataSourceSpec . |
DataSourceTable | Доступ и изменение существующей таблицы источника данных. |
DataSourceTableColumn | Получите доступ к существующему столбцу в DataSourceTable и измените его. |
DataSourceTableFilter | Получите доступ к существующему фильтру таблицы источника данных и измените его. |
DataSourceType | Перечисление типов источников данных. |
DataValidation | Доступ к правилам проверки данных. |
DataValidationBuilder | Построитель правил проверки данных. |
DataValidationCriteria | Перечисление, представляющее критерии проверки данных, которые можно задать для диапазона. |
DateTimeGroupingRule | Доступ к существующему правилу группировки даты и времени. |
DateTimeGroupingRuleType | Типы правил группировки даты и времени. |
DeveloperMetadata | Доступ и изменение метаданных разработчика. |
DeveloperMetadataFinder | Найдите метаданные разработчика в электронной таблице. |
DeveloperMetadataLocation | Получите доступ к информации о расположении метаданных разработчика. |
DeveloperMetadataLocationType | Перечисление типов расположения метаданных разработчика. |
DeveloperMetadataVisibility | Перечисление типов видимости метаданных разработчика. |
Dimension | Перечисление возможных направлений, по которым данные могут храниться в электронной таблице. |
Direction | Перечисление, представляющее возможные направления, в которых можно перемещаться в электронной таблице с помощью клавиш со стрелками. |
Drawing | Представляет рисунок на листе электронной таблицы. |
EmbeddedAreaChartBuilder | Построитель диаграмм с областями. |
EmbeddedBarChartBuilder | Построитель гистограмм. |
EmbeddedChart | Представляет диаграмму, встроенную в электронную таблицу. |
EmbeddedChartBuilder | Builder, используемый для редактирования EmbeddedChart . |
EmbeddedColumnChartBuilder | Построитель столбчатых диаграмм. |
EmbeddedComboChartBuilder | Построитель комбинированных диаграмм. |
EmbeddedHistogramChartBuilder | Построитель гистограмм. |
EmbeddedLineChartBuilder | Построитель линейных диаграмм. |
EmbeddedPieChartBuilder | Построитель круговых диаграмм. |
EmbeddedScatterChartBuilder | Построитель точечных диаграмм. |
EmbeddedTableChartBuilder | Построитель табличных диаграмм. |
Filter | Используйте этот класс для изменения существующих фильтров на листах Grid , типе листа по умолчанию. |
FilterCriteria | Используйте этот класс, чтобы получить информацию или скопировать критерии существующих фильтров. |
FilterCriteriaBuilder | Чтобы добавить критерии к фильтру, необходимо сделать следующее:
|
FrequencyType | Перечень частотных типов. |
GradientCondition | Доступ к условиям градиента (цвета) в ConditionalFormatRuleApis . |
Group | Доступ и изменение групп электронных таблиц. |
GroupControlTogglePosition | Перечисление, представляющее возможные позиции, которые может иметь переключатель управления группой. |
InterpolationType | Перечисление, представляющее параметры интерполяции для вычисления значения, используемого в GradientCondition в ConditionalFormatRule . |
NamedRange | Создавайте, получайте доступ и изменяйте именованные диапазоны в электронной таблице. |
OverGridImage | Представляет изображение над сеткой в электронной таблице. |
| Доступ и изменение защищенных листов в старой версии Google Sheets. |
PivotFilter | Доступ и изменение фильтров сводной таблицы. |
PivotGroup | Доступ и изменение секционных групп сводной таблицы. |
PivotGroupLimit | Доступ и изменение ограничения группы сводной таблицы. |
PivotTable | Доступ и изменение сводных таблиц. |
PivotTableSummarizeFunction | Перечисление функций, обобщающих данные сводной таблицы. |
PivotValue | Доступ и изменение групп значений в сводных таблицах. |
PivotValueDisplayType | Перечисление способов отображения сводного значения как функции другого значения. |
Protection | Доступ и изменение защищенных диапазонов и листов. |
ProtectionType | Перечисление, представляющее части электронной таблицы, которые можно защитить от редактирования. |
Range | Доступ и изменение диапазонов электронных таблиц. |
RangeList | Коллекция из одного или нескольких экземпляров Range на одном листе. |
RecalculationInterval | Перечисление, представляющее возможные интервалы, используемые при пересчете электронной таблицы. |
RelativeDate | Перечисление, представляющее параметры относительной даты для вычисления значения, которое будет использоваться в BooleanCriteria на основе даты. |
RichTextValue | Стилизованная текстовая строка, используемая для представления текста ячейки. |
RichTextValueBuilder | Построитель для значений Rich Text. |
Selection | Доступ к текущему активному выбору на активном листе. |
Sheet | Доступ и изменение таблиц электронных таблиц. |
SheetType | Различные типы листов, которые могут существовать в электронной таблице. |
Slicer | Представляет срез , который используется для фильтрации диапазонов, диаграмм и сводных таблиц без совместной работы. |
SortOrder | Перечисление, представляющее порядок сортировки. |
SortSpec | Спецификация сортировки. |
Spreadsheet | Доступ и изменение файлов Google Sheets. |
SpreadsheetApp | Доступ и создание файлов Google Sheets. |
SpreadsheetTheme | Доступ и изменение существующих тем. |
TextDirection | Перечисления направлений текста. |
TextFinder | Поиск или замена текста в пределах диапазона, листа или электронной таблицы. |
TextRotation | Доступ к настройкам поворота текста для ячейки. |
TextStyle | Отображаемый стиль текста в ячейке. |
TextStyleBuilder | Конструктор текстовых стилей. |
TextToColumnsDelimiter | Перечисление типов предустановленных разделителей, которые могут разделить столбец текста на несколько столбцов. |
ThemeColor | Представление цвета темы. |
ThemeColorType | Перечисление, описывающее различные элементы цвета, поддерживаемые в темах. |
ValueType | Перечисление типов значений, возвращаемых функциями Range.getValue() и Range.getValues() из класса Range службы электронных таблиц. |
WrapStrategy | Перечисление стратегий, используемых для обработки переноса текста в ячейке. |
AutoFillSeries
Характеристики
Свойство | Тип | Описание |
---|---|---|
DEFAULT_SERIES | Enum | По умолчанию. |
ALTERNATE_SERIES | Enum | Автозаполнение с этим параметром приводит к тому, что пустые ячейки в расширенном диапазоне заполняются копиями существующих значений. |
Banding
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copyTo(range) | Banding | Копирует эту полосу в другой диапазон. |
getFirstColumnColorObject() | Color | Возвращает цвет первого чередующегося столбца в полосе или значение null , если цвет не задан. |
getFirstRowColorObject() | Color | Возвращает первый чередующийся цвет строки или null , если цвет не задан. |
getFooterColumnColorObject() | Color | Возвращает цвет последнего столбца в полосе или null , если цвет не задан. |
getFooterRowColorObject() | Color | Возвращает цвет последней строки в полосе или null , если цвет не задан. |
getHeaderColumnColorObject() | Color | Возвращает цвет первого столбца в полосе или null , если цвет не задан. |
getHeaderRowColorObject() | Color | Возвращает цвет строки заголовка или null , если цвет не задан. |
getRange() | Range | Возвращает диапазон для этого диапазона. |
getSecondColumnColorObject() | Color | Возвращает второй чередующийся цвет столбца в полосе или null , если цвет не задан. |
getSecondRowColorObject() | Color | Возвращает второй чередующийся цвет строки или null , если цвет не задан. |
remove() | void | Удаляет эту полосу. |
setFirstColumnColor(color) | Banding | Устанавливает чередующийся цвет первого столбца. |
setFirstColumnColorObject(color) | Banding | Задает цвет первого чередующегося столбца в полосе. |
setFirstRowColor(color) | Banding | Устанавливает чередующийся цвет первой строки. |
setFirstRowColorObject(color) | Banding | Устанавливает цвет первой чередующейся строки в полосе. |
setFooterColumnColor(color) | Banding | Устанавливает цвет последнего столбца. |
setFooterColumnColorObject(color) | Banding | Устанавливает цвет последнего столбца в полосе. |
setFooterRowColor(color) | Banding | Устанавливает цвет последней строки. |
setFooterRowColorObject(color) | Banding | Устанавливает цвет строки нижнего колонтитула в полосе. |
setHeaderColumnColor(color) | Banding | Устанавливает цвет столбца заголовка. |
setHeaderColumnColorObject(color) | Banding | Устанавливает цвет столбца заголовка. |
setHeaderRowColor(color) | Banding | Устанавливает цвет строки заголовка. |
setHeaderRowColorObject(color) | Banding | Устанавливает цвет строки заголовка. |
setRange(range) | Banding | Устанавливает диапазон для этой полосы. |
setSecondColumnColor(color) | Banding | Устанавливает чередующийся цвет второго столбца. |
setSecondColumnColorObject(color) | Banding | Устанавливает второй чередующийся цвет столбца в полосе. |
setSecondRowColor(color) | Banding | Устанавливает чередующийся цвет второй строки. |
setSecondRowColorObject(color) | Banding | Устанавливает второй чередующийся цвет в полосе. |
BandingTheme
Характеристики
Свойство | Тип | Описание |
---|---|---|
LIGHT_GREY | Enum | Тема со светло-серыми полосами. |
CYAN | Enum | Тема голубой полосы. |
GREEN | Enum | Зеленая полоса темы. |
YELLOW | Enum | Тема с желтыми полосами. |
ORANGE | Enum | Тема с оранжевой полосой. |
BLUE | Enum | Тема с синей полосой. |
TEAL | Enum | Тема бирюзовой полосы. |
GREY | Enum | Тема с серыми полосами. |
BROWN | Enum | Тема коричневых полос. |
LIGHT_GREEN | Enum | Тема светло-зеленых полос. |
INDIGO | Enum | Тема полос индиго. |
PINK | Enum | Тема с розовыми полосами. |
BigQueryDataSourceSpec
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy() | DataSourceSpecBuilder | Создает DataSourceSpecBuilder на основе настроек этого источника данных. |
getDatasetId() | String | Получает идентификатор набора данных BigQuery. |
getParameters() | DataSourceParameter[] | Получает параметры источника данных. |
getProjectId() | String | Получает идентификатор платежного проекта. |
getRawQuery() | String | Получает необработанную строку запроса. |
getTableId() | String | Получает идентификатор таблицы BigQuery. |
getTableProjectId() | String | Получает идентификатор проекта BigQuery для таблицы. |
getType() | DataSourceType | Получает тип источника данных. |
BigQueryDataSourceSpecBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | DataSourceSpec | Создает спецификацию источника данных из настроек в этом компоновщике. |
copy() | DataSourceSpecBuilder | Создает DataSourceSpecBuilder на основе настроек этого источника данных. |
getDatasetId() | String | Получает идентификатор набора данных BigQuery. |
getParameters() | DataSourceParameter[] | Получает параметры источника данных. |
getProjectId() | String | Получает идентификатор платежного проекта. |
getRawQuery() | String | Получает необработанную строку запроса. |
getTableId() | String | Получает идентификатор таблицы BigQuery. |
getTableProjectId() | String | Получает идентификатор проекта BigQuery для таблицы. |
getType() | DataSourceType | Получает тип источника данных. |
removeAllParameters() | BigQueryDataSourceSpecBuilder | Удаляет все параметры. |
removeParameter(parameterName) | BigQueryDataSourceSpecBuilder | Удаляет указанный параметр. |
setDatasetId(datasetId) | BigQueryDataSourceSpecBuilder | Задает идентификатор набора данных BigQuery. |
setParameterFromCell(parameterName, sourceCell) | BigQueryDataSourceSpecBuilder | Добавляет параметр или, если параметр с таким именем существует, обновляет исходную ячейку. |
setProjectId(projectId) | BigQueryDataSourceSpecBuilder | Задает идентификатор платежного проекта BigQuery. |
setRawQuery(rawQuery) | BigQueryDataSourceSpecBuilder | Задает необработанную строку запроса. |
setTableId(tableId) | BigQueryDataSourceSpecBuilder | Задает идентификатор таблицы BigQuery. |
setTableProjectId(projectId) | BigQueryDataSourceSpecBuilder | Задает идентификатор проекта BigQuery для таблицы. |
BooleanCondition
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getBackgroundObject() | Color | Получает цвет фона для этого логического условия. |
getBold() | Boolean | Возвращает true , если это логическое условие выделяет текст жирным шрифтом, и возвращает false если это логическое условие удаляет жирный шрифт из текста. |
getCriteriaType() | BooleanCriteria | Получает тип критериев правила, определенный в перечислении BooleanCriteria . |
getCriteriaValues() | Object[] | Получает массив аргументов для критериев правила. |
getFontColorObject() | Color | Получает цвет шрифта для этого логического условия. |
getItalic() | Boolean | Возвращает true , если это логическое условие выделяет текст курсивом, и возвращает false , если это логическое условие удаляет курсив из текста. |
getStrikethrough() | Boolean | Возвращает true , если это логическое условие зачеркивает текст, и возвращает false , если это логическое условие удаляет зачеркивание из текста. |
getUnderline() | Boolean | Возвращает true , если это логическое условие подчеркивает текст, и возвращает false , если это логическое условие удаляет подчеркивание из текста. |
BooleanCriteria
Характеристики
Свойство | Тип | Описание |
---|---|---|
CELL_EMPTY | Enum | Критерий выполняется, когда ячейка пуста. |
CELL_NOT_EMPTY | Enum | Критерий соблюдается, когда ячейка не пуста. |
DATE_AFTER | Enum | Критерий выполняется, когда дата находится после заданного значения. |
DATE_BEFORE | Enum | Критерий выполняется, когда дата предшествует заданному значению. |
DATE_EQUAL_TO | Enum | Критерий выполняется, когда дата равна заданному значению. |
DATE_NOT_EQUAL_TO | Enum | Критерий выполняется, когда дата не равна заданному значению. |
DATE_AFTER_RELATIVE | Enum | Критерий выполняется, когда дата находится после относительного значения даты. |
DATE_BEFORE_RELATIVE | Enum | Критерий выполняется, когда дата предшествует относительному значению даты. |
DATE_EQUAL_TO_RELATIVE | Enum | Критерий выполняется, когда дата равна относительному значению даты. |
NUMBER_BETWEEN | Enum | Критерий удовлетворяется, когда число находится между заданными значениями. |
NUMBER_EQUAL_TO | Enum | Критерий считается выполненным, когда число равно заданному значению. |
NUMBER_GREATER_THAN | Enum | Критерий считается выполненным, когда число больше заданного значения. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | Критерий считается выполненным, когда число больше или равно заданному значению. |
NUMBER_LESS_THAN | Enum | Критерий соблюдается, когда число меньше заданного значения. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | Критерий считается выполненным, когда число меньше или равно заданному значению. |
NUMBER_NOT_BETWEEN | Enum | Критерий соблюдается, когда число не находится между заданными значениями. |
NUMBER_NOT_EQUAL_TO | Enum | Критерий считается выполненным, когда число не равно заданному значению. |
TEXT_CONTAINS | Enum | Критерий выполняется, когда вход содержит заданное значение. |
TEXT_DOES_NOT_CONTAIN | Enum | Критерий выполняется, когда вход не содержит заданного значения. |
TEXT_EQUAL_TO | Enum | Критерий выполняется, когда вход равен заданному значению. |
TEXT_NOT_EQUAL_TO | Enum | Критерий выполняется, когда вход не равен заданному значению. |
TEXT_STARTS_WITH | Enum | Критерий выполняется, когда ввод начинается с заданного значения. |
TEXT_ENDS_WITH | Enum | Критерий выполняется, когда ввод заканчивается заданным значением. |
CUSTOM_FORMULA | Enum | Критерий соблюдается, когда ввод делает данную формулу true . |
BorderStyle
Характеристики
Свойство | Тип | Описание |
---|---|---|
DOTTED | Enum | Границы пунктирной линии. |
DASHED | Enum | Границы пунктирной линии. |
SOLID | Enum | Тонкие сплошные границы. |
SOLID_MEDIUM | Enum | Границы средней сплошной линии. |
SOLID_THICK | Enum | Толстая сплошная линия границ. |
DOUBLE | Enum | Две сплошные линии границы. |
CellImage
Характеристики
Свойство | Тип | Описание |
---|---|---|
valueType | ValueType | Поле, для которого задано ValueType.IMAGE , представляющее тип значения изображения. |
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getAltTextDescription() | String | Возвращает описание замещающего текста для этого изображения. |
getAltTextTitle() | String | Возвращает заголовок альтернативного текста для этого изображения. |
getContentUrl() | String | Возвращает размещенный в Google URL-адрес изображения. |
getUrl() | String | Получает URL-адрес источника изображения; возвращает null если URL-адрес недоступен. |
toBuilder() | CellImageBuilder | Создает построитель, который превращает изображение в тип значения изображения, чтобы его можно было поместить в ячейку. |
CellImageBuilder
Характеристики
Свойство | Тип | Описание |
---|---|---|
valueType | ValueType | Поле, для которого задано ValueType.IMAGE , представляющее тип значения изображения. |
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | CellImage | Создает тип значения изображения, необходимый для добавления изображения в ячейку. |
getAltTextDescription() | String | Возвращает описание замещающего текста для этого изображения. |
getAltTextTitle() | String | Возвращает заголовок альтернативного текста для этого изображения. |
getContentUrl() | String | Возвращает размещенный в Google URL-адрес изображения. |
getUrl() | String | Получает URL-адрес источника изображения; возвращает null если URL-адрес недоступен. |
setAltTextDescription(description) | CellImage | Устанавливает описание альтернативного текста для этого изображения. |
setAltTextTitle(title) | CellImage | Устанавливает заголовок альтернативного текста для этого изображения. |
setSourceUrl(url) | CellImageBuilder | Задает URL-адрес источника изображения. |
toBuilder() | CellImageBuilder | Создает построитель, который превращает изображение в тип значения изображения, чтобы его можно было поместить в ячейку. |
Color
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
asRgbColor() | RgbColor | Преобразует этот цвет в RgbColor . |
asThemeColor() | ThemeColor | Преобразует этот цвет в ThemeColor . |
getColorType() | ColorType | Получите тип этого цвета. |
ColorBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
asRgbColor() | RgbColor | Преобразует этот цвет в RgbColor . |
asThemeColor() | ThemeColor | Преобразует этот цвет в ThemeColor . |
build() | Color | Создает цветной объект из настроек, предоставленных компоновщику. |
getColorType() | ColorType | Получите тип этого цвета. |
setRgbColor(cssString) | ColorBuilder | Устанавливается как цвет RGB. |
setThemeColor(themeColorType) | ColorBuilder | Устанавливается в качестве цвета темы. |
ConditionalFormatRule
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy() | ConditionalFormatRuleBuilder | Возвращает предустановку построителя правил с настройками этого правила. |
getBooleanCondition() | BooleanCondition | Извлекает информацию о BooleanCondition правила, если это правило использует критерии логического условия. |
getGradientCondition() | GradientCondition | Извлекает информацию GradientCondition правила, если это правило использует критерии условия градиента. |
getRanges() | Range[] | Извлекает диапазоны, к которым применяется это правило условного форматирования. |
ConditionalFormatRuleBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | ConditionalFormatRule | Создает правило условного форматирования из настроек, примененных к построителю. |
copy() | ConditionalFormatRuleBuilder | Возвращает предустановку построителя правил с настройками этого правила. |
getBooleanCondition() | BooleanCondition | Извлекает информацию о BooleanCondition правила, если это правило использует критерии логического условия. |
getGradientCondition() | GradientCondition | Извлекает информацию GradientCondition правила, если это правило использует критерии условия градиента. |
getRanges() | Range[] | Извлекает диапазоны, к которым применяется это правило условного форматирования. |
setBackground(color) | ConditionalFormatRuleBuilder | Задает цвет фона для формата правила условного форматирования. |
setBackgroundObject(color) | ConditionalFormatRuleBuilder | Задает цвет фона для формата правила условного форматирования. |
setBold(bold) | ConditionalFormatRuleBuilder | Задает полужирный шрифт для формата правила условного форматирования. |
setFontColor(color) | ConditionalFormatRuleBuilder | Задает цвет шрифта для формата правила условного форматирования. |
setFontColorObject(color) | ConditionalFormatRuleBuilder | Задает цвет шрифта для формата правила условного форматирования. |
setGradientMaxpoint(color) | ConditionalFormatRuleBuilder | Очищает значение максимальной точки градиента правила условного форматирования и вместо этого использует максимальное значение в диапазонах правила. |
setGradientMaxpointObject(color) | ConditionalFormatRuleBuilder | Очищает значение максимальной точки градиента правила условного форматирования и вместо этого использует максимальное значение в диапазонах правила. |
setGradientMaxpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля maxpoint градиента правила условного форматирования. |
setGradientMaxpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля maxpoint градиента правила условного форматирования. |
setGradientMidpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля средней точки градиента правила условного формата. |
setGradientMidpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля средней точки градиента правила условного формата. |
setGradientMinpoint(color) | ConditionalFormatRuleBuilder | Очищает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила. |
setGradientMinpointObject(color) | ConditionalFormatRuleBuilder | Очищает значение минимальной точки градиента правила условного форматирования и вместо этого использует минимальное значение в диапазонах правила. |
setGradientMinpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля минимальной точки градиента правила условного форматирования. |
setGradientMinpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Задает поля минимальной точки градиента правила условного форматирования. |
setItalic(italic) | ConditionalFormatRuleBuilder | Устанавливает курсив текста для формата правила условного форматирования. |
setRanges(ranges) | ConditionalFormatRuleBuilder | Задает один или несколько диапазонов, к которым применяется это правило условного форматирования. |
setStrikethrough(strikethrough) | ConditionalFormatRuleBuilder | Устанавливает зачеркивание текста для формата правила условного форматирования. |
setUnderline(underline) | ConditionalFormatRuleBuilder | Устанавливает подчеркивание текста для формата правила условного форматирования. |
whenCellEmpty() | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда ячейка пуста. |
whenCellNotEmpty() | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда ячейка не пуста. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата находится после заданного значения. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата находится после заданной относительной даты. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата предшествует заданной дате. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата предшествует заданной относительной дате. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата равна заданной дате. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда дата равна заданной относительной дате. |
whenFormulaSatisfied(formula) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда данная формула оценивается как true . |
whenNumberBetween(start, end) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число попадает между двумя указанными значениями или является одним из них. |
whenNumberEqualTo(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число равно заданному значению. |
whenNumberGreaterThan(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число больше заданного значения. |
whenNumberGreaterThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число больше или равно заданному значению. |
whenNumberLessThan(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного условного формата для срабатывания, когда число меньше заданного значения. |
whenNumberLessThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число меньше или равно заданному значению. |
whenNumberNotBetween(start, end) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число не попадает между двумя указанными значениями и не является ни одним из них. |
whenNumberNotEqualTo(number) | ConditionalFormatRuleBuilder | Устанавливает правило условного форматирования для срабатывания, когда число не равно заданному значению. |
whenTextContains(text) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда ввод содержит заданное значение. |
whenTextDoesNotContain(text) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда ввод не содержит заданного значения. |
whenTextEndsWith(text) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда ввод заканчивается заданным значением. |
whenTextEqualTo(text) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда ввод равен заданному значению. |
whenTextStartsWith(text) | ConditionalFormatRuleBuilder | Устанавливает правило условного формата для срабатывания, когда ввод начинается с заданного значения. |
withCriteria(criteria, args) | ConditionalFormatRuleBuilder | Задает для правила условного форматирования критерии, определенные значениями BooleanCriteria , которые обычно берутся из criteria и arguments существующего правила. |
ContainerInfo
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getAnchorColumn() | Integer | Левая сторона диаграммы привязана к этому столбцу. |
getAnchorRow() | Integer | Верхняя сторона диаграммы привязана к этой строке. |
getOffsetX() | Integer | Верхний левый угол диаграммы смещен от столбца привязки на указанное количество пикселей. |
getOffsetY() | Integer | Верхний левый угол диаграммы смещен от строки привязки на указанное количество пикселей. |
CopyPasteType
Характеристики
Свойство | Тип | Описание |
---|---|---|
PASTE_NORMAL | Enum | Вставка значений, формул, форматов и слияний. |
PASTE_NO_BORDERS | Enum | Вставляйте значения, формулы, форматы и слияния, но без границ. |
PASTE_FORMAT | Enum | Вставьте только формат. |
PASTE_FORMULA | Enum | Вставьте только формулы. |
PASTE_DATA_VALIDATION | Enum | Вставьте только проверку данных. |
PASTE_VALUES | Enum | Вставляйте значения ТОЛЬКО без форматов, формул или слияний. |
PASTE_CONDITIONAL_FORMATTING | Enum | Вставьте только правила цвета. |
PASTE_COLUMN_WIDTHS | Enum | Вставьте только ширину столбца. |
DataExecutionErrorCode
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Код ошибки выполнения данных, который не поддерживается в Apps Script. |
NONE | Enum | Выполнение данных не имеет ошибок. |
TIME_OUT | Enum | Время выполнения данных истекло. |
TOO_MANY_ROWS | Enum | Выполнение данных возвращает больше строк, чем ограничение. |
TOO_MANY_COLUMNS | Enum | Выполнение данных возвращает больше столбцов, чем ограничение. |
TOO_MANY_CELLS | Enum | Выполнение данных возвращает больше ячеек, чем предел. |
ENGINE | Enum | Ошибка механизма выполнения данных. |
PARAMETER_INVALID | Enum | Недопустимый параметр выполнения данных. |
UNSUPPORTED_DATA_TYPE | Enum | Выполнение данных возвращает неподдерживаемый тип данных. |
DUPLICATE_COLUMN_NAMES | Enum | Выполнение данных возвращает повторяющиеся имена столбцов. |
INTERRUPTED | Enum | Выполнение данных прерывается. |
OTHER | Enum | Другие ошибки. |
TOO_MANY_CHARS_PER_CELL | Enum | Выполнение данных возвращает значения, которые превышают максимально допустимое количество символов в одной ячейке. |
DATA_NOT_FOUND | Enum | База данных, на которую ссылается источник данных, не найдена. |
PERMISSION_DENIED | Enum | У пользователя нет доступа к базе данных, на которую ссылается источник данных. |
DataExecutionState
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Состояние выполнения данных не поддерживается в Apps Script. |
RUNNING | Enum | Выполнение данных началось и выполняется. |
SUCCESS | Enum | Выполнение данных завершено и успешно. |
ERROR | Enum | Выполнение данных завершено и имеет ошибки. |
NOT_STARTED | Enum | Выполнение данных не началось. |
DataExecutionStatus
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getErrorCode() | DataExecutionErrorCode | Получает код ошибки выполнения данных. |
getErrorMessage() | String | Получает сообщение об ошибке выполнения данных. |
getExecutionState() | DataExecutionState | Получает состояние выполнения данных. |
getLastExecutionTime() | Date | Получает время последнего выполнения данных независимо от состояния выполнения. |
getLastRefreshedTime() | Date | Получает время последнего успешного обновления данных. |
isTruncated() | Boolean | Возвращает true если данные последнего успешного выполнения усекаются, или false в противном случае. |
DataSource
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createCalculatedColumn(name, formula) | DataSourceColumn | Создает вычисляемый столбец. |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | Создает сводную таблицу источника данных из этого источника данных в первой ячейке нового листа. |
createDataSourceTableOnNewSheet() | DataSourceTable | Создает таблицу источника данных из этого источника данных в первой ячейке нового листа. |
getCalculatedColumnByName(columnName) | DataSourceColumn | Возвращает вычисляемый столбец в источнике данных, который соответствует имени столбца. |
getCalculatedColumns() | DataSourceColumn[] | Возвращает все вычисляемые столбцы в источнике данных. |
getColumns() | DataSourceColumn[] | Возвращает все столбцы в источнике данных. |
getDataSourceSheets() | DataSourceSheet[] | Возвращает листы источника данных, связанные с этим источником данных. |
getSpec() | DataSourceSpec | Получает спецификацию источника данных. |
refreshAllLinkedDataSourceObjects() | void | Обновляет все объекты источника данных, связанные с источником данных. |
updateSpec(spec) | DataSource | Обновляет спецификацию источника данных и обновляет объекты источников данных, связанные с этим источником данных, с новой спецификацией. |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | Обновляет спецификацию источника данных и обновляет связанные data source sheets новой спецификацией. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Ожидает завершения всех текущих выполнений связанных объектов источника данных, время ожидания истекает через указанное количество секунд. |
DataSourceChart
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
forceRefreshData() | DataSourceChart | Обновляет данные этого объекта независимо от текущего состояния. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getStatus() | DataExecutionStatus | Получает состояние выполнения данных объекта. |
refreshData() | DataSourceChart | Обновляет данные объекта. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
DataSourceColumn
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getDataSource() | DataSource | Получает источник данных, связанный со столбцом источника данных. |
getFormula() | String | Получает формулу для столбца источника данных. |
getName() | String | Получает имя столбца источника данных. |
hasArrayDependency() | Boolean | Возвращает, имеет ли столбец зависимость от массива. |
isCalculatedColumn() | Boolean | Возвращает, является ли столбец вычисляемым столбцом. |
remove() | void | Удаляет столбец источника данных. |
setFormula(formula) | DataSourceColumn | Задает формулу для столбца источника данных. |
setName(name) | DataSourceColumn | Задает имя столбца источника данных. |
DataSourceFormula
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
forceRefreshData() | DataSourceFormula | Обновляет данные этого объекта независимо от текущего состояния. |
getAnchorCell() | Range | Возвращает Range , представляющий ячейку, к которой привязана эта формула источника данных. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getDisplayValue() | String | Возвращает отображаемое значение формулы источника данных. |
getFormula() | String | Возвращает формулу для этой формулы источника данных. |
getStatus() | DataExecutionStatus | Получает состояние выполнения данных объекта. |
refreshData() | DataSourceFormula | Обновляет данные объекта. |
setFormula(formula) | DataSourceFormula | Обновляет формулу. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
DataSourceParameter
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getName() | String | Получает имя параметра. |
getSourceCell() | String | Получает исходную ячейку, на основе которой оценивается параметр, или null , если тип параметра не DataSourceParameterType.CELL . |
getType() | DataSourceParameterType | Получает тип параметра. |
DataSourceParameterType
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Тип параметра источника данных, который не поддерживается в Apps Script. |
CELL | Enum | Параметр источника данных оценивается на основе ячейки. |
DataSourcePivotTable
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addColumnGroup(columnName) | PivotGroup | Добавляет новую группу сводных столбцов на основе указанного столбца источника данных. |
addFilter(columnName, filterCriteria) | PivotFilter | Добавляет новый фильтр на основе указанного столбца источника данных с указанными критериями фильтра. |
addPivotValue(columnName, summarizeFunction) | PivotValue | Добавляет новое значение сводки на основе указанного столбца источника данных с указанной функцией суммирования. |
addRowGroup(columnName) | PivotGroup | Добавляет новую группу сводных строк на основе указанного столбца источника данных. |
asPivotTable() | PivotTable | Возвращает сводную таблицу источника данных как обычный объект сводной таблицы. |
forceRefreshData() | DataSourcePivotTable | Обновляет данные этого объекта независимо от текущего состояния. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getStatus() | DataExecutionStatus | Получает состояние выполнения данных объекта. |
refreshData() | DataSourcePivotTable | Обновляет данные объекта. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
DataSourceRefreshSchedule
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | Получает частоту обновления расписания, которая указывает, как часто и когда обновлять. |
getScope() | DataSourceRefreshScope | Получает область этого расписания обновления. |
getTimeIntervalOfNextRun() | TimeInterval | Получает временное окно следующего запуска этого расписания обновления. |
isEnabled() | Boolean | Определяет, включено ли это расписание обновления. |
DataSourceRefreshScheduleFrequency
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getDaysOfTheMonth() | Integer[] | Получает дни месяца в виде чисел (1–28), в которые необходимо обновить источник данных. |
getDaysOfTheWeek() | Weekday[] | Получает дни недели, в которые необходимо обновить источник данных. |
getFrequencyType() | FrequencyType | Получает тип частоты. |
getStartHour() | Integer | Получает начальный час (число от 0 до 23) интервала времени, в течение которого выполняется расписание обновления. |
DataSourceRefreshScope
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | Область обновления источника данных не поддерживается. |
ALL_DATA_SOURCES | Enum | Обновление применяется ко всем источникам данных в электронной таблице. |
DataSourceSheet
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Добавляет фильтр, применяемый к листу источника данных. |
asSheet() | Sheet | Возвращает лист источника данных как обычный объект листа. |
autoResizeColumn(columnName) | DataSourceSheet | Автоматически изменяет ширину указанного столбца. |
autoResizeColumns(columnNames) | DataSourceSheet | Автоматически изменяет ширину указанных столбцов. |
forceRefreshData() | DataSourceSheet | Обновляет данные этого объекта независимо от текущего состояния. |
getColumnWidth(columnName) | Integer | Возвращает ширину указанного столбца. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getFilters() | DataSourceSheetFilter[] | Возвращает все фильтры, примененные к листу источника данных. |
getSheetValues(columnName) | Object[] | Возвращает все значения для листа источника данных для указанного имени столбца. |
getSheetValues(columnName, startRow, numRows) | Object[] | Возвращает все значения для листа источника данных для предоставленного имени столбца из предоставленной начальной строки (на основе 1) и до предоставленного numRows . |
getSortSpecs() | SortSpec[] | Получает все спецификации сортировки в таблице источника данных. |
getStatus() | DataExecutionStatus | Получает состояние выполнения данных объекта. |
refreshData() | DataSourceSheet | Обновляет данные объекта. |
removeFilters(columnName) | DataSourceSheet | Удаляет все фильтры, примененные к столбцу таблицы источника данных. |
removeSortSpec(columnName) | DataSourceSheet | Удаляет спецификацию сортировки для столбца на листе источника данных. |
setColumnWidth(columnName, width) | DataSourceSheet | Задает ширину указанного столбца. |
setColumnWidths(columnNames, width) | DataSourceSheet | Задает ширину указанных столбцов. |
setSortSpec(columnName, ascending) | DataSourceSheet | Задает спецификацию сортировки для столбца на листе источника данных. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Задает спецификацию сортировки для столбца на листе источника данных. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
DataSourceSheetFilter
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Возвращает столбец источника данных, к которому применяется этот фильтр. |
getDataSourceSheet() | DataSourceSheet | Возвращает DataSourceSheet , которому принадлежит этот фильтр. |
getFilterCriteria() | FilterCriteria | Возвращает критерии фильтра для этого фильтра. |
remove() | void | Удаляет этот фильтр из объекта источника данных. |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | Задает критерии фильтрации для этого фильтра. |
DataSourceSpec
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | Получает спецификацию для источника данных BigQuery. |
copy() | DataSourceSpecBuilder | Создает DataSourceSpecBuilder на основе настроек этого источника данных. |
getParameters() | DataSourceParameter[] | Получает параметры источника данных. |
getType() | DataSourceType | Получает тип источника данных. |
DataSourceSpecBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | Получает построитель для источника данных BigQuery. |
build() | DataSourceSpec | Создает спецификацию источника данных из настроек в этом компоновщике. |
copy() | DataSourceSpecBuilder | Создает DataSourceSpecBuilder на основе настроек этого источника данных. |
getParameters() | DataSourceParameter[] | Получает параметры источника данных. |
getType() | DataSourceType | Получает тип источника данных. |
removeAllParameters() | DataSourceSpecBuilder | Удаляет все параметры. |
removeParameter(parameterName) | DataSourceSpecBuilder | Удаляет указанный параметр. |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | Добавляет параметр или, если параметр с таким именем существует, обновляет исходную ячейку. |
DataSourceTable
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addColumns(columnNames) | DataSourceTable | Добавляет столбцы в таблицу источника данных. |
addFilter(columnName, filterCriteria) | DataSourceTable | Добавляет фильтр, применяемый к таблице источника данных. |
addSortSpec(columnName, ascending) | DataSourceTable | Добавляет спецификацию сортировки для столбца в таблице источника данных. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Добавляет спецификацию сортировки для столбца в таблице источника данных. |
forceRefreshData() | DataSourceTable | Обновляет данные этого объекта независимо от текущего состояния. |
getColumns() | DataSourceTableColumn[] | Получает все столбцы источника данных, добавленные в таблицу источника данных. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getFilters() | DataSourceTableFilter[] | Возвращает все фильтры, примененные к таблице источника данных. |
getRange() | Range | Получает Range который охватывает эта таблица источника данных. |
getRowLimit() | Integer | Возвращает ограничение на количество строк для таблицы источника данных. |
getSortSpecs() | SortSpec[] | Получает все спецификации сортировки в таблице источника данных. |
getStatus() | DataExecutionStatus | Получает состояние выполнения данных объекта. |
isSyncingAllColumns() | Boolean | Возвращает, синхронизирует ли таблица источника данных все столбцы в связанном источнике данных. |
refreshData() | DataSourceTable | Обновляет данные объекта. |
removeAllColumns() | DataSourceTable | Удаляет все столбцы в таблице источника данных. |
removeAllSortSpecs() | DataSourceTable | Удаляет все спецификации сортировки в таблице источника данных. |
setRowLimit(rowLimit) | DataSourceTable | Обновляет лимит строк для таблицы источника данных. |
syncAllColumns() | DataSourceTable | Синхронизируйте все текущие и будущие столбцы в связанном источнике данных с таблицей источника данных. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
DataSourceTableColumn
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Получает столбец источника данных. |
remove() | void | Удаляет столбец из DataSourceTable . |
DataSourceTableFilter
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Возвращает столбец источника данных, к которому применяется этот фильтр. |
getDataSourceTable() | DataSourceTable | Возвращает DataSourceTable , к которому принадлежит этот фильтр. |
getFilterCriteria() | FilterCriteria | Возвращает критерии фильтра для этого фильтра. |
remove() | void | Удаляет этот фильтр из объекта источника данных. |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | Задает критерии фильтрации для этого фильтра. |
DataSourceType
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Тип источника данных, который не поддерживается в Apps Script. |
BIGQUERY | Enum | Источник данных BigQuery. |
DataValidation
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy() | DataValidationBuilder | Создает построитель для правила проверки данных на основе настроек этого правила. |
getAllowInvalid() | Boolean | Возвращает true если правило выводит предупреждение, когда ввод не проходит проверку данных, или false , если оно полностью отклоняет ввод. |
getCriteriaType() | DataValidationCriteria | Получает тип критериев правила, определенный в перечислении DataValidationCriteria . |
getCriteriaValues() | Object[] | Получает массив аргументов для критериев правила. |
getHelpText() | String | Получает текст справки по правилу или null , если текст справки не задан. |
DataValidationBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | DataValidation | Создает правило проверки данных из настроек, примененных к построителю. |
copy() | DataValidationBuilder | Создает построитель для правила проверки данных на основе настроек этого правила. |
getAllowInvalid() | Boolean | Возвращает true если правило выводит предупреждение, когда ввод не проходит проверку данных, или false , если оно полностью отклоняет ввод. |
getCriteriaType() | DataValidationCriteria | Получает тип критериев правила, определенный в перечислении DataValidationCriteria . |
getCriteriaValues() | Object[] | Получает массив аргументов для критериев правила. |
getHelpText() | String | Получает текст справки по правилу или null , если текст справки не задан. |
requireCheckbox() | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был логическим значением; это значение отображается как флажок. |
requireCheckbox(checkedValue) | DataValidationBuilder | Задает правило проверки данных, требующее, чтобы ввод был заданным значением или пустым. |
requireCheckbox(checkedValue, uncheckedValue) | DataValidationBuilder | Задает правило проверки данных, требующее, чтобы ввод был одним из указанных значений. |
requireDate() | DataValidationBuilder | Устанавливает для правила проверки данных требование даты. |
requireDateAfter(date) | DataValidationBuilder | Устанавливает правило проверки данных, требующее дату после заданного значения. |
requireDateBefore(date) | DataValidationBuilder | Устанавливает правило проверки данных, требующее дату перед заданным значением. |
requireDateBetween(start, end) | DataValidationBuilder | Задает для правила проверки данных требование даты, которая находится между двумя указанными датами или является одной из них. |
requireDateEqualTo(date) | DataValidationBuilder | Устанавливает правило проверки данных, требующее дату, равную заданному значению. |
requireDateNotBetween(start, end) | DataValidationBuilder | Задает для правила проверки данных требование даты, которая не попадает между двумя указанными датами и не является ни одной из них. |
requireDateOnOrAfter(date) | DataValidationBuilder | Устанавливает правило проверки данных, требующее даты, не превышающей заданное значение. |
requireDateOnOrBefore(date) | DataValidationBuilder | Устанавливает правило проверки данных, требующее даты, предшествующей заданному значению. |
requireFormulaSatisfied(formula) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы данная формула оценивалась как true . |
requireNumberBetween(start, end) | DataValidationBuilder | Задает правило проверки данных, требующее число, которое находится между двумя указанными числами или является одним из них. |
requireNumberEqualTo(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число, равное заданному значению. |
requireNumberGreaterThan(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число больше заданного значения. |
requireNumberGreaterThanOrEqualTo(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число, большее или равное заданному значению. |
requireNumberLessThan(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число меньше заданного значения. |
requireNumberLessThanOrEqualTo(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число, меньшее или равное заданному значению. |
requireNumberNotBetween(start, end) | DataValidationBuilder | Задает правило проверки данных, требующее число, которое не попадает между двумя указанными числами и не является ни одним из них. |
requireNumberNotEqualTo(number) | DataValidationBuilder | Устанавливает правило проверки данных, требующее число, не равное заданному значению. |
requireTextContains(text) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод содержал заданное значение. |
requireTextDoesNotContain(text) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы входные данные не содержали заданное значение. |
requireTextEqualTo(text) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был равен заданному значению. |
requireTextIsEmail() | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был в форме адреса электронной почты. |
requireTextIsUrl() | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был в форме URL-адреса. |
requireValueInList(values) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был равен одному из заданных значений. |
requireValueInList(values, showDropdown) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был равен одному из заданных значений, с возможностью скрыть раскрывающееся меню. |
requireValueInRange(range) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был равен значению в заданном диапазоне. |
requireValueInRange(range, showDropdown) | DataValidationBuilder | Устанавливает правило проверки данных, требующее, чтобы ввод был равен значению в заданном диапазоне, с возможностью скрыть раскрывающееся меню. |
setAllowInvalid(allowInvalidData) | DataValidationBuilder | Устанавливает, показывать ли предупреждение, когда ввод не проходит проверку данных, или полностью отклонять ввод. |
setHelpText(helpText) | DataValidationBuilder | Задает текст справки, который появляется, когда пользователь наводит курсор на ячейку, для которой установлена проверка данных. |
withCriteria(criteria, args) | DataValidationBuilder | Задает для правила проверки данных критерии, определенные значениями DataValidationCriteria , которые обычно берутся из criteria и arguments существующего правила. |
DataValidationCriteria
Характеристики
Свойство | Тип | Описание |
---|---|---|
DATE_AFTER | Enum | Requires a date that is after the given value. |
DATE_BEFORE | Enum | Requires a date that is before the given value. |
DATE_BETWEEN | Enum | Requires a date that is between the given values. |
DATE_EQUAL_TO | Enum | Requires a date that is equal to the given value. |
DATE_IS_VALID_DATE | Enum | Requires a date. |
DATE_NOT_BETWEEN | Enum | Requires a date that is not between the given values. |
DATE_ON_OR_AFTER | Enum | Require a date that is on or after the given value. |
DATE_ON_OR_BEFORE | Enum | Requires a date that is on or before the given value. |
NUMBER_BETWEEN | Enum | Requires a number that is between the given values. |
NUMBER_EQUAL_TO | Enum | Requires a number that is equal to the given value. |
NUMBER_GREATER_THAN | Enum | Require a number that is greater than the given value. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | Requires a number that is greater than or equal to the given value. |
NUMBER_LESS_THAN | Enum | Requires a number that is less than the given value. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | Requires a number that is less than or equal to the given value. |
NUMBER_NOT_BETWEEN | Enum | Requires a number that is not between the given values. |
NUMBER_NOT_EQUAL_TO | Enum | Requires a number that is not equal to the given value. |
TEXT_CONTAINS | Enum | Requires that the input contains the given value. |
TEXT_DOES_NOT_CONTAIN | Enum | Requires that the input does not contain the given value. |
TEXT_EQUAL_TO | Enum | Requires that the input is equal to the given value. |
TEXT_IS_VALID_EMAIL | Enum | Requires that the input is in the form of an email address. |
TEXT_IS_VALID_URL | Enum | Requires that the input is in the form of a URL. |
VALUE_IN_LIST | Enum | Requires that the input is equal to one of the given values. |
VALUE_IN_RANGE | Enum | Requires that the input is equal to a value in the given range. |
CUSTOM_FORMULA | Enum | Requires that the input makes the given formula evaluate to true . |
CHECKBOX | Enum | Requires that the input is a custom value or a boolean; rendered as a checkbox. |
DateTimeGroupingRule
Методы
Метод | Return type | Brief description |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | Gets the type of the date-time grouping rule. |
DateTimeGroupingRuleType
Properties
Property | Тип | Описание |
---|---|---|
UNSUPPORTED | Enum | A date-time grouping rule type that is not supported. |
SECOND | Enum | Group date-time by second, from 0 to 59. |
MINUTE | Enum | Group date-time by minute, from 0 to 59. |
HOUR | Enum | Group date-time by hour using a 24-hour system, from 0 to 23. |
HOUR_MINUTE | Enum | Group date-time by hour and minute using a 24-hour system, for example 19:45 . |
HOUR_MINUTE_AMPM | Enum | Group date-time by hour and minute using a 12-hour system, for example 7:45 PM . |
DAY_OF_WEEK | Enum | Group date-time by day of week, for example Sunday . |
DAY_OF_YEAR | Enum | Group date-time by day of year, from 1 to 366. |
DAY_OF_MONTH | Enum | Group date-time by day of month, from 1 to 31. |
DAY_MONTH | Enum | Group date-time by day and month, for example 22-Nov . |
MONTH | Enum | Group date-time by month, for example Nov . |
QUARTER | Enum | Group date-time by quarter, for example Q1 (which represents Jan-Mar). |
YEAR | Enum | Group date-time by year, for example 2008. |
YEAR_MONTH | Enum | Group date-time by year and month, for example 2008-Nov . |
YEAR_QUARTER | Enum | Group date-time by year and quarter, for example 2008 Q4 . |
YEAR_MONTH_DAY | Enum | Group date-time by year, month, and day, for example 2008-11-22 . |
DeveloperMetadata
Методы
Метод | Return type | Brief description |
---|---|---|
getId() | Integer | Returns the unique ID associated with this developer metadata. |
getKey() | String | Returns the key associated with this developer metadata. |
getLocation() | DeveloperMetadataLocation | Returns the location of this developer metadata. |
getValue() | String | Returns the value associated with this developer metadata, or null if this metadata has no value. |
getVisibility() | DeveloperMetadataVisibility | Returns the visibility of this developer metadata. |
moveToColumn(column) | DeveloperMetadata | Moves this developer metadata to the specified column. |
moveToRow(row) | DeveloperMetadata | Moves this developer metadata to the specified row. |
moveToSheet(sheet) | DeveloperMetadata | Moves this developer metadata to the specified sheet. |
moveToSpreadsheet() | DeveloperMetadata | Moves this developer metadata to the top-level spreadsheet. |
remove() | void | Deletes this metadata. |
setKey(key) | DeveloperMetadata | Sets the key of this developer metadata to the specified value. |
setValue(value) | DeveloperMetadata | Sets the value associated with this developer metadata to the specified value. |
setVisibility(visibility) | DeveloperMetadata | Sets the visibility of this developer metadata to the specified visibility. |
DeveloperMetadataFinder
Методы
Метод | Return type | Brief description |
---|---|---|
find() | DeveloperMetadata[] | Executes this search and returns the matching metadata. |
onIntersectingLocations() | DeveloperMetadataFinder | Configures the search to consider intersecting locations that have metadata. |
withId(id) | DeveloperMetadataFinder | Limits this search to consider only metadata that match the specified ID. |
withKey(key) | DeveloperMetadataFinder | Limits this search to consider only metadata that match the specified key. |
withLocationType(locationType) | DeveloperMetadataFinder | Limits this search to consider only metadata that match the specified location type. |
withValue(value) | DeveloperMetadataFinder | Limits this search to consider only metadata that match the specified value. |
withVisibility(visibility) | DeveloperMetadataFinder | Limits this search to consider only metadata that match the specified visibility. |
DeveloperMetadataLocation
Методы
Метод | Return type | Brief description |
---|---|---|
getColumn() | Range | Returns the Range for the column location of this metadata, or null if the location type is not DeveloperMetadataLocationType.COLUMN . |
getLocationType() | DeveloperMetadataLocationType | Gets the type of location. |
getRow() | Range | Returns the Range for the row location of this metadata, or null if the location type is not DeveloperMetadataLocationType.ROW . |
getSheet() | Sheet | Returns the Sheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SHEET . |
getSpreadsheet() | Spreadsheet | Returns the Spreadsheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SPREADSHEET . |
DeveloperMetadataLocationType
Properties
Property | Тип | Описание |
---|---|---|
SPREADSHEET | Enum | The location type for developer metadata associated with the top-level spreadsheet. |
SHEET | Enum | The location type for developer metadata associated with a whole sheet. |
ROW | Enum | The location type for developer metadata associated with a row. |
COLUMN | Enum | The location type for developer metadata associated with a column. |
DeveloperMetadataVisibility
Properties
Property | Тип | Описание |
---|---|---|
DOCUMENT | Enum | Document-visible metadata is accessible from any developer project with access to the document. |
PROJECT | Enum | Project-visible metadata is only visible to and accessible by the developer project that created the metadata. |
Dimension
Properties
Property | Тип | Описание |
---|---|---|
COLUMNS | Enum | The column (vertical) dimension. |
ROWS | Enum | The row (horizontal) dimension. |
Direction
Properties
Property | Тип | Описание |
---|---|---|
UP | Enum | The direction of decreasing row indices. |
DOWN | Enum | The direction of increasing row indices. |
PREVIOUS | Enum | The direction of decreasing column indices. |
NEXT | Enum | The direction of increasing column indices. |
Drawing
Методы
Метод | Return type | Brief description |
---|---|---|
getContainerInfo() | ContainerInfo | Gets information about where the drawing is positioned in the sheet. |
getHeight() | Integer | Returns the actual height of this drawing in pixels. |
getOnAction() | String | Returns the name of the macro attached to this drawing. |
getSheet() | Sheet | Returns the sheet this drawing appears on. |
getWidth() | Integer | Returns the actual width of this drawing in pixels. |
getZIndex() | Number | Returns the z-index of this drawing. |
remove() | void | Deletes this drawing from the spreadsheet. |
setHeight(height) | Drawing | Sets the actual height of this drawing in pixels. |
setOnAction(macroName) | Drawing | Assigns a macro function to this drawing. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Sets the position where the drawing appears on the sheet. |
setWidth(width) | Drawing | Sets the actual width of this drawing in pixels. |
setZIndex(zIndex) | Drawing | Sets the z-index of this drawing. |
EmbeddedAreaChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedAreaChartBuilder | Reverses the drawing of series in the domain axis. |
setBackgroundColor(cssValue) | EmbeddedAreaChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedAreaChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedAreaChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPointStyle(style) | EmbeddedAreaChartBuilder | Sets the style for points in the line. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedAreaChartBuilder | Sets the range for the chart. |
setStacked() | EmbeddedAreaChartBuilder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
setTitle(chartTitle) | EmbeddedAreaChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedAreaChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedAreaChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedAreaChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedBarChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedBarChartBuilder | Reverses the drawing of series in the domain axis. |
reverseDirection() | EmbeddedBarChartBuilder | Reverses the direction in which the bars grow along the horizontal axis. |
setBackgroundColor(cssValue) | EmbeddedBarChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedBarChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedBarChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedBarChartBuilder | Sets the range for the chart. |
setStacked() | EmbeddedBarChartBuilder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
setTitle(chartTitle) | EmbeddedBarChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedBarChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedBarChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedBarChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedChart
Методы
Метод | Return type | Brief description |
---|---|---|
asDataSourceChart() | DataSourceChart | Casts to a data source chart instance if the chart is a data source chart, or null otherwise. |
getAs(contentType) | Blob | Return the data inside this object as a blob converted to the specified content type. |
getBlob() | Blob | Return the data inside this object as a blob. |
getChartId() | Integer | Returns a stable identifier for the chart that is unique across the spreadsheet containing the chart or null if the chart is not in a spreadsheet. |
getContainerInfo() | ContainerInfo | Returns information about where the chart is positioned within a sheet. |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | Returns the strategy to use for handling hidden rows and columns. |
getMergeStrategy() | ChartMergeStrategy | Returns the merge strategy used when more than one range exists. |
getNumHeaders() | Integer | Returns the number of rows or columns the range that are treated as headers. |
getOptions() | ChartOptions | Returns the options for this chart, such as height, colors, and axes. |
getRanges() | Range[] | Returns the ranges that this chart uses as a data source. |
getTransposeRowsAndColumns() | Boolean | If true , the rows and columns used to populate the chart are switched. |
modify() | EmbeddedChartBuilder | Returns an EmbeddedChartBuilder that can be used to modify this chart. |
EmbeddedChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
EmbeddedColumnChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedColumnChartBuilder | Reverses the drawing of series in the domain axis. |
setBackgroundColor(cssValue) | EmbeddedColumnChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedColumnChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedColumnChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedColumnChartBuilder | Sets the range for the chart. |
setStacked() | EmbeddedColumnChartBuilder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
setTitle(chartTitle) | EmbeddedColumnChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedColumnChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedColumnChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedColumnChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedComboChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedComboChartBuilder | Reverses the drawing of series in the domain axis. |
setBackgroundColor(cssValue) | EmbeddedComboChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedComboChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedComboChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedComboChartBuilder | Sets the range for the chart. |
setStacked() | EmbeddedComboChartBuilder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
setTitle(chartTitle) | EmbeddedComboChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedComboChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedComboChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedComboChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedHistogramChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedHistogramChartBuilder | Reverses the drawing of series in the domain axis. |
setBackgroundColor(cssValue) | EmbeddedHistogramChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedHistogramChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedHistogramChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedHistogramChartBuilder | Sets the range for the chart. |
setStacked() | EmbeddedHistogramChartBuilder | Uses stacked lines, meaning that line and bar values are stacked (accumulated). |
setTitle(chartTitle) | EmbeddedHistogramChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedHistogramChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedHistogramChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedHistogramChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedLineChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedLineChartBuilder | Reverses the drawing of series in the domain axis. |
setBackgroundColor(cssValue) | EmbeddedLineChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedLineChartBuilder | Sets the colors for the lines in the chart. |
setCurveStyle(style) | EmbeddedLineChartBuilder | Sets the style to use for curves in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedLineChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPointStyle(style) | EmbeddedLineChartBuilder | Sets the style for points in the line. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setRange(start, end) | EmbeddedLineChartBuilder | Sets the range for the chart. |
setTitle(chartTitle) | EmbeddedLineChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedLineChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the horizontal axis title text style. |
setYAxisTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedLineChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Sets the vertical axis title text style. |
useLogScale() | EmbeddedLineChartBuilder | Makes the range axis into a logarithmic scale (requires all values to be positive). |
EmbeddedPieChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
reverseCategories() | EmbeddedPieChartBuilder | Reverses the drawing of series in the domain axis. |
set3D() | EmbeddedPieChartBuilder | Sets the chart to be three-dimensional. |
setBackgroundColor(cssValue) | EmbeddedPieChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedPieChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedPieChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedPieChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setTitle(chartTitle) | EmbeddedPieChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedPieChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
EmbeddedScatterChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
setBackgroundColor(cssValue) | EmbeddedScatterChartBuilder | Sets the background color for the chart. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setColors(cssValues) | EmbeddedScatterChartBuilder | Sets the colors for the lines in the chart. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setLegendPosition(position) | EmbeddedScatterChartBuilder | Sets the position of the legend with respect to the chart. |
setLegendTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the text style of the chart legend. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPointStyle(style) | EmbeddedScatterChartBuilder | Sets the style for points in the line. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setTitle(chartTitle) | EmbeddedScatterChartBuilder | Sets the title of the chart. |
setTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the text style of the chart title. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
setXAxisLogScale() | EmbeddedScatterChartBuilder | Makes the horizontal axis into a logarithmic scale (requires all values to be positive). |
setXAxisRange(start, end) | EmbeddedScatterChartBuilder | Sets the range for the horizontal axis of the chart. |
setXAxisTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the horizontal axis text style. |
setXAxisTitle(title) | EmbeddedScatterChartBuilder | Adds a title to the horizontal axis. |
setXAxisTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the horizontal axis title text style. |
setYAxisLogScale() | EmbeddedScatterChartBuilder | Makes the vertical axis into a logarithmic scale (requires all values to be positive). |
setYAxisRange(start, end) | EmbeddedScatterChartBuilder | Sets the range for the vertical axis of the chart. |
setYAxisTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the vertical axis text style. |
setYAxisTitle(title) | EmbeddedScatterChartBuilder | Adds a title to the vertical axis. |
setYAxisTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Sets the vertical axis title text style. |
EmbeddedTableChartBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adds a range to the chart this builder modifies. |
asAreaChart() | EmbeddedAreaChartBuilder | Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Builds the chart to reflect all changes made to it. |
clearRanges() | EmbeddedChartBuilder | Removes all ranges from the chart this builder modifies. |
enablePaging(enablePaging) | EmbeddedTableChartBuilder | Sets whether to enable paging through the data. |
enablePaging(pageSize) | EmbeddedTableChartBuilder | Enables paging and sets the number of rows in each page. |
enablePaging(pageSize, startPage) | EmbeddedTableChartBuilder | Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based). |
enableRtlTable(rtlEnabled) | EmbeddedTableChartBuilder | Adds basic support for right-to-left languages (such as Arabic or Hebrew) by reversing the column order of the table, so that column zero is the right-most column, and the last column is the left-most column. |
enableSorting(enableSorting) | EmbeddedTableChartBuilder | Sets whether to sort columns when the user clicks a column heading. |
getChartType() | ChartType | Returns the current chart type. |
getContainer() | ContainerInfo | Return the chart ContainerInfo , which encapsulates where the chart appears on the sheet. |
getRanges() | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
removeRange(range) | EmbeddedChartBuilder | Removes the specified range from the chart this builder modifies. |
setChartType(type) | EmbeddedChartBuilder | Changes the type of chart. |
setFirstRowNumber(number) | EmbeddedTableChartBuilder | Sets the row number for the first row in the data table. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Sets the strategy to use for hidden rows and columns. |
setInitialSortingAscending(column) | EmbeddedTableChartBuilder | Sets the index of the column according to which the table should be initially sorted (ascending). |
setInitialSortingDescending(column) | EmbeddedTableChartBuilder | Sets the index of the column according to which the table should be initially sorted (descending). |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Sets the merge strategy to use when more than one range exists. |
setNumHeaders(headers) | EmbeddedChartBuilder | Sets the number of rows or columns of the range that should be treated as headers. |
setOption(option, value) | EmbeddedChartBuilder | Sets advanced options for this chart. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Sets the position, changing where the chart appears on the sheet. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Sets whether the chart's rows and columns are transposed. |
showRowNumberColumn(showRowNumber) | EmbeddedTableChartBuilder | Sets whether to show the row number as the first column of the table. |
useAlternatingRowStyle(alternate) | EmbeddedTableChartBuilder | Sets whether alternating color style is assigned to odd and even rows of a table chart. |
Filter
Методы
Метод | Return type | Brief description |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | Gets the filter criteria on the specified column, or null if the column doesn't have filter criteria applied to it. |
getRange() | Range | Gets the range this filter applies to. |
remove() | void | Removes this filter. |
removeColumnFilterCriteria(columnPosition) | Filter | Removes the filter criteria from the specified column. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | Sets the filter criteria on the specified column. |
sort(columnPosition, ascending) | Filter | Sorts the filtered range by the specified column, excluding the first row (the header row) in the range this filter applies to. |
FilterCriteria
Методы
Метод | Return type | Brief description |
---|---|---|
copy() | FilterCriteriaBuilder | Copies this filter criteria and creates a criteria builder that you can apply to another filter. |
getCriteriaType() | BooleanCriteria | Returns the criteria's boolean type, for example, CELL_EMPTY . |
getCriteriaValues() | Object[] | Returns an array of arguments for boolean criteria. |
getHiddenValues() | String[] | Returns the values that the filter hides. |
getVisibleBackgroundColor() | Color | Returns the background color used as filter criteria. |
getVisibleForegroundColor() | Color | Returns the foreground color used as a filter criteria. |
getVisibleValues() | String[] | Returns the values that the pivot table filter shows. |
FilterCriteriaBuilder
Методы
Метод | Return type | Brief description |
---|---|---|
build() | FilterCriteria | Assembles the filter criteria using the settings you add to the criteria builder. |
copy() | FilterCriteriaBuilder | Copies this filter criteria and creates a criteria builder that you can apply to another filter. |
getCriteriaType() | BooleanCriteria | Returns the criteria's boolean type, for example, CELL_EMPTY . |
getCriteriaValues() | Object[] | Returns an array of arguments for boolean criteria. |
getHiddenValues() | String[] | Returns the values that the filter hides. |
getVisibleBackgroundColor() | Color | Returns the background color used as filter criteria. |
getVisibleForegroundColor() | Color | Returns the foreground color used as a filter criteria. |
getVisibleValues() | String[] | Returns the values that the pivot table filter shows. |
setHiddenValues(values) | FilterCriteriaBuilder | Sets the values to hide. |
setVisibleBackgroundColor(visibleBackgroundColor) | FilterCriteriaBuilder | Sets the background color used as filter criteria. |
setVisibleForegroundColor(visibleForegroundColor) | FilterCriteriaBuilder | Sets the foreground color used as filter criteria. |
setVisibleValues(values) | FilterCriteriaBuilder | Sets the values to show on a pivot table. |
whenCellEmpty() | FilterCriteriaBuilder | Sets the filter criteria to show empty cells. |
whenCellNotEmpty() | FilterCriteriaBuilder | Sets the filter criteria to show cells that aren't empty. |
whenDateAfter(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are after the specified date. |
whenDateAfter(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are after the specified relative date. |
whenDateBefore(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are before the specified date. |
whenDateBefore(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are before the specified relative date. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are equal to the specified date. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Sets filter criteria that shows cells with dates that are equal to the specified relative date. |
whenDateEqualToAny(dates) | FilterCriteriaBuilder | Sets the filter criteria to show cells with dates that are equal to any of the specified dates. |
whenDateNotEqualTo(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells that aren't equal to the specified date. |
whenDateNotEqualToAny(dates) | FilterCriteriaBuilder | Sets the filter criteria to show cells with dates that aren't equal to any of the specified dates. |
whenFormulaSatisfied(formula) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a specified formula (such as =B:B<C:C ) that evaluates to true . |
whenNumberBetween(start, end) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that falls between, or is either of, 2 specified numbers. |
whenNumberEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that's equal to the specified number. |
whenNumberEqualToAny(numbers) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that's equal to any of the specified numbers. |
whenNumberGreaterThan(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number greater than the specified number |
whenNumberGreaterThanOrEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number greater than or equal to the specified number. |
whenNumberLessThan(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that's less than the specified number. |
whenNumberLessThanOrEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number less than or equal to the specified number. |
whenNumberNotBetween(start, end) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number doesn't fall between, and is neither of, 2 specified numbers. |
whenNumberNotEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that isn't equal to the specified number. |
whenNumberNotEqualToAny(numbers) | FilterCriteriaBuilder | Sets the filter criteria to show cells with a number that isn't equal to any of the specified numbers. |
whenTextContains(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that contains the specified text. |
whenTextDoesNotContain(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that doesn't contain the specified text. |
whenTextEndsWith(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that ends with the specified text. |
whenTextEqualTo(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that's equal to the specified text. |
whenTextEqualToAny(texts) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that's equal to any of the specified text values. |
whenTextNotEqualTo(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that isn't equal to the specified text. |
whenTextNotEqualToAny(texts) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that isn't equal to any of the specified values. |
whenTextStartsWith(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells with text that starts with the specified text. |
withCriteria(criteria, args) | FilterCriteriaBuilder | Sets the filter criteria to a boolean condition defined by BooleanCriteria values, such as CELL_EMPTY or NUMBER_GREATER_THAN . |
FrequencyType
Properties
Property | Тип | Описание |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | The frequency type is unsupported. |
DAILY | Enum | Refresh daily. |
WEEKLY | Enum | Refresh weekly, on given days of the week. |
MONTHLY | Enum | Refresh monthly, on given days of the month. |
GradientCondition
Методы
Метод | Return type | Brief description |
---|---|---|
getMaxColorObject() | Color | Gets the color set for the maximum value of this gradient condition. |
getMaxType() | InterpolationType | Gets the interpolation type for the maximum value of this gradient condition. |
getMaxValue() | String | Gets the max value of this gradient condition. |
getMidColorObject() | Color | Gets the color set for the midpoint value of this gradient condition. |
getMidType() | InterpolationType | Gets the interpolation type for the mid-point value of this gradient condition. |
getMidValue() | String | Gets the mid-point value of this gradient condition. |
getMinColorObject() | Color | Gets the color set for the minimum value of this gradient condition. |
getMinType() | InterpolationType | Gets the interpolation type for the minimum value of this gradient condition. |
getMinValue() | String | Gets the minimum value of this gradient condition. |
Group
Методы
Метод | Return type | Brief description |
---|---|---|
collapse() | Group | Collapses this group. |
expand() | Group | Expands this group. |
getControlIndex() | Integer | Returns the control toggle index of this group. |
getDepth() | Integer | Returns the depth of this group. |
getRange() |
|