Class Range

Rentang

Mengakses dan mengubah rentang spreadsheet. Rentang sel dapat berupa sel tunggal di {i>sheet<i} atau sekelompok sel yang berdekatan dalam suatu {i>sheet<i}.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
activate()RangeMenetapkan rentang yang ditentukan sebagai active range, dengan bagian atas sel kiri dalam rentang sebagai current cell.
activateAsCurrentCell()RangeMenetapkan sel yang ditentukan sebagai current cell.
addDeveloperMetadata(key)RangeMenambahkan metadata developer dengan kunci yang ditentukan ke rentang.
addDeveloperMetadata(key, visibility)RangeMenambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke rentang.
addDeveloperMetadata(key, value)RangeMenambahkan metadata developer dengan kunci dan nilai yang ditentukan ke rentang.
addDeveloperMetadata(key, value, visibility)RangeMenambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke rentang.
applyColumnBanding()BandingMenerapkan tema garis berwarna kolom default ke rentang.
applyColumnBanding(bandingTheme)BandingMenerapkan tema garis berwarna kolom yang ditentukan ke rentang.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingMenerapkan tema garis banding kolom tertentu ke rentang dengan header dan footer yang ditentukan setelan.
applyRowBanding()BandingMenerapkan tema baris garis default ke rentang.
applyRowBanding(bandingTheme)BandingMenerapkan tema garis banding baris yang ditentukan ke rentang.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingMenerapkan tema garis bergaris yang ditentukan ke rentang dengan setelan header dan footer yang ditentukan.
autoFill(destination, series)voidMengisi destinationRange dengan data berdasarkan data dalam rentang ini.
autoFillToNeighbor(series)voidMenghitung rentang yang akan diisi dengan data baru berdasarkan sel di sekitarnya dan secara otomatis mengisi rentang itu dengan nilai-nilai baru berdasarkan data yang ada di rentang itu.
breakApart()RangePisahkan sel multi-kolom dalam rentang menjadi sel individual lagi.
canEdit()BooleanMenentukan apakah pengguna memiliki izin untuk mengedit setiap sel dalam rentang.
check()RangeMengubah status kotak centang dalam rentang menjadi "dicentang".
clear()RangeMenghapus rentang konten dan format.
clear(options)RangeMenghapus rentang konten, format, aturan validasi data, dan/atau komentar, seperti yang ditentukan dengan opsi lanjutan yang diberikan.
clearContent()RangeMenghapus konten rentang dan membiarkan pemformatan tetap utuh.
clearDataValidations()RangeMenghapus aturan validasi data untuk rentang tersebut.
clearFormat()RangeMenghapus pemformatan untuk rentang ini.
clearNote()RangeMengosongkan catatan di sel atau beberapa sel yang ditentukan.
collapseGroups()RangeMenciutkan semua grup yang sepenuhnya tercakup dalam rentang.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidSalin format rentang ke lokasi yang ditentukan.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidSalin format rentang ke lokasi yang ditentukan.
copyTo(destination)voidMenyalin data dari rentang sel ke rentang sel lain.
copyTo(destination, copyPasteType, transposed)voidMenyalin data dari rentang sel ke rentang sel lain.
copyTo(destination, options)voidMenyalin data dari rentang sel ke rentang sel lain.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidSalin konten rentang ke lokasi yang ditentukan.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidSalin konten rentang ke lokasi yang ditentukan.
createDataSourcePivotTable(dataSource)DataSourcePivotTableMembuat tabel pivot sumber data kosong dari sumber data, yang ditambatkan di sel pertama dalam rentang ini.
createDataSourceTable(dataSource)DataSourceTableMembuat tabel sumber data kosong dari sumber data, yang ditambatkan di sel pertama dalam {i>range<i}.
createDeveloperMetadataFinder()DeveloperMetadataFinderMenampilkan DeveloperMetadataFinderApi untuk menemukan metadata developer dalam cakupan {i>range<i}.
createFilter()FilterMembuat filter dan menerapkannya ke rentang yang ditentukan pada sheet.
createPivotTable(sourceData)PivotTableMembuat tabel pivot kosong dari sourceData yang ditentukan yang ditambatkan di sel pertama dalam rentang ini.
createTextFinder(findText)TextFinderMembuat pencari teks untuk rentang, yang dapat menemukan dan mengganti teks dalam rentang ini.
deleteCells(shiftDimension)voidMenghapus rentang sel ini.
expandGroups()RangeLuaskan grup yang diciutkan yang rentang atau tombol kontrolnya berpotongan dengan rentang ini.
getA1Notation()StringMenampilkan deskripsi string rentang, dalam notasi A1.
getBackground()StringMenampilkan warna latar belakang sel kiri atas dalam rentang (misalnya, '#ffffff').
getBackgroundObject()ColorMenampilkan warna latar belakang sel kiri atas dalam rentang.
getBackgroundObjects()Color[][]Menampilkan warna latar belakang sel dalam rentang.
getBackgrounds()String[][]Menampilkan warna latar belakang sel dalam rentang (misalnya, '#ffffff').
getBandings()Banding[]Menampilkan semua garis berwarna yang diterapkan ke sel mana pun dalam rentang ini.
getCell(row, column)RangeMenampilkan sel tertentu dalam rentang.
getColumn()IntegerMenampilkan posisi kolom awal untuk rentang ini.
getDataRegion()RangeMenampilkan salinan rentang yang diperluas dalam empat Direction utama untuk mencakup semua sel yang berdekatan dengan data di dalamnya.
getDataRegion(dimension)RangeMenampilkan salinan rentang yang diperluas Direction.UP dan Direction.DOWN jika dimensi yang ditentukan adalah Dimension.ROWS, atau Direction.NEXT dan Direction.PREVIOUS jika dimensinya adalah Dimension.COLUMNS.
getDataSourceFormula()DataSourceFormulaMenampilkan DataSourceFormula untuk sel pertama dalam rentang, atau null jika sel tidak berisi rumus sumber data.
getDataSourceFormulas()DataSourceFormula[]Menampilkan DataSourceFormula untuk sel dalam rentang.
getDataSourcePivotTables()DataSourcePivotTable[]Mendapatkan semua tabel pivot sumber data yang berpotongan dengan rentang.
getDataSourceTables()DataSourceTable[]Mendapatkan semua tabel sumber data yang berpotongan dengan rentang.
getDataSourceUrl()StringMenampilkan URL untuk data dalam rentang ini, yang dapat digunakan untuk membuat diagram dan kueri.
getDataTable()DataTableMenampilkan data di dalam objek ini sebagai DataTable.
getDataTable(firstRowIsHeader)DataTableMenampilkan data di dalam rentang ini sebagai DataTable.
getDataValidation()DataValidationMenampilkan aturan validasi data untuk sel kiri atas dalam rentang.
getDataValidations()DataValidation[][]Menampilkan aturan validasi data untuk semua sel dalam rentang.
getDeveloperMetadata()DeveloperMetadata[]Mendapatkan metadata developer yang terkait dengan rentang ini.
getDisplayValue()StringMenampilkan nilai sel kiri atas yang ditampilkan dalam rentang.
getDisplayValues()String[][]Menampilkan petak nilai persegi panjang untuk rentang ini.
getFilter()FilterMenampilkan filter pada sheet yang memiliki rentang ini, atau null jika tidak ada filter di pada lembar kerja.
getFontColorObject()ColorMenampilkan warna {i>font<i} sel di sudut kiri atas rentang.
getFontColorObjects()Color[][]Menampilkan warna font sel dalam rentang.
getFontFamilies()String[][]Menampilkan jenis font sel dalam rentang.
getFontFamily()StringMenampilkan jenis font sel di sudut kiri atas rentang.
getFontLine()StringMendapatkan gaya garis sel di sudut kiri atas rentang ('underline', 'line-through', atau 'none').
getFontLines()String[][]Mendapatkan gaya garis sel dalam rentang ('underline', 'line-through', atau 'none').
getFontSize()IntegerMengembalikan ukuran {i>font<i} dalam ukuran titik sel di sudut kiri atas rentang.
getFontSizes()Integer[][]Menampilkan ukuran font sel dalam rentang.
getFontStyle()StringMenampilkan gaya font ('italic' atau 'normal') untuk sel di bagian kiri atas sudut rentang.
getFontStyles()String[][]Menampilkan gaya font sel dalam rentang.
getFontWeight()StringMengembalikan ketebalan {i>font<i} (normal/tebal) untuk sel di sudut kiri atas rentang itu.
getFontWeights()String[][]Menampilkan bobot font sel dalam rentang.
getFormula()StringMengembalikan rumus (notasi A1) untuk sel kiri atas rentang, atau string kosong jika sel kosong atau tidak berisi formula.
getFormulaR1C1()StringMenampilkan formula (notasi R1C1) untuk sel tertentu, atau null jika tidak ada.
getFormulas()String[][]Menampilkan rumus (notasi A1) untuk sel dalam rentang.
getFormulasR1C1()String[][]Menampilkan rumus (notasi R1C1) untuk sel dalam rentang.
getGridId()IntegerMenampilkan ID petak sheet induk rentang.
getHeight()IntegerMenampilkan tinggi rentang.
getHorizontalAlignment()StringMengembalikan perataan horizontal teks (kiri/tengah/kanan) sel di kiri atas sudut rentang.
getHorizontalAlignments()String[][]Menampilkan perataan horizontal sel dalam rentang.
getLastColumn()IntegerMenampilkan posisi kolom akhir.
getLastRow()IntegerMenampilkan posisi baris akhir.
getMergedRanges()Range[]Menampilkan array objek Range yang mewakili sel gabungan yang sepenuhnya dalam rentang saat ini, atau berisi setidaknya satu sel dalam rentang saat ini.
getNextDataCell(direction)RangeMulai dari sel di kolom dan baris pertama rentang, mengembalikan sel berikutnya yang ada di arah tertentu yang merupakan tepi rentang sel yang berdekatan dengan data di dalamnya atau sel di tepi {i>spreadsheet<i} ke arah itu.
getNote()StringMenampilkan catatan yang terkait dengan rentang yang diberikan.
getNotes()String[][]Menampilkan catatan yang terkait dengan sel dalam rentang.
getNumColumns()IntegerMenampilkan jumlah kolom dalam rentang ini.
getNumRows()IntegerMenampilkan jumlah baris dalam rentang ini.
getNumberFormat()StringDapatkan format angka atau tanggal dari sel kiri atas dalam rentang yang ditentukan.
getNumberFormats()String[][]Menampilkan format angka atau tanggal untuk sel dalam rentang.
getRichTextValue()RichTextValueMenampilkan nilai Teks Kaya untuk sel kiri atas rentang, atau null jika sel nilainya bukan teks.
getRichTextValues()RichTextValue[][]Menampilkan nilai Rich Text untuk sel dalam rentang.
getRow()IntegerMenampilkan posisi baris untuk rentang ini.
getRowIndex()IntegerMenampilkan posisi baris untuk rentang ini.
getSheet()SheetMenampilkan sheet yang mencakup rentang ini.
getTextDirection()TextDirectionMenampilkan arah teks untuk sel kiri atas rentang.
getTextDirections()TextDirection[][]Menampilkan arah teks untuk sel dalam rentang.
getTextRotation()TextRotationMenampilkan pengaturan rotasi teks untuk sel kiri atas rentang.
getTextRotations()TextRotation[][]Mengembalikan pengaturan rotasi teks untuk sel dalam rentang.
getTextStyle()TextStyleMenampilkan gaya teks untuk sel kiri atas rentang.
getTextStyles()TextStyle[][]Menampilkan gaya teks untuk sel dalam rentang.
getValue()ObjectMenampilkan nilai sel kiri atas dalam rentang.
getValues()Object[][]Menampilkan petak nilai persegi panjang untuk rentang ini.
getVerticalAlignment()StringMengembalikan perataan vertikal (atas/tengah/bawah) sel di sudut kiri atas {i>range<i}.
getVerticalAlignments()String[][]Menampilkan perataan vertikal sel dalam rentang.
getWidth()IntegerMenampilkan lebar rentang dalam kolom.
getWrap()BooleanMenampilkan apakah teks dalam sel dibungkus.
getWrapStrategies()WrapStrategy[][]Menampilkan strategi pengemasan teks untuk sel dalam rentang.
getWrapStrategy()WrapStrategyMenampilkan strategi pengemasan teks untuk sel kiri atas rentang.
getWraps()Boolean[][]Menampilkan apakah teks dalam sel dibungkus.
insertCells(shiftDimension)RangeMenyisipkan sel kosong ke dalam rentang ini.
insertCheckboxes()RangeMenyisipkan kotak centang ke setiap sel dalam rentang, yang dikonfigurasi dengan true untuk dicentang dan false untuk tidak dicentang.
insertCheckboxes(checkedValue)RangeMenyisipkan kotak centang ke setiap sel dalam rentang, yang dikonfigurasi dengan nilai khusus untuk kotak centang dan {i>string<i} kosong untuk tidak dicentang.
insertCheckboxes(checkedValue, uncheckedValue)RangeMenyisipkan kotak centang ke setiap sel dalam rentang, yang dikonfigurasi dengan nilai khusus untuk kotak yang dicentang dan status tidak dicentang.
isBlank()BooleanMenampilkan true jika rentang benar-benar kosong.
isChecked()BooleanMengembalikan apakah semua sel dalam rentang memiliki status kotak centang sebagai 'dicentang'.
isEndColumnBounded()BooleanMenentukan apakah akhir rentang terikat dengan kolom tertentu.
isEndRowBounded()BooleanMenentukan apakah akhir rentang terikat dengan baris tertentu.
isPartOfMerge()BooleanMenampilkan true jika sel dalam rentang saat ini tumpang-tindih dengan sel yang digabungkan.
isStartColumnBounded()BooleanMenentukan apakah awal rentang terikat ke kolom tertentu.
isStartRowBounded()BooleanMenentukan apakah awal rentang terikat pada baris tertentu.
merge()RangeMenggabungkan sel dalam rentang bersama menjadi satu blok.
mergeAcross()RangeGabungkan sel-sel dalam rentang di seluruh kolom rentang tersebut.
mergeVertically()RangeMenggabungkan sel-sel dalam rentang bersama-sama.
moveTo(target)voidPotong dan tempel (baik format maupun nilai) dari rentang ini ke rentang target.
offset(rowOffset, columnOffset)RangeMenampilkan rentang baru yang di-offset dari rentang ini berdasarkan jumlah baris dan kolom yang ditentukan (yang bisa bernilai negatif).
offset(rowOffset, columnOffset, numRows)RangeMengembalikan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atasnya di-offset dari rentang saat ini dengan baris dan kolom tertentu, dan dengan ketinggian yang ditentukan dalam sel.
offset(rowOffset, columnOffset, numRows, numColumns)RangeMengembalikan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atasnya di-offset dari rentang saat ini dengan baris dan kolom yang diberikan, dan dengan tinggi dan lebar yang ditentukan sel.
protect()ProtectionMembuat objek yang dapat melindungi rentang agar tidak diedit kecuali oleh pengguna yang memiliki izin akses.
randomize()RangeMengacak urutan baris dalam rentang yang ditentukan.
removeCheckboxes()RangeMenghapus semua kotak centang dari rentang.
removeDuplicates()RangeMenghapus baris dalam rentang ini yang berisi nilai yang merupakan duplikat nilai di baris sebelumnya.
removeDuplicates(columnsToCompare)RangeMenghapus baris dalam rentang ini yang berisi nilai di kolom tertentu yang merupakan duplikat nilai di baris sebelumnya.
setBackground(color)RangeMenetapkan warna latar belakang semua sel dalam rentang dalam notasi CSS (seperti '#ffffff' atau 'white').
setBackgroundObject(color)RangeMenetapkan warna latar belakang semua sel dalam rentang.
setBackgroundObjects(color)RangeMenetapkan petak persegi panjang warna latar belakang (harus sesuai dengan dimensi rentang ini).
setBackgroundRGB(red, green, blue)RangeMenyetel latar belakang ke warna yang diberikan menggunakan nilai RGB (bilangan bulat antara 0 dan 255 inklusif).
setBackgrounds(color)RangeMenetapkan petak persegi panjang warna latar belakang (harus sesuai dengan dimensi rentang ini).
setBorder(top, left, bottom, right, vertical, horizontal)RangeMenetapkan properti batas.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeMenetapkan properti batas dengan warna dan/atau gaya.
setDataValidation(rule)RangeMenetapkan satu aturan validasi data untuk semua sel dalam rentang.
setDataValidations(rules)RangeMenetapkan aturan validasi data untuk semua sel dalam rentang.
setFontColor(color)RangeMenetapkan warna font dalam notasi CSS (seperti '#ffffff' atau 'white').
setFontColorObject(color)RangeMenetapkan warna font rentang yang ditentukan.
setFontColorObjects(colors)RangeMenetapkan petak warna font persegi panjang (harus sesuai dengan dimensi rentang ini).
setFontColors(colors)RangeMenetapkan petak warna font persegi panjang (harus sesuai dengan dimensi rentang ini).
setFontFamilies(fontFamilies)RangeMenetapkan petak persegi panjang jenis font (harus cocok dengan dimensi rentang ini).
setFontFamily(fontFamily)RangeMenetapkan jenis font, seperti "Documents" atau "Helvetica".
setFontLine(fontLine)RangeMenetapkan gaya garis font rentang yang ditentukan ('underline', 'line-through', atau 'none').
setFontLines(fontLines)RangeMenetapkan petak gaya garis persegi panjang (harus cocok dengan dimensi rentang ini).
setFontSize(size)RangeMenetapkan ukuran font, dengan ukuran menjadi ukuran titik yang akan digunakan.
setFontSizes(sizes)RangeMenetapkan petak ukuran font persegi panjang (harus sesuai dengan dimensi rentang ini).
setFontStyle(fontStyle)RangeMenetapkan gaya font untuk rentang yang ditentukan ('italic' atau 'normal').
setFontStyles(fontStyles)RangeMenetapkan petak gaya font persegi panjang (harus sesuai dengan dimensi rentang ini).
setFontWeight(fontWeight)RangeMenetapkan ketebalan font untuk rentang yang ditentukan (normal/tebal).
setFontWeights(fontWeights)RangeMenetapkan petak persegi panjang untuk bobot font (harus sesuai dengan dimensi rentang ini).
setFormula(formula)RangeMemperbarui formula untuk rentang ini.
setFormulaR1C1(formula)RangeMemperbarui formula untuk rentang ini.
setFormulas(formulas)RangeMenetapkan petak formula persegi panjang (harus cocok dengan dimensi rentang ini).
setFormulasR1C1(formulas)RangeMenetapkan petak formula persegi panjang (harus cocok dengan dimensi rentang ini).
setHorizontalAlignment(alignment)RangeTetapkan perataan horizontal (kiri ke kanan) untuk rentang yang ditentukan (kiri/tengah/kanan).
setHorizontalAlignments(alignments)RangeMenetapkan petak persegi panjang perataan horizontal.
setNote(note)RangeMenetapkan catatan ke nilai yang diberikan.
setNotes(notes)RangeMenetapkan petak catatan persegi panjang (harus sesuai dengan dimensi rentang ini).
setNumberFormat(numberFormat)RangeMenetapkan format angka atau tanggal ke string pemformatan yang diberikan.
setNumberFormats(numberFormats)RangeMenetapkan petak persegi panjang untuk format angka atau tanggal (harus cocok dengan dimensi rentang ini).
setRichTextValue(value)RangeMenetapkan nilai Rich Text untuk sel dalam rentang.
setRichTextValues(values)RangeMenetapkan petak persegi panjang nilai Rich Text.
setShowHyperlink(showHyperlink)RangeMenetapkan apakah rentang akan menampilkan hyperlink atau tidak.
setTextDirection(direction)RangeMenetapkan arah teks untuk sel dalam rentang.
setTextDirections(directions)RangeMenetapkan petak persegi panjang untuk arah teks.
setTextRotation(degrees)RangeMenetapkan setelan rotasi teks untuk sel dalam rentang.
setTextRotation(rotation)RangeMenetapkan setelan rotasi teks untuk sel dalam rentang.
setTextRotations(rotations)RangeMenetapkan petak rotasi teks persegi panjang.
setTextStyle(style)RangeMenetapkan gaya teks untuk sel dalam rentang.
setTextStyles(styles)RangeMenetapkan petak gaya teks persegi panjang.
setValue(value)RangeMenetapkan nilai rentang.
setValues(values)RangeMenetapkan petak nilai persegi panjang (harus sesuai dengan dimensi rentang ini).
setVerticalAlignment(alignment)RangeSetel perataan vertikal (atas ke bawah) untuk rentang yang diberikan (atas/tengah/bawah).
setVerticalAlignments(alignments)RangeMenetapkan petak persegi panjang garis vertikal (harus sesuai dengan dimensi rentang ini).
setVerticalText(isVertical)RangeMenetapkan apakah akan menumpuk teks untuk sel dalam rentang atau tidak.
setWrap(isWrapEnabled)RangeMenetapkan gabungan sel dari rentang yang ditentukan.
setWrapStrategies(strategies)RangeMenetapkan strategi penggabungan persegi panjang.
setWrapStrategy(strategy)RangeMenetapkan strategi pengemasan teks untuk sel dalam rentang.
setWraps(isWrapEnabled)RangeMenetapkan petak persegi panjang kebijakan penggabungan kata (harus cocok dengan dimensi rentang ini).
shiftColumnGroupDepth(delta)RangeMengubah kedalaman pengelompokan kolom berdasarkan jumlah yang ditentukan.
shiftRowGroupDepth(delta)RangeMengubah kedalaman pengelompokan baris dalam rentang berdasarkan jumlah yang ditentukan.
sort(sortSpecObj)RangeMengurutkan sel dalam rentang yang diberikan, berdasarkan kolom dan urutan yang ditentukan.
splitTextToColumns()voidMemisahkan kolom teks menjadi beberapa kolom berdasarkan pembatas yang terdeteksi secara otomatis.
splitTextToColumns(delimiter)voidMemisahkan kolom teks menjadi beberapa kolom menggunakan string yang ditentukan sebagai pemisah kustom.
splitTextToColumns(delimiter)voidMemisahkan kolom teks menjadi beberapa kolom berdasarkan pembatas yang ditentukan.
trimWhitespace()RangeMemangkas spasi kosong (seperti spasi, tab, atau baris baru) di setiap sel dalam rentang ini.
uncheck()RangeMengubah status kotak centang dalam rentang menjadi “tidak dicentang”.

