Class Range

Rentang

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
activate()RangeMenetapkan rentang yang ditentukan sebagai active range, dengan sel kiri atas 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 berwarna kolom yang ditentukan ke rentang dengan setelan header dan footer yang ditentukan.
applyRowBanding()BandingMenerapkan tema garis berwarna baris default ke rentang.
applyRowBanding(bandingTheme)BandingMenerapkan tema garis berwarna baris yang ditentukan ke rentang.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingMenerapkan tema garis berwarna baris 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 tersebut dengan nilai baru berdasarkan data yang terdapat dalam rentang ini.
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, membiarkan format tetap utuh.
clearDataValidations()RangeMenghapus aturan validasi data untuk rentang.
clearFormat()RangeMenghapus pemformatan untuk rentang ini.
clearNote()RangeMenghapus catatan dalam sel atau beberapa sel tertentu.
collapseGroups()RangeMenciutkan semua grup yang sepenuhnya berada 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 diberikan.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidSalin konten rentang ke lokasi yang diberikan.
createDataSourcePivotTable(dataSource)DataSourcePivotTableMembuat tabel pivot sumber data kosong dari sumber data, yang ditempatkan di sel pertama dalam rentang ini.
createDataSourceTable(dataSource)DataSourceTableMembuat tabel sumber data kosong dari sumber data, yang ditambatkan di sel pertama dalam rentang ini.
createDeveloperMetadataFinder()DeveloperMetadataFinderMenampilkan DeveloperMetadataFinderApi untuk menemukan metadata developer dalam cakupan rentang ini.
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 mencari dan mengganti teks dalam rentang ini.
deleteCells(shiftDimension)voidMenghapus rentang sel ini.
expandGroups()RangeMeluaskan 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 di empat Direction kardinal untuk mencakup semua sel yang berdekatan dengan data di dalamnya.
getDataRegion(dimension)RangeMenampilkan salinan rentang Direction.UP dan Direction.DOWN yang diperluas 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 formula 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 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 berada dalam rentang ini, atau null jika tidak ada filter pada sheet.
getFontColorObject()ColorMenampilkan warna font sel di sudut kiri atas rentang.
getFontColorObjects()Color[][]Menampilkan warna font sel dalam rentang.
getFontFamilies()String[][]Menampilkan kelompok 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()IntegerMenampilkan ukuran font dalam ukuran titik sel di sudut kiri atas rentang.
getFontSizes()Integer[][]Menampilkan ukuran font sel dalam rentang.
getFontStyle()StringMenampilkan gaya font ('italic' atau 'normal') sel di sudut kiri atas rentang.
getFontStyles()String[][]Menampilkan gaya font sel dalam rentang.
getFontWeight()StringMenampilkan ketebalan font (normal/tebal) dari sel di sudut kiri atas rentang.
getFontWeights()String[][]Menampilkan ketebalan font sel dalam rentang.
getFormula()StringMenampilkan formula (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 formula (notasi A1) untuk sel dalam rentang.
getFormulasR1C1()String[][]Menampilkan formula (notasi R1C1) untuk sel dalam rentang.
getGridId()IntegerMenampilkan ID petak dari sheet induk rentang.
getHeight()IntegerMenampilkan tinggi rentang.
getHorizontalAlignment()StringMenampilkan perataan horizontal teks (kiri/tengah/kanan) sel di sudut kiri atas 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 merepresentasikan sel gabungan yang sepenuhnya berada dalam rentang saat ini, atau berisi setidaknya satu sel dalam rentang saat ini.
getNextDataCell(direction)RangeMulai dari sel di kolom dan baris pertama rentang, menampilkan sel berikutnya dalam arah tertentu, yaitu tepi rentang sel yang berdekatan yang berisi data atau sel di tepi spreadsheet di arah tersebut.
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()StringMendapatkan format angka atau tanggal di sel kiri atas dari rentang yang ditentukan.
getNumberFormats()String[][]Menampilkan format angka atau tanggal untuk sel dalam rentang.
getRichTextValue()RichTextValueMenampilkan nilai Rich Text untuk sel kiri atas rentang, atau null jika nilai sel 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 memiliki rentang ini.
getTextDirection()TextDirectionMenampilkan arah teks untuk sel kiri atas rentang.
getTextDirections()TextDirection[][]Menampilkan teks arah untuk sel dalam rentang.
getTextRotation()TextRotationMenampilkan setelan rotasi teks untuk sel kiri atas rentang.
getTextRotations()TextRotation[][]Menampilkan 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()StringMenampilkan perataan vertikal (atas/tengah/bawah) sel di sudut kiri atas rentang.
getVerticalAlignments()String[][]Menampilkan perataan vertikal sel dalam rentang.
getWidth()IntegerMenampilkan lebar rentang dalam kolom.
getWrap()BooleanMenampilkan apakah teks dalam sel merapikan atau tidak.
getWrapStrategies()WrapStrategy[][]Menampilkan strategi pengemasan teks untuk sel dalam rentang.
getWrapStrategy()WrapStrategyMenampilkan strategi penggabungan teks untuk sel kiri atas rentang.
getWraps()Boolean[][]Menampilkan apakah teks dalam pengemasan sel.
insertCells(shiftDimension)RangeMenyisipkan sel kosong ke rentang ini.
insertCheckboxes()RangeMenyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan true untuk dicentang dan false untuk tidak dicentang.
insertCheckboxes(checkedValue)RangeMenyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan nilai kustom untuk yang dicentang dan string kosong untuk tidak dicentang.
insertCheckboxes(checkedValue, uncheckedValue)RangeMenyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan nilai kustom untuk status yang dicentang dan tidak dicentang.
isBlank()BooleanMenampilkan true jika rentang benar-benar kosong.
isChecked()BooleanMenampilkan apakah semua sel dalam rentang memiliki status kotak centang sebagai 'dicentang'.
isEndColumnBounded()BooleanMenentukan apakah akhir rentang terikat pada kolom tertentu.
isEndRowBounded()BooleanMenentukan apakah akhir rentang terikat ke baris tertentu.
isPartOfMerge()BooleanMenampilkan true jika sel dalam rentang saat ini tumpang-tindih dengan sel gabungan.
isStartColumnBounded()BooleanMenentukan apakah awal rentang terikat ke kolom tertentu.
isStartRowBounded()BooleanMenentukan apakah awal rentang terikat ke baris tertentu.
merge()RangeMenggabungkan sel dalam rentang menjadi satu blok.
mergeAcross()RangeGabungkan sel dalam rentang yang memenuhi kolom rentang.
mergeVertically()RangeMenggabungkan sel dalam rentang secara bersamaan.
moveTo(target)voidPotong dan tempel (format dan 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 (bisa negatif).
offset(rowOffset, columnOffset, numRows)RangeMenampilkan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atas diimbangi dari rentang saat ini menurut baris dan kolom yang diberikan, dan dengan tinggi yang diberikan dalam sel.
offset(rowOffset, columnOffset, numRows, numColumns)RangeMenampilkan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atas di-offset dari rentang saat ini menurut baris dan kolom yang diberikan, serta dengan tinggi dan lebar yang diberikan dalam sel.
protect()ProtectionMembuat objek yang dapat melindungi rentang agar tidak diedit, kecuali oleh pengguna yang memiliki izin.
randomize()RangeMengacak urutan baris dalam rentang yang diberikan.
removeCheckboxes()RangeMenghapus semua kotak centang dari rentang.
removeDuplicates()RangeMenghapus baris dalam rentang ini yang berisi nilai yang merupakan duplikat dari nilai pada baris sebelumnya.
removeDuplicates(columnsToCompare)RangeMenghapus baris dalam rentang ini yang berisi nilai di kolom tertentu yang merupakan duplikat dari nilai pada 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 warna latar belakang persegi panjang (harus sesuai dengan dimensi rentang ini).
setBackgroundRGB(red, green, blue)RangeMenetapkan latar belakang ke warna yang diberikan menggunakan nilai RGB (bilangan bulat antara 0 dan 255 inklusif).
setBackgrounds(color)RangeMenetapkan petak warna latar belakang persegi panjang (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 untuk rentang yang ditetapkan.
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 sesuai dengan dimensi rentang ini).
setFontFamily(fontFamily)RangeMenetapkan jenis font, seperti "MMS" atau "Helvetica".
setFontLine(fontLine)RangeMenetapkan gaya garis font untuk rentang yang ditentukan ('underline', 'line-through', atau 'none').
setFontLines(fontLines)RangeMenetapkan kisi gaya garis persegi panjang (harus sesuai 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 cocok 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 cocok dengan dimensi rentang ini).
setFontWeight(fontWeight)RangeMenetapkan ketebalan font untuk rentang yang ditentukan (normal/tebal).
setFontWeights(fontWeights)RangeMenetapkan petak persegi panjang ketebalan font (harus sesuai dengan dimensi rentang ini).
setFormula(formula)RangeMemperbarui formula untuk rentang ini.
setFormulaR1C1(formula)RangeMemperbarui formula untuk rentang ini.
setFormulas(formulas)RangeMenetapkan kisi formula persegi panjang (harus sesuai dengan dimensi rentang ini).
setFormulasR1C1(formulas)RangeMenetapkan kisi formula persegi panjang (harus sesuai dengan dimensi rentang ini).
setHorizontalAlignment(alignment)RangeMenyetel 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 kisi 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 angka atau format tanggal (harus sesuai dengan dimensi rentang ini).
setRichTextValue(value)RangeMenetapkan nilai Rich Text untuk sel dalam rentang.
setRichTextValues(values)RangeMenetapkan petak persegi panjang nilai Teks Kaya.
setShowHyperlink(showHyperlink)RangeMenetapkan apakah rentang harus menampilkan hyperlink atau tidak.
setTextDirection(direction)RangeMenetapkan arah teks untuk sel dalam rentang.
setTextDirections(directions)RangeMenetapkan petak teks arah persegi panjang.
setTextRotation(degrees)RangeMenetapkan pengaturan rotasi teks untuk sel dalam rentang.
setTextRotation(rotation)RangeMenetapkan pengaturan 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 persegi panjang gaya teks.
setValue(value)RangeMenetapkan nilai rentang.
setValues(values)RangeMenetapkan kisi nilai persegi panjang (harus sesuai dengan dimensi rentang ini).
setVerticalAlignment(alignment)RangeMenetapkan perataan vertikal (atas ke bawah) untuk rentang yang ditentukan (atas/tengah/bawah).
setVerticalAlignments(alignments)RangeMenetapkan kisi persegi panjang perataan vertikal (harus sesuai dengan dimensi rentang ini).
setVerticalText(isVertical)RangeMenetapkan apakah akan menumpuk teks untuk sel dalam rentang atau tidak.
setWrap(isWrapEnabled)RangeMenetapkan penggabungan sel pada rentang yang ditentukan.
setWrapStrategies(strategies)RangeMenetapkan petak strategi penggabungan persegi panjang.
setWrapStrategy(strategy)RangeMenetapkan strategi pengemasan teks untuk sel dalam rentang.
setWraps(isWrapEnabled)RangeMenetapkan petak persegi panjang untuk kebijakan penggabungan kata (harus sesuai dengan dimensi rentang ini).
shiftColumnGroupDepth(delta)RangeMengubah kedalaman pengelompokan kolom rentang berdasarkan jumlah yang ditentukan.
shiftRowGroupDepth(delta)RangeMengubah kedalaman pengelompokan baris 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 otomatis.
splitTextToColumns(delimiter)voidMemisahkan kolom teks menjadi beberapa kolom menggunakan string yang ditentukan sebagai pembatas 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 sel kiri atas 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();

Return

Range — Rentang ini, untuk perantaian.


activateAsCurrentCell()

Menetapkan sel yang ditentukan sebagai current cell.

Jika sel yang ditentukan berada dalam rentang yang sudah ada, rentang tersebut akan menjadi rentang aktif dengan sel sebagai sel saat ini.

Jika sel yang ditentukan tidak ada di rentang yang ada, pilihan yang ada akan dihapus dan sel tersebut menjadi sel saat ini dan rentang yang aktif.

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

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

Return

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

NamaTypeDeskripsi
keyStringKunci untuk metadata developer baru.

Return

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

NamaTypeDeskripsi
keyStringKunci untuk metadata developer baru.
visibilityDeveloperMetadataVisibilityVisibilitas metadata developer baru.

Return

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

NamaTypeDeskripsi
keyStringKunci untuk metadata developer baru.
valueStringNilai untuk metadata developer baru.

Return

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

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

Return

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 tanpa warna footer.

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

Return

Banding — Kode 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 footer.

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

NamaTypeDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan ke kolom dalam rentang.

Return

Banding — Kode 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 berwarna kolom yang ditentukan ke rentang dengan setelan header dan footer yang ditentukan.

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

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

Return

Banding — Kode 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 garis berwarna baris default ke rentang. Secara default, garis berwarna memiliki header dan tanpa warna footer.

// 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);

Return

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 berwarna baris yang ditentukan ke rentang. Secara default, garis berwarna memiliki header dan tanpa warna footer.

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

NamaTypeDeskripsi
bandingThemeBandingThemeTema warna yang akan diterapkan pada baris dalam rentang.

Return

Banding — Kode 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 berwarna baris yang ditentukan 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

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

Return

Banding — Kode 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 baru juga ditentukan oleh jenis series yang telah ditentukan. Rentang tujuan harus memuat rentang ini dan memperluasnya hanya ke satu arah. Misalnya, kode berikut mengisi A1:A20 dengan serangkaian angka yang meningkat berdasarkan nilai saat ini dalam 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

NamaTypeDeskripsi
destinationRangeRentang yang akan diisi otomatis dengan nilai. Rentang tujuan harus memuat rentang ini dan memperluasnya hanya ke satu arah (ke atas, bawah, kiri, atau kanan).
seriesAutoFillSeriesJenis deret autoFill yang harus digunakan untuk menghitung nilai baru. Efek dari 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 tersebut dengan nilai baru berdasarkan data yang terdapat dalam rentang ini. Nilai baru ini juga ditentukan oleh jenis series yang telah ditentukan.

Rentang tujuan yang dihitung mempertimbangkan data di sekitarnya untuk menentukan tempat nilai baru harus dimasukkan: jika ada data di sebelah kiri atau kanan kolom yang diisi otomatis, nilai baru hanya 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 akan dimasukkan ke B5:B20. Dengan cara ini, nilai baru tersebut "melekat" ke 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

NamaTypeDeskripsi
seriesAutoFillSeriesJenis deret autoFill yang harus digunakan untuk menghitung nilai baru. Efek dari 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 > Gabungkan sel > 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();

Return

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. Pemilik spreadsheet selalu dapat mengedit rentang dan sheet yang 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());

Return

Booleantrue jika pengguna memiliki izin untuk mengedit setiap sel dalam rentang; 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

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

Return

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 rentang konten dan format.

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

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

Return

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

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

Parameter lanjutan

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

Return

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, membiarkan format tetap utuh.

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

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

Return

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.

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

Return

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.

Tindakan ini akan menghapus pemformatan teks untuk sel atau beberapa sel dalam rentang, tetapi tidak mereset aturan pemformatan angka apa pun.

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

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

Return

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

Menghapus catatan dalam sel atau beberapa sel tertentu.

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

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

Return

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 berada dalam rentang. Jika tidak ada grup yang sepenuhnya berada dalam rentang, grup yang diperluas terdalam yang sebagian dalam rentang tersebut akan diciutkan.

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

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

Return

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 dari rentang sumber, sumber akan diulang atau dipotong sebagaimana mestinya. Perhatikan bahwa metode ini hanya menyalin format.

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

NamaTypeDeskripsi
gridIdIntegerID unik sheet dalam spreadsheet, di mana pun posisinya.
columnIntegerKolom pertama dari 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 dari rentang sumber, sumber akan diulang atau dipotong sebagaimana mestinya. Perhatikan bahwa metode ini hanya menyalin format.

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

NamaTypeDeskripsi
sheetSheetSheet target.
columnIntegerKolom pertama dari 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 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

NamaTypeDeskripsi
destinationRangeRentang tujuan yang akan disalin; hanya posisi sel 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

NamaTypeDeskripsi
destinationRangeRentang tujuan yang akan disalin; hanya posisi sel kiri atas yang relevan.
copyPasteTypeCopyPasteTypeJenis yang menentukan cara konten rentang ditempelkan ke tujuan.
transposedBooleanApakah rentang harus ditempelkan dalam orientasi transisinya.

Otorisasi

Skrip yang 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 default, nilai dan pemformatan disalin, tetapi ini dapat diganti 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

NamaTypeDeskripsi
destinationRangeRentang tujuan yang akan disalin; hanya posisi sel kiri atas yang relevan.
optionsObjectObjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah.

Parameter lanjutan

NamaTypeDeskripsi
formatOnlyBooleanmenetapkan bahwa hanya format yang harus 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 diberikan. Jika tujuan lebih besar atau lebih kecil dari rentang sumber, sumber akan diulang atau dipotong sebagaimana mestinya.

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

NamaTypeDeskripsi
gridIdIntegerID unik sheet dalam spreadsheet, di mana pun posisinya.
columnIntegerKolom pertama dari 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 diberikan. Jika tujuan lebih besar atau lebih kecil dari rentang sumber, sumber akan diulang atau dipotong sebagaimana mestinya.

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

NamaTypeDeskripsi
sheetSheetSheet target.
columnIntegerKolom pertama dari 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 ditempatkan 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

NamaTypeDeskripsi
dataSourceDataSourceSumber data yang akan digunakan untuk membuat tabel pivot.

Return

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 rentang ini.

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

NamaTypeDeskripsi
dataSourceDataSourceSumber data yang akan digunakan untuk membuat tabel pivot.

Return

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 rentang ini. Metadata berada dalam cakupan rentang hanya jika sepenuhnya dimuat dalam rentang tersebut. Misalnya, metadata yang terkait 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());

