Class DataSourceSheet

Лист источника данных

Доступ и изменение существующей таблицы источника данных. Чтобы создать новый лист источника данных, используйте Spreadsheet.insertDataSourceSheet(spec) .

Используйте этот класс только с данными, подключенными к базе данных.

Методы

Метод Тип возврата Краткое описание
add Filter(columnName, filterCriteria) Data Source Sheet Добавляет фильтр, примененный к листу источника данных.
as Sheet() Sheet Возвращает лист источника данных как обычный объект листа.
auto Resize Column(columnName) Data Source Sheet Автоматически изменяет ширину указанного столбца.
auto Resize Columns(columnNames) Data Source Sheet Автоматически изменяет ширину указанных столбцов.
cancel Data Refresh() Data Source Sheet Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.
force Refresh Data() Data Source Sheet Обновляет данные этого объекта независимо от текущего состояния.
get Column Width(columnName) Integer Возвращает ширину указанного столбца.
get Data Source() Data Source Получает источник данных, с которым связан объект.
get Filters() Data Source Sheet Filter[] Возвращает все фильтры, примененные к листу источника данных.
get Sheet Values(columnName) Object[] Возвращает все значения листа источника данных для указанного имени столбца.
get Sheet Values(columnName, startRow, numRows) Object[] Возвращает все значения для листа источника данных для указанного имени столбца, начиная с предоставленной начальной строки (на основе 1) и до указанного num Rows .
get Sort Specs() Sort Spec[] Получает все характеристики сортировки на листе источника данных.
get Status() Data Execution Status Получает статус выполнения данных объекта.
refresh Data() Data Source Sheet Обновляет данные объекта.
remove Filters(columnName) Data Source Sheet Удаляет все фильтры, примененные к столбцу листа источника данных.
remove Sort Spec(columnName) Data Source Sheet Удаляет спецификацию сортировки для столбца на листе источника данных.
set Column Width(columnName, width) Data Source Sheet Устанавливает ширину указанного столбца.
set Column Widths(columnNames, width) Data Source Sheet Устанавливает ширину указанных столбцов.
set Sort Spec(columnName, ascending) Data Source Sheet Устанавливает спецификацию сортировки для столбца на листе источника данных.
set Sort Spec(columnName, sortOrder) Data Source Sheet Устанавливает спецификацию сортировки для столбца на листе источника данных.
wait For Completion(timeoutInSeconds) Data Execution Status Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд.

Подробная документация

add Filter(columnName, filterCriteria)

Добавляет фильтр, примененный к листу источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца, к которому нужно применить этот фильтр.
filter Criteria Filter Criteria Критерии фильтра, которые необходимо применить.

Возвращаться

Data Source Sheet — лист источника данных для цепочки методов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

as Sheet()

Возвращает лист источника данных как обычный объект листа.

Возвращаться

Sheet — обычный лист.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

auto Resize Column(columnName)

Автоматически изменяет ширину указанного столбца.

Параметры

Имя Тип Описание
column Name String Имя столбца.

Возвращаться

Data Source Sheet — этот лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

auto Resize Columns(columnNames)

Автоматически изменяет ширину указанных столбцов.

Параметры

Имя Тип Описание
column Names String[] Список имен столбцов для обновления.

Возвращаться

Data Source Sheet — этот лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancel Data Refresh()

Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.

В этом примере показано, как отменить обновление формулы.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Sheet — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

force Refresh Data()

Обновляет данные этого объекта независимо от текущего состояния. См refresh Data() для получения более подробной информации. Если вы хотите отменить текущее обновление этого объекта, см. раздел cancel Data Refresh() .

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Sheet — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Column Width(columnName)

Возвращает ширину указанного столбца.

Параметры

Имя Тип Описание
column Name String Имя столбца.

Возвращаться

Integer — ширина столбца или null , если столбец использует ширину по умолчанию.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source()

Получает источник данных, с которым связан объект.

Возвращаться

Data Source — источник данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Filters()

Возвращает все фильтры, примененные к листу источника данных.

Возвращаться

Data Source Sheet Filter[] — массив всех фильтров, примененных к листу источника данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheet Values(columnName)

Возвращает все значения листа источника данных для указанного имени столбца.

Параметры

Имя Тип Описание
column Name String Имя столбца источника данных, для которого нужно получить значения.

Возвращаться

Object[] — Одномерный массив значений.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheet Values(columnName, startRow, numRows)

Возвращает все значения для листа источника данных для указанного имени столбца, начиная с предоставленной начальной строки (на основе 1) и до указанного num Rows .

Параметры

Имя Тип Описание
column Name String Имя столбца источника данных, для которого нужно получить значения.
start Row Integer Позиция строки, с которой начинается получение значений.
num Rows Integer Количество строк для выборки.

Возвращаться

Object[] — Одномерный массив значений.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sort Specs()

Получает все характеристики сортировки на листе источника данных.

Возвращаться

Sort Spec[] — список спецификаций сортировки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Status()

Получает статус выполнения данных объекта.

Возвращаться

Data Execution Status — статус выполнения данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refresh Data()

Обновляет данные объекта.

Выдает исключение, если в данный момент находится в состоянии error . Используйте Data Source#updateSpec() для обновления спецификации. Этот метод предпочтительнее force Refresh Data() чтобы предотвратить неожиданные изменения в источнике данных.

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Sheet — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Filters(columnName)

Удаляет все фильтры, примененные к столбцу листа источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца, из которого нужно удалить фильтры.

Возвращаться

Data Source Sheet — лист источника данных для цепочки методов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Sort Spec(columnName)

Удаляет спецификацию сортировки для столбца на листе источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца.

Возвращаться

Data Source Sheet — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Column Width(columnName, width)

Устанавливает ширину указанного столбца.

Параметры

Имя Тип Описание
column Name String Имя столбца.
width Integer Новая ширина столбца.

Возвращаться

Data Source Sheet — этот лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Column Widths(columnNames, width)

Устанавливает ширину указанных столбцов.

Параметры

Имя Тип Описание
column Names String[] Список имен столбцов для обновления.
width Integer Новая ширина столбцов.

Возвращаться

Data Source Sheet — этот лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Sort Spec(columnName, ascending)

Устанавливает спецификацию сортировки для столбца на листе источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца для сортировки.
ascending Boolean Если true , отсортируйте столбец в порядке возрастания; если false , отсортируйте столбец в порядке убывания.

Возвращаться

Data Source Sheet — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Sort Spec(columnName, sortOrder)

Устанавливает спецификацию сортировки для столбца на листе источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца для сортировки.
sort Order Sort Order Порядок сортировки.

Возвращаться

Data Source Sheet — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

wait For Completion(timeoutInSeconds)

Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершено по истечении времени ожидания, но не отменяет выполнение данных.

Параметры

Имя Тип Описание
timeout In Seconds Integer Время ожидания выполнения данных в секундах. Максимум — 300 секунд.

Возвращаться

Data Execution Status — статус выполнения данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets