Class Sheet

Sheet

Mengakses dan mengubah sheet spreadsheet. Operasi umum adalah mengganti nama sheet dan mengakses objek rentang dari sheet.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
activate()SheetMengaktifkan sheet ini.
addDeveloperMetadata(key)SheetMenambahkan metadata developer dengan kunci yang ditentukan ke sheet.
addDeveloperMetadata(key, visibility)SheetMenambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke sheet.
addDeveloperMetadata(key, value)SheetMenambahkan metadata developer dengan kunci dan nilai yang ditentukan ke sheet.
addDeveloperMetadata(key, value, visibility)SheetMenambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke sheet.
appendRow(rowContents)SheetMenambahkan baris ke bagian bawah area data saat ini di sheet.
asDataSourceSheet()DataSourceSheetMenampilkan sheet sebagai DataSourceSheet jika sheet berjenis SheetType.DATASOURCE, atau null jika tidak.
autoResizeColumn(columnPosition)SheetMenetapkan lebar kolom tertentu agar sesuai dengan kontennya.
autoResizeColumns(startColumn, numColumns)SheetMenetapkan lebar semua kolom mulai dari posisi kolom yang diberikan agar sesuai dengan kontennya.
autoResizeRows(startRow, numRows)SheetMenetapkan tinggi semua baris mulai dari posisi baris yang diberikan agar sesuai dengan kontennya.
clear()SheetMenghapus informasi konten dan pemformatan dari sheet.
clear(options)SheetMenghapus sheet konten dan/atau format, seperti yang ditentukan dengan opsi lanjutan yang diberikan.
clearConditionalFormatRules()voidMenghapus semua aturan format bersyarat dari sheet.
clearContents()SheetMenghapus sheet konten, sekaligus mempertahankan informasi pemformatan.
clearFormats()SheetMenghapus format sheet, tetapi mempertahankan konten.
clearNotes()SheetMenghapus semua catatan dari sheet.
collapseAllColumnGroups()SheetMenciutkan semua grup kolom pada sheet.
collapseAllRowGroups()SheetMenciutkan semua grup baris pada sheet.
copyTo(spreadsheet)SheetMenyalin sheet ke spreadsheet tertentu, yang dapat berupa spreadsheet yang sama dengan sumber.
createDeveloperMetadataFinder()DeveloperMetadataFinderMenampilkan DeveloperMetadataFinder untuk menemukan metadata developer dalam cakupan sheet ini.
createTextFinder(findText)TextFinderMembuat pencari teks untuk sheet, yang dapat menemukan dan mengganti teks dalam sheet.
deleteColumn(columnPosition)SheetMenghapus kolom pada posisi kolom yang ditentukan.
deleteColumns(columnPosition, howMany)voidMenghapus sejumlah kolom mulai dari posisi kolom yang ditentukan.
deleteRow(rowPosition)SheetMenghapus baris di posisi baris yang ditentukan.
deleteRows(rowPosition, howMany)voidMenghapus sejumlah baris yang dimulai dari posisi baris tertentu.
expandAllColumnGroups()SheetMemperluas semua grup kolom di sheet.
expandAllRowGroups()SheetMemperluas semua grup baris pada sheet.
expandColumnGroupsUpToDepth(groupDepth)SheetMemperluas semua grup kolom hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya.
expandRowGroupsUpToDepth(groupDepth)SheetMemperluas semua grup baris hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya.
getActiveCell()RangeMenampilkan sel aktif di sheet ini.
getActiveRange()RangeMenampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif.
getActiveRangeList()RangeListMenampilkan 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)GroupMenampilkan grup kolom pada indeks dan kedalaman grup yang ditentukan.
getColumnGroupControlPosition()GroupControlTogglePositionMenampilkan GroupControlTogglePosition untuk semua grup kolom di sheet.
getColumnGroupDepth(columnIndex)IntegerMenampilkan kedalaman grup kolom pada indeks yang ditentukan.
getColumnWidth(columnPosition)IntegerMendapatkan lebar dalam piksel dari kolom yang ditentukan.
getConditionalFormatRules()ConditionalFormatRule[]Mendapatkan semua aturan format bersyarat di sheet ini.
getCurrentCell()RangeMenampilkan sel saat ini di sheet aktif atau null jika tidak ada sel saat ini.
getDataRange()RangeMenampilkan Range yang sesuai dengan dimensi tempat data berada.
getDataSourceFormulas()DataSourceFormula[]Mendapatkan semua formula sumber data.
getDataSourcePivotTables()DataSourcePivotTable[]Mendapatkan semua tabel pivot sumber data.
getDataSourceTables()DataSourceTable[]Mendapatkan semua tabel sumber data.
getDeveloperMetadata()DeveloperMetadata[]Mendapatkan semua metadata developer yang terkait dengan sheet ini.
getDrawings()Drawing[]Menampilkan array gambar pada sheet.
getFilter()FilterMenampilkan filter di sheet ini, atau null jika tidak ada filter.
getFormUrl()StringMenampilkan URL untuk formulir yang mengirimkan responsnya ke sheet ini, atau null jika sheet ini tidak memiliki formulir terkait.
getFrozenColumns()IntegerMenampilkan jumlah kolom yang dibekukan.
getFrozenRows()IntegerMenampilkan jumlah baris yang dibekukan.
getImages()OverGridImage[]Menampilkan semua gambar di atas petak pada sheet.
getIndex()IntegerMendapatkan posisi sheet di spreadsheet induknya.
getLastColumn()IntegerMenampilkan posisi kolom terakhir yang memiliki konten.
getLastRow()IntegerMenampilkan posisi baris terakhir yang memiliki konten.
getMaxColumns()IntegerMenampilkan jumlah kolom saat ini di sheet, terlepas dari kontennya.
getMaxRows()IntegerMenampilkan jumlah baris saat ini di sheet, terlepas dari kontennya.
getName()StringMenampilkan nama sheet.
getNamedRanges()NamedRange[]Mendapatkan semua rentang bernama di sheet ini.
getParent()SpreadsheetMenampilkan Spreadsheet yang berisi sheet ini.
getPivotTables()PivotTable[]Menampilkan semua tabel pivot di 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)RangeMenampilkan rentang dengan sel kiri atas pada koordinat yang diberikan.
getRange(row, column, numRows)RangeMenampilkan rentang dengan sel kiri atas pada koordinat yang diberikan, dan dengan jumlah baris yang diberikan.
getRange(row, column, numRows, numColumns)RangeMenampilkan rentang dengan sel kiri atas pada koordinat yang diberikan dengan jumlah baris dan kolom yang diberikan.
getRange(a1Notation)RangeMenampilkan rentang seperti yang ditentukan dalam notasi A1 atau notasi R1C1.
getRangeList(a1Notations)RangeListMenampilkan koleksi RangeList yang mewakili rentang di sheet yang sama yang ditentukan oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong.
getRowGroup(rowIndex, groupDepth)GroupMenampilkan grup baris pada indeks dan kedalaman grup yang ditentukan.
getRowGroupControlPosition()GroupControlTogglePositionMenampilkan GroupControlTogglePosition untuk semua grup baris di sheet.
getRowGroupDepth(rowIndex)IntegerMenampilkan kedalaman grup baris pada indeks yang ditentukan.
getRowHeight(rowPosition)IntegerMendapatkan tinggi dalam piksel dari baris yang diberikan.
getSelection()SelectionMenampilkan Selection saat ini di spreadsheet.
getSheetId()IntegerMenampilkan ID sheet yang diwakili oleh objek ini.
getSheetName()StringMenampilkan nama sheet.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Menampilkan petak nilai persegi panjang untuk rentang ini yang dimulai dari koordinat yang diberikan.
getSlicers()Slicer[]Menampilkan array pemisah di sheet.
getTabColorObject()ColorMendapatkan warna tab sheet, atau null jika tab sheet tidak memiliki warna.
getType()SheetTypeMenampilkan jenis sheet.
hasHiddenGridlines()BooleanMenampilkan true jika garis petak sheet disembunyikan; jika tidak, menampilkan false.
hideColumn(column)voidMenyembunyikan kolom dalam rentang yang ditentukan.
hideColumns(columnIndex)voidMenyembunyikan satu kolom pada indeks yang ditentukan.
hideColumns(columnIndex, numColumns)voidMenyembunyikan satu atau beberapa kolom berturut-turut yang dimulai dari indeks yang diberikan.
hideRow(row)voidMenyembunyikan baris dalam rentang yang ditentukan.
hideRows(rowIndex)voidMenyembunyikan baris pada indeks yang diberikan.
hideRows(rowIndex, numRows)voidMenyembunyikan satu atau beberapa baris berturut-turut yang dimulai dari indeks yang diberikan.
hideSheet()SheetMenyembunyikan sheet ini.
insertChart(chart)voidMenambahkan diagram baru ke sheet ini.
insertColumnAfter(afterPosition)SheetMenyisipkan kolom setelah posisi kolom yang ditentukan.
insertColumnBefore(beforePosition)SheetMenyisipkan kolom sebelum posisi kolom yang ditentukan.
insertColumns(columnIndex)voidMenyisipkan kolom kosong di sheet pada lokasi yang ditentukan.
insertColumns(columnIndex, numColumns)voidMenyisipkan satu atau beberapa kolom kosong berturut-turut dalam sheet yang dimulai dari lokasi yang ditentukan.
insertColumnsAfter(afterPosition, howMany)SheetMenyisipkan jumlah kolom tertentu setelah posisi kolom yang ditentukan.
insertColumnsBefore(beforePosition, howMany)SheetMenyisipkan sejumlah kolom sebelum posisi kolom yang ditentukan.
insertImage(blobSource, column, row)OverGridImageMenyisipkan BlobSource sebagai gambar dalam dokumen pada baris dan kolom tertentu.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageMenyisipkan BlobSource sebagai gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel.
insertImage(url, column, row)OverGridImageMenyisipkan gambar dalam dokumen pada baris dan kolom tertentu.
insertImage(url, column, row, offsetX, offsetY)OverGridImageMenyisipkan gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel.
insertRowAfter(afterPosition)SheetMenyisipkan baris setelah posisi baris yang diberikan.
insertRowBefore(beforePosition)SheetMenyisipkan baris sebelum posisi baris yang ditentukan.
insertRows(rowIndex)voidMenyisipkan baris kosong di sheet pada lokasi yang ditentukan.
insertRows(rowIndex, numRows)voidMenyisipkan satu atau beberapa baris kosong berturut-turut dalam sheet yang dimulai dari lokasi yang ditentukan.
insertRowsAfter(afterPosition, howMany)SheetMenyisipkan sejumlah baris setelah posisi baris yang diberikan.
insertRowsBefore(beforePosition, howMany)SheetMenyisipkan sejumlah baris sebelum posisi baris yang ditentukan.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerMenambahkan pemisah baru ke sheet ini.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerMenambahkan pemisah baru ke sheet ini.
isColumnHiddenByUser(columnPosition)BooleanMenampilkan apakah kolom tertentu disembunyikan oleh pengguna.
isRightToLeft()BooleanMenampilkan true jika tata letak sheet ini adalah kanan ke kiri.
isRowHiddenByFilter(rowPosition)BooleanMenampilkan apakah baris yang diberikan disembunyikan oleh filter (bukan tampilan filter).
isRowHiddenByUser(rowPosition)BooleanMenampilkan apakah baris tertentu disembunyikan oleh pengguna.
isSheetHidden()BooleanMenampilkan true jika sheet saat ini disembunyikan.
moveColumns(columnSpec, destinationIndex)voidMemindahkan kolom yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex.
moveRows(rowSpec, destinationIndex)voidMemindahkan baris yang dipilih oleh rentang yang diberikan ke posisi yang ditunjukkan oleh destinationIndex.
newChart()EmbeddedChartBuilderMenampilkan builder untuk membuat diagram baru untuk sheet ini.
protect()ProtectionMembuat objek yang dapat melindungi sheet agar tidak diedit kecuali oleh pengguna yang memiliki izin.
removeChart(chart)voidMenghapus diagram dari sheet induk.
setActiveRange(range)RangeMenetapkan rentang yang ditentukan sebagai active range di sheet aktif, dengan sel kiri atas dalam rentang sebagai current cell.
setActiveRangeList(rangeList)RangeListMenetapkan daftar rentang yang ditentukan sebagai active ranges di sheet aktif.
setActiveSelection(range)RangeMenetapkan wilayah pilihan aktif untuk sheet ini.
setActiveSelection(a1Notation)RangeMenetapkan pilihan aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.
setColumnGroupControlPosition(position)SheetMenetapkan posisi tombol kontrol grup kolom pada sheet.
setColumnWidth(columnPosition, width)SheetMenetapkan lebar kolom yang diberikan dalam piksel.
setColumnWidths(startColumn, numColumns, width)SheetMenetapkan lebar kolom yang diberikan dalam piksel.
setConditionalFormatRules(rules)voidMengganti semua aturan format bersyarat yang ada saat ini di sheet dengan aturan input.
setCurrentCell(cell)RangeMenetapkan sel yang ditentukan sebagai current cell.
setFrozenColumns(columns)voidMembekukan jumlah kolom yang ditentukan.
setFrozenRows(rows)voidMembekukan jumlah baris yang ditentukan.
setHiddenGridlines(hideGridlines)SheetMenyembunyikan atau menampilkan garis petak sheet.
setName(name)SheetMenetapkan nama sheet.
setRightToLeft(rightToLeft)SheetMenetapkan atau membatalkan penetapan tata letak sheet ke kanan-ke-kiri.
setRowGroupControlPosition(position)SheetMenetapkan posisi tombol kontrol grup baris pada sheet.
setRowHeight(rowPosition, height)SheetMenetapkan tinggi baris dari baris yang diberikan dalam piksel.
setRowHeights(startRow, numRows, height)SheetMenetapkan tinggi baris yang diberikan dalam piksel.
setRowHeightsForced(startRow, numRows, height)SheetMenetapkan tinggi baris yang diberikan dalam piksel.
setTabColor(color)SheetMenetapkan warna tab sheet.
setTabColorObject(color)SheetMenetapkan warna tab sheet.
showColumns(columnIndex)voidMenampilkan kolom di indeks yang ditentukan.
showColumns(columnIndex, numColumns)voidMenampilkan satu atau beberapa kolom berturut-turut mulai dari indeks yang diberikan.
showRows(rowIndex)voidMenampilkan baris di indeks yang ditentukan.
showRows(rowIndex, numRows)voidMenampilkan satu atau beberapa baris berturut-turut mulai dari indeks yang diberikan.
showSheet()SheetMembuat sheet terlihat.
sort(columnPosition)SheetMengurutkan sheet menurut kolom, dari bawah ke atas.
sort(columnPosition, ascending)SheetMengurutkan sheet menurut kolom.
unhideColumn(column)voidMenampilkan kolom dalam rentang yang ditentukan.
unhideRow(row)voidMenampilkan baris dalam rentang yang ditentukan.
updateChart(chart)voidMemperbarui diagram di sheet ini.