Dokumentasi mendetail

activate()

Menetapkan rentang yang ditentukan sebagai active range, dengan bagian atas sel kiri dalam rentang sebagai current cell.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

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

Pulang pergi

Range — Rentang ini, untuk perantaian.


activateAsCurrentCell()

Menetapkan sel yang ditentukan sebagai current cell.

Jika sel yang ditentukan ada dalam rentang yang sudah ada, rentang tersebut akan menjadi aktif rentang dengan sel sebagai sel yang sedang digunakan.

Jika sel yang ditentukan tidak ada dalam rentang yang ada, maka pilihan 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 muncul pengecualian.

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

addDeveloperMetadata(key)

Menambahkan metadata developer dengan kunci yang ditentukan ke rentang.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Parameter

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

addDeveloperMetadata(key, visibility)

Menambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke rentang.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Parameter

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

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

addDeveloperMetadata(key, value)

Menambahkan metadata developer dengan kunci dan nilai yang ditentukan ke rentang.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Parameter

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

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

addDeveloperMetadata(key, value, visibility)

Menambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke rentang.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.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

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

applyColumnBanding()

Menerapkan tema garis berwarna kolom default ke rentang. Secara default, garis berwarna memiliki header dan tidak warna {i>footer<i}.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Pulang pergi

