Class DataSourceFormula

DataSourceFormula

Для доступа к существующим формулам источников данных и их изменения используйте Range.setFormula(formula) .

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

Методы

Метод Тип возвращаемого значения Краткое описание
cancel Data Refresh() Data Source Formula Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.
force Refresh Data() Data Source Formula Обновляет данные этого объекта независимо от его текущего состояния.
get Anchor Cell() Range Возвращает Range , представляющий ячейку, в которой закреплена формула этого источника данных.
get Data Source() Data Source Получает источник данных, к которому привязан объект.
get Display Value() String Возвращает отображаемое значение формулы источника данных.
get Formula() String Возвращает формулу для данного источника данных.
get Status() Data Execution Status Получает статус выполнения данных объекта.
refresh Data() Data Source Formula Обновляет данные объекта.
set Formula(formula) Data Source Formula Обновляет формулу.
wait For Completion(timeoutInSeconds) Data Execution Status Ожидает завершения текущего выполнения, истекая по истечении заданного количества секунд.

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

cancelDataRefresh()

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

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

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

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

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

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

Авторизация

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

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

forceRefreshData()

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

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

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

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

Авторизация

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

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

getAnchorCell()

Возвращает Range , представляющий ячейку, в которой закреплена формула этого источника данных.

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

Range — опорная ячейка.

Авторизация

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

  • 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

getDisplayValue()

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

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

String — отображаемое значение.

Авторизация

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

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

getFormula()

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

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

String — формула.

Авторизация

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

  • 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() для включения выполнения данных для определенного типа источника данных.

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

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

Авторизация

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

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

setFormula(formula)

Обновляет формулу.

Параметры

Имя Тип Описание
formula String Новая формула.

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

DataSourceFormula — Формула источника данных для построения цепочек.

Авторизация

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

  • 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