Dokumentasi mendetail

activate()

Mengaktifkan sheet ini. Tidak mengubah sheet itu sendiri, hanya konsep induk dari sheet aktif.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
visibilityDeveloperMetadataVisibilityVisibilitas metadata developer baru.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
valueStringNilai untuk metadata developer baru.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
valueStringNilai untuk metadata developer baru.
visibilityDeveloperMetadataVisibilityVisibilitas metadata developer baru.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 area data saat ini di sheet. Jika konten sel dimulai dengan =, konten tersebut akan ditafsirkan sebagai formula.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

NamaJenisDeskripsi
rowContentsObject[]Array nilai yang akan disisipkan setelah baris terakhir di sheet.

Pulang pergi

Sheet — Sheet, 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 tertentu agar sesuai dengan kontennya.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang ditentukan untuk diubah ukurannya.

Pulang pergi

Sheet — sheet, 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

autoResizeColumns(startColumn, numColumns)

Menetapkan lebar semua kolom mulai dari posisi kolom yang diberikan agar sesuai dengan kontennya.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Parameter

NamaJenisDeskripsi
startColumnIntegerKolom awal yang akan diubah ukurannya secara otomatis.
numColumnsIntegerJumlah kolom yang akan diubah ukurannya secara otomatis.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 yang diberikan agar sesuai dengan kontennya.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Parameter

NamaJenisDeskripsi
startRowIntegerBaris awal untuk mengubah ukuran secara otomatis.
numRowsIntegerJumlah baris yang akan diubah ukurannya secara otomatis.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 informasi konten dan pemformatan dari sheet.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.clear({formatOnly: true, contentsOnly: true});

Parameter

NamaJenisDeskripsi
optionsObjectPeta JavaScript yang berisi opsi lanjutan, yang tercantum di bawah.

Parameter lanjutan

NamaJenisDeskripsi
contentsOnlyBooleanApakah akan menghapus konten.
formatOnlyBooleanMenentukan apakah format akan dihapus.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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.

const 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, sekaligus mempertahankan informasi pemformatan.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearContents();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 format sheet, tetapi mempertahankan konten.

Format mengacu pada cara data diformat seperti yang diizinkan oleh pilihan di menu "Format" (misalnya: tebal, miring, format bersyarat), bukan lebar atau tinggi sel.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearFormats();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 semua catatan dari sheet.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 di sheet.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 pada sheet.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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]".

const source = SpreadsheetApp.getActiveSpreadsheet();
const sheet = source.getSheets()[0];

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Parameter

NamaJenisDeskripsi
spreadsheetSpreadsheetSpreadsheet tempat menyalin sheet ini, yang dapat berupa spreadsheet yang sama dengan sumber.

Pulang pergi

Sheet — Sheet baru, untuk penyambungan.

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 dikaitkan dengan baris, kolom, atau rentang di 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.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

Parameter

NamaJenisDeskripsi
findTextStringTeks yang akan ditelusuri.

Pulang pergi

TextFinderTextFinder untuk sheet.


deleteColumn(columnPosition)

Menghapus kolom pada posisi kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom, dimulai dari 1 untuk kolom pertama.

Pulang pergi

Sheet — sheet, 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

deleteColumns(columnPosition, howMany)

Menghapus sejumlah kolom mulai dari posisi kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom pertama yang akan dihapus.
howManyIntegerJumlah 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 di posisi baris yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris, dimulai dari 1 untuk baris pertama.

Pulang pergi

Sheet — sheet, 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

deleteRows(rowPosition, howMany)

Menghapus sejumlah baris yang dimulai dari posisi baris tertentu.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris pertama yang akan dihapus.
howManyIntegerJumlah 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()

Memperluas semua grup kolom di sheet. Metode ini memerlukan minimal satu grup kolom.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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()

Memperluas semua grup baris di sheet. Metode ini memerlukan minimal satu grup baris.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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)

Memperluas semua grup kolom hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya.

const 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

NamaJenisDeskripsi
groupDepthIntegerKedalaman grup hingga grup kolom diperluas.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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)