Banding — Satu garis 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

applyColumnBanding(bandingTheme)

Menerapkan tema garis berwarna kolom yang ditentukan ke rentang. Secara default, garis berwarna memiliki header dan tanpa warna {i>footer<i}.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Parameter

NamaJenisDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan ke kolom dalam rentang.

Pulang pergi

Banding — Satu garis 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

applyColumnBanding(bandingTheme, showHeader, showFooter)

Menerapkan tema garis banding kolom tertentu ke rentang dengan header dan footer yang ditentukan setelan.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

Parameter

NamaJenisDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan ke kolom dalam rentang.
showHeaderBooleanJika true, warna header tema garis berwarna akan diterapkan ke warna .
showFooterBooleanJika true, warna footer tema garis berwarna diterapkan ke warna terakhir .

Pulang pergi

Banding — Satu garis 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

applyRowBanding()

Menerapkan tema baris garis default ke rentang. Secara default, garis berwarna memiliki header dan tidak warna {i>footer<i}.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Pulang pergi

Banding — Garis berwarna.

Otorisasi

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

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

applyRowBanding(bandingTheme)

Menerapkan tema garis banding baris yang ditentukan ke rentang. Secara default, garis berwarna memiliki header dan tidak warna {i>footer<i}.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Parameter

NamaJenisDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan ke baris dalam rentang.

