Доступ и изменение существующей диаграммы источника данных.
Используйте этот класс только с данными, подключенными к базе данных.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
cancelDataRefresh() | DataSourceChart | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
forceRefreshData() | DataSourceChart | Обновляет данные этого объекта независимо от текущего состояния. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getStatus() | DataExecutionStatus | Получает статус выполнения данных объекта. |
refreshData() | DataSourceChart | Обновляет данные объекта. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
Подробная документация
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)
Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершено по истечении времени ожидания, но не отменяет выполнение данных.
Параметры
Имя | Тип | Описание |
---|---|---|
timeoutInSeconds | Integer | Время ожидания выполнения данных в секундах. Максимум — 300 секунд. |
Возвращаться
DataExecutionStatus
— Статус выполнения данных.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets