Mengakses dan mengubah sheet sumber data yang ada. Untuk membuat sheet sumber data baru, gunakan Spreadsheet.insertDataSourceSheet(spec)
.
Hanya gunakan class ini dengan data yang terhubung ke database.
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Menambahkan filter yang diterapkan ke sheet sumber data. |
asSheet() | Sheet | Menampilkan sheet sumber data sebagai objek sheet reguler. |
autoResizeColumn(columnName) | DataSourceSheet | Otomatis mengubah ukuran lebar kolom yang ditentukan. |
autoResizeColumns(columnNames) | DataSourceSheet | Otomatis mengubah ukuran lebar kolom yang ditentukan. |
cancelDataRefresh() | DataSourceSheet | Membatalkan pemuatan ulang data yang terkait dengan objek ini jika objek sedang berjalan. |
forceRefreshData() | DataSourceSheet | Memuat ulang data objek ini terlepas dari status saat ini. |
getColumnWidth(columnName) | Integer | Menampilkan lebar kolom yang ditentukan. |
getDataSource() | DataSource | Mendapatkan sumber data yang ditautkan ke objek. |
getFilters() | DataSourceSheetFilter[] | Menampilkan semua filter yang diterapkan ke sheet sumber data. |
getSheetValues(columnName) | Object[] | Menampilkan semua nilai sheet sumber data untuk nama kolom yang diberikan. |
getSheetValues(columnName, startRow, numRows) | Object[] | Menampilkan semua nilai sheet sumber data untuk nama kolom yang diberikan dari kolom yang disediakan
baris awal (based-1) dan hingga numRows yang dimasukkan. |
getSortSpecs() | SortSpec[] | Mendapatkan semua spesifikasi pengurutan dalam sheet sumber data. |
getStatus() | DataExecutionStatus | Mendapatkan status eksekusi data objek. |
refreshData() | DataSourceSheet | Memuat ulang data objek. |
removeFilters(columnName) | DataSourceSheet | Menghapus semua filter yang diterapkan ke kolom sheet sumber data. |
removeSortSpec(columnName) | DataSourceSheet | Menghapus spesifikasi pengurutan pada kolom dalam sheet sumber data. |
setColumnWidth(columnName, width) | DataSourceSheet | Menetapkan lebar kolom yang ditentukan. |
setColumnWidths(columnNames, width) | DataSourceSheet | Menetapkan lebar kolom yang ditentukan. |
setSortSpec(columnName, ascending) | DataSourceSheet | Menetapkan spesifikasi pengurutan pada kolom dalam sheet sumber data. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Menetapkan spesifikasi pengurutan pada kolom dalam sheet sumber data. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Menunggu hingga eksekusi saat ini selesai, waktu habis setelah jumlah detik yang diberikan. |
Dokumentasi mendetail
addFilter(columnName, filterCriteria)
Menambahkan filter yang diterapkan ke sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom tempat filter ini akan diterapkan. |
filterCriteria | FilterCriteria | Kriteria filter yang akan diterapkan. |
Pulang pergi
DataSourceSheet
— Sheet sumber data, untuk perantaian metode.
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
asSheet()
Menampilkan sheet sumber data sebagai objek sheet reguler.
Pulang pergi
Sheet
— Sheet reguler.
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
autoResizeColumn(columnName)
Otomatis mengubah ukuran lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom. |
Pulang pergi
DataSourceSheet
— Sheet sumber data ini, 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
autoResizeColumns(columnNames)
Otomatis mengubah ukuran lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnNames | String[] | Daftar nama kolom yang akan diperbarui. |
Pulang pergi
DataSourceSheet
— Sheet sumber data ini, 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
cancelDataRefresh()
Membatalkan pemuatan ulang data yang terkait dengan objek ini jika objek 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. Menggunakan metode
SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data bagi sumber data tertentu
.
Pulang pergi
DataSourceSheet
— 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 status saat ini. Lihat refreshData()
untuk
secara lebih mendetail. Jika Anda ingin membatalkan pemuatan ulang objek ini yang sedang berjalan, lihat cancelDataRefresh()
.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Menggunakan metode SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data bagi sumber data tertentu
.
Pulang pergi
DataSourceSheet
— 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
getColumnWidth(columnName)
Menampilkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom. |
Pulang pergi
Integer
— Lebar kolom, atau null
jika kolom menggunakan lebar default.
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.
Pulang pergi
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
getFilters()
Menampilkan semua filter yang diterapkan ke sheet sumber data.
Pulang pergi
DataSourceSheetFilter[]
— Array semua filter yang diterapkan ke sheet 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
getSheetValues(columnName)
Menampilkan semua nilai sheet sumber data untuk nama kolom yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom sumber data yang nilainya akan diambil. |
Pulang pergi
Object[]
— Array nilai satu dimensi.
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
getSheetValues(columnName, startRow, numRows)
Menampilkan semua nilai sheet sumber data untuk nama kolom yang diberikan dari kolom yang disediakan
baris awal (based-1) dan hingga numRows
yang dimasukkan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom sumber data yang nilainya akan diambil. |
startRow | Integer | Posisi baris untuk mulai mengambil nilai. |
numRows | Integer | Jumlah baris yang akan diambil. |
Pulang pergi
Object[]
— Array nilai satu dimensi.
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
getSortSpecs()
Mendapatkan semua spesifikasi pengurutan dalam sheet sumber data.
Pulang pergi
SortSpec[]
— Daftar spesifikasi pengurutan.
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.
Pulang pergi
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 mengupdate spesifikasi. Metodenya adalah
lebih disukai daripada forceRefreshData()
untuk mencegah pengeditan yang tidak terduga pada sumber data.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Menggunakan metode SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data bagi sumber data tertentu
.
Pulang pergi
DataSourceSheet
— 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
removeFilters(columnName)
Menghapus semua filter yang diterapkan ke kolom sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom yang filternya akan dihapus. |
Pulang pergi
DataSourceSheet
— Sheet sumber data, untuk perantaian metode.
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
removeSortSpec(columnName)
Menghapus spesifikasi pengurutan pada kolom dalam sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom. |
Pulang pergi
DataSourceSheet
— Sheet 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
setColumnWidth(columnName, width)
Menetapkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom. |
width | Integer | Lebar baru untuk kolom. |
Pulang pergi
DataSourceSheet
— Sheet sumber data ini, 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
setColumnWidths(columnNames, width)
Menetapkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnNames | String[] | Daftar nama kolom yang akan diperbarui. |
width | Integer | Lebar baru untuk kolom. |
Pulang pergi
DataSourceSheet
— Sheet sumber data ini, 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
setSortSpec(columnName, ascending)
Menetapkan spesifikasi pengurutan pada kolom dalam sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom yang akan diurutkan. |
ascending | Boolean | Jika true , urutkan kolom dalam urutan menaik; jika false , urutkan
kolom dalam
urutan menurun. |
Pulang pergi
DataSourceSheet
— Sheet 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
setSortSpec(columnName, sortOrder)
Menetapkan spesifikasi pengurutan pada kolom dalam sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom yang akan diurutkan. |
sortOrder | SortOrder | Tata urutan. |
Pulang pergi
DataSourceSheet
— Sheet 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, waktu habis setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai saat waktu habis, tetapi tidak membatalkan dalam eksekusi data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
timeoutInSeconds | Integer | Waktu tunggu untuk eksekusi data, dalam detik. Maksimumnya adalah 300 detik. |
Pulang pergi
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