Pulang pergi

Banding — Satu garis 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

applyRowBanding(bandingTheme, showHeader, showFooter)

Menerapkan tema garis banding baris tertentu ke rentang dengan setelan header dan footer yang ditentukan.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

Parameter

NamaJenisDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan ke baris dalam rentang.
showHeaderBooleanJika true, warna header tema garis berwarna diterapkan ke baris pertama.
showFooterBooleanJika true, warna footer tema garis berwarna diterapkan ke baris terakhir.

Pulang pergi

Banding — Satu garis 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

autoFill(destination, series)

Mengisi destinationRange dengan data berdasarkan data dalam rentang ini. Nilai-nilai baru juga ditentukan oleh jenis series yang ditentukan. Rentang tujuan harus berisi rentang ini dan memperluasnya hanya ke satu arah. Misalnya, kode berikut mengisi A1:A20 dengan serangkaian angka yang meningkat berdasarkan nilai saat ini di A1:A4:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parameter

NamaJenisDeskripsi
destinationRangeRentang yang akan diisi secara otomatis dengan nilai. Rentang tujuan harus memuat rentang ini dan memperluasnya hanya ke satu arah (ke atas, bawah, kiri, atau kanan).
seriesAutoFillSeriesJenis deret isi otomatis yang harus digunakan untuk menghitung nilai baru. Tujuan efek rangkaian ini berbeda berdasarkan jenis dan jumlah data sumber.

