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|null Возвращает ширину указанного столбца.
get Data Source() Data Source Получает источник данных, к которому привязан объект.
get Filters() Data Source Sheet Filter[] Возвращает все фильтры, примененные к листу с исходными данными.
get Sheet Values(columnName) Object[] Возвращает все значения из листа источника данных для указанного имени столбца.
get Sheet Values(columnName, startRow, numRows) Object[] Возвращает все значения для листа источника данных по указанному имени столбца, начиная с указанной начальной строки (based-1) и до указанного num Rows .
get Sort Specs() Sort Spec[] Получает все параметры сортировки из таблицы источников данных.
get Status() Data Execution Status Получает статус выполнения данных объекта.
refresh Data() Data Source Sheet Обновляет данные объекта.
remove Filters(columnName) Data Source Sheet Удаляет все фильтры, примененные к столбцу листа источника данных.
remove Sort Spec(columnName) Data Source Sheet Удаляет спецификацию сортировки для столбца в листе источника данных.
set Column Width(columnName, width) Data Source Sheet Задает ширину указанного столбца.
set Column Widths(columnNames, width) Data Source Sheet Задает ширину указанных столбцов.
set Sort Spec(columnName, ascending) Data Source Sheet Задает параметры сортировки для столбца в листе «Источник данных».
set Sort Spec(columnName, sortOrder) Data Source Sheet Задает параметры сортировки для столбца в листе «Источник данных».
wait For Completion(timeoutInSeconds) Data Execution Status Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд.

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

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 — ширина столбца, или 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)

Возвращает все значения для листа источника данных по указанному имени столбца, начиная с указанной начальной строки (based-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