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

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

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 Formula — объект данных.

Авторизация

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

  • 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 Formula — объект данных.

Авторизация

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

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

get Anchor Cell()

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

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

Range — ячейка привязки.

Авторизация

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

  • 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 Display Value()

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

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

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

Авторизация

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

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

get Formula()

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

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

String — формула.

Авторизация

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

  • 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 Formula — объект данных.

Авторизация

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

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

set Formula(formula)

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

Параметры

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

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

Data Source Formula — формула источника данных для цепочки.

Авторизация

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

  • 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