Otorisasi

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

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

autoFillToNeighbor(series)

Menghitung rentang yang akan diisi dengan data baru berdasarkan sel di sekitarnya dan secara otomatis mengisi rentang itu dengan nilai-nilai baru berdasarkan data yang ada di rentang itu. Nilai-nilai baru ini juga ditentukan oleh jenis series yang ditentukan.

Rentang tujuan yang dihitung mempertimbangkan data di sekitarnya untuk menentukan lokasi nilai harus dimasukkan: jika ada data di sebelah kiri atau kanan kolom yang diisi otomatis, nilai baru hanya akan diperluas sejauh data yang berdekatan ini.

Misalnya, jika A1:A20 diisi dengan serangkaian angka yang meningkat dan metode ini dipanggil pada rentang B1:B4 yang berisi serangkaian tanggal, nilai baru hanya disisipkan ke dalam B5:B20. Dengan cara ini, nilai-nilai baru ini “melekat” ke sel-sel yang berisi nilai di kolom A.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parameter

NamaJenisDeskripsi
seriesAutoFillSeriesJenis deret isi otomatis yang harus digunakan untuk menghitung nilai baru. Tujuan efek rangkaian ini berbeda berdasarkan jenis dan jumlah data sumber.

Otorisasi

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

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

breakApart()

Pisahkan sel multi-kolom dalam rentang menjadi sel individual lagi.

Memanggil fungsi ini pada rentang sama dengan memilih rentang dan mengklik Format &gt; Gabungkan sel &gt; Pisahkan.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

canEdit()

Menentukan apakah pengguna memiliki izin untuk mengedit setiap sel dalam rentang. {i>Spreadsheet<i} pemilik selalu dapat mengedit rentang dan sheet dilindungi.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

Pulang pergi

Booleantrue jika pengguna memiliki izin untuk mengedit setiap sel dalam rentang; false sebaliknya.

Otorisasi

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

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

check()

Mengubah status kotak centang dalam rentang menjadi "dicentang". Mengabaikan sel dalam rentang yang saat ini tidak berisi nilai yang dicentang atau tidak dicentang, yang telah dikonfigurasi.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clear()

Menghapus berbagai konten dan format.

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

var range = sheet.getRange("A1:D10");
range.clear();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clear(options)

