Class DataSourceSheet

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 Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд.

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

addFilter(columnName, filterCriteria)

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

Параметры

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

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

DataSourceSheet — Таблица источников данных для цепочки вызовов методов.

Авторизация

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

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

asSheet()

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

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

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

Авторизация

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

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

autoResizeColumn(columnName)

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

Параметры

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

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

DataSourceSheet — Этот лист с источниками данных предназначен для создания цепочек данных.

Авторизация

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

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

autoResizeColumns(columnNames)

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

Параметры

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

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

DataSourceSheet — Этот лист с источниками данных предназначен для создания цепочек данных.

Авторизация

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

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

cancelDataRefresh()

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

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

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

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

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

DataSourceSheet — объект данных.

Авторизация

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

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

forceRefreshData()

Обновляет данные этого объекта независимо от его текущего состояния. Дополнительные сведения см. в refreshData() . Если вы хотите отменить текущее обновление этого объекта, см. cancelDataRefresh() .

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

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

DataSourceSheet — объект данных.

Авторизация

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

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

getColumnWidth(columnName)

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

Параметры

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

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

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

Авторизация

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

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

getDataSource()

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

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

DataSource — Источник данных.

Авторизация

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

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

getFilters()

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

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

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

Авторизация

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

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

getSheetValues(columnName)

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

Параметры

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

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

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

Авторизация

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

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

getSheetValues(columnName, startRow, numRows)

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

Параметры

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

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

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

Авторизация

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

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

getSortSpecs()

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

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

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

Авторизация

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

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

getStatus()

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

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

DataExecutionStatus — Статус выполнения данных.

Авторизация

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

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

refreshData()

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

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

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

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

DataSourceSheet — объект данных.

Авторизация

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

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

removeFilters(columnName)

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

Параметры

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

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

DataSourceSheet — Таблица источников данных для цепочки вызовов методов.

Авторизация

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

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

removeSortSpec(columnName)

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

Параметры

Имя Тип Описание
column Name String Название колонки.

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

DataSourceSheet — Таблица источников данных для построения цепочек.

Авторизация

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

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

setColumnWidth(columnName, width)

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

Параметры

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

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

DataSourceSheet — Этот лист с источниками данных предназначен для создания цепочек данных.

Авторизация

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

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

setColumnWidths(columnNames, width)

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

Параметры

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

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

DataSourceSheet — Этот лист с источниками данных предназначен для создания цепочек данных.

Авторизация

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

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

setSortSpec(columnName, ascending)

Задает параметры сортировки для столбца в листе «Источник данных».

Параметры

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

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

DataSourceSheet — Таблица источников данных для построения цепочек.

Авторизация

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

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

setSortSpec(columnName, sortOrder)

Задает параметры сортировки для столбца в листе «Источник данных».

Параметры

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

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

DataSourceSheet — Таблица источников данных для построения цепочек.

Авторизация

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

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

waitForCompletion(timeoutInSeconds)

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

Параметры

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

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

DataExecutionStatus — Статус выполнения данных.

Авторизация

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

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