Class DataSourceFormula

DataSourceFormula

Mengakses dan mengubah formula sumber data yang ada. Untuk membuat formula sumber data baru, gunakan Range.setFormula(formula).

Hanya gunakan class ini dengan data yang terhubung ke database.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
cancelDataRefresh()DataSourceFormulaMembatalkan refresh data yang terkait dengan objek ini jika sedang berjalan.
forceRefreshData()DataSourceFormulaMemuat ulang data objek ini, terlepas dari statusnya saat ini.
getAnchorCell()RangeMenampilkan Range yang mewakili sel tempat formula sumber data ini ditambatkan.
getDataSource()DataSourceMendapatkan sumber data yang ditautkan ke objek.
getDisplayValue()StringMenampilkan nilai tampilan dari formula sumber data.
getFormula()StringMenampilkan formula untuk formula sumber data ini.
getStatus()DataExecutionStatusMendapatkan status eksekusi data objek.
refreshData()DataSourceFormulaMemuat ulang data objek.
setFormula(formula)DataSourceFormulaMemperbarui formula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusMenunggu hingga eksekusi saat ini selesai, akan kehabisan waktu setelah jumlah detik yang diberikan.

Dokumentasi mendetail

cancelDataRefresh()

Membatalkan refresh data yang terkait dengan objek ini jika sedang berjalan.

Contoh ini menunjukkan cara membatalkan pemuatan ulang formula.

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

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk jenis sumber data tertentu.

Return

DataSourceFormula — Objek data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

forceRefreshData()

Memuat ulang data objek ini, terlepas dari statusnya saat ini. Lihat refreshData() untuk detail selengkapnya. Jika Anda ingin membatalkan refresh objek yang sedang berjalan ini, lihat cancelDataRefresh().

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk jenis sumber data tertentu.

Return

DataSourceFormula — Objek data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getAnchorCell()

Menampilkan Range yang mewakili sel tempat formula sumber data ini ditambatkan.

Return

Range — Sel anchor.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getDataSource()

Mendapatkan sumber data yang ditautkan ke objek.

Return

DataSource — Sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getDisplayValue()

Menampilkan nilai tampilan dari formula sumber data.

Return

String — Nilai tampilan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFormula()

Menampilkan formula untuk formula sumber data ini.

Return

String — Formula.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getStatus()

Mendapatkan status eksekusi data objek.

Return

DataExecutionStatus — Status eksekusi data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

refreshData()

Memuat ulang data objek.

Menampilkan pengecualian jika saat ini dalam status error. Gunakan DataSource#updateSpec() untuk memperbarui spesifikasi. Metode ini lebih disarankan daripada forceRefreshData() untuk mencegah pengeditan yang tidak terduga pada sumber data.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk jenis sumber data tertentu.

Return

DataSourceFormula — Objek data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

setFormula(formula)

Memperbarui formula.

Parameter

NamaJenisDeskripsi
formulaStringFormula baru.

Return

DataSourceFormula — Formula sumber data, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

waitForCompletion(timeoutInSeconds)

Menunggu hingga eksekusi saat ini selesai, akan kehabisan waktu setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai saat waktu habis, tetapi tidak membatalkan eksekusi data.

Parameter

NamaJenisDeskripsi
timeoutInSecondsIntegerWaktu tunggu eksekusi data, dalam detik. Durasi maksimumnya adalah 300 detik.

Return

DataExecutionStatus — Status eksekusi data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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