Return

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 satu lembar. Untuk mengakses dan mengubah filter Anda 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 sheet Grid, yang merupakan jenis default sheet. Lembar kisi adalah lembar yang tidak terhubung ke {i>database<i}. Untuk membuat jenis filter lainnya, lihat hal berikut:

Return

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

NamaTypeDeskripsi
sourceDataRangeData yang akan digunakan untuk membuat tabel pivot.

Return

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

NamaTypeDeskripsi
findTextStringTeks yang akan ditelusuri.

Return

TextFinderTextFinder untuk rentang


deleteCells(shiftDimension)

Menghapus rentang sel ini. Data yang ada di sheet di sepanjang dimensi yang disediakan digeser ke rentang yang dihapus.

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

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

Parameter

NamaTypeDeskripsi
shiftDimensionDimensionDimensi yang akan digunakan untuk menggeser 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()

Meluaskan grup yang diciutkan yang rentang atau tombol kontrolnya berpotongan dengan rentang ini. Lokasi tombol kontrol adalah indeks tempat tombol kontrol ditampilkan, langsung sebelum atau setelah grup, bergantung pada setelan. Jika ada lebih dari satu grup di lokasi yang sama, grup mustowest akan diperluas.

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

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

Return

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

Return

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

Return

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

Return

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