Menghapus rentang konten, format, aturan validasi data, dan/atau komentar, seperti yang ditentukan dengan opsi lanjutan yang diberikan. Secara default, semua data dihapus.

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

Parameter

NamaJenisDeskripsi
optionsObjectObjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini.

Parameter lanjutan

NamaJenisDeskripsi
commentsOnlyBooleanApakah hanya menghapus komentar.
contentsOnlyBooleanApakah akan menghapus konten saja.
formatOnlyBooleanApakah akan menghapus format saja; perhatikan bahwa menghapus format ini juga menghapus aturan validasi data.
validationsOnlyBooleanApakah akan menghapus hanya aturan validasi data.
skipFilteredRowsBooleanApakah ingin menghindari penghapusan baris yang difilter.

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clearContent()

Menghapus konten rentang dan membiarkan pemformatan tetap utuh.

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

var range = sheet.getRange("A1:D10");
range.clearContent();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clearDataValidations()

Menghapus aturan validasi data untuk rentang tersebut.

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clearFormat()

Menghapus pemformatan untuk rentang ini.

Ini akan menghapus pemformatan teks untuk sel atau sel dalam rentang, tetapi tidak mengatur ulang aturan pemformatan angka.

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

clearNote()

Mengosongkan catatan di sel atau beberapa sel yang ditentukan.

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

var range = sheet.getRange("A1:D10");
range.clearNote();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

collapseGroups()

Menciutkan semua grup yang sepenuhnya tercakup dalam rentang. Jika tidak ada grup yang sepenuhnya dalam rentang, grup diperluas terdalam yang sebagian berada dalam rentang diciutkan.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are collapsed.
range.collapseGroups();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

copyFormatToRange(gridId, column, columnEnd, row, rowEnd)

Salin format rentang ke lokasi yang ditentukan. Jika tujuan lebih besar atau lebih kecil daripada rentang sumber, maka sumber akan diulangi atau dipotong sesuai dengan itu. Perhatikan bahwa akan menyalin pemformatan saja.

Untuk deskripsi mendetail tentang parameter gridId, lihat getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

Parameter

NamaJenisDeskripsi
gridIdIntegerID unik sheet dalam spreadsheet, terlepas dari posisi.
columnIntegerKolom pertama rentang target.
columnEndIntegerKolom akhir rentang target.
rowIntegerBaris awal rentang target.
rowEndIntegerBaris akhir rentang target.

Otorisasi

Skrip yang 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


copyFormatToRange(sheet, column, columnEnd, row, rowEnd)

Salin format rentang ke lokasi yang ditentukan. Jika tujuan lebih besar atau lebih kecil daripada rentang sumber, maka sumber akan diulangi atau dipotong sesuai dengan itu. Perhatikan bahwa akan menyalin pemformatan saja.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

Parameter

NamaJenisDeskripsi
sheetSheetSheet target.
columnIntegerKolom pertama rentang target.
columnEndIntegerKolom akhir rentang target.
rowIntegerBaris awal rentang target.
rowEndIntegerBaris akhir rentang target.

Otorisasi

Skrip yang 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(destination)

Menyalin data dari rentang sel ke rentang sel lain. Nilai dan pemformatan akan disalin.

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

Parameter

NamaJenisDeskripsi
destinationRangeRentang tujuan untuk menyalin; hanya posisi sel di kiri atas yang relevan.

Otorisasi

Skrip yang 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(destination, copyPasteType, transposed)

Menyalin data dari rentang sel ke rentang sel lain.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

Parameter

NamaJenisDeskripsi
destinationRangeRentang tujuan untuk menyalin; hanya posisi sel di kiri atas yang relevan.
copyPasteTypeCopyPasteTypeJenis yang menentukan cara isi rentang ditempelkan ke tujuan.
transposedBooleanApakah rentang harus ditempelkan pada orientasi yang ditransposisikan.

Otorisasi

Skrip yang 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(destination, options)

Menyalin data dari rentang sel ke rentang sel lain. Secara {i>default<i} dan pemformatan disalin, tetapi Anda dapat menggantinya menggunakan argumen lanjutan.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

Parameter

NamaJenisDeskripsi
destinationRangeRentang tujuan untuk menyalin; hanya posisi sel di kiri atas yang relevan.
optionsObjectObjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini.

Parameter lanjutan

NamaJenisDeskripsi
formatOnlyBooleanmenetapkan bahwa hanya format yang boleh disalin
contentsOnlyBooleanmenetapkan bahwa hanya konten yang boleh disalin

Otorisasi

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

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

copyValuesToRange(gridId, column, columnEnd, row, rowEnd)

Salin konten rentang ke lokasi yang ditentukan. Jika tujuan lebih besar atau lebih kecil daripada rentang sumber, maka sumber akan diulangi atau dipotong sesuai dengan itu.

Untuk deskripsi mendetail tentang parameter gridId, lihat getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

Parameter

NamaJenisDeskripsi
gridIdIntegerID unik sheet dalam spreadsheet, terlepas dari posisi.
columnIntegerKolom pertama rentang target.
columnEndIntegerKolom akhir rentang target.
rowIntegerBaris awal rentang target.
rowEndIntegerBaris akhir rentang target.

Otorisasi

Skrip yang 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


copyValuesToRange(sheet, column, columnEnd, row, rowEnd)

Salin konten rentang ke lokasi yang ditentukan. Jika tujuan lebih besar atau lebih kecil daripada rentang sumber, maka sumber akan diulangi atau dipotong sesuai dengan itu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

Parameter

NamaJenisDeskripsi
sheetSheetSheet target.
columnIntegerKolom pertama rentang target.
columnEndIntegerKolom akhir rentang target.
rowIntegerBaris awal rentang target.
rowEndIntegerBaris akhir rentang target.

Otorisasi

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

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

createDataSourcePivotTable(dataSource)

