Class DataSourceFormula

DataSourceFormula

uzyskiwać dostęp do istniejących formuł źródeł danych i je modyfikować; 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 BigQuery.

Metody

MetodaZwracany typKrótki opis
cancelDataRefresh()DataSourceFormulaAnuluje odświeżanie danych powiązane z tym obiektem, jeśli jest on uruchomiony.
forceRefreshData()DataSourceFormulaOdświeża dane tego obiektu niezależnie od bieżącego stanu.
getAnchorCell()RangeZwraca Range reprezentujący komórkę, w której zakotwiczona jest ta formuła źródła danych.
getDataSource()DataSourcePobiera źródło danych, z którym połączony jest obiekt.
getDisplayValue()StringZwraca wartość wyświetlaną formuły źródła danych.
getFormula()StringZwraca formułę 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)DataExecutionStatusCzekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund.

Szczegółowa dokumentacja

cancelDataRefresh()

Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest on 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();

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

Powrót

DataSourceFormula – obiekt danych.

Autoryzacja

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 jego bieżącego stanu. Więcej informacji znajdziesz w artykule refreshData(). Jeśli chcesz anulować aktualnie uruchomione odświeżanie tego obiektu, zobacz cancelDataRefresh().

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

Powrót

DataSourceFormula – obiekt danych.

Autoryzacja

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 Range reprezentujący komórkę, w której zakotwiczona jest ta formuła źródła danych.

Powrót

Range – komórka kotwicy.

Autoryzacja

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.

Powrót

DataSource – źródło danych.

Autoryzacja

Skrypty, które korzystają 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 wartość wyświetlaną formuły źródła danych.

Powrót

String – wyświetlana wartość.

Autoryzacja

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łę tej formuły źródła danych.

Powrót

String – formuła.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

DataExecutionStatus – stan wykonania kodu.

Autoryzacja

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 obecnie jest w stanie error. Aby zaktualizować specyfikację, użyj polecenia DataSource#updateSpec(). Metoda preferowana niż forceRefreshData(), aby zapobiec nieoczekiwanym edytowaniu źródła danych.

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

Powrót

DataSourceFormula – obiekt danych.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

DataSourceFormula – formuła źródła danych służąca do tworzenia łańcuchów.

Autoryzacja

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)

Czekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonanie nie zostanie ukończone po przekroczeniu limitu czasu, ale nie anuluje i generowanie danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie bazy danych (w sekundach). Maksymalna liczba to 300 sek.

Powrót

DataExecutionStatus – stan wykonania kodu.

Autoryzacja

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