Class DataSourceChart

DataSourceChart

Dostęp do istniejącego wykresu źródła danych i jego modyfikacja.

Używaj tej klasy tylko w przypadku danych połączonych z bazą danych.

Metody

MetodaTyp zwracanej wartościKrótki opis
cancelDataRefresh()DataSourceChartAnuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony.
forceRefreshData()DataSourceChartOdświeża dane tego obiektu niezależnie od bieżącego stanu.
getDataSource()DataSourcePobiera źródło danych, z którym jest połączony obiekt.
getStatus()DataExecutionStatusPobiera stan wykonania danych obiektu.
refreshData()DataSourceChartOdświeża dane obiektu.
waitForCompletion(timeoutInSeconds)DataExecutionStatusCzeka na zakończenie bieżącego wykonania, a limit czasu oczekiwania po określonej liczbie sekund zostanie przekroczony.

Szczegółowa dokumentacja

cancelDataRefresh()

Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony.

Ten przykład pokazuje, jak anulować odświeżenie formuły.

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

Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.

Powroty

DataSourceChart – obiekt danych;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

forceRefreshData()

Odświeża dane tego obiektu niezależnie od bieżącego stanu. Aby dowiedzieć się więcej, wejdź na refreshData(). Jeśli chcesz anulować uruchomione odświeżanie tego obiektu, zobacz cancelDataRefresh().

Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.

Powroty

DataSourceChart – obiekt danych;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getDataSource()

Pobiera źródło danych, z którym jest połączony obiekt.

Powroty

DataSource – źródło danych.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getStatus()

Pobiera stan wykonania danych obiektu.

Powroty

DataExecutionStatus – stan wykonania danych.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

refreshData()

Odświeża dane obiektu.

Zgłasza wyjątek, jeśli użytkownik jest w stanie error. Użyj narzędzia DataSource#updateSpec(), aby zaktualizować specyfikację. Ta metoda jest preferowana zamiast metody forceRefreshData(), aby zapobiegać nieoczekiwanym zmianom w źródle danych.

Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.

Powroty

DataSourceChart – obiekt danych;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

waitForCompletion(timeoutInSeconds)

Czeka na zakończenie bieżącego wykonania, a limit czasu oczekiwania po określonej liczbie sekund zostanie przekroczony. Zgłasza wyjątek, jeśli wykonanie nie zostało ukończone w momencie przekroczenia limitu czasu, ale nie anuluje wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalna długość to 300 sekund.

Powroty

DataExecutionStatus – stan wykonania danych.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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