Membuat tabel pivot sumber data kosong dari sumber data, yang ditambatkan di sel pertama dalam rentang ini.

Contoh ini menunjukkan cara membuat dan mengonfigurasi tabel pivot sumber data baru.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

Parameter

NamaJenisDeskripsi
dataSourceDataSourceSumber data untuk membuat tabel pivot.

Pulang pergi

DataSourcePivotTable — Tabel pivot sumber data yang baru dibuat.

Otorisasi

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

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

createDataSourceTable(dataSource)

Membuat tabel sumber data kosong dari sumber data, yang ditambatkan di sel pertama dalam {i>range<i}.

Contoh ini menunjukkan cara membuat dan mengonfigurasi tabel sumber data baru.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

Parameter

NamaJenisDeskripsi
dataSourceDataSourceSumber data untuk membuat tabel pivot.

Pulang pergi

DataSourceTable — Tabel sumber data yang baru dibuat.

Otorisasi

Skrip yang 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 DeveloperMetadataFinderApi untuk menemukan metadata developer dalam cakupan {i>range<i}. Metadata berada dalam cakupan rentang itu, hanya jika metadata tersebut sepenuhnya terkandung dalam {i>range<i}. Misalnya, metadata yang dikaitkan dengan baris '3:3' tidak berada dalam cakupan rentang ‘A1:D5’ tetapi berada dalam cakupan rentang ‘1:5’.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Pulang pergi

DeveloperMetadataFinder — Pencari metadata developer untuk menelusuri metadata dalam cakupan rentang ini.


createFilter()

Membuat filter dan menerapkannya ke rentang yang ditentukan pada sheet. Anda tidak dapat membuat lebih dari satu filter pada sebuah {i>sheet<i}. Untuk mengakses dan mengubah filter setelah membuatnya, gunakan getFilter() atau Sheet.getFilter().

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
Gunakan metode ini untuk membuat filter bagi Grid sheet, jenis default sheet. Lembar kisi adalah lembar yang tidak terhubung ke {i>database<i}. Untuk membuat jenis filter lain, lihat referensi berikut:

Pulang pergi

Filter — Filter 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

createPivotTable(sourceData)

Membuat tabel pivot kosong dari sourceData yang ditentukan yang ditambatkan di sel pertama dalam rentang 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

Parameter

NamaJenisDeskripsi
sourceDataRangeData yang menjadi asal pembuatan tabel pivot.

Pulang pergi

PivotTablePivotTable yang baru dibuat.

Otorisasi

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

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

createTextFinder(findText)

Membuat pencari teks untuk rentang, yang dapat menemukan dan mengganti teks dalam rentang ini.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

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

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

Parameter

NamaJenisDeskripsi
findTextStringTeks yang akan ditelusuri.

Pulang pergi

TextFinderTextFinder untuk rentang


deleteCells(shiftDimension)

Menghapus rentang sel ini. Data yang ada dalam sheet di sepanjang dimensi yang disediakan akan digeser menuju rentang yang dihapus.

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Parameter

NamaJenisDeskripsi
shiftDimensionDimensionDimensi yang akan digunakan untuk mengalihkan data yang 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

expandGroups()

Luaskan grup yang diciutkan yang rentang atau tombol kontrolnya berpotongan dengan rentang ini. Tujuan lokasi tombol alih kontrol adalah indeks tempat tombol kontrol ditampilkan, langsung sebelum atau setelah grup tergantung pada pengaturan. Jika ada lebih dari satu kelompok di lokasi yang sama, kelompok dangkal dan diperbesar.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are expanded.
range.expandGroups();

Pulang pergi

Range — Rentang ini, untuk perantaian.

Otorisasi

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

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

getA1Notation()

Menampilkan deskripsi string rentang, dalam notasi A1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

Pulang pergi

String — Deskripsi string rentang dalam notasi A1.

Otorisasi

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

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

getBackground()

Menampilkan warna latar belakang sel kiri atas dalam rentang (misalnya, '#ffffff').

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

Pulang pergi

String — Kode warna latar belakang.

Otorisasi

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

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

getBackgroundObject()

Menampilkan warna latar belakang sel kiri atas dalam rentang.

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Pulang pergi

Color — Warna latar belakang sel kiri atas dalam rentang.

Otorisasi

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

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

getBackgroundObjects()

Menampilkan warna latar belakang sel dalam rentang.

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

Pulang pergi

Color[][] — Array dua dimensi warna latar belakang.

Otorisasi

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

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

getBackgrounds()

Menampilkan warna latar belakang sel dalam rentang (misalnya, '#ffffff').

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

Pulang pergi

String[][] — Array dua dimensi dari kode warna dari latar belakang.

Otorisasi

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

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

getBandings()

Menampilkan semua garis berwarna yang diterapkan ke sel mana pun dalam rentang 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Pulang pergi

Banding[] — Semua garis berwarna yang diterapkan ke sel mana pun dalam rentang 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

getCell(row, column)

Menampilkan sel tertentu dalam rentang.

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

var range = sheet.getRange("B2:D4");

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Parameter

NamaJenisDeskripsi
rowIntegerBaris sel relatif terhadap rentang.
columnIntegerKolom sel relatif terhadap rentang.

Pulang pergi

Range — Rentang yang berisi satu sel pada koordinat 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

getColumn()

Menampilkan posisi kolom awal untuk rentang ini.

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

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

Pulang pergi

Integer — Posisi kolom awal rentang di 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

getDataRegion()

Menampilkan salinan rentang yang diperluas dalam empat Direction utama untuk mencakup semua sel yang berdekatan dengan data di dalamnya. Jika rentang dikelilingi oleh sel kosong yang tidak termasuk yang di sepanjang diagonal, rentang itu sendiri dikembalikan. Ini mirip dengan memilih rentang dan mengetik Ctrl+A di editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

Pulang pergi

Range — Region data rentang atau rentang untuk seluruh 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

