Class DataSourceFormula

DataSourceFormula

Dostęp do istniejących formuł źródeł danych i ich modyfikowanie. Aby utworzyć nową formułę źródła danych, użyj funkcji Range.setFormula(formula).

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

Metody

MetodaTyp zwracanej wartościKrótki opis
cancelDataRefresh()DataSourceFormulaAnuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony.
forceRefreshData()DataSourceFormulaOdświeża dane tego obiektu niezależnie od bieżącego stanu.
getAnchorCell()RangeZwraca wartość Range reprezentującą komórkę, w której ta formuła źródła danych jest zakotwiczona.
getDataSource()DataSourcePobiera źródło danych, z którym jest połączony obiekt.
getDisplayValue()StringZwraca wyświetlaną wartość formuły źródła danych.
getFormula()StringZwraca formułę dla tej formuły źródła danych.
getStatus()DataExecutionStatusPobiera stan wykonania danych obiektu.
refreshData()DataSourceFormulaOdświeża dane obiektu.
setFormula(formula)DataSourceFormulaAktualizuje formułę.
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

DataSourceFormula – 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

DataSourceFormula – 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

getAnchorCell()

Zwraca wartość Range reprezentującą komórkę, w której ta formuła źródła danych jest zakotwiczona.

Powroty

Range – komórka zakotwiczona.

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

getDisplayValue()

Zwraca wyświetlaną wartość formuły źródła danych.

Powroty

String – wartość wyświetlana.

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

getFormula()

Zwraca formułę dla tej formuły źródła danych.

Powroty

String – formuła.

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

DataSourceFormula – 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

setFormula(formula)

Aktualizuje formułę.

Parametry

NazwaTypOpis
formulaStringNowa formuła.

Powroty

DataSourceFormula – formuła źródła danych na potrzeby łańcuchów.

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