Memperluas semua grup baris hingga kedalaman yang ditentukan, dan menciutkan semua grup lainnya.

const 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

NamaJenisDeskripsi
groupDepthIntegerKedalaman grup yang akan digunakan untuk memperluas grup baris.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 di sheet ini.

Catatan: Sebaiknya gunakan getCurrentCell(), yang menampilkan sel yang saat ini ditandai.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const 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 menampilkan rentang terakhir yang dipilih.

Istilah "rentang aktif" mengacu pada rentang yang dipilih pengguna di sheet aktif, tetapi dalam fungsi kustom, istilah ini mengacu pada sel yang dihitung ulang secara aktif.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const 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, perilakunya akan sama seperti panggilan getActiveRange().

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const 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 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

getCharts()

Menampilkan array diagram pada sheet ini.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const charts = sheet.getCharts();

for (const i in charts) {
  const 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.

const 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.
const columnGroup = sheet.getColumnGroup(2, 1);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks kolom tombol kontrol grup atau indeks dalam grup.
groupDepthIntegerKedalaman 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 di sheet.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

Pulang pergi

GroupControlTogglePositiontrue 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 yang ditentukan.

Kedalaman grup menunjukkan jumlah grup yang tumpang-tindih dengan kolom. Rentang ini dapat berkisar antara nol dan delapan.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks kolom.

Pulang pergi

Integer — Kedalaman grup kolom pada indeks 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

getColumnWidth(columnPosition)

Mendapatkan lebar dalam piksel dari kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi 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()

Mendapatkan semua aturan format bersyarat di sheet ini.

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const 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 di sheet aktif atau null jika tidak ada sel saat ini. Sel saat ini adalah sel yang memiliki fokus di UI Google Spreadsheet, dan ditandai dengan batas gelap. Tidak pernah ada lebih dari satu sel saat ini. Saat pengguna memilih satu atau beberapa rentang sel, salah satu sel dalam pilihan adalah sel saat ini.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
const 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 tempat data berada.

Secara fungsional, tindakan ini sama dengan membuat Rentang yang dibatasi oleh A1 dan (Sheet.getLastColumn(), Sheet.getLastRow()).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

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.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

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.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

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()

Mendapatkan 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 di sheet ini, atau null jika tidak ada filter.

// Gets the filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const 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 mengirimkan responsnya ke sheet ini, atau null jika sheet ini tidak memiliki formulir terkait. Menampilkan pengecualian jika pengguna tidak memiliki izin untuk mengedit spreadsheet.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

Pulang pergi

String — URL untuk formulir yang menempatkan responsnya di 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

Pulang pergi

Integer — jumlah kolom yang 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

getFrozenRows()

Menampilkan jumlah baris yang dibekukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

Pulang pergi

Integer — jumlah baris yang 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

getImages()

Menampilkan semua gambar di atas petak pada sheet.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

Pulang pergi

OverGridImage[] — Array gambar di atas petak.

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 di spreadsheet induknya. Dimulai pada pukul 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Pulang pergi

Integer — kolom 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

getLastRow()

Menampilkan posisi baris terakhir yang memiliki konten.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const 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, terlepas dari kontennya.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, terlepas dari kontennya.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

Pulang pergi

NamedRange[] — Array dari semua rentang bernama di 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const 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 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 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 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

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.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

Parameter

NamaJenisDeskripsi
typeProtectionTypeJenis area lindung, 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
const range = sheet.getRange(1, 1);
const values = range.getValues();
Logger.log(values[0][0]);

Parameter

NamaJenisDeskripsi
rowIntegerIndeks baris sel yang akan ditampilkan; pengindeksan baris dimulai dengan 1.
columnIntegerIndeks 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parameter

NamaJenisDeskripsi
rowIntegerIndeks baris awal rentang; pengindeksan baris dimulai dengan 1.
columnIntegerIndeks kolom rentang; pengindeksan kolom dimulai dengan 1.
numRowsIntegerJumlah baris yang akan 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 yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parameter

NamaJenisDeskripsi
rowIntegerIndeks baris awal rentang; pengindeksan baris dimulai dengan 1.
columnIntegerIndeks kolom awal rentang; pengindeksan kolom dimulai dengan 1.
numRowsIntegerJumlah baris yang akan ditampilkan.
numColumnsIntegerJumlah kolom yang akan 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

Parameter

NamaJenisDeskripsi
a1NotationStringRentang 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 mewakili rentang di sheet yang sama yang ditentukan oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parameter

NamaJenisDeskripsi
a1NotationsString[]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.

const 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.
const rowGroup = sheet.getRowGroup(2, 1);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks baris tombol kontrol grup atau indeks dalam grup.
groupDepthIntegerKedalaman 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.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

Pulang pergi

GroupControlTogglePositiontrue 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 yang ditentukan.

Kedalaman grup menunjukkan jumlah grup yang tumpang-tindih dengan baris. Nilai ini dapat berkisar antara nol dan delapan.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks baris.

Pulang pergi

Integer — Kedalaman grup baris pada 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 dalam piksel dari baris yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi 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.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const 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 dan 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 yang dimulai dari koordinat yang diberikan. Nilai -1 yang diberikan sebagai posisi baris atau kolom setara dengan mendapatkan baris atau kolom terakhir yang memiliki data di sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parameter

NamaJenisDeskripsi
startRowIntegerPosisi baris awal.
startColumnIntegerPosisi kolom awal.
numRowsIntegerJumlah baris yang akan menampilkan nilai.
numColumnsIntegerJumlah kolom yang akan menampilkan nilai.

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 pemisah di 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 pemisah 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

getTabColorObject()

Mendapatkan warna tab sheet, atau null jika tab sheet tidak memiliki warna.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const 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 sheet default-nya adalah SheetType.GRID. Sheet yang berisi satu objek tersemat seperti EmbeddedChart adalah sheet SheetType.OBJECT.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 petak 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

Booleantrue 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 kolom dalam rentang yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

Parameter

NamaJenisDeskripsi
columnRangeRentang 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 yang ditentukan. Gunakan indeks 1 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().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks 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 dari indeks yang diberikan. Gunakan indeks 1 untuk metode ini.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks awal kolom yang akan disembunyikan.
numColumnsIntegerJumlah 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 ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

Parameter

NamaJenisDeskripsi
rowRangeRentang 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)