getDataRegion(dimension)

Menampilkan salinan rentang yang diperluas Direction.UP dan Direction.DOWN jika dimensi yang ditentukan adalah Dimension.ROWS, atau Direction.NEXT dan Direction.PREVIOUS jika dimensinya adalah Dimension.COLUMNS. Perluasan rentang didasarkan pada deteksi data di samping rentang yang diatur seperti tabel. Rentang yang diperluas mencakup semua sel yang berdekatan dengan data di dalamnya sepanjang dimensi yang ditentukan termasuk tabel batasan data. Jika rentang asli dikelilingi oleh sel kosong di sepanjang dimensi yang ditentukan, maka rentang itu sendiri akan dikembalikan. Metode ini mirip dengan memilih rentang dan mengetik Ctrl+Space untuk kolom atau Shift+Space untuk baris di editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

Parameter

NamaJenisDeskripsi
dimensionDimensionDimensi yang akan diperluas rentangnya.

Pulang pergi

Range — Region data atau rentang rentang yang mencakup setiap kolom atau setiap baris yang dibentangkan oleh rentang asli.

Otorisasi

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

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

getDataSourceFormula()

Menampilkan DataSourceFormula untuk sel pertama dalam rentang, atau null jika sel tidak berisi rumus 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

Pulang pergi

DataSourceFormulaDataSourceFormula untuk sel.

Otorisasi

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

Menampilkan DataSourceFormula untuk sel dalam rentang.

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

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

Pulang pergi

DataSourceFormula[] — Array DataSourceFormula.

Otorisasi

Skrip yang 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 yang berpotongan dengan rentang.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.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 yang berpotongan dengan rentang.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.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

getDataSourceUrl()

Menampilkan URL untuk data dalam rentang ini, yang dapat digunakan untuk membuat diagram dan kueri.

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

Pulang pergi

String — URL untuk rentang ini sebagai sumber data yang dapat diteruskan ke API lain seperti 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

getDataTable()

Menampilkan data di dalam objek ini sebagai DataTable.

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

Pulang pergi

DataTable — data sebagai tabel data.


getDataTable(firstRowIsHeader)

Menampilkan data di dalam rentang ini sebagai DataTable.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

Parameter

NamaJenisDeskripsi
firstRowIsHeaderBooleanApakah akan memperlakukan baris pertama sebagai header.

Pulang pergi

DataTable — Data sebagai tabel 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

getDataValidation()

Menampilkan aturan validasi data untuk sel kiri atas dalam rentang. Jika validasi data belum telah ditetapkan pada sel, metode ini akan menampilkan null.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

Pulang pergi

DataValidation — Aturan validasi data untuk sel kiri atas dalam rentang.

Otorisasi

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

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

getDataValidations()

Menampilkan aturan validasi data untuk semua sel dalam rentang. Jika validasi data belum ditetapkan pada sel tertentu, metode ini akan menampilkan null untuk posisi sel tersebut dalam array.

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

Pulang pergi

DataValidation[][] — Array dua dimensi aturan validasi data yang terkait dengan sel dalam {i>range<i}.

Otorisasi

Skrip yang 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 metadata developer yang terkait dengan rentang 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

Pulang pergi

DeveloperMetadata[] — Metadata developer yang terkait dengan rentang 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

getDisplayValue()

Menampilkan nilai sel kiri atas yang ditampilkan dalam rentang. Nilainya adalah String. Nilai yang ditampilkan memperhitungkan format tanggal, waktu, dan mata uang, termasuk format yang diterapkan secara otomatis oleh setelan lokal spreadsheet. Sel kosong menampilkan nilai kosong {i>string<i}.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

Pulang pergi

String — Nilai yang ditampilkan dalam 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

getDisplayValues()

Menampilkan petak nilai persegi panjang untuk rentang ini.

Menampilkan array dua dimensi dari nilai yang ditampilkan, diindeks menurut baris, lalu menurut kolom. Tujuan nilainya adalah objek String. Nilai yang ditampilkan memperhitungkan tanggal, waktu, dan pemformatan mata uang, termasuk format yang diterapkan secara otomatis oleh lokal spreadsheet deskripsi tempat. Sel kosong diwakili oleh string kosong dalam array. Ingatlah bahwa meskipun indeks rentang dimulai dari 1, 1, array JavaScript diindeks dari [0][0].

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Pulang pergi

String[][] — 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

getFilter()

Menampilkan filter pada sheet yang memiliki rentang ini, atau null jika tidak ada filter di pada lembar kerja.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.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

getFontColorObject()

Menampilkan warna {i>font<i} sel di sudut kiri atas rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

Pulang pergi

Color — Warna font sel kiri atas dalam rentang.

Otorisasi

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

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

getFontColorObjects()

Menampilkan warna font sel dalam rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

Pulang pergi

Color[][] — Array dua dimensi warna font yang terkait dengan sel dalam rentang.

Otorisasi

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

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

getFontFamilies()

Menampilkan jenis font sel dalam rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Pulang pergi

String[][] — Array dua dimensi dari jenis font yang terkait dengan sel dalam rentang.

Otorisasi

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

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

getFontFamily()

Menampilkan jenis font sel di sudut kiri atas rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontFamily());

Pulang pergi

String — Jenis font sel.

Otorisasi

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

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

getFontLine()

Mendapatkan gaya garis sel di sudut kiri atas rentang ('underline', 'line-through', atau 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontLine());

Pulang pergi

String — Baris font.

Otorisasi

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

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

getFontLines()

Mendapatkan gaya garis sel dalam rentang ('underline', 'line-through', atau 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Pulang pergi

String[][] — Array dua dimensi dari garis font yang dikaitkan dengan sel dalam rentang.

Otorisasi

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

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

getFontSize()

Mengembalikan ukuran {i>font<i} dalam ukuran titik sel di sudut kiri atas rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4"