Mengakses dan mengubah sheet spreadsheet. Operasi umum adalah mengganti nama sheet dan mengakses objek rentang dari sheet.
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
activate() | Sheet | Mengaktifkan sheet ini. |
addDeveloperMetadata(key) | Sheet | Menambahkan metadata developer dengan kunci yang ditentukan ke sheet. |
addDeveloperMetadata(key, visibility) | Sheet | Menambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke sheet. |
addDeveloperMetadata(key, value) | Sheet | Menambahkan metadata developer dengan kunci dan nilai yang ditentukan ke sheet. |
addDeveloperMetadata(key, value, visibility) | Sheet | Menambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke sheet. |
appendRow(rowContents) | Sheet | Menambahkan baris ke bagian bawah region data saat ini di sheet. |
asDataSourceSheet() | DataSourceSheet | Menampilkan sheet sebagai DataSourceSheet jika sheet berjenis SheetType.DATASOURCE , atau null jika tidak. |
autoResizeColumn(columnPosition) | Sheet | Menetapkan lebar kolom yang diberikan agar sesuai dengan kontennya. |
autoResizeColumns(startColumn, numColumns) | Sheet | Menetapkan lebar semua kolom mulai dari posisi kolom tertentu agar sesuai dengan kontennya. |
autoResizeRows(startRow, numRows) | Sheet | Menetapkan tinggi semua baris mulai dari posisi baris tertentu agar sesuai dengan kontennya. |
clear() | Sheet | Menghapus sheet konten dan informasi pemformatan. |
clear(options) | Sheet | Menghapus sheet konten dan/atau format, seperti yang ditentukan dengan opsi lanjutan tertentu. |
clearConditionalFormatRules() | void | Menghapus semua aturan format bersyarat dari sheet. |
clearContents() | Sheet | Menghapus sheet konten, sembari mempertahankan informasi pemformatan. |
clearFormats() | Sheet | Menghapus sheet pemformatan, sekaligus mempertahankan konten. |
clearNotes() | Sheet | Menghapus sheet semua catatan. |
collapseAllColumnGroups() | Sheet | Menciutkan semua grup kolom pada sheet. |
collapseAllRowGroups() | Sheet | Menciutkan semua grup baris di sheet. |
copyTo(spreadsheet) | Sheet | Menyalin sheet ke spreadsheet tertentu, yang dapat berupa spreadsheet yang sama dengan sumber. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Menampilkan DeveloperMetadataFinder untuk menemukan metadata developer dalam cakupan
sheet ini. |
createTextFinder(findText) | TextFinder | Membuat pencari teks untuk sheet, yang dapat menemukan dan mengganti teks dalam sheet. |
deleteColumn(columnPosition) | Sheet | Menghapus kolom di posisi kolom yang ditentukan. |
deleteColumns(columnPosition, howMany) | void | Menghapus sejumlah kolom mulai dari posisi kolom tertentu. |
deleteRow(rowPosition) | Sheet | Menghapus baris pada posisi baris tertentu. |
deleteRows(rowPosition, howMany) | void | Menghapus sejumlah baris yang dimulai pada posisi baris tertentu. |
expandAllColumnGroups() | Sheet | Meluaskan semua grup kolom di sheet. |
expandAllRowGroups() | Sheet | Meluaskan semua grup baris di sheet. |
expandColumnGroupsUpToDepth(groupDepth) | Sheet | Meluaskan semua grup kolom hingga kedalaman tertentu, dan menciutkan semua kolom lainnya. |
expandRowGroupsUpToDepth(groupDepth) | Sheet | Meluaskan semua grup baris hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya. |
getActiveCell() | Range | Menampilkan sel aktif dalam sheet ini. |
getActiveRange() | Range | Menampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif. |
getActiveRangeList() | RangeList | Menampilkan daftar rentang aktif di sheet aktif atau null jika tidak ada rentang
aktif. |
getBandings() | Banding[] | Menampilkan semua banding di sheet ini. |
getCharts() | EmbeddedChart[] | Menampilkan array diagram pada sheet ini. |
getColumnGroup(columnIndex, groupDepth) | Group | Menampilkan grup kolom pada indeks dan kedalaman grup yang ditentukan. |
getColumnGroupControlPosition() | GroupControlTogglePosition | Menampilkan GroupControlTogglePosition untuk semua grup kolom pada sheet. |
getColumnGroupDepth(columnIndex) | Integer | Menampilkan kedalaman grup kolom pada indeks tertentu. |
getColumnWidth(columnPosition) | Integer | Mendapatkan lebar dalam piksel untuk kolom yang diberikan. |
getConditionalFormatRules() | ConditionalFormatRule[] | Dapatkan semua aturan format bersyarat di sheet ini. |
getCurrentCell() | Range | Menampilkan sel saat ini dalam sheet aktif atau null jika tidak ada sel saat ini. |
getDataRange() | Range | Menampilkan Range yang sesuai dengan dimensi yang menampilkan data. |
getDataSourceFormulas() | DataSourceFormula[] | Mendapatkan semua formula sumber data. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Mendapatkan semua tabel pivot sumber data. |
getDataSourceTables() | DataSourceTable[] | Mendapatkan semua tabel sumber data. |
getDeveloperMetadata() | DeveloperMetadata[] | Dapatkan semua metadata developer yang terkait dengan sheet ini. |
getDrawings() | Drawing[] | Menampilkan array gambar pada sheet. |
getFilter() | Filter | Menampilkan filter dalam sheet ini, atau null jika tidak ada filter. |
getFormUrl() | String | Menampilkan URL untuk formulir yang mengirim respons ke sheet ini, atau null jika sheet ini tidak memiliki formulir terkait. |
getFrozenColumns() | Integer | Menampilkan jumlah kolom yang dibekukan. |
getFrozenRows() | Integer | Menampilkan jumlah baris yang dibekukan. |
getImages() | OverGridImage[] | Menampilkan semua gambar over-the-grid di sheet. |
getIndex() | Integer | Mendapatkan posisi sheet dalam spreadsheet induknya. |
getLastColumn() | Integer | Menampilkan posisi kolom terakhir yang memiliki konten. |
getLastRow() | Integer | Menampilkan posisi baris terakhir yang memiliki konten. |
getMaxColumns() | Integer | Menampilkan jumlah kolom saat ini di sheet, apa pun kontennya. |
getMaxRows() | Integer | Menampilkan jumlah baris saat ini di sheet, apa pun kontennya. |
getName() | String | Menampilkan nama sheet. |
getNamedRanges() | NamedRange[] | Mendapatkan semua rentang bernama di sheet ini. |
getParent() | Spreadsheet | Menampilkan Spreadsheet yang berisi sheet ini. |
getPivotTables() | PivotTable[] | Menampilkan semua tabel pivot pada sheet ini. |
getProtections(type) | Protection[] | Mendapatkan array objek yang mewakili semua rentang yang dilindungi di sheet, atau array elemen tunggal yang mewakili perlindungan pada sheet itu sendiri. |
getRange(row, column) | Range | Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan. |
getRange(row, column, numRows) | Range | Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan, dan dengan jumlah baris yang diberikan. |
getRange(row, column, numRows, numColumns) | Range | Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan dengan jumlah baris dan kolom tertentu. |
getRange(a1Notation) | Range | Menampilkan rentang seperti yang ditentukan dalam notasi A1 atau notasi R1C1. |
getRangeList(a1Notations) | RangeList | Menampilkan koleksi RangeList yang merepresentasikan rentang dalam sheet yang sama yang ditentukan
oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong. |
getRowGroup(rowIndex, groupDepth) | Group | Menampilkan grup baris pada indeks dan kedalaman grup yang ditentukan. |
getRowGroupControlPosition() | GroupControlTogglePosition | Menampilkan GroupControlTogglePosition untuk semua grup baris di sheet. |
getRowGroupDepth(rowIndex) | Integer | Menampilkan kedalaman grup baris pada indeks tertentu. |
getRowHeight(rowPosition) | Integer | Mendapatkan tinggi piksel dalam baris tertentu. |
getSelection() | Selection | Menampilkan Selection saat ini di spreadsheet. |
getSheetId() | Integer | Menampilkan ID sheet yang diwakili oleh objek ini. |
getSheetName() | String | Menampilkan nama sheet. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Menampilkan petak nilai persegi panjang untuk rentang ini mulai dari koordinat yang diberikan. |
getSlicers() | Slicer[] | Menampilkan array pemotong pada sheet. |
getTabColorObject() | Color | Mendapatkan warna tab sheet, atau null jika tab sheet tidak memiliki warna. |
getType() | SheetType | Menampilkan jenis sheet. |
hasHiddenGridlines() | Boolean | Menampilkan true jika garis petak sheet disembunyikan; jika tidak, menampilkan false . |
hideColumn(column) | void | Menyembunyikan satu atau beberapa kolom dalam rentang yang ditentukan. |
hideColumns(columnIndex) | void | Menyembunyikan satu kolom pada indeks tertentu. |
hideColumns(columnIndex, numColumns) | void | Menyembunyikan satu atau beberapa kolom berturut-turut yang dimulai pada indeks tertentu. |
hideRow(row) | void | Menyembunyikan baris dalam rentang yang diberikan. |
hideRows(rowIndex) | void | Menyembunyikan baris pada indeks tertentu. |
hideRows(rowIndex, numRows) | void | Menyembunyikan satu atau beberapa baris berturut-turut yang dimulai pada indeks tertentu. |
hideSheet() | Sheet | Menyembunyikan sheet ini. |
insertChart(chart) | void | Menambahkan diagram baru ke sheet ini. |
insertColumnAfter(afterPosition) | Sheet | Menyisipkan kolom setelah posisi kolom yang ditentukan. |
insertColumnBefore(beforePosition) | Sheet | Menyisipkan kolom sebelum posisi kolom yang ditentukan. |
insertColumns(columnIndex) | void | Menyisipkan kolom kosong pada sheet di lokasi yang ditentukan. |
insertColumns(columnIndex, numColumns) | void | Menyisipkan satu atau beberapa kolom kosong berturut-turut dalam sebuah sheet yang dimulai dari lokasi yang ditentukan. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Menyisipkan sejumlah kolom setelah posisi kolom yang ditentukan. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Menyisipkan sejumlah kolom sebelum posisi kolom yang ditentukan. |
insertImage(blobSource, column, row) | OverGridImage | Menyisipkan BlobSource sebagai gambar di dokumen pada baris dan kolom tertentu. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Menyisipkan BlobSource sebagai gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel. |
insertImage(url, column, row) | OverGridImage | Menyisipkan gambar dalam dokumen di baris dan kolom tertentu. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Menyisipkan gambar dalam dokumen di baris dan kolom tertentu, dengan offset piksel. |
insertRowAfter(afterPosition) | Sheet | Menyisipkan baris setelah posisi baris yang ditentukan. |
insertRowBefore(beforePosition) | Sheet | Menyisipkan baris sebelum posisi baris yang ditentukan. |
insertRows(rowIndex) | void | Menyisipkan baris kosong dalam sheet di lokasi yang ditentukan. |
insertRows(rowIndex, numRows) | void | Menyisipkan satu atau beberapa baris kosong yang berurutan dalam sebuah sheet yang dimulai dari lokasi yang ditentukan. |
insertRowsAfter(afterPosition, howMany) | Sheet | Menyisipkan sejumlah baris setelah posisi baris tertentu. |
insertRowsBefore(beforePosition, howMany) | Sheet | Menyisipkan sejumlah baris sebelum posisi baris tertentu. |
insertSlicer(range, anchorRowPos, anchorColPos) | Slicer | Menambahkan pemotong baru ke sheet ini. |
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Menambahkan pemotong baru ke sheet ini. |
isColumnHiddenByUser(columnPosition) | Boolean | Menampilkan apakah kolom tertentu disembunyikan oleh pengguna. |
isRightToLeft() | Boolean | Menampilkan true jika tata letak sheet ini ditulis dari kanan ke kiri. |
isRowHiddenByFilter(rowPosition) | Boolean | Menampilkan apakah baris tertentu disembunyikan oleh filter (bukan tampilan filter). |
isRowHiddenByUser(rowPosition) | Boolean | Menampilkan apakah baris tertentu disembunyikan oleh pengguna. |
isSheetHidden() | Boolean | Menampilkan true jika sheet saat ini disembunyikan. |
moveColumns(columnSpec, destinationIndex) | void | Memindahkan kolom yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex . |
moveRows(rowSpec, destinationIndex) | void | Memindahkan baris yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex . |
newChart() | EmbeddedChartBuilder | Menampilkan builder untuk membuat diagram baru untuk sheet ini. |
protect() | Protection | Membuat objek yang dapat melindungi sheet agar tidak diedit, kecuali oleh pengguna yang memiliki izin. |
removeChart(chart) | void | Menghapus diagram dari sheet induk. |
setActiveRange(range) | Range | Menetapkan rentang yang ditentukan sebagai active range di sheet aktif, dengan
sel kiri atas dalam rentang sebagai current cell . |
setActiveRangeList(rangeList) | RangeList | Menetapkan daftar rentang yang ditentukan sebagai active ranges dalam
sheet aktif. |
setActiveSelection(range) | Range | Menetapkan wilayah pemilihan yang aktif untuk sheet ini. |
setActiveSelection(a1Notation) | Range | Menyetel pemilihan aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1. |
setColumnGroupControlPosition(position) | Sheet | Menetapkan posisi tombol kontrol grup kolom pada sheet. |
setColumnWidth(columnPosition, width) | Sheet | Menetapkan lebar kolom yang diberikan dalam piksel. |
setColumnWidths(startColumn, numColumns, width) | Sheet | Menetapkan lebar kolom yang diberikan dalam piksel. |
setConditionalFormatRules(rules) | void | Mengganti semua aturan format bersyarat yang ada saat ini di sheet dengan aturan input. |
setCurrentCell(cell) | Range | Menetapkan sel yang ditentukan sebagai current cell . |
setFrozenColumns(columns) | void | Membekukan jumlah kolom tertentu. |
setFrozenRows(rows) | void | Membekukan jumlah baris yang ditentukan. |
setHiddenGridlines(hideGridlines) | Sheet | Menyembunyikan atau menampilkan garis kisi sheet. |
setName(name) | Sheet | Menetapkan nama sheet. |
setRightToLeft(rightToLeft) | Sheet | Menetapkan atau membatalkan penetapan tata letak sheet dari kanan ke kiri. |
setRowGroupControlPosition(position) | Sheet | Menetapkan posisi tombol kontrol grup baris di sheet. |
setRowHeight(rowPosition, height) | Sheet | Menetapkan tinggi baris untuk baris yang ditentukan dalam piksel. |
setRowHeights(startRow, numRows, height) | Sheet | Menetapkan tinggi baris yang ditentukan dalam piksel. |
setRowHeightsForced(startRow, numRows, height) | Sheet | Menetapkan tinggi baris yang ditentukan dalam piksel. |
setTabColor(color) | Sheet | Menetapkan warna tab sheet. |
setTabColorObject(color) | Sheet | Menetapkan warna tab sheet. |
showColumns(columnIndex) | void | Memperlihatkan kolom pada indeks tertentu. |
showColumns(columnIndex, numColumns) | void | Memperlihatkan satu atau beberapa kolom berturut-turut yang dimulai pada indeks tertentu. |
showRows(rowIndex) | void | Memperlihatkan baris pada indeks tertentu. |
showRows(rowIndex, numRows) | void | Memperlihatkan satu atau beberapa baris berturut-turut yang dimulai pada indeks tertentu. |
showSheet() | Sheet | Membuat sheet terlihat. |
sort(columnPosition) | Sheet | Mengurutkan sheet berdasarkan kolom, secara menaik. |
sort(columnPosition, ascending) | Sheet | Mengurutkan sheet berdasarkan kolom. |
unhideColumn(column) | void | Memperlihatkan kolom dalam rentang yang diberikan. |
unhideRow(row) | void | Memperlihatkan baris dalam rentang yang diberikan. |
updateChart(chart) | void | Memperbarui diagram pada sheet ini. |
Dokumentasi mendetail
activate()
Mengaktifkan sheet ini. Tidak mengubah sheet itu sendiri, hanya gagasan induk dari sheet aktif.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate();
Pulang pergi
Sheet
— Sheet yang baru aktif.
addDeveloperMetadata(key)
Menambahkan metadata developer dengan kunci yang ditentukan ke sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME'); // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | Kunci untuk metadata developer baru. |
Pulang pergi
Sheet
— Sheet 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
addDeveloperMetadata(key, visibility)
Menambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | Kunci untuk metadata developer baru. |
visibility | DeveloperMetadataVisibility | Visibilitas metadata developer baru. |
Pulang pergi
Sheet
— Sheet 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
addDeveloperMetadata(key, value)
Menambahkan metadata developer dengan kunci dan nilai yang ditentukan ke sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH'); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | Kunci untuk metadata developer baru. |
value | String | Nilai untuk metadata developer baru. |
Pulang pergi
Sheet
— Sheet 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
addDeveloperMetadata(key, value, visibility)
Menambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the // visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata( 'COMPANY', 'TECH', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | Kunci untuk metadata developer baru. |
value | String | Nilai untuk metadata developer baru. |
visibility | DeveloperMetadataVisibility | Visibilitas metadata developer baru. |
Pulang pergi
Sheet
— Sheet 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
appendRow(rowContents)
Menambahkan baris ke bagian bawah region data saat ini di sheet.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Appends a new row with 3 columns to the bottom of the current // data region in the sheet containing the values in the array. sheet.appendRow(["a man", "a plan", "panama"]);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowContents | Object[] | Array nilai yang akan disisipkan setelah baris terakhir dalam sheet. |
Pulang pergi
Sheet
— Sheet, yang berguna 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
asDataSourceSheet()
Menampilkan sheet sebagai DataSourceSheet
jika sheet berjenis SheetType.DATASOURCE
, atau null
jika tidak.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
Pulang pergi
DataSourceSheet
— 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
autoResizeColumn(columnPosition)
Menetapkan lebar kolom yang diberikan agar sesuai dengan kontennya.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom yang akan diubah ukurannya. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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(startColumn, numColumns)
Menetapkan lebar semua kolom mulai dari posisi kolom tertentu agar sesuai dengan kontennya.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startColumn | Integer | Kolom awal untuk mengubah ukuran otomatis. |
numColumns | Integer | Jumlah kolom untuk mengubah ukuran secara otomatis. |
Pulang pergi
Sheet
— Sheet 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
autoResizeRows(startRow, numRows)
Menetapkan tinggi semua baris mulai dari posisi baris tertentu agar sesuai dengan kontennya.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startRow | Integer | Baris awal untuk mengubah ukuran secara otomatis. |
numRows | Integer | Jumlah baris yang akan diubah ukurannya secara otomatis. |
Pulang pergi
Sheet
— Sheet 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
clear()
Menghapus sheet konten dan informasi pemformatan.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clear();
Pulang pergi
Sheet
— Sheet yang dihapus.
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
clear(options)
Menghapus sheet konten dan/atau format, seperti yang ditentukan dengan opsi lanjutan tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.clear({ formatOnly: true, contentsOnly: true });
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
options | Object | Peta JavaScript yang berisi opsi lanjutan, yang tercantum di bawah ini. |
Parameter lanjutan
Nama | Jenis | Deskripsi |
---|---|---|
contentsOnly | Boolean | Apakah konten akan dihapus. |
formatOnly | Boolean | Apakah akan menghapus format. |
Pulang pergi
Sheet
— Sheet 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
clearConditionalFormatRules()
Menghapus semua aturan format bersyarat dari sheet. Setara dengan memanggil setConditionalFormatRules(rules)
dengan array kosong sebagai input.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
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
clearContents()
Menghapus sheet konten, sembari mempertahankan informasi pemformatan.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearContents();
Pulang pergi
Sheet
— Sheet 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
clearFormats()
Menghapus sheet pemformatan, sekaligus mempertahankan konten.
Pemformatan merujuk pada cara data diformat sebagai diizinkan oleh pilihan di menu "Format" (contoh: tebal, miring, format bersyarat) dan bukan lebar atau tinggi sel.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearFormats();
Pulang pergi
Sheet
— Sheet 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
clearNotes()
Menghapus sheet semua catatan.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearNotes();
Pulang pergi
Sheet
— Sheet 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
collapseAllColumnGroups()
Menciutkan semua grup kolom pada sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
Pulang pergi
Sheet
— Sheet 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
collapseAllRowGroups()
Menciutkan semua grup baris di sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
Pulang pergi
Sheet
— Sheet 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
copyTo(spreadsheet)
Menyalin sheet ke spreadsheet tertentu, yang dapat berupa spreadsheet yang sama dengan sumber. Sheet yang disalin diberi nama "Salinan [nama asli]".
var source = SpreadsheetApp.getActiveSpreadsheet(); var sheet = source.getSheets()[0]; var destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
spreadsheet | Spreadsheet | Spreadsheet tujuan penyalinan sheet ini, yang dapat berupa spreadsheet yang sama dengan sumbernya. |
Pulang pergi
Sheet
— Sheet baru, 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
createDeveloperMetadataFinder()
Menampilkan DeveloperMetadataFinder
untuk menemukan metadata developer dalam cakupan
sheet ini. Metadata berada dalam cakupan sheet tertentu jika dikaitkan dengan
sheet itu sendiri, atau terkait dengan baris, kolom, atau rentang pada sheet tersebut.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder(); // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());
Pulang pergi
DeveloperMetadataFinder
— Pencari metadata developer untuk menelusuri metadata dalam cakupan sheet ini.
createTextFinder(findText)
Membuat pencari teks untuk sheet, yang dapat menemukan dan mengganti teks dalam sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. var textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = findOccurrence.replaceWith('cat');
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
findText | String | Teks yang akan ditelusuri. |
Pulang pergi
TextFinder
— TextFinder
untuk sheet.
deleteColumn(columnPosition)
Menghapus kolom di posisi kolom yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom, mulai dari 1 untuk kolom pertama. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
deleteColumns(columnPosition, howMany)
Menghapus sejumlah kolom mulai dari posisi kolom tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom pertama yang akan dihapus. |
howMany | Integer | Jumlah kolom yang akan dihapus. |
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
deleteRow(rowPosition)
Menghapus baris pada posisi baris tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris, mulai dari 1 untuk baris pertama. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
deleteRows(rowPosition, howMany)
Menghapus sejumlah baris yang dimulai pada posisi baris tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris pertama yang akan dihapus. |
howMany | Integer | Jumlah baris yang akan dihapus. |
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
expandAllColumnGroups()
Meluaskan semua grup kolom di sheet. Metode ini memerlukan setidaknya satu grup kolom.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
Pulang pergi
Sheet
— Sheet 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
expandAllRowGroups()
Meluaskan semua grup baris di sheet. Metode ini memerlukan setidaknya satu grup baris.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
Pulang pergi
Sheet
— Sheet 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
expandColumnGroupsUpToDepth(groupDepth)
Meluaskan semua grup kolom hingga kedalaman tertentu, dan menciutkan semua kolom lainnya.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
groupDepth | Integer | Kedalaman grup yang akan digunakan untuk meluaskan grup kolom. |
Pulang pergi
Sheet
— Sheet 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
expandRowGroupsUpToDepth(groupDepth)
Meluaskan semua grup baris hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
groupDepth | Integer | Kedalaman grup yang akan digunakan untuk meluaskan grup baris. |
Pulang pergi
Sheet
— Sheet 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
getActiveCell()
Menampilkan sel aktif dalam sheet ini.
Catatan: Sebaiknya gunakan getCurrentCell()
, yang menampilkan sel yang disorot
saat ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Returns the active cell var cell = sheet.getActiveCell();
Pulang pergi
Range
— sel aktif saat ini
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
getActiveRange()
Menampilkan rentang yang dipilih di sheet aktif, atau null
jika tidak ada rentang aktif. Jika beberapa rentang dipilih, metode ini hanya akan menampilkan rentang terakhir yang dipilih.
Istilah "rentang aktif" mengacu pada rentang yang telah dipilih pengguna di sheet aktif, namun dalam fungsi kustom, rentang ini mengacu pada sel yang dihitung ulang secara aktif.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
Pulang pergi
Range
— rentang aktif
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
Lihat juga
getActiveRangeList()
Menampilkan daftar rentang aktif di sheet aktif atau null
jika tidak ada rentang
aktif.
Jika ada satu rentang yang dipilih, ini akan berperilaku sebagai panggilan getActiveRange()
.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
Pulang pergi
RangeList
— daftar rentang aktif
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
Lihat juga
getBandings()
Menampilkan semua banding di sheet ini.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the banding info for the sheet. const bandings = sheet.getBandings(); // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) { console.log(banding.getSecondRowColor()); }
Pulang pergi
Banding[]
— Semua banding dalam sheet ini.
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
getCharts()
Menampilkan array diagram pada sheet ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; // Do something with the chart }
Pulang pergi
EmbeddedChart[]
— Array diagram.
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
getColumnGroup(columnIndex, groupDepth)
Menampilkan grup kolom pada indeks dan kedalaman grup yang ditentukan.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. var columnGroup = sheet.getColumnGroup(2, 1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks kolom dari tombol kontrol grup atau indeks dalam grup. |
groupDepth | Integer | Kedalaman grup. |
Pulang pergi
Group
— Grup kolom pada indeks dan kedalaman kontrol, atau menampilkan pengecualian jika grup tidak ada.
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
getColumnGroupControlPosition()
Menampilkan GroupControlTogglePosition
untuk semua grup kolom pada sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the // group. var columnGroupControlPosition = sheet.getColumnGroupControlPosition();
Pulang pergi
GroupControlTogglePosition
— true
jika tombol kontrol pengelompokan kolom ditampilkan setelah grup di sheet ini dan false
jika tidak.
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
getColumnGroupDepth(columnIndex)
Menampilkan kedalaman grup kolom pada indeks tertentu.
Kedalaman grup menunjukkan jumlah grup yang tumpang-tindih dengan kolom. Rentangnya antara nol dan delapan.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 var groupDepth = sheet.getColumnGroupDepth(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks kolom. |
Pulang pergi
Integer
— Kedalaman grup kolom di indeks tertentu.
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(columnPosition)
Mendapatkan lebar dalam piksel untuk kolom yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom yang akan diperiksa. |
Pulang pergi
Integer
— lebar kolom dalam piksel
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
getConditionalFormatRules()
Dapatkan semua aturan format bersyarat di sheet ini.
// Logs the conditional format rules in a sheet. var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (var i = 0; i < rules.length; i++) { var rule = rules[i]; Logger.log(rule); }
Pulang pergi
ConditionalFormatRule[]
— Array dari semua aturan dalam sheet.
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
getCurrentCell()
Menampilkan sel saat ini dalam sheet aktif atau null
jika tidak ada sel saat ini. Sel
saat ini adalah sel yang memiliki fokus di UI Google Spreadsheet, dan ditandai oleh batas
gelap. Tidak pernah ada lebih dari satu sel saat ini. Ketika pengguna memilih satu atau beberapa rentang sel,
salah satu sel dalam pilihan adalah sel saat ini.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.getCurrentCell();
Pulang pergi
Range
— sel saat ini
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
getDataRange()
Menampilkan Range
yang sesuai dengan dimensi yang menampilkan data.
Ini secara fungsional setara dengan membuat Rentang yang dibatasi oleh A1 dan (Sheet.getLastColumn(), Sheet.getLastRow()).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = row + ","; } Logger.log(row); }
Pulang pergi
Range
— rentang yang terdiri dari semua data dalam spreadsheet
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
getDataSourceFormulas()
Mendapatkan semua formula sumber data.
Pulang pergi
DataSourceFormula[]
— Daftar formula 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
getDataSourcePivotTables()
Mendapatkan semua tabel pivot sumber data.
Pulang pergi
DataSourcePivotTable[]
— Daftar tabel pivot 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
getDataSourceTables()
Mendapatkan semua tabel sumber data.
Pulang pergi
DataSourceTable[]
— Daftar tabel 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
getDeveloperMetadata()
Dapatkan semua metadata developer yang terkait dengan sheet ini.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata(); // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) { console.log(developerMetaData.getKey()); }
Pulang pergi
DeveloperMetadata[]
— Metadata developer yang terkait dengan sheet ini.
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
getDrawings()
Menampilkan array gambar pada sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings(); // Logs the number of drawings present on the sheet. console.log(allDrawings.length);
Pulang pergi
Drawing[]
— Daftar gambar di sheet ini.
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
getFilter()
Menampilkan filter dalam sheet ini, atau null
jika tidak ada filter.
// Gets the filter on the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter();
Pulang pergi
Filter
— Filter.
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
getFormUrl()
Menampilkan URL untuk formulir yang mengirim respons ke sheet ini, atau null
jika sheet ini tidak memiliki formulir terkait.
var sheet = SpreadsheetApp.getActiveSheet(); var url = sheet.getFormUrl();
Pulang pergi
String
— URL untuk formulir yang menempatkan responsnya dalam sheet ini, atau null
jika sheet ini tidak memiliki formulir terkait.
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
getFrozenColumns()
Menampilkan jumlah kolom yang dibekukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());
Pulang pergi
Integer
— jumlah kolom beku
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
getFrozenRows()
Menampilkan jumlah baris yang dibekukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());
Pulang pergi
Integer
— jumlah baris beku
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
getImages()
Menampilkan semua gambar over-the-grid di sheet.
Pulang pergi
OverGridImage[]
— Array gambar over-the-grid.
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
getIndex()
Mendapatkan posisi sheet dalam spreadsheet induknya. Dimulai dari 1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 var sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
Pulang pergi
Integer
— Posisi sheet dalam spreadsheet induknya.
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
getLastColumn()
Menampilkan posisi kolom terakhir yang memiliki konten.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Pulang pergi
Integer
— kolom terakhir pada sheet yang berisi konten
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
getLastRow()
Menampilkan posisi baris terakhir yang memiliki konten.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Pulang pergi
Integer
— baris terakhir sheet yang berisi konten
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
getMaxColumns()
Menampilkan jumlah kolom saat ini di sheet, apa pun kontennya.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxColumns());
Pulang pergi
Integer
— Lebar maksimum sheet.
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
getMaxRows()
Menampilkan jumlah baris saat ini di sheet, apa pun kontennya.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxRows());
Pulang pergi
Integer
— Tinggi maksimum sheet.
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
getName()
Menampilkan nama sheet.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
Pulang pergi
String
— Nama sheet.
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
getNamedRanges()
Mendapatkan semua rentang bernama di sheet ini.
// The code below logs the name of the first named range. var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
Pulang pergi
NamedRange[]
— Array dari semua rentang bernama dalam sheet.
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
getParent()
Menampilkan Spreadsheet
yang berisi sheet ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // parent is identical to ss var parent = sheet.getParent();
Pulang pergi
Spreadsheet
— Spreadsheet induk.
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
getPivotTables()
Menampilkan semua tabel pivot pada sheet ini.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables(); // Logs the pivot tables to the console. for (const pivotTable of pivotTables) { console.log(pivotTable.getSourceDataRange().getValues()); }
Pulang pergi
PivotTable[]
— Tabel pivot pada sheet ini.
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
getProtections(type)
Mendapatkan array objek yang mewakili semua rentang yang dilindungi di sheet, atau array elemen tunggal yang mewakili perlindungan pada sheet itu sendiri.
// Remove all range protections in the spreadsheet that the user has permission to edit. var sheet = SpreadsheetApp.getActiveSheet(); var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to edit it. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection && protection.canEdit()) { protection.remove(); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
type | ProtectionType | Jenis area yang dilindungi, baik SpreadsheetApp.ProtectionType.RANGE atau
SpreadsheetApp.ProtectionType.SHEET . |
Pulang pergi
Protection[]
— Array objek yang mewakili semua rentang yang dilindungi di sheet, atau array elemen tunggal yang mewakili perlindungan pada sheet itu sendiri.
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
getRange(row, column)
Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. var range = sheet.getRange(1, 1); var values = range.getValues(); Logger.log(values[0][0]);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
row | Integer | Indeks baris sel yang akan ditampilkan; pengindeksan baris dimulai dengan 1. |
column | Integer | Indeks kolom sel yang akan ditampilkan; pengindeksan kolom dimulai dengan 1. |
Pulang pergi
Range
— Rentang yang hanya berisi sel ini.
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
getRange(row, column, numRows)
Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan, dan dengan jumlah baris yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is returned. var range = sheet.getRange(1, 1, 3); var values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
row | Integer | Indeks baris awal rentang; pengindeksan baris dimulai dengan angka 1. |
column | Integer | Indeks kolom rentang; pengindeksan kolom dimulai dengan 1. |
numRows | Integer | Jumlah baris yang perlu ditampilkan. |
Pulang pergi
Range
— Rentang yang berisi satu kolom data dengan jumlah baris yang ditentukan.
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
getRange(row, column, numRows, numColumns)
Menampilkan rentang dengan sel kiri atas pada koordinat yang diberikan dengan jumlah baris dan kolom tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 3, 3); var values = range.getValues(); // Print values from a 3x3 box. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
row | Integer | Indeks baris awal rentang; pengindeksan baris dimulai dengan angka 1. |
column | Integer | Indeks kolom awal rentang; pengindeksan kolom dimulai dengan angka 1. |
numRows | Integer | Jumlah baris yang perlu ditampilkan. |
numColumns | Integer | Jumlah kolom yang perlu ditampilkan. |
Pulang pergi
Range
— Rentang yang sesuai dengan area yang ditentukan.
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
getRange(a1Notation)
Menampilkan rentang seperti yang ditentukan dalam notasi A1 atau notasi R1C1.
// Get a range A1:D4 on sheet titled "Invoices" var ss = SpreadsheetApp.getActiveSpreadsheet(); var range = ss.getRange("Invoices!A1:D4"); // Get cell A1 on the first sheet var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1");
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
a1Notation | String | Rentang yang akan ditampilkan, seperti yang ditentukan dalam notasi A1 atau notasi R1C1. |
Pulang pergi
Range
— rentang di lokasi yang ditetapkan
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
getRangeList(a1Notations)
Menampilkan koleksi RangeList
yang merepresentasikan rentang dalam sheet yang sama yang ditentukan
oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong.
// Get a list of ranges A1:D4, F1:H4. var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
a1Notations | String[] | Daftar rentang yang akan ditampilkan, seperti yang ditentukan dalam notasi A1 atau notasi R1C1. |
Pulang pergi
RangeList
— daftar rentang di lokasi yang ditetapkan
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
getRowGroup(rowIndex, groupDepth)
Menampilkan grup baris pada indeks dan kedalaman grup yang ditentukan.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. var rowGroup = sheet.getRowGroup(2, 1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks baris dari tombol kontrol grup atau indeks dalam grup. |
groupDepth | Integer | Kedalaman grup. |
Pulang pergi
Group
— Grup baris pada indeks dan kedalaman kontrol, atau menampilkan pengecualian jika grup tidak ada.
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
getRowGroupControlPosition()
Menampilkan GroupControlTogglePosition
untuk semua grup baris di sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the // group. var rowGroupControlPosition = sheet.getRowGroupControlPosition();
Pulang pergi
GroupControlTogglePosition
— true
jika tombol kontrol pengelompokan baris ditampilkan setelah grup di sheet ini
dan false
jika tidak.
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
getRowGroupDepth(rowIndex)
Menampilkan kedalaman grup baris pada indeks tertentu.
Kedalaman grup menunjukkan jumlah grup yang tumpang-tindih dengan baris. Rentangnya antara nol dan delapan.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 var groupDepth = sheet.getRowGroupDepth(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks baris. |
Pulang pergi
Integer
— Kedalaman grup baris di indeks tertentu.
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
getRowHeight(rowPosition)
Mendapatkan tinggi piksel dalam baris tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris yang akan diperiksa. |
Pulang pergi
Integer
— tinggi baris dalam piksel
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
getSelection()
Menampilkan Selection
saat ini di spreadsheet.
var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); var currentCell = selection.getCurrentCell();
Pulang pergi
Selection
— pilihan saat ini
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
getSheetId()
Menampilkan ID sheet yang diwakili oleh objek ini.
Ini adalah ID untuk sheet yang unik untuk spreadsheet. ID adalah bilangan bulat yang meningkat
secara monoton yang ditetapkan pada waktu pembuatan sheet yang tidak bergantung pada posisi sheet. Hal ini
berguna bersama dengan metode seperti Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
yang menggunakan parameter gridId
, bukan instance Sheet
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
Pulang pergi
Integer
— ID untuk sheet yang unik untuk spreadsheet
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
getSheetName()
Menampilkan nama sheet.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
Pulang pergi
String
— nama sheet
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(startRow, startColumn, numRows, numColumns)
Menampilkan petak nilai persegi panjang untuk rentang ini mulai dari koordinat yang diberikan. Nilai -1 yang diberikan sebagai posisi baris atau kolom sama dengan mendapatkan baris atau kolom terakhir yang memiliki data di sheet.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The two samples below produce the same output var values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); var range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startRow | Integer | Posisi baris awal. |
startColumn | Integer | Posisi kolom awal. |
numRows | Integer | Jumlah baris untuk menampilkan nilai. |
numColumns | Integer | Jumlah kolom yang nilainya akan ditampilkan. |
Pulang pergi
Object[][]
— array nilai dua 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
getSlicers()
Menampilkan array pemotong pada sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers(); // Logs the slicer titles to the console. for (const slicer of slicers) { console.log(slicer.getTitle()); }
Pulang pergi
Slicer[]
— Daftar pemotong pada sheet ini.
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
getTabColorObject()
Mendapatkan warna tab sheet, atau null
jika tab sheet tidak memiliki warna.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = first.getTabColorObject();
Pulang pergi
Color
— Warna tab sheet, atau null
jika tab sheet tidak memiliki warna.
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
getType()
Menampilkan jenis sheet.
Jenis default sheet adalah SheetType.GRID
. Sheet yang berisi satu objek tersemat, seperti EmbeddedChart
, adalah sheet SheetType.OBJECT
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
Pulang pergi
SheetType
— Jenis sheet.
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
hasHiddenGridlines()
Menampilkan true
jika garis petak sheet disembunyikan; jika tidak, menampilkan false
.
Garis kisi terlihat secara default.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if the spreadsheet has hidden gridelines and logs the result to the console. console.log(sheet.hasHiddenGridlines());
Pulang pergi
Boolean
— true
jika garis petak disembunyikan; false
jika tidak.
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
hideColumn(column)
Menyembunyikan satu atau beberapa kolom dalam rentang yang ditentukan.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange("A1"); sheet.hideColumn(range); // This hides the first 3 columns let range = sheet.getRange("A:C"); sheet.hideColumn(range);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | Range | Rentang kolom yang akan disembunyikan. |
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
hideColumns(columnIndex)
Menyembunyikan satu kolom pada indeks tertentu. Gunakan 1 indeks untuk metode ini.
Untuk menyembunyikan lebih dari satu kolom menggunakan indeks, gunakan hideColumns(columnIndex, numColumns)
.
Untuk menyembunyikan lebih dari satu kolom menggunakan rentang, gunakan hideColumn()
.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks kolom yang akan disembunyikan. |
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
hideColumns(columnIndex, numColumns)
Menyembunyikan satu atau beberapa kolom berturut-turut yang dimulai pada indeks tertentu. Gunakan 1 indeks untuk metode ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks awal kolom yang akan disembunyikan. |
numColumns | Integer | Jumlah kolom yang akan disembunyikan. |
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
hideRow(row)
Menyembunyikan baris dalam rentang yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This hides the first row var range = sheet.getRange("A1"); sheet.hideRow(range);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
row | Range | Rentang baris untuk disembunyikan. |
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
hideRows(rowIndex)
Menyembunyikan baris pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks baris yang akan disembunyikan. |
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
hideRows(rowIndex, numRows)
Menyembunyikan satu atau beberapa baris berturut-turut yang dimulai pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks awal baris yang akan disembunyikan. |
numRows | Integer | Jumlah baris yang akan disembunyikan. |
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
hideSheet()
Menyembunyikan sheet ini. Tidak berpengaruh jika sheet sudah disembunyikan. Jika metode ini dipanggil di satu-satunya sheet yang terlihat, metode ini akan menampilkan pengecualian.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
Pulang pergi
Sheet
— Sheet saat ini.
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
insertChart(chart)
Menambahkan diagram baru ke sheet ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B4")) .setPosition(5, 5, 0, 0) .setOption("title", "Dynamic Chart") .build(); sheet.insertChart(chart);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
chart | EmbeddedChart | Diagram yang akan disisipkan. |
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
insertColumnAfter(afterPosition)
Menyisipkan kolom setelah posisi kolom yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
afterPosition | Integer | Kolom yang akan digunakan untuk menambahkan kolom baru. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertColumnBefore(beforePosition)
Menyisipkan kolom sebelum posisi kolom yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
beforePosition | Integer | Kolom yang akan menambahkan kolom baru. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertColumns(columnIndex)
Menyisipkan kolom kosong pada sheet di lokasi yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks yang menunjukkan tempat untuk menyisipkan kolom. |
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
insertColumns(columnIndex, numColumns)
Menyisipkan satu atau beberapa kolom kosong berturut-turut dalam sebuah sheet yang dimulai dari lokasi yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks yang menunjukkan tempat untuk menyisipkan kolom. |
numColumns | Integer | Jumlah kolom yang akan disisipkan. |
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
insertColumnsAfter(afterPosition, howMany)
Menyisipkan sejumlah kolom setelah posisi kolom yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the second column position sheet.insertColumnsAfter(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
afterPosition | Integer | Kolom yang akan digunakan untuk menambahkan kolom baru. |
howMany | Integer | Jumlah kolom yang akan disisipkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertColumnsBefore(beforePosition, howMany)
Menyisipkan sejumlah kolom sebelum posisi kolom yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
beforePosition | Integer | Kolom yang akan menambahkan kolom baru. |
howMany | Integer | Jumlah kolom yang akan disisipkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertImage(blobSource, column, row)
Menyisipkan BlobSource
sebagai gambar di dokumen pada baris dan kolom tertentu. Ukuran gambar
diambil dari konten blob. Ukuran blob maksimum yang didukung adalah 2 MB.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
blobSource | BlobSource | Blob yang berisi konten gambar, jenis MIME, dan nama (opsional). |
column | Integer | Posisi kolom. |
row | Integer | Posisi baris. |
Pulang pergi
OverGridImage
— Gambar yang disisipkan.
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
insertImage(blobSource, column, row, offsetX, offsetY)
Menyisipkan BlobSource
sebagai gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel. Ukuran gambar diambil dari konten blob. Ukuran blob maksimum yang didukung adalah 2 MB.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
blobSource | BlobSource | Blob yang berisi konten gambar, jenis MIME, dan nama (opsional). |
column | Integer | Posisi kolom. |
row | Integer | Posisi baris. |
offsetX | Integer | Offset horizontal dari sudut sel dalam piksel. |
offsetY | Integer | Offset vertikal dari sudut sel dalam piksel. |
Pulang pergi
OverGridImage
— Gambar yang disisipkan.
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
insertImage(url, column, row)
Menyisipkan gambar dalam dokumen di baris dan kolom tertentu.
URL yang diberikan harus dapat diakses secara publik.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
url | String | URL gambar. |
column | Integer | Posisi kolom petak. |
row | Integer | Posisi baris petak. |
Pulang pergi
OverGridImage
— Gambar yang disisipkan.
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
insertImage(url, column, row, offsetX, offsetY)
Menyisipkan gambar dalam dokumen di baris dan kolom tertentu, dengan offset piksel.
URL yang diberikan harus dapat diakses secara publik.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
url | String | URL untuk gambar. |
column | Integer | Posisi kolom. |
row | Integer | Posisi baris. |
offsetX | Integer | Offset horizontal dari sudut sel dalam piksel. |
offsetY | Integer | Offset vertikal dari sudut sel dalam piksel. |
Pulang pergi
OverGridImage
— Gambar yang disisipkan.
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
insertRowAfter(afterPosition)
Menyisipkan baris setelah posisi baris yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
afterPosition | Integer | Baris yang berisi baris baru harus ditambahkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertRowBefore(beforePosition)
Menyisipkan baris sebelum posisi baris yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
beforePosition | Integer | Baris yang harus ditambahkan baris baru. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertRows(rowIndex)
Menyisipkan baris kosong dalam sheet di lokasi yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks yang menunjukkan tempat untuk menyisipkan baris. |
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
insertRows(rowIndex, numRows)
Menyisipkan satu atau beberapa baris kosong yang berurutan dalam sebuah sheet yang dimulai dari lokasi yang ditentukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks yang menunjukkan tempat untuk menyisipkan baris. |
numRows | Integer | Jumlah baris yang akan disisipkan. |
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
insertRowsAfter(afterPosition, howMany)
Menyisipkan sejumlah baris setelah posisi baris tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
afterPosition | Integer | Baris yang berisi baris baru harus ditambahkan. |
howMany | Integer | Jumlah baris yang akan disisipkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertRowsBefore(beforePosition, howMany)
Menyisipkan sejumlah baris sebelum posisi baris tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
beforePosition | Integer | Baris yang harus ditambahkan baris baru. |
howMany | Integer | Jumlah baris yang akan disisipkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
insertSlicer(range, anchorRowPos, anchorColPos)
Menambahkan pemotong baru ke sheet ini.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range of the sheet. const range = sheet.getRange('A1:D10'); // Inserts the slicer with a random range into the sheet. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10); // Logs the insert slicer result to the console. console.log(insertSlicers);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
range | Range | Rentang pembuatan pemotong. |
anchorRowPos | Integer | Sisi atas pemotong ditambatkan dalam baris ini. |
anchorColPos | Integer | Sisi atas pemotong ditambatkan dalam col ini. |
Pulang pergi
Slicer
— Pemotong yang baru disisipkan
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
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
Menambahkan pemotong baru ke sheet ini.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range. const range = sheet.getRange('A1:D10'); // Inserts a slicer using the random range function. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0); // Logs the insert slicer result to the console. console.log(insertSlicers);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
range | Range | Rentang pembuatan pemotong. |
anchorRowPos | Integer | Sisi atas pemotong ditambatkan dalam baris ini. |
anchorColPos | Integer | Sisi atas pemotong ditambatkan dalam col ini. |
offsetX | Integer | Offset horizontal dari sudut sel dalam piksel. |
offsetY | Integer | Offset vertikal dari sudut sel dalam piksel. |
Pulang pergi
Slicer
— Pemotong yang baru disisipkan
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
isColumnHiddenByUser(columnPosition)
Menampilkan apakah kolom tertentu disembunyikan oleh pengguna.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom yang akan diperiksa. |
Pulang pergi
Boolean
— true
jika kolom disembunyikan, false
jika tidak.
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
isRightToLeft()
Menampilkan true
jika tata letak sheet ini ditulis dari kanan ke kiri. Menampilkan false
jika sheet
menggunakan tata letak kiri ke kanan default.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if a spreadsheet is ordered from right to left and logs the result to the console. console.log(sheet.isRightToLeft());
Pulang pergi
Boolean
— true
jika dari kanan ke kiri; false
jika tidak.
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
isRowHiddenByFilter(rowPosition)
Menampilkan apakah baris tertentu disembunyikan oleh filter (bukan tampilan filter).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris yang akan diperiksa. |
Pulang pergi
Boolean
— true
jika baris disembunyikan, false
jika tidak.
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
isRowHiddenByUser(rowPosition)
Menampilkan apakah baris tertentu disembunyikan oleh pengguna.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris yang akan diperiksa. |
Pulang pergi
Boolean
— true
jika baris disembunyikan, false
jika tidak.
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
isSheetHidden()
Menampilkan true
jika sheet saat ini disembunyikan.
var sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
Pulang pergi
Boolean
— true
jika sheet disembunyikan, false
jika tidak.
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
moveColumns(columnSpec, destinationIndex)
Memindahkan kolom yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex
. columnSpec
itu sendiri tidak harus merepresentasikan keseluruhan kolom atau grup kolom untuk dipindahkan—ini memilih semua kolom yang mencakup rentang.
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. var sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. var columnSpec = sheet.getRange("A1:B1"); sheet.moveColumns(columnSpec, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnSpec | Range | Rentang yang mencakup kolom yang harus dipindahkan. |
destinationIndex | Integer | Indeks tempat kolom akan dipindahkan. Perhatikan bahwa indeks ini didasarkan pada koordinat sebelum kolom dipindahkan. Data yang ada akan digeser ke kanan untuk memberikan ruang bagi kolom yang dipindahkan, sedangkan kolom sumber dihapus dari petak. Oleh karena itu, data dapat masuk ke indeks yang berbeda dari yang ditentukan sebelumnya. |
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
moveRows(rowSpec, destinationIndex)
Memindahkan baris yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex
. rowSpec
itu sendiri tidak harus merepresentasikan seluruh baris atau grup baris untuk dipindahkan—ini memilih semua baris yang mencakup rentang.
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. var sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. var rowSpec = sheet.getRange("A1:A2"); sheet.moveRows(rowSpec, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowSpec | Range | Rentang yang mencakup baris yang harus dipindahkan. |
destinationIndex | Integer | Indeks yang akan menjadi tujuan pemindahan baris. Perhatikan bahwa indeks ini didasarkan pada koordinat sebelum baris dipindahkan. Data yang ada akan digeser ke bawah untuk memberi ruang bagi baris yang dipindahkan, sedangkan baris sumber dihapus dari petak. Oleh karena itu, data dapat masuk ke indeks yang berbeda dari yang ditentukan sebelumnya. |
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
newChart()
Menampilkan builder untuk membuat diagram baru untuk sheet ini.
Contoh ini menunjukkan cara membuat diagram baru:
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
Pulang pergi
EmbeddedChartBuilder
— Builder untuk membuat diagram baru.
protect()
Membuat objek yang dapat melindungi sheet agar tidak diedit, kecuali oleh pengguna yang memiliki izin. Hingga skrip benar-benar mengubah daftar editor untuk sheet (dengan memanggil
Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
, atau menetapkan nilai
baru untuk Protection.setDomainEdit(editable)
), izin tersebut akan mencerminkan versi
spreadsheet itu sendiri, yang secara efektif berarti sheet tetap tidak dilindungi. Jika sheet
sudah dilindungi, metode ini akan menampilkan objek yang mewakili setelan perlindungan yang ada.
Sheet yang dilindungi dapat menyertakan wilayah yang tidak dilindungi.
// Protect the active sheet, then remove all other users from the list of editors. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if the user's edit // permission comes from a group, the script throws an exception upon removing the group. var me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
Pulang pergi
Protection
— Objek yang mewakili setelan perlindungan.
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
removeChart(chart)
Menghapus diagram dari sheet induk.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet var charts = sheet.getCharts(); for (var i in charts) { sheet.removeChart(charts[i]); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
chart | EmbeddedChart | Diagram yang akan dihapus. |
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
setActiveRange(range)
Menetapkan rentang yang ditentukan sebagai active range
di sheet aktif, dengan
sel kiri atas dalam rentang sebagai current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D4 var activeRange = selection.getActiveRange();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
range | Range | Rentang yang akan ditetapkan sebagai rentang aktif. |
Pulang pergi
Range
— rentang yang baru aktif
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
setActiveRangeList(rangeList)
Menetapkan daftar rentang yang ditentukan sebagai active ranges
dalam
sheet aktif. Rentang terakhir dalam daftar ditetapkan sebagai active range
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); var selection = sheet.getSelection(); // Current cell: B2 var currentCell = selection.getCurrentCell(); // Active range: B2:C4 var activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] var activeRangeList = selection.getActiveRangeList();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rangeList | RangeList | Daftar rentang yang dapat dipilih. |
Pulang pergi
RangeList
— daftar rentang yang baru dipilih
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
setActiveSelection(range)
Menetapkan wilayah pemilihan yang aktif untuk sheet ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D4"); sheet.setActiveSelection(range);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
range | Range | Rentang yang akan ditetapkan sebagai pilihan aktif. |
Pulang pergi
Range
— rentang yang baru aktif
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
setActiveSelection(a1Notation)
Menyetel pemilihan aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.setActiveSelection("A1:D4");
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
a1Notation | String | Rentang yang ditetapkan sebagai aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1. |
Pulang pergi
Range
— rentang yang baru aktif
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
setColumnGroupControlPosition(position)
Menetapkan posisi tombol kontrol grup kolom pada sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
position | GroupControlTogglePosition | Posisi tombol kontrol grup kolom. |
Pulang pergi
Sheet
— Sheet 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
setColumnWidth(columnPosition, width)
Menetapkan lebar kolom yang diberikan dalam piksel.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Posisi kolom yang ditentukan untuk ditetapkan. |
width | Integer | Lebar dalam piksel untuk menyetelnya. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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(startColumn, numColumns, width)
Menetapkan lebar kolom yang diberikan dalam piksel.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startColumn | Integer | Posisi kolom awal yang akan diubah. |
numColumns | Integer | Jumlah kolom yang akan diubah. |
width | Integer | Lebar dalam piksel untuk menyetelnya. |
Pulang pergi
Sheet
— Sheet 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
setConditionalFormatRules(rules)
Mengganti semua aturan format bersyarat yang ada saat ini di sheet dengan aturan input. Aturan dievaluasi dalam urutan input.
// Remove one of the existing conditional format rules. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rules | ConditionalFormatRule[] | Aturan format bersyarat baru. |
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
setCurrentCell(cell)
Menetapkan sel yang ditentukan sebagai current cell
.
Jika sel yang ditentukan ada dalam rentang yang sudah dipilih, rentang tersebut akan menjadi rentang aktif dengan sel sebagai sel saat ini.
Jika sel yang ditentukan tidak ada dalam rentang yang dipilih, pilihan apa pun yang ada akan dihapus dan sel akan menjadi sel saat ini dan rentang aktif.
Catatan: Range
yang ditentukan harus terdiri dari satu sel, jika tidak, pengecualian akan
ditampilkan.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); var selection = sheet.getSelection(); // Current cell: B5 var currentCell = selection.getCurrentCell();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
cell | Range | Sel yang akan ditetapkan sebagai sel saat ini. |
Pulang pergi
Range
— sel yang baru ditetapkan
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
setFrozenColumns(columns)
Membekukan jumlah kolom tertentu. Jika nol, tidak ada kolom yang dibekukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columns | Integer | Jumlah kolom yang akan dibekukan. |
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
setFrozenRows(rows)
Membekukan jumlah baris yang ditentukan. Jika nol, tidak ada baris yang dibekukan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rows | Integer | Jumlah baris yang akan dibekukan. |
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
setHiddenGridlines(hideGridlines)
Menyembunyikan atau menampilkan garis kisi sheet.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Hides the gridlines in the sheet. sheet.setHiddenGridlines(true);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
hideGridlines | Boolean | Jika true , sembunyikan garis petak di sheet ini; jika tidak, tampilkan
garis petak. |
Pulang pergi
Sheet
— Sheet 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
setName(name)
Menetapkan nama sheet.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setName("not first anymore");
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama baru untuk sheet. |
Pulang pergi
Sheet
— Sheet 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
setRightToLeft(rightToLeft)
Menetapkan atau membatalkan penetapan tata letak sheet dari kanan ke kiri.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the sheet layout, so that the sheet is ordered from right to left. sheet.setRightToLeft(true);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rightToLeft | Boolean | Jika true , tata letak sheet disetel dari kanan ke kiri, dengan sel A1 di
sudut kanan atas. Jika false , tata letak sheet disetel ke default dari
kiri ke kanan, dengan sel A1 di kiri atas. |
Pulang pergi
Sheet
— Sheet 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
setRowGroupControlPosition(position)
Menetapkan posisi tombol kontrol grup baris di sheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
position | GroupControlTogglePosition | Posisi tombol kontrol grup baris. |
Pulang pergi
Sheet
— Sheet 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
setRowHeight(rowPosition, height)
Menetapkan tinggi baris untuk baris yang ditentukan dalam piksel. Secara default, baris disesuaikan agar cocok dengan konten sel. Jika
Anda ingin memaksa baris ke tinggi yang ditentukan, gunakan setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first row to a height of 200 pixels sheet.setRowHeight(1, 200);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowPosition | Integer | Posisi baris yang akan diubah. |
height | Integer | Tinggi dalam piksel yang akan ditetapkan. |
Pulang pergi
Sheet
— Sheet, yang berguna 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
setRowHeights(startRow, numRows, height)
Menetapkan tinggi baris yang ditentukan dalam piksel. Secara default, baris disesuaikan agar cocok dengan konten sel. Jika Anda
ingin memaksa baris ke tinggi yang ditentukan, gunakan setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startRow | Integer | Posisi baris awal yang akan diubah. |
numRows | Integer | Jumlah baris yang akan diubah. |
height | Integer | Tinggi dalam piksel yang akan ditetapkan. |
Pulang pergi
Sheet
— Sheet 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
setRowHeightsForced(startRow, numRows, height)
Menetapkan tinggi baris yang ditentukan dalam piksel. Secara default, baris disesuaikan agar cocok dengan konten sel. Saat
Anda menggunakan setRowHeightsForced
, baris akan dipaksa ke tinggi yang ditentukan meskipun
konten sel lebih tinggi dari tinggi baris.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startRow | Integer | Posisi baris awal yang akan diubah. |
numRows | Integer | Jumlah baris yang akan diubah. |
height | Integer | Tinggi dalam piksel yang akan ditetapkan. |
Pulang pergi
Sheet
— Sheet 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
setTabColor(color)
Menetapkan warna tab sheet.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setTabColor("ff0000"); // Set the color to red. first.setTabColor(null); // Unset the color.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
color | String | Kode warna dalam notasi CSS (seperti '#ffffff' atau 'white' ), atau
null untuk mereset warna tab. |
Pulang pergi
Sheet
— Sheet 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
setTabColorObject(color)
Menetapkan warna tab sheet.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
color | Color | Warna tab sheet yang akan ditetapkan. |
Pulang pergi
Sheet
— Sheet 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
showColumns(columnIndex)
Memperlihatkan kolom pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks kolom yang akan diperlihatkan. |
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
showColumns(columnIndex, numColumns)
Memperlihatkan satu atau beberapa kolom berturut-turut yang dimulai pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnIndex | Integer | Indeks awal kolom yang akan diperlihatkan. |
numColumns | Integer | Jumlah kolom yang perlu diperlihatkan. |
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
showRows(rowIndex)
Memperlihatkan baris pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks baris yang akan diperlihatkan. |
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
showRows(rowIndex, numRows)
Memperlihatkan satu atau beberapa baris berturut-turut yang dimulai pada indeks tertentu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowIndex | Integer | Indeks awal baris yang diperlihatkan. |
numRows | Integer | Jumlah baris untuk ditampilkan. |
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
showSheet()
Membuat sheet terlihat. Tidak berpengaruh jika sheet sudah terlihat.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
Pulang pergi
Sheet
— Sheet saat ini.
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
sort(columnPosition)
Mengurutkan sheet berdasarkan kolom, secara menaik.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Kolom yang akan diurutkan. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
sort(columnPosition, ascending)
Mengurutkan sheet berdasarkan kolom. Dibutuhkan parameter untuk menentukan menaik atau menurun.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnPosition | Integer | Kolom yang akan diurutkan. |
ascending | Boolean | true untuk urutan menaik, false untuk urutan menurun. |
Pulang pergi
Sheet
— sheet, berguna untuk metode 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
unhideColumn(column)
Memperlihatkan kolom dalam rentang yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideColumn(range);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | Range | Rentang yang akan diperlihatkan, jika disembunyikan. |
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
unhideRow(row)
Memperlihatkan baris dalam rentang yang diberikan.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideRow(range);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
row | Range | Rentang yang akan diperlihatkan, jika disembunyikan. |
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
updateChart(chart)
Memperbarui diagram pada sheet ini.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; var newChart = chart .modify() .setChartType(Charts.ChartType.COLUMN) .build(); sheet.updateChart(newChart); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
chart | EmbeddedChart | Diagram yang akan diperbarui. |
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