Menyembunyikan baris pada indeks yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks 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 dari indeks yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks awal baris yang akan disembunyikan.
numRowsIntegerJumlah 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 lembar yang hanya terlihat, metode ini akan menampilkan pengecualian.

const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const 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

NamaJenisDeskripsi
chartEmbeddedChartDiagram 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parameter

NamaJenisDeskripsi
afterPositionIntegerKolom tempat kolom baru akan ditambahkan.

Pulang pergi

Sheet — sheet, 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

insertColumnBefore(beforePosition)

Menyisipkan kolom sebelum posisi kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parameter

NamaJenisDeskripsi
beforePositionIntegerKolom sebelum kolom baru ditambahkan.

Pulang pergi

Sheet — sheet, 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

insertColumns(columnIndex)

Menyisipkan kolom kosong di sheet pada lokasi yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks 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 sheet yang dimulai dari lokasi yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks yang menunjukkan tempat untuk menyisipkan kolom.
numColumnsIntegerJumlah 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 jumlah kolom tertentu setelah posisi kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Parameter

NamaJenisDeskripsi
afterPositionIntegerKolom tempat kolom baru akan ditambahkan.
howManyIntegerJumlah kolom yang akan disisipkan.

Pulang pergi

Sheet — sheet, 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

insertColumnsBefore(beforePosition, howMany)

Menyisipkan sejumlah kolom sebelum posisi kolom yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parameter

NamaJenisDeskripsi
beforePositionIntegerKolom sebelum kolom baru ditambahkan.
howManyIntegerJumlah kolom yang akan disisipkan.

Pulang pergi

Sheet — sheet, 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

insertImage(blobSource, column, row)

Menyisipkan BlobSource sebagai gambar dalam dokumen pada baris dan kolom tertentu. Ukuran gambar diambil dari konten blob. Ukuran blob maksimum yang didukung adalah 2 MB.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

NamaJenisDeskripsi
blobSourceBlobSourceBlob yang berisi konten gambar, jenis MIME, dan (opsional) nama.
columnIntegerPosisi kolom.
rowIntegerPosisi 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NamaJenisDeskripsi
blobSourceBlobSourceBlob yang berisi konten gambar, jenis MIME, dan (opsional) nama.
columnIntegerPosisi kolom.
rowIntegerPosisi baris.
offsetXIntegerOffset horizontal dari sudut sel dalam piksel.
offsetYIntegerOffset 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 pada baris dan kolom tertentu.

URL yang diberikan harus dapat diakses secara publik.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

Parameter

NamaJenisDeskripsi
urlStringURL gambar.
columnIntegerPosisi kolom petak.
rowIntegerPosisi 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 pada baris dan kolom tertentu, dengan offset piksel.

URL yang diberikan harus dapat diakses secara publik.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

Parameter

NamaJenisDeskripsi
urlStringURL untuk gambar.
columnIntegerPosisi kolom.
rowIntegerPosisi baris.
offsetXIntegerOffset horizontal dari sudut sel dalam piksel.
offsetYIntegerOffset 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 diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parameter

NamaJenisDeskripsi
afterPositionIntegerBaris tempat baris baru akan ditambahkan.

Pulang pergi

Sheet — sheet, 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