Return

Color[][] — Array dua dimensi dari 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]);
  }
}

Return

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

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

Return

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

NamaTypeDeskripsi
rowIntegerBaris sel relatif terhadap rentang.
columnIntegerKolom sel relatif terhadap rentang.

Return

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

Return

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

getDataRegion()

Menampilkan salinan rentang yang diperluas di empat Direction kardinal untuk mencakup semua sel yang berdekatan dengan data di dalamnya. Jika rentang dikelilingi oleh sel kosong yang tidak termasuk di sepanjang diagonal, rentang itu sendiri akan ditampilkan. Hal 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());

Return

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 Direction.UP dan Direction.DOWN yang diperluas jika dimensi yang ditentukan adalah Dimension.ROWS, atau Direction.NEXT dan Direction.PREVIOUS jika dimensinya adalah Dimension.COLUMNS. Perluasan rentang didasarkan pada pendeteksian data di samping rentang yang diatur seperti tabel. Rentang yang diperluas mencakup semua sel yang berdekatan dengan data di dalamnya di sepanjang dimensi yang ditentukan, termasuk batas tabel. Jika rentang asli dikelilingi oleh sel kosong di sepanjang dimensi yang ditentukan, rentang itu sendiri akan ditampilkan. 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

NamaTypeDeskripsi
dimensionDimensionDimensi yang akan diperluas rentangnya.

Return

Range — Region data rentang atau 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 formula 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);

Return

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

Return

DataSourceFormula[] — Array dari 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());

Return

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

Return

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

bagan pai.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>

Return

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

Return

DataTable — data sebagai tabel data.


getDataTable(firstRowIsHeader)

Menampilkan data 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

NamaTypeDeskripsi
firstRowIsHeaderBooleanApakah akan memperlakukan baris pertama sebagai header atau tidak.

Return

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 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.')
}

Return

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

Return

