Class DataSourceChart

DataSourceChart

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

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

Методы

Метод Тип возвращаемого значения Краткое описание
cancel Data Refresh() Data Source Chart Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.
force Refresh Data() Data Source Chart Обновляет данные этого объекта независимо от его текущего состояния.
get Data Source() Data Source Получает источник данных, к которому привязан объект.
get Status() Data Execution Status Получает статус выполнения данных объекта.
refresh Data() Data Source Chart Обновляет данные объекта.
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() для включения выполнения данных для определенного типа источника данных.

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

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

Авторизация

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

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

forceRefreshData()

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

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

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

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

Авторизация

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

  • 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

getStatus()

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

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

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

Авторизация

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

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

refreshData()

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

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

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

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

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

Авторизация

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

  • 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