insertRowBefore(beforePosition)

Menyisipkan baris sebelum posisi baris yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parameter

NamaJenisDeskripsi
beforePositionIntegerBaris sebelum baris baru ditambahkan.

Pulang pergi

Sheet — sheet, 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

insertRows(rowIndex)

Menyisipkan baris kosong di sheet pada lokasi yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks 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 berturut-turut dalam sheet yang dimulai dari lokasi yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks yang menunjukkan tempat untuk menyisipkan baris.
numRowsIntegerJumlah 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 yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parameter

NamaJenisDeskripsi
afterPositionIntegerBaris tempat baris baru akan ditambahkan.
howManyIntegerJumlah baris yang akan disisipkan.

Pulang pergi

Sheet — sheet, 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

insertRowsBefore(beforePosition, howMany)

Menyisipkan sejumlah baris sebelum posisi baris yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parameter

NamaJenisDeskripsi
beforePositionIntegerBaris sebelum baris baru ditambahkan.
howManyIntegerJumlah baris yang akan disisipkan.

Pulang pergi

Sheet — sheet, 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

insertSlicer(range, anchorRowPos, anchorColPos)

Menambahkan pemisah 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

NamaJenisDeskripsi
rangeRangeRentang tempat slicer dibuat.
anchorRowPosIntegerSisi atas pemisah disematkan di baris ini.
anchorColPosIntegerSisi atas pemisah diatarkan di kolom 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 pemisah 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

NamaJenisDeskripsi
rangeRangeRentang tempat slicer dibuat.
anchorRowPosIntegerSisi atas pemisah disematkan di baris ini.
anchorColPosIntegerSisi atas pemisah diatarkan di kolom ini.
offsetXIntegerOffset horizontal dari sudut sel dalam piksel.
offsetYIntegerOffset 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang akan diperiksa.

Pulang pergi

Booleantrue 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 adalah 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

Booleantrue 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 yang diberikan disembunyikan oleh filter (bukan tampilan filter).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diperiksa.

Pulang pergi

Booleantrue 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diperiksa.

Pulang pergi

Booleantrue 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.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Pulang pergi

Booleantrue 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 mewakili seluruh kolom atau grup kolom yang akan dipindahkan—columnSpec memilih semua kolom yang dicakup rentang.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Parameter

NamaJenisDeskripsi
columnSpecRangeRentang yang mencakup kolom yang harus dipindahkan.
destinationIndexIntegerIndeks tempat kolom akan dipindahkan. Perhatikan bahwa indeks ini didasarkan pada koordinat sebelum kolom dipindahkan. Data yang ada digeser ke kanan untuk memberi ruang bagi kolom yang dipindahkan, sedangkan kolom sumber dihapus dari petak. Oleh karena itu, data mungkin berakhir di indeks yang berbeda dengan 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 mewakili seluruh baris atau grup baris yang akan dipindahkan secara persis—rowSpec memilih semua baris yang dicakup rentang.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Parameter

NamaJenisDeskripsi
rowSpecRangeRentang yang mencakup baris yang harus dipindahkan.
destinationIndexIntegerIndeks tempat baris akan dipindahkan. Perhatikan bahwa indeks ini didasarkan pada koordinat sebelum baris dipindahkan. Data yang ada akan digeser ke bawah untuk membuat ruang bagi baris yang dipindahkan, sedangkan baris sumber akan dihapus dari petak. Oleh karena itu, data dapat berakhir pada indeks yang berbeda dengan 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:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const 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 akan mencerminkan izin dari 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.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

Parameter

NamaJenisDeskripsi
chartEmbeddedChartDiagram 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.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

Parameter

NamaJenisDeskripsi
rangeRangeRentang 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 di sheet aktif. Rentang terakhir dalam daftar ditetapkan sebagai active range.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Parameter

NamaJenisDeskripsi
rangeListRangeListDaftar rentang yang akan 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 pilihan aktif untuk sheet ini.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Parameter

NamaJenisDeskripsi
rangeRangeRentang 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)

Menetapkan pilihan aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

Parameter

NamaJenisDeskripsi
a1NotationStringRentang yang akan 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.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parameter

NamaJenisDeskripsi
positionGroupControlTogglePositionPosisi tombol kontrol grup kolom.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 tertentu dalam piksel.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom tertentu yang akan ditetapkan.
widthIntegerLebar dalam piksel yang akan ditetapkan.

Pulang pergi

Sheet — sheet, 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

setColumnWidths(startColumn, numColumns, width)

Menetapkan lebar kolom yang diberikan dalam piksel.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Parameter

NamaJenisDeskripsi
startColumnIntegerPosisi kolom awal yang akan diubah.
numColumnsIntegerJumlah kolom yang akan diubah.
widthIntegerLebar dalam piksel yang akan ditetapkan.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 sesuai urutan inputnya.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Parameter