DataValidation[][] — Array dua dimensi dari aturan validasi data 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

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()}`);
}

Return

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 pemformatan tanggal, waktu, dan mata uang, termasuk format yang diterapkan secara otomatis oleh setelan lokal spreadsheet. Sel kosong akan menampilkan string kosong.

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

Return

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, kemudian menurut kolom. Nilainya adalah objek String. Nilai yang ditampilkan memperhitungkan pemformatan tanggal, waktu, dan mata uang, termasuk format yang diterapkan secara otomatis oleh setelan lokal spreadsheet. Sel kosong diwakili oleh string kosong dalam array. Ingat bahwa saat indeks rentang dimulai pada 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]);

Return

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 berada dalam rentang ini, atau null jika tidak ada filter pada sheet.

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

Return

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 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.getFontColorObject().asRgbColor().asHexString());

Return

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

Return

Color[][] — Array dua dimensi dari 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 kelompok 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]);
  }
}

Return

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

Return

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

Return

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]);
  }
}

Return

String[][] — Array dua dimensi dari garis 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

getFontSize()

Menampilkan ukuran font dalam ukuran titik sel di sudut kiri atas rentang.

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

Logger.log(range.getFontSize());

Return

Integer — Ukuran font dalam ukuran titik.

Otorisasi

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

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

getFontSizes()

Menampilkan ukuran font sel dalam rentang.

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

var results = range.getFontSizes();

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

Return

Integer[][] — Array dua dimensi dari ukuran font teks 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

getFontStyle()

Menampilkan gaya font ('italic' atau 'normal') sel di sudut kiri atas rentang.

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

Logger.log(range.getFontStyle());

Return

String — Gaya font teks dalam 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

getFontStyles()

Menampilkan gaya font sel dalam rentang.

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

var results = range.getFontStyles();

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

Return

String[][] — Array dua dimensi dari gaya font teks 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

getFontWeight()

Menampilkan ketebalan font (normal/tebal) dari sel di sudut kiri atas rentang.

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

Logger.log(range.getFontWeight());

Return

String — Ketebalan font teks dalam 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

getFontWeights()

Menampilkan ketebalan font sel dalam rentang.

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

var results = range.getFontWeights();

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

Return

String[][] — Array dua dimensi dari ketebalan font teks 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

getFormula()

Menampilkan formula (notasi A1) untuk sel kiri atas rentang, atau string kosong jika sel kosong atau tidak berisi formula.

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

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

Return

String — Formula 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

getFormulaR1C1()

Menampilkan formula (notasi R1C1) untuk sel tertentu, atau null jika tidak ada.

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

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

Return

String — Formula dalam notasi R1C1.

Otorisasi

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

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

getFormulas()

Menampilkan formula (notasi A1) untuk sel dalam rentang. Entri dalam {i>array<i} 2D adalah {i>string<i} kosong untuk sel tanpa formula.

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

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

Return

String[][] — Array formula dua dimensi dalam format string.

Otorisasi

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

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

getFormulasR1C1()

Menampilkan formula (notasi R1C1) untuk sel dalam rentang. Entri dalam array 2D adalah null untuk sel tanpa formula.

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

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

Return

String[][] — Array formula dua dimensi dalam notasi R1C1.

Otorisasi

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

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

getGridId()

Menampilkan ID petak dari sheet induk rentang. ID adalah nilai int non-negatif acak.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

Return

Integer — ID petak dari sheet 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

getHeight()

Menampilkan tinggi rentang.

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

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

Return

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

getHorizontalAlignment()

Menampilkan perataan horizontal teks (kiri/tengah/kanan) sel di sudut kiri atas rentang.

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

Logger.log(range.getHorizontalAlignment());

Return

String — Perataan horizontal teks dalam 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

getHorizontalAlignments()

Menampilkan perataan horizontal sel dalam rentang.

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

var results = range.getHorizontalAlignments();

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

Return

String[][] — Array dua dimensi dari perataan horizontal teks 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

getLastColumn()

Menampilkan posisi kolom akhir.

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

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

Return

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

getLastRow()

Menampilkan posisi baris akhir.

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

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

Return

Integer — Posisi baris akhir rentang 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

getMergedRanges()

Menampilkan array objek Range yang merepresentasikan sel gabungan yang sepenuhnya berada dalam rentang saat ini, atau berisi setidaknya satu sel dalam rentang saat ini.

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

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

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

Return

Range[] — Array objek Range, yang mewakili sel gabungan yang tumpang-tindih dengan rentang.


getNextDataCell(direction)

Mulai dari sel di kolom dan baris pertama rentang, menampilkan sel berikutnya dalam arah tertentu, yaitu tepi rentang sel yang berdekatan yang berisi data atau sel di tepi spreadsheet di arah tersebut. Hal ini sama dengan mengetik Ctrl+[arrow key] di editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

Parameter

NamaTypeDeskripsi
directionDirectionArah untuk menemukan sel edge region data berikutnya.

Return

Range — Sel tepi region data atau sel di tepi 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

getNote()

Menampilkan catatan yang terkait dengan rentang yang diberikan.

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

Logger.log(range.getNote());

Return

String — Catatan yang terkait dengan sel 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

getNotes()

Menampilkan catatan yang terkait dengan sel dalam rentang.

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

var results = range.getNotes();

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

Return

String[][] — Array catatan dua dimensi 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

getNumColumns()

Menampilkan jumlah kolom dalam rentang ini.

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

Return

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

getNumRows()

Menampilkan jumlah baris dalam rentang ini.

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

Return

Integer — Jumlah baris 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

getNumberFormat()

Mendapatkan format angka atau tanggal di sel kiri atas dari rentang yang ditentukan. Pola format yang ditampilkan dijelaskan di dokumentasi Sheets API.

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

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

Return

String — Format angka untuk sel kiri atas 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

getNumberFormats()

Menampilkan format angka atau tanggal untuk sel dalam rentang. Pola format yang ditampilkan dijelaskan dalam dokumentasi Sheets API.

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

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

Return

String[][] — Array dua dimensi dari format angka.

Otorisasi

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

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

getRichTextValue()

Menampilkan nilai Rich Text untuk sel kiri atas rentang, atau null jika nilai sel bukan teks.

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

Return

RichTextValue — Nilai Rich Text dari sel kiri atas dalam rentang, atau null jika nilai sel bukan teks.

Otorisasi

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

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

getRichTextValues()

Menampilkan nilai Rich Text untuk sel dalam rentang.

// Gets the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

Return

RichTextValue[][] — Array dua dimensi dari nilai Rich Text.

Otorisasi

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

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

getRow()

Menampilkan posisi baris untuk rentang ini. Identasi dengan getRowIndex().

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

var range = sheet.getRange("B2");
Logger.log(range.getRow());

Return

Integer — Posisi baris pada 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

getRowIndex()

Menampilkan posisi baris untuk rentang ini. Identasi dengan getRow().

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

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

Return

Integer — Posisi baris pada 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

Lihat juga


getSheet()

Menampilkan sheet yang memiliki 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 the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

Return

Sheet — Sheet yang mencakup 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

getTextDirection()

Menampilkan arah teks untuk sel kiri atas rentang. Menampilkan null jika arah teks sel ditentukan dengan deteksi otomatis.

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

Return

TextDirection — Arah teks 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

getTextDirections()

Menampilkan teks arah untuk sel dalam rentang. Entri dalam array 2D adalah null untuk sel yang menggunakan deteksi otomatis.

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

Return

TextDirection[][] — Array dua dimensi arah teks.

Otorisasi

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

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

getTextRotation()

Menampilkan setelan rotasi teks untuk sel kiri atas rentang.

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

Return

TextRotation — Setelan rotasi teks.

Otorisasi

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

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

getTextRotations()

Menampilkan pengaturan rotasi teks untuk sel dalam rentang.

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

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

Return

TextRotation[][] — Array dua dimensi rotasi teks 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

getTextStyle()

Menampilkan gaya teks untuk sel kiri atas rentang.

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

Return

TextStyle — Gaya teks 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

getTextStyles()

Menampilkan gaya teks untuk sel dalam rentang.

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

Return

TextStyle[][] — Array dua dimensi dari gaya teks.

Otorisasi

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

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

getValue()

Menampilkan nilai sel kiri atas dalam rentang. Nilainya dapat berupa jenis Number, Boolean, Date, atau String, bergantung pada nilai sel. Sel kosong menampilkan string kosong.

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

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

Return

Object — Nilai 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

getValues()

Menampilkan petak nilai persegi panjang untuk rentang ini.

Menampilkan array nilai dua dimensi, diindeks menurut baris, kemudian menurut kolom. Nilainya dapat berjenis Number, Boolean, Date, atau String, bergantung pada nilai sel. Sel kosong diwakili oleh string kosong dalam array. Ingat bahwa meskipun indeks rentang dimulai pada 1, 1, array JavaScript diindeks dari [0][0].

// The code below gets the 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).getValues();
Logger.log(values[0][0]);
Di aplikasi web, nilai Date bukanlah parameter hukum. getValues() gagal menampilkan data ke aplikasi web jika rentang berisi sel dengan nilai Date. Sebagai gantinya, ubah semua nilai yang diambil dari sheet ke primitif JavaScript yang didukung seperti Number, Boolean, atau String.

Return

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

getVerticalAlignment()

Menampilkan perataan vertikal (atas/tengah/bawah) sel di sudut kiri atas rentang.

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

Logger.log(range.getVerticalAlignment());

Return

String — Perataan vertikal teks dalam 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

getVerticalAlignments()

Menampilkan perataan vertikal sel dalam rentang.

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

var results = range.getVerticalAlignments();

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

Return

String[][] — Array dua dimensi dari perataan vertikal teks 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

getWidth()

Menampilkan lebar rentang dalam kolom.

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

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

Return

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

getWrap()

Menampilkan apakah teks dalam sel merapikan atau tidak. Untuk mendapatkan strategi penggabungan yang lebih terperinci, gunakan getWrapStrategy().

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

Logger.log(range.getWrap());

Return

Boolean — Apakah teks dalam sel ini digabungkan atau 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

getWrapStrategies()

Menampilkan strategi pengemasan teks untuk sel dalam rentang.

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

Return

WrapStrategy[][] — Array dua dimensi dari strategi penggabungan teks.

Otorisasi

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

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

getWrapStrategy()

Menampilkan strategi penggabungan teks untuk sel kiri atas rentang.

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

Return

WrapStrategy — Strategi penggabungan teks dari 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

getWraps()

Menampilkan apakah teks dalam pengemasan sel. Untuk mendapatkan strategi penggabungan yang lebih terperinci, gunakan getWrapStrategies().

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

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

Return

Boolean[][] — Array dua dimensi dari perataan vertikal teks 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

insertCells(shiftDimension)

Menyisipkan sel kosong ke rentang ini. Sel baru mempertahankan format apa pun yang ada dalam sel yang sebelumnya menempati rentang ini. Data yang ada di sheet di sepanjang dimensi yang disediakan digeser dari rentang yang disisipkan.

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

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

Parameter

NamaTypeDeskripsi
shiftDimensionDimensionDimensi yang akan digunakan untuk menggeser data yang ada.

Return

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

insertCheckboxes()

Menyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan true untuk dicentang dan false untuk tidak dicentang. Menetapkan nilai semua sel dalam rentang ke false.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

Return

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

insertCheckboxes(checkedValue)

Menyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan nilai kustom untuk yang dicentang dan string kosong untuk tidak dicentang. Menetapkan nilai setiap sel dalam rentang ke string kosong.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

Parameter

NamaTypeDeskripsi
checkedValueObjectNilai yang dicentang untuk validasi data kotak centang.

Return

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

insertCheckboxes(checkedValue, uncheckedValue)

Menyisipkan kotak centang ke dalam setiap sel dalam rentang, yang dikonfigurasi dengan nilai kustom untuk status yang dicentang dan tidak dicentang. Menetapkan nilai setiap sel dalam rentang ke nilai kustom yang tidak dicentang.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

Parameter

NamaTypeDeskripsi
checkedValueObjectNilai yang dicentang untuk validasi data kotak centang.
uncheckedValueObjectNilai yang tidak dicentang untuk validasi data kotak centang.

Return

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

isBlank()

Menampilkan true jika rentang benar-benar kosong.

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

Logger.log(range.isBlank());

Return

Booleantrue jika rentang kosong; 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

isChecked()

Menampilkan apakah semua sel dalam rentang memiliki status kotak centang sebagai 'dicentang'. Menampilkan null jika beberapa sel dicentang dan sisanya tidak dicentang, atau jika beberapa sel tidak memiliki validasi data kotak centang.

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

Return

Booleantrue, jika semua sel dalam rentang dicentang, false jika semua sel dalam rentang tidak dicentang, atau null jika salah satu sel tidak dicentang atau tidak memiliki validasi data kotak centang.

Otorisasi

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

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

isEndColumnBounded()

Menentukan apakah akhir rentang terikat pada kolom tertentu. Misalnya, untuk rentang A1:B10 atau B:B, yang terikat ke kolom di akhir rentang, metode ini akan menampilkan true; untuk rentang 3:7 atau A1:5, yang terikat hanya ke baris tertentu di akhir rentang, metode ini akan menampilkan false.

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

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

Return

Booleantrue jika akhir rentang terikat ke kolom tertentu; 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

isEndRowBounded()

Menentukan apakah akhir rentang terikat ke baris tertentu. Misalnya, untuk rentang A1:B10 atau 3:7, yang terikat ke baris di akhir rentang, metode ini akan menampilkan true; untuk rentang B:B atau A1:C, yang terikat hanya ke kolom tertentu di akhir rentang, metode ini akan menampilkan false.

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

// Determines if the end of the range is bound to a particular row and logs it to the console.
console.log(range.isEndRowBounded());

Return

Booleantrue jika akhir rentang terikat ke baris tertentu; 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

isPartOfMerge()

Menampilkan true jika sel dalam rentang saat ini tumpang-tindih dengan sel gabungan.

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

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

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

Return

Booleantrue jika rentang tumpang-tindih dengan sel yang digabungkan, jika tidak, false akan ditampilkan.


isStartColumnBounded()

Menentukan apakah awal rentang terikat ke kolom tertentu. Misalnya, untuk rentang A1:B10 atau B:B, yang terikat dengan kolom pada awal rentang, metode ini akan menampilkan true; untuk rentang 3:7, yang hanya terikat ke baris di awal rentang, metode ini akan menampilkan false.

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

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

Return

Booleantrue jika awal rentang terikat ke kolom tertentu; 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

isStartRowBounded()

Menentukan apakah awal rentang terikat ke baris tertentu. Misalnya, untuk rentang A1:B10 atau 3:7, yang terikat dengan baris pada awal rentang, metode ini akan menampilkan true; untuk rentang B:B, yang terikat hanya ke kolom tertentu di awal rentang, metode ini akan menampilkan false.

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

// Determines if the start of the range is bound to a particular row and logs it to the
// console.
console.log(range.isStartRowBounded());

Return

Booleantrue jika awal rentang terikat ke baris tertentu; 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

merge()

Menggabungkan sel dalam rentang menjadi satu blok.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

Return

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

mergeAcross()

Gabungkan sel dalam rentang yang memenuhi kolom rentang.

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

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

Return

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

mergeVertically()

Menggabungkan sel dalam rentang secara bersamaan.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

Return

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

moveTo(target)

Potong dan tempel (format dan nilai) dari rentang ini ke rentang target.

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

Parameter

NamaTypeDeskripsi
targetRangeRentang target untuk menyalin rentang ini; hanya posisi sel 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

offset(rowOffset, columnOffset)

Menampilkan rentang baru yang di-offset dari rentang ini berdasarkan jumlah baris dan kolom yang ditentukan (bisa negatif). Rentang baru memiliki ukuran yang sama dengan rentang awal.

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

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

Parameter

NamaTypeDeskripsi
rowOffsetIntegerJumlah baris di bawah dari sel kiri atas rentang; nilai negatif mewakili baris di atas dari sel kiri atas rentang.
columnOffsetIntegerJumlah kolom di kanan dari sel kiri atas rentang; nilai negatif mewakili kolom yang kiri dari sel kiri atas rentang.

Return

Range — Rentang ini, untuk perantaian.


offset(rowOffset, columnOffset, numRows)

Menampilkan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atas diimbangi dari rentang saat ini menurut baris dan kolom yang diberikan, dan dengan tinggi yang diberikan dalam sel.

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

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

Parameter

NamaTypeDeskripsi
rowOffsetIntegerJumlah baris di bawah dari sel kiri atas rentang; nilai negatif mewakili baris di atas dari sel kiri atas rentang.
columnOffsetIntegerJumlah kolom di kanan dari sel kiri atas rentang; nilai negatif mewakili kolom yang kiri dari sel kiri atas rentang.
numRowsIntegerTinggi dalam baris rentang baru.

Return

Range — Rentang ini, untuk perantaian.


offset(rowOffset, columnOffset, numRows, numColumns)

Menampilkan rentang baru yang relatif terhadap rentang saat ini, yang titik kiri atas di-offset dari rentang saat ini menurut baris dan kolom yang diberikan, serta dengan tinggi dan lebar yang diberikan dalam sel.

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

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

Parameter

NamaTypeDeskripsi
rowOffsetIntegerJumlah baris di bawah dari sel kiri atas rentang; nilai negatif mewakili baris di atas dari sel kiri atas rentang.
columnOffsetIntegerJumlah kolom di kanan dari sel kiri atas rentang; nilai negatif mewakili kolom yang kiri dari sel kiri atas rentang.
numRowsIntegerTinggi dalam baris rentang baru.
numColumnsIntegerLebar di kolom rentang baru.

Return

Range — Rentang ini, untuk perantaian.


protect()

Membuat objek yang dapat melindungi rentang agar tidak diedit, kecuali oleh pengguna yang memiliki izin. Hingga skrip benar-benar mengubah daftar editor untuk rentang (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 mencerminkan izin dari spreadsheet itu sendiri, yang secara efektif berarti bahwa rentang tersebut tetap tidak dilindungi. Jika rentang sudah dilindungi, metode ini akan membuat rentang dilindungi baru yang tumpang-tindih dengan rentang yang sudah ada. Jika sel dilindungi oleh beberapa rentang dilindungi dan salah satunya mencegah pengguna tertentu mengedit sel, pengguna tersebut tidak diizinkan untuk mengedit sel tersebut.

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Return

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

randomize()

Mengacak urutan baris dalam rentang yang diberikan.

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

// Randomizes the range
range.randomize();

Return

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

removeCheckboxes()

Menghapus semua kotak centang dari rentang. Menghapus validasi data setiap sel, dan juga menghapus nilainya jika sel berisi nilai yang dicentang atau tidak dicentang.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

Return

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

removeDuplicates()

Menghapus baris dalam rentang ini yang berisi nilai yang merupakan duplikat dari nilai pada baris sebelumnya. Baris dengan nilai yang identik, tetapi kapitalisasi, pemformatan, atau formula yang berbeda dianggap sebagai duplikat. Metode ini juga menghapus baris duplikat yang disembunyikan dari tampilan (misalnya, karena filter). Konten di luar rentang ini tidak dihapus.

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

// Remove duplicate rows in the range.
range.removeDuplicates();

Return

Range — Rentang yang dihasilkan setelah menghapus duplikat. Ukuran rentang dikurangi dengan satu baris untuk setiap baris 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

removeDuplicates(columnsToCompare)

Menghapus baris dalam rentang ini yang berisi nilai di kolom tertentu yang merupakan duplikat dari nilai pada baris sebelumnya. Baris dengan nilai yang identik, tetapi kapitalisasi, format, atau formula yang berbeda dianggap sebagai duplikat. Metode ini juga menghapus baris duplikat yang disembunyikan dari tampilan (misalnya, karena filter). Konten di luar rentang ini tidak dihapus.

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

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

Parameter

NamaTypeDeskripsi
columnsToCompareInteger[]Kolom yang akan dianalisis untuk menemukan nilai duplikat. Jika tidak ada kolom yang disediakan, semua kolom akan dianalisis untuk duplikasi.

Return

Range — Rentang yang dihasilkan setelah menghapus duplikat. Ukuran rentang dikurangi dengan satu baris untuk setiap baris 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

setBackground(color)

Menetapkan warna latar belakang semua sel dalam rentang dalam notasi CSS (seperti '#ffffff' atau 'white').

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

var range = sheet.getRange("B2:D5");
range.setBackground("red");

Parameter

NamaTypeDeskripsi
colorStringKode warna dalam notasi CSS (seperti '#ffffff' atau 'white'); nilai null mereset warna.

Return

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

setBackgroundObject(color)

Menetapkan warna latar belakang semua sel dalam rentang.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

Parameter

NamaTypeDeskripsi
colorColorWarna latar belakang yang akan ditetapkan; nilai null mereset warna latar belakang.

Return

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

setBackgroundObjects(color)

Menetapkan petak warna latar belakang persegi panjang (harus sesuai dengan dimensi rentang ini).

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

Parameter

NamaTypeDeskripsi
colorColor[][]Array warna dua dimensi; nilai null mereset warna.

Return

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

setBackgroundRGB(red, green, blue)

Menetapkan latar belakang ke warna yang diberikan menggunakan nilai RGB (bilangan bulat antara 0 dan 255 inklusif).

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

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

Parameter

NamaTypeDeskripsi
redIntegerNilai merah dalam notasi RGB.
greenIntegerNilai hijau dalam notasi RGB.
blueIntegerNilai biru dalam notasi RGB.

Return

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

setBackgrounds(color)

Menetapkan petak warna latar belakang persegi panjang (harus sesuai dengan dimensi rentang ini). Warna dalam notasi CSS (seperti '#ffffff' atau 'white').

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

Parameter

NamaTypeDeskripsi
colorString[][]Array warna dua dimensi dalam notasi CSS (seperti '#ffffff' atau 'white'); nilai null mereset warna.

Return

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

setBorder(top, left, bottom, right, vertical, horizontal)

Menetapkan properti batas. Nilai yang valid adalah true (aktif), false (nonaktif) dan null (tidak ada perubahan).

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

Parameter

NamaTypeDeskripsi
topBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
leftBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
bottomBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
rightBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
verticalBooleantrue untuk batas vertikal internal, false untuk tidak ada, null jika tidak ada perubahan.
horizontalBooleantrue untuk batas horizontal internal, false untuk tidak ada, null untuk tidak ada perubahan.

Return

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

Menetapkan properti batas dengan warna dan/atau gaya. Nilai yang valid adalah true (aktif), false (nonaktif) dan null (tidak ada perubahan). Untuk warna, gunakan Warna dalam notasi CSS (seperti '#ffffff' atau 'white').

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

Parameter

NamaTypeDeskripsi
topBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
leftBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
bottomBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
rightBooleantrue untuk batas, false untuk tidak ada, null untuk tidak ada perubahan.
verticalBooleantrue untuk batas vertikal internal, false untuk tidak ada, null jika tidak ada perubahan.
horizontalBooleantrue untuk batas horizontal internal, false untuk tidak ada, null untuk tidak ada perubahan.
colorStringWarna dalam notasi CSS (seperti '#ffffff' atau 'white'), null untuk warna default (hitam).
styleBorderStyleGaya untuk batas, null untuk gaya default (solid).

Return

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

setDataValidation(rule)

Menetapkan satu aturan validasi data untuk semua sel dalam rentang.

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Parameter

NamaTypeDeskripsi
ruleDataValidationAturan validasi data yang akan ditetapkan, atau null untuk menghapus validasi data.

Return

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

setDataValidations(rules)

Menetapkan aturan validasi data untuk semua sel dalam rentang. Metode ini menggunakan array validasi data dua dimensi, yang diindeks menurut baris, lalu menurut kolom. Dimensi array harus sesuai dengan dimensi rentang.

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Parameter

NamaTypeDeskripsi
rulesDataValidation[][]Array dua dimensi dari aturan validasi data yang akan ditetapkan; nilai null menghapus validasi data.

Return

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

setFontColor(color)

Menetapkan warna font dalam notasi CSS (seperti '#ffffff' atau 'white').

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

var cell = sheet.getRange("B2");
cell.setFontColor("red");

Parameter

NamaTypeDeskripsi
colorStringWarna font dalam notasi CSS (seperti '#ffffff' atau 'white'); nilai null mereset warna.

Return

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

setFontColorObject(color)

Menetapkan warna font untuk rentang yang ditetapkan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

Parameter

NamaTypeDeskripsi
colorColorWarna font yang akan ditetapkan; nilai null akan mereset warna.

Return

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

setFontColorObjects(colors)

Menetapkan petak warna font persegi panjang (harus sesuai dengan dimensi rentang ini).

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

Parameter

NamaTypeDeskripsi
colorsColor[][]Array warna dua dimensi; nilai null mereset warna font.

Return

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

setFontColors(colors)

Menetapkan petak warna font persegi panjang (harus sesuai dengan dimensi rentang ini). Warna dalam notasi CSS (seperti '#ffffff' atau 'white').

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

Parameter

NamaTypeDeskripsi
colorsObject[][]Array warna dua dimensi dalam notasi CSS (seperti '#ffffff' atau 'white'); nilai null mereset warna.

Return

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

setFontFamilies(fontFamilies)

Menetapkan petak persegi panjang jenis font (harus sesuai dengan dimensi rentang ini). Contoh jenis font adalah "YouTube" atau "Helvetica".

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

Parameter

NamaTypeDeskripsi
fontFamiliesObject[][]Array dua dimensi dari jenis font; nilai null mereset jenis font.

Return

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

setFontFamily(fontFamily)

Menetapkan jenis font, seperti "MMS" atau "Helvetica".

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

Parameter

NamaTypeDeskripsi
fontFamilyStringJenis font yang akan ditetapkan; nilai null akan mereset jenis font.

Return

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

setFontLine(fontLine)

Menetapkan gaya garis font untuk rentang yang ditentukan ('underline', 'line-through', atau 'none').

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

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

Parameter

NamaTypeDeskripsi
fontLineStringGaya garis font, baik 'underline', 'line-through', atau 'none'; nilai null akan mereset gaya garis font.

Return

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

setFontLines(fontLines)

Menetapkan kisi gaya garis persegi panjang (harus sesuai dengan dimensi rentang ini).

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

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

Parameter

NamaTypeDeskripsi
fontLinesObject[][]Array dua dimensi gaya garis font ('underline', 'line-through', atau 'none'); nilai null mereset gaya garis font.

Return

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

setFontSize(size)

Menetapkan ukuran font, dengan ukuran menjadi ukuran titik yang akan digunakan.

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

Parameter

NamaTypeDeskripsi
sizeIntegerUkuran font dalam ukuran poin.

Return

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

setFontSizes(sizes)

Menetapkan petak ukuran font persegi panjang (harus cocok dengan dimensi rentang ini). Ukurannya ditunjukkan dalam poin/poin.

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

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

Parameter

NamaTypeDeskripsi
sizesObject[][]Array ukuran dua dimensi.

Return

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

setFontStyle(fontStyle)

Menetapkan gaya font untuk rentang yang ditentukan ('italic' atau 'normal').

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

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

Parameter

NamaTypeDeskripsi
fontStyleStringGaya font, 'italic' atau 'normal'; nilai null akan mereset gaya font.

Return

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

setFontStyles(fontStyles)

Menetapkan petak gaya font persegi panjang (harus cocok dengan dimensi rentang ini).

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

Parameter

NamaTypeDeskripsi
fontStylesObject[][]Array dua dimensi gaya font, baik 'italic' atau 'normal'; nilai null mereset gaya font.

Return

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

setFontWeight(fontWeight)

Menetapkan ketebalan font untuk rentang yang ditentukan (normal/tebal).

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

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

Parameter

NamaTypeDeskripsi
fontWeightStringKetebalan font, 'bold' atau 'normal'; nilai null akan mereset ketebalan font.

Return

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

setFontWeights(fontWeights)

Menetapkan petak persegi panjang ketebalan font (harus sesuai dengan dimensi rentang ini). Contoh ketebalan {i>font<i} adalah "tebal".

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

Parameter

NamaTypeDeskripsi
fontWeightsObject[][]Array dua dimensi ketebalan font, baik 'bold' atau 'normal'; nilai null mereset ketebalan font.

Return

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

setFormula(formula)

Memperbarui formula untuk rentang ini. Formula yang diberikan harus dalam notasi A1.

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

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

Parameter

NamaTypeDeskripsi
formulaStringString yang mewakili formula yang akan ditetapkan untuk sel.

Return

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

setFormulaR1C1(formula)

Memperbarui formula untuk rentang ini. Formula yang diberikan harus dalam notasi R1C1.

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

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

Parameter

NamaTypeDeskripsi
formulaStringFormula string.

Return

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

setFormulas(formulas)

Menetapkan kisi formula persegi panjang (harus sesuai dengan dimensi rentang ini). Formula yang ditentukan harus dalam notasi A1. Metode ini menggunakan array formula dua dimensi, yang diindeks menurut baris, lalu menurut kolom. Dimensi array harus sesuai dengan dimensi rentang.

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

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

Parameter

NamaTypeDeskripsi
formulasString[][]Larik string formula dua dimensi.

Return

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

setFormulasR1C1(formulas)

Menetapkan kisi formula persegi panjang (harus sesuai dengan dimensi rentang ini). Formula yang ditentukan harus dalam notasi R1C1.

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

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

Parameter

NamaTypeDeskripsi
formulasString[][]Array formula dua dimensi dalam format R1C1.

Return

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

setHorizontalAlignment(alignment)

Menyetel perataan horizontal (kiri ke kanan) untuk rentang yang ditentukan (kiri/tengah/kanan).

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

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

Parameter

NamaTypeDeskripsi
alignmentStringPerataan, baik 'left', 'center', maupun 'normal'; nilai null akan mereset penyelarasan.

Return

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

setHorizontalAlignments(alignments)

Menetapkan petak persegi panjang perataan horizontal. lihat setHorizontalAlignment(alignment)

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

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

Parameter

NamaTypeDeskripsi
alignmentsObject[][]Array dua dimensi perataan, baik 'left', 'center', atau 'normal'; nilai null akan mereset perataan.

Return

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

Lihat juga


setNote(note)

Menetapkan catatan ke nilai yang diberikan.

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

Parameter

NamaTypeDeskripsi
noteStringNilai catatan yang ditetapkan untuk rentang; nilai null akan menghapus catatan.

Return

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

setNotes(notes)

Menetapkan kisi catatan persegi panjang (harus sesuai dengan dimensi rentang ini).

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

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

Parameter

NamaTypeDeskripsi
notesObject[][]Array catatan dua dimensi; nilai null akan menghapus catatan.

Return

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

Lihat juga


setNumberFormat(numberFormat)

Menetapkan format angka atau tanggal ke string pemformatan yang diberikan. Pola format yang diterima dijelaskan dalam dokumentasi Sheets API.

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

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

Parameter

NamaTypeDeskripsi
numberFormatStringString format angka.

Return

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

setNumberFormats(numberFormats)

Menetapkan petak persegi panjang untuk angka atau format tanggal (harus sesuai dengan dimensi rentang ini). Nilainya adalah string pola format seperti yang dijelaskan di dokumentasi Sheets API.

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

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

Parameter

NamaTypeDeskripsi
numberFormatsObject[][]Array dua dimensi dari format angka.

Return

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

setRichTextValue(value)

Menetapkan nilai Rich Text untuk sel dalam rentang.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

Parameter

NamaTypeDeskripsi
valueRichTextValueNilai Rich Text yang diinginkan.

Return

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

setRichTextValues(values)

Menetapkan petak persegi panjang nilai Teks Kaya.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

Parameter

NamaTypeDeskripsi
valuesRichTextValue[][]Nilai Rich Text yang diinginkan.

Return

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

Menetapkan apakah rentang harus menampilkan hyperlink atau 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

Parameter

NamaTypeDeskripsi
showHyperlinkBooleanApakah hyperlink akan ditampilkan atau tidak.

Return

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

setTextDirection(direction)

Menetapkan arah teks untuk sel dalam rentang. Jika arah yang ditentukan adalah null, arah akan disimpulkan lalu ditetapkan.

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parameter

NamaTypeDeskripsi
directionTextDirectionArah teks yang diinginkan; jika null, arah disimpulkan sebelum disetel.

Return

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

setTextDirections(directions)

Menetapkan petak teks arah persegi panjang. Jika arah yang ditentukan adalah null, arah akan disimpulkan, lalu ditetapkan.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

Parameter

NamaTypeDeskripsi
directionsTextDirection[][]Rute teks yang diinginkan; jika arah yang ditentukan adalah null, arah tersebut akan disimpulkan sebelum disetel.

Return

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

setTextRotation(degrees)

Menetapkan pengaturan rotasi teks untuk sel dalam rentang. Input sesuai dengan sudut antara orientasi teks standar dan orientasi yang diinginkan. Input nol menunjukkan bahwa teks ditetapkan ke orientasi standar.

Untuk arah teks kiri ke kanan, sudut positifnya berlawanan arah jarum jam, sedangkan untuk kanan ke kiri, sudutnya searah jarum jam.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

Parameter

NamaTypeDeskripsi
degreesIntegerSudut yang diinginkan antara orientasi standar dan orientasi yang diinginkan. Untuk teks kiri ke kanan, sudut positifnya berlawanan arah jarum jam.

Return

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

setTextRotation(rotation)

Menetapkan pengaturan rotasi teks untuk sel dalam rentang.

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

Parameter

NamaTypeDeskripsi
rotationTextRotationSetelan rotasi teks yang diinginkan.

Return

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

setTextRotations(rotations)

Menetapkan petak rotasi teks persegi panjang.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

Parameter

NamaTypeDeskripsi
rotationsTextRotation[][]Setelan rotasi teks yang diinginkan.

Return

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

setTextStyle(style)

Menetapkan gaya teks untuk sel dalam rentang.

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Parameter

NamaTypeDeskripsi
styleTextStyleGaya teks yang diinginkan.

Return

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

setTextStyles(styles)

Menetapkan petak persegi panjang gaya teks.

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

Parameter

NamaTypeDeskripsi
stylesTextStyle[][]Gaya teks yang diinginkan.

Return

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

setValue(value)

Menetapkan nilai rentang. Nilainya bisa berupa numerik, string, boolean, atau tanggal. Jika diawali dengan '=', ini akan ditafsirkan sebagai formula.

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

var cell = sheet.getRange("B2");
cell.setValue(100);

Parameter

NamaTypeDeskripsi
valueObjectNilai untuk rentang.

Return

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

setValues(values)

Menetapkan kisi nilai persegi panjang (harus sesuai dengan dimensi rentang ini). Jika nilai diawali dengan =, nilai tersebut akan ditafsirkan sebagai formula.

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

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

Parameter

NamaTypeDeskripsi
valuesObject[][]Array nilai dua dimensi.

Return

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

setVerticalAlignment(alignment)

Menetapkan perataan vertikal (atas ke bawah) untuk rentang yang ditentukan (atas/tengah/bawah).

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

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

Parameter

NamaTypeDeskripsi
alignmentStringPerataan, baik 'top', 'middle', maupun 'bottom'; nilai null akan mereset penyelarasan.

Return

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

setVerticalAlignments(alignments)

Menetapkan kisi persegi panjang perataan vertikal (harus sesuai dengan dimensi rentang ini).

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

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

Parameter

NamaTypeDeskripsi
alignmentsObject[][]Array dua dimensi perataan, baik 'top', 'middle', atau 'bottom'; nilai null akan mereset perataan.

Return

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

Lihat juga


setVerticalText(isVertical)

Menetapkan apakah akan menumpuk teks untuk sel dalam rentang atau tidak. Jika teks ditumpuk secara vertikal, setelan rotasi teks derajat akan diabaikan.

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

Parameter

NamaTypeDeskripsi
isVerticalBooleanApakah teks menumpuk atau tidak.

Return

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

setWrap(isWrapEnabled)

Menetapkan penggabungan sel pada rentang yang ditentukan.

Sel dengan wrap yang diaktifkan (default) diubah ukurannya untuk menampilkan konten lengkapnya. Sel dengan penggabungan dinonaktifkan menampilkan sebanyak mungkin dalam sel tanpa mengubah ukuran atau berjalan ke beberapa baris.

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

var cell = sheet.getRange("B2");
cell.setWrap(true);

Parameter

NamaTypeDeskripsi
isWrapEnabledBooleanApakah akan menggabungkan teks atau tidak.

Return

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

setWrapStrategies(strategies)

Menetapkan petak strategi penggabungan persegi panjang.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

Parameter

NamaTypeDeskripsi
strategiesWrapStrategy[][]Strategi penggabungan yang diinginkan.

Return

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

setWrapStrategy(strategy)

Menetapkan strategi pengemasan teks untuk sel dalam rentang.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parameter

NamaTypeDeskripsi
strategyWrapStrategyStrategi penggabungan yang diinginkan.

Return

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

setWraps(isWrapEnabled)

Menetapkan petak persegi panjang untuk kebijakan penggabungan kata (harus sesuai dengan dimensi rentang ini). Sel dengan penggabungan yang diaktifkan (default) akan diubah ukurannya untuk menampilkan konten lengkapnya. Sel dengan penggabungan yang dinonaktifkan akan menampilkan sebanyak mungkin dalam sel tanpa mengubah ukuran atau berjalan ke beberapa baris.

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

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

Parameter

NamaTypeDeskripsi
isWrapEnabledObject[][]Array dua dimensi dari variabel penggabungan yang menentukan apakah akan menggabungkan teks dalam sel atau tidak.

Return

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

Lihat juga


shiftColumnGroupDepth(delta)

Mengubah kedalaman pengelompokan kolom rentang berdasarkan jumlah yang ditentukan.

Tindakan ini memiliki efek pada pembuatan, modifikasi, atau penghapusan grup yang bersinggungan dengan rentang. Untuk delta positif, grup dibuat dan/atau dimodifikasi; untuk delta negatif, grup dihancurkan dan/atau dimodifikasi.

Hal ini tidak berpengaruh saat mengurangi kedalaman grup di bawah nol atau di atas delapan.

Jika column group control position adalah BEFORE, tindakan ini akan menampilkan error saat mencoba mengubah kedalaman baris pertama.

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

Parameter

NamaTypeDeskripsi
deltaIntegerJumlah yang digunakan untuk mengubah kedalaman grup kolom rentang ini.

Return

Range — Rentang ini, untuk perantaian.

Menampilkan

Error — saat mencoba menggeser kedalaman kolom pertama ketika posisi kontrol adalah GroupControlTogglePosition.BEFORE

Otorisasi

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

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

shiftRowGroupDepth(delta)

Mengubah kedalaman pengelompokan baris rentang berdasarkan jumlah yang ditentukan.

Tindakan ini memiliki efek pada pembuatan, modifikasi, atau penghapusan grup yang bersinggungan dengan rentang. Untuk delta positif, grup dibuat dan/atau dimodifikasi; untuk delta negatif, grup dihancurkan dan/atau dimodifikasi.

Hal ini tidak berpengaruh saat mengurangi kedalaman grup di bawah nol atau di atas delapan.

Jika row group control position adalah BEFORE, tindakan ini akan menampilkan error saat mencoba menggeser kedalaman baris pertama.

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

Parameter

NamaTypeDeskripsi
deltaIntegerJumlah yang digunakan untuk mengubah kedalaman grup baris rentang ini.

Return

Range — Rentang ini, untuk perantaian.

Menampilkan

Error — saat mencoba menggeser kedalaman baris pertama ketika posisi kontrol adalah GroupControlTogglePosition.BEFORE

Otorisasi

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

Mengurutkan sel dalam rentang yang diberikan, berdasarkan kolom dan urutan yang ditentukan.

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

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

Parameter

NamaTypeDeskripsi
sortSpecObjObjectKolom yang akan diurutkan.

Return

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

splitTextToColumns()

Memisahkan kolom teks menjadi beberapa kolom berdasarkan pembatas yang terdeteksi otomatis.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Otorisasi

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

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

splitTextToColumns(delimiter)

Memisahkan kolom teks menjadi beberapa kolom menggunakan string yang ditentukan sebagai pembatas kustom.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parameter

NamaTypeDeskripsi
delimiterStringPemisah kustom yang akan dipisahkan.

Otorisasi

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

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

splitTextToColumns(delimiter)

Memisahkan kolom teks menjadi beberapa kolom berdasarkan pembatas yang ditentukan.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parameter

NamaTypeDeskripsi
delimiterTextToColumnsDelimiterPembatas preset untuk dipisahkan.

Otorisasi

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

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

trimWhitespace()

Memangkas spasi kosong (seperti spasi, tab, atau baris baru) di setiap sel dalam rentang ini. Menghapus semua spasi kosong dari awal dan akhir teks setiap sel, serta mengurangi suburutan karakter spasi kosong yang tersisa menjadi satu spasi.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

Return

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

uncheck()

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

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

Return

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

Metode yang tidak digunakan lagi