NamaJenisDeskripsi
rulesConditionalFormatRule[]Aturan format bersyarat yang 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, pemilihan yang ada akan dihapus dan sel menjadi sel saat ini dan rentang aktif.

Catatan:Range yang ditentukan harus terdiri dari satu sel, jika tidak, akan menampilkan pengecualian.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Parameter

NamaJenisDeskripsi
cellRangeSel yang akan ditetapkan sebagai sel saat ini.

Pulang pergi

Range — sel saat ini 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 yang ditentukan. Jika nol, tidak ada kolom yang dibekukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parameter

NamaJenisDeskripsi
columnsIntegerJumlah 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parameter

NamaJenisDeskripsi
rowsIntegerJumlah 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 petak 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

NamaJenisDeskripsi
hideGridlinesBooleanJika true, sembunyikan garis petak di sheet ini; jika tidak, tampilkan garis petak.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

Parameter

NamaJenisDeskripsi
nameStringNama baru untuk sheet.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 ke 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

NamaJenisDeskripsi
rightToLeftBooleanJika true, tata letak sheet ditetapkan ke kanan ke kiri, dengan sel A1 di pojok kanan atas. Jika false, tata letak sheet ditetapkan ke kiri ke kanan default, dengan sel A1 di kiri atas.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 pada sheet.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parameter

NamaJenisDeskripsi
positionGroupControlTogglePositionPosisi tombol kontrol grup baris.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 dari baris yang diberikan dalam piksel. Secara default, baris akan bertambah untuk menyesuaikan konten sel. Jika Anda ingin memaksa baris ke tinggi yang ditentukan, gunakan setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diubah.
heightIntegerTinggi dalam piksel yang akan ditetapkan.

Pulang pergi

Sheet — Sheet, 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 diberikan dalam piksel. Secara default, baris akan bertambah agar sesuai dengan konten sel. Jika Anda ingin memaksa baris ke tinggi yang ditentukan, gunakan setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Parameter

NamaJenisDeskripsi
startRowIntegerPosisi baris awal yang akan diubah.
numRowsIntegerJumlah baris yang akan diubah.
heightIntegerTinggi dalam piksel yang akan ditetapkan.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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 diberikan dalam piksel. Secara default, baris akan bertambah untuk menyesuaikan konten sel. Saat Anda menggunakan setRowHeightsForced, baris dipaksa ke tinggi yang ditentukan meskipun konten sel lebih tinggi dari tinggi baris.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Parameter

NamaJenisDeskripsi
startRowIntegerPosisi baris awal yang akan diubah.
numRowsIntegerJumlah baris yang akan diubah.
heightIntegerTinggi dalam piksel yang akan ditetapkan.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

Parameter

NamaJenisDeskripsi
colorStringKode warna dalam notasi CSS (seperti '#ffffff' atau 'white'), atau null untuk mereset warna tab.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const 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

NamaJenisDeskripsi
colorColorWarna tab sheet yang akan ditetapkan.

Pulang pergi

Sheet — Sheet ini, untuk pembuatan rantai.

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)

Menampilkan kolom di indeks yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks kolom yang akan 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

showColumns(columnIndex, numColumns)

Menampilkan satu atau beberapa kolom berturut-turut mulai dari indeks yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Parameter

NamaJenisDeskripsi
columnIndexIntegerIndeks awal kolom yang akan ditampilkan.
numColumnsIntegerJumlah kolom yang akan 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

showRows(rowIndex)

Menampilkan baris di indeks yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks baris yang akan 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

showRows(rowIndex, numRows)

Menampilkan satu atau beberapa baris berturut-turut mulai dari indeks yang diberikan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Parameter

NamaJenisDeskripsi
rowIndexIntegerIndeks awal baris yang akan ditampilkan.
numRowsIntegerJumlah baris yang akan 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.

const 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 menurut kolom, menaik.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parameter

NamaJenisDeskripsi
columnPositionIntegerKolom yang akan diurutkan.

Pulang pergi

Sheet — sheet, 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

sort(columnPosition, ascending)

Mengurutkan sheet menurut kolom. Mengambil parameter untuk menentukan naik atau turun.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parameter

NamaJenisDeskripsi
columnPositionIntegerKolom yang akan diurutkan.
ascendingBooleantrue untuk pengurutan menaik, false untuk menurun.

Pulang pergi

Sheet — sheet, 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

unhideColumn(column)

Menampilkan kolom dalam rentang yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Parameter

NamaJenisDeskripsi
columnRangeRentang yang akan ditampilkan, 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)

Menampilkan baris dalam rentang yang ditentukan.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Parameter

NamaJenisDeskripsi
rowRangeRentang yang akan ditampilkan, 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 di sheet ini.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

Parameter

NamaJenisDeskripsi
chartEmbeddedChartDiagram 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

Metode yang tidak digunakan lagi