Class Sheet

ชีต

เข้าถึงและแก้ไขชีตสเปรดชีต การดำเนินการทั่วไปคือการเปลี่ยนชื่อชีตและเข้าถึงออบเจ็กต์ช่วงจากชีต

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
activate()Sheetเปิดใช้งานชีตนี้
addDeveloperMetadata(key)Sheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุลงในชีต
addDeveloperMetadata(key, visibility)Sheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์และระดับการเข้าถึงที่ระบุลงในชีต
addDeveloperMetadata(key, value)Sheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่มีคีย์และค่าที่ระบุลงในชีต
addDeveloperMetadata(key, value, visibility)Sheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ ค่า และระดับการเข้าถึงที่ระบุลงในชีต
appendRow(rowContents)Sheetเพิ่มแถวที่ด้านล่างของเขตข้อมูลปัจจุบันในชีต
asDataSourceSheet()DataSourceSheetแสดงผลแผ่นงานเป็น DataSourceSheet หากแผ่นงานเป็นประเภท SheetType.DATASOURCE หรือ null ในกรณีอื่นๆ
autoResizeColumn(columnPosition)Sheetตั้งค่าความกว้างของคอลัมน์ที่ระบุเพื่อให้พอดีกับเนื้อหา
autoResizeColumns(startColumn, numColumns)Sheetตั้งค่าความกว้างของคอลัมน์ทั้งหมดโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุเพื่อให้พอดีกับเนื้อหา
autoResizeRows(startRow, numRows)Sheetกำหนดความสูงของแถวทั้งหมดโดยเริ่มจากตำแหน่งของแถวที่ระบุเพื่อให้พอดีกับเนื้อหา
clear()Sheetล้างชีตของข้อมูลเนื้อหาและการจัดรูปแบบ
clear(options)Sheetล้างชีตเนื้อหาและ/หรือรูปแบบตามที่ระบุด้วยตัวเลือกขั้นสูงที่มีให้
clearConditionalFormatRules()voidนำกฎการจัดรูปแบบตามเงื่อนไขทั้งหมดออกจากชีต
clearContents()Sheetล้างชีตเนื้อหาแต่ยังรักษาข้อมูลการจัดรูปแบบไว้ได้
clearFormats()Sheetล้างชีตการจัดรูปแบบและเก็บเนื้อหาไว้
clearNotes()Sheetล้างชีตของโน้ตทั้งหมด
collapseAllColumnGroups()Sheetยุบกลุ่มคอลัมน์ทั้งหมดในชีต
collapseAllRowGroups()Sheetยุบกลุ่มแถวทั้งหมดในชีต
copyTo(spreadsheet)Sheetคัดลอกชีตไปยังสเปรดชีตที่ระบุ ซึ่งอาจเป็นสเปรดชีตเดียวกับต้นทาง
createDeveloperMetadataFinder()DeveloperMetadataFinderแสดงผล DeveloperMetadataFinder สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของชีตนี้
createTextFinder(findText)TextFinderสร้างเครื่องมือค้นหาข้อความสำหรับชีต ซึ่งสามารถค้นหาและแทนที่ข้อความในชีตได้
deleteColumn(columnPosition)Sheetลบคอลัมน์ ณ ตำแหน่งคอลัมน์ที่ระบุ
deleteColumns(columnPosition, howMany)voidลบคอลัมน์จำนวนหนึ่งโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุ
deleteRow(rowPosition)Sheetลบแถวตรงตําแหน่งของแถวที่ระบุ
deleteRows(rowPosition, howMany)voidลบแถวจำนวนหนึ่งโดยเริ่มจากตำแหน่งของแถวที่ระบุ
expandAllColumnGroups()Sheetขยายกลุ่มคอลัมน์ทั้งหมดในชีต
expandAllRowGroups()Sheetขยายกลุ่มแถวทั้งหมดในชีต
expandColumnGroupsUpToDepth(groupDepth)Sheetขยายกลุ่มคอลัมน์ทั้งหมดจนถึงระดับความลึกที่ระบุ และยุบกลุ่มอื่นๆ ทั้งหมด
expandRowGroupsUpToDepth(groupDepth)Sheetขยายกลุ่มแถวทั้งหมดจนถึงระดับความลึกที่กำหนด และยุบกลุ่มอื่นๆ ทั้งหมด
getActiveCell()Rangeแสดงผลเซลล์ที่ใช้งานอยู่ในชีตนี้
getActiveRange()Rangeแสดงผลช่วงที่เลือกในชีตที่ใช้งานอยู่ หรือแสดงผล null หากไม่มีช่วงที่ใช้งานอยู่
getActiveRangeList()RangeListแสดงผลรายการช่วงที่ใช้งานอยู่ในชีตที่ใช้งานอยู่หรือ null หากไม่มีช่วงที่ใช้งานอยู่
getBandings()Banding[]แสดงแถบสีทั้งหมดในชีตนี้
getCharts()EmbeddedChart[]แสดงอาร์เรย์ของแผนภูมิในชีตนี้
getColumnGroup(columnIndex, groupDepth)Groupแสดงผลกลุ่มคอลัมน์ที่ดัชนีและความลึกของกลุ่มที่ระบุ
getColumnGroupControlPosition()GroupControlTogglePositionแสดงผล GroupControlTogglePosition ของกลุ่มคอลัมน์ทั้งหมดในชีต
getColumnGroupDepth(columnIndex)Integerแสดงผลความลึกของกลุ่มของคอลัมน์ที่ดัชนีที่กำหนด
getColumnWidth(columnPosition)Integerรับความกว้างเป็นพิกเซลของคอลัมน์ที่ระบุ
getConditionalFormatRules()ConditionalFormatRule[]รับกฎการจัดรูปแบบตามเงื่อนไขทั้งหมดในชีตนี้
getCurrentCell()Rangeแสดงผลเซลล์ปัจจุบันในชีตที่ใช้งานอยู่หรือ null หากไม่มีเซลล์ปัจจุบัน
getDataRange()Rangeแสดงผล Range ที่สอดคล้องกับมิติข้อมูลที่มีข้อมูลอยู่
getDataSourceFormulas()DataSourceFormula[]รับสูตรแหล่งข้อมูลทั้งหมด
getDataSourcePivotTables()DataSourcePivotTable[]รับตาราง Pivot ของแหล่งข้อมูลทั้งหมด
getDataSourceTables()DataSourceTable[]รับตารางแหล่งข้อมูลทั้งหมด
getDeveloperMetadata()DeveloperMetadata[]รับข้อมูลเมตาทั้งหมดของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับชีตนี้
getDrawings()Drawing[]แสดงผลอาร์เรย์ของภาพวาดในชีต
getFilter()Filterแสดงผลตัวกรองในชีตนี้ หรือแสดงผล null หากไม่มีตัวกรอง
getFormUrl()Stringแสดง URL สำหรับแบบฟอร์มที่ส่งคำตอบไปยังชีตนี้ หรือ null หากชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง
getFrozenColumns()Integerแสดงผลจำนวนคอลัมน์ที่ตรึงไว้
getFrozenRows()Integerแสดงผลจำนวนแถวที่ตรึง
getImages()OverGridImage[]แสดงรูปภาพเหนือตารางทั้งหมดในชีต
getIndex()Integerรับตำแหน่งของชีตในสเปรดชีตระดับบนสุด
getLastColumn()Integerแสดงผลตำแหน่งของคอลัมน์สุดท้ายที่มีเนื้อหา
getLastRow()Integerแสดงผลตำแหน่งของแถวสุดท้ายที่มีเนื้อหา
getMaxColumns()Integerแสดงผลจำนวนคอลัมน์ปัจจุบันในชีตโดยไม่คำนึงถึงเนื้อหา
getMaxRows()Integerแสดงผลจำนวนแถวปัจจุบันในชีตโดยไม่คำนึงถึงเนื้อหา
getName()Stringแสดงชื่อของชีต
getNamedRanges()NamedRange[]เรียกช่วงที่ตั้งชื่อแล้วทั้งหมดในชีตนี้
getParent()Spreadsheetแสดงผล Spreadsheet ที่มีชีตนี้
getPivotTables()PivotTable[]แสดงตาราง Pivot ทั้งหมดในชีตนี้
getProtections(type)Protection[]รับอาร์เรย์ของออบเจ็กต์ที่เป็นตัวแทนช่วงที่มีการป้องกันทั้งหมดในชีต หรืออาร์เรย์องค์ประกอบเดียว ที่แทนการป้องกันในชีต
getRange(row, column)Rangeแสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ
getRange(row, column, numRows)Rangeแสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ และจำนวนแถวที่กำหนด
getRange(row, column, numRows, numColumns)Rangeแสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ พร้อมจำนวนแถวและคอลัมน์ที่กำหนด
getRange(a1Notation)Rangeแสดงผลช่วงตามที่ระบุในเครื่องหมาย A1 หรือ R1C1
getRangeList(a1Notations)RangeListแสดงผลคอลเล็กชัน RangeList ที่แสดงถึงช่วงในชีตเดียวกันที่ระบุโดยรายการเครื่องหมาย A1 หรือเครื่องหมาย R1C1 ที่ไม่ว่างเปล่า
getRowGroup(rowIndex, groupDepth)Groupแสดงผลกลุ่มแถวที่ดัชนีและความลึกของกลุ่มที่ระบุ
getRowGroupControlPosition()GroupControlTogglePositionแสดงผล GroupControlTogglePosition สำหรับกลุ่มแถวทั้งหมดในชีต
getRowGroupDepth(rowIndex)Integerแสดงผลความลึกของกลุ่มของแถวที่ดัชนีที่กำหนด
getRowHeight(rowPosition)Integerรับความสูงเป็นพิกเซลของแถวที่กำหนด
getSelection()Selectionแสดง Selection ปัจจุบันในสเปรดชีต
getSheetId()Integerแสดงผลรหัสของชีตที่แสดงโดยออบเจ็กต์นี้
getSheetName()Stringแสดงชื่อชีต
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]แสดงค่าตารางสี่เหลี่ยมผืนผ้าของช่วงนี้โดยเริ่มจากพิกัดที่ระบุ
getSlicers()Slicer[]แสดงผลอาร์เรย์ของตัวควบคุมตัวกรองในชีต
getTabColorObject()Colorดูสีแท็บชีต หรือnullหากแท็บชีตไม่มีสี
getType()SheetTypeแสดงประเภทของแผ่นงาน
hasHiddenGridlines()Booleanแสดงผล true หากเส้นตารางของชีตซ่อนอยู่ ไม่เช่นนั้นจะแสดงผลเป็น false
hideColumn(column)voidซ่อนคอลัมน์ในช่วงที่กำหนด
hideColumns(columnIndex)voidซ่อนคอลัมน์เดียวที่ดัชนีที่กำหนด
hideColumns(columnIndex, numColumns)voidซ่อนคอลัมน์ที่ต่อเนื่องกันอย่างน้อย 1 คอลัมน์โดยเริ่มจากดัชนีที่กำหนด
hideRow(row)voidซ่อนแถวในช่วงที่กำหนด
hideRows(rowIndex)voidซ่อนแถวที่ดัชนีที่กำหนด
hideRows(rowIndex, numRows)voidซ่อนแถวติดกันอย่างน้อย 1 แถวที่เริ่มจากดัชนีที่กำหนด
hideSheet()Sheetซ่อนแผ่นงานนี้
insertChart(chart)voidเพิ่มแผนภูมิใหม่ไปยังแผ่นงานนี้
insertColumnAfter(afterPosition)Sheetแทรกคอลัมน์หลังตำแหน่งคอลัมน์ที่ระบุ
insertColumnBefore(beforePosition)Sheetแทรกคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ
insertColumns(columnIndex)voidจะแทรกคอลัมน์เปล่าในชีตในตำแหน่งที่ระบุ
insertColumns(columnIndex, numColumns)voidแทรกคอลัมน์ว่างที่ติดกันอย่างน้อย 1 คอลัมน์ในชีตโดยเริ่มจากตำแหน่งที่ระบุ
insertColumnsAfter(afterPosition, howMany)Sheetแทรกคอลัมน์ตามจำนวนที่กำหนดหลังตำแหน่งคอลัมน์ที่กำหนด
insertColumnsBefore(beforePosition, howMany)Sheetแทรกคอลัมน์จำนวนหนึ่งก่อนตำแหน่งคอลัมน์ที่ระบุ
insertImage(blobSource, column, row)OverGridImageแทรก BlobSource เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่กำหนด
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageแทรก BlobSource เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่กำหนด พร้อมด้วยออฟเซ็ตพิกเซล
insertImage(url, column, row)OverGridImageแทรกรูปภาพในเอกสารตามแถวและคอลัมน์ที่กำหนด
insertImage(url, column, row, offsetX, offsetY)OverGridImageแทรกรูปภาพในเอกสารตามแถวและคอลัมน์ที่ระบุ โดยมีออฟเซ็ตพิกเซล
insertRowAfter(afterPosition)Sheetแทรกแถวหลังตำแหน่งของแถวที่ระบุ
insertRowBefore(beforePosition)Sheetแทรกแถวก่อนตำแหน่งของแถวที่ระบุ
insertRows(rowIndex)voidจะแทรกแถวว่างในชีตในตำแหน่งที่ระบุ
insertRows(rowIndex, numRows)voidแทรกแถวว่างที่ติดกันอย่างน้อย 1 แถวในชีตโดยเริ่มจากตำแหน่งที่ระบุ
insertRowsAfter(afterPosition, howMany)Sheetแทรกจำนวนแถวหลังตำแหน่งของแถวที่ระบุ
insertRowsBefore(beforePosition, howMany)Sheetแทรกจำนวนแถวก่อนตำแหน่งของแถวที่ระบุ
insertSlicer(range, anchorRowPos, anchorColPos)Slicerเพิ่มตัวควบคุมตัวกรองใหม่ลงในชีตนี้
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)Slicerเพิ่มตัวควบคุมตัวกรองใหม่ลงในชีตนี้
isColumnHiddenByUser(columnPosition)Booleanแสดงผลว่าผู้ใช้ซ่อนคอลัมน์ที่ระบุหรือไม่
isRightToLeft()Booleanแสดงผล true ถ้าเลย์เอาต์ชีตนี้เป็นแบบขวาไปซ้าย
isRowHiddenByFilter(rowPosition)Booleanแสดงผลว่าแถวที่ระบุถูกซ่อนโดยตัวกรองหรือไม่ (ไม่ใช่มุมมองตัวกรอง)
isRowHiddenByUser(rowPosition)Booleanแสดงผลว่าผู้ใช้ซ่อนแถวที่ระบุหรือไม่
isSheetHidden()Booleanแสดงผล true หากแผ่นงานซ่อนอยู่
moveColumns(columnSpec, destinationIndex)voidย้ายคอลัมน์ที่เลือกโดยช่วงที่ระบุไปยังตำแหน่งที่ระบุโดย destinationIndex
moveRows(rowSpec, destinationIndex)voidย้ายแถวที่เลือกโดยช่วงที่ระบุไปยังตำแหน่งที่ระบุโดย destinationIndex
newChart()EmbeddedChartBuilderแสดงตัวสร้างเพื่อสร้างแผนภูมิใหม่สำหรับชีตนี้
protect()Protectionสร้างออบเจ็กต์ที่ป้องกันไม่ให้แก้ไขชีตได้ ยกเว้นผู้ใช้ที่มีสิทธิ์
removeChart(chart)voidนำแผนภูมิออกจากชีตหลัก
setActiveRange(range)Rangeตั้งค่าช่วงที่ระบุเป็น active range ในชีตที่ใช้งานอยู่ โดยเซลล์ซ้ายบนสุดของช่วงเป็น current cell
setActiveRangeList(rangeList)RangeListตั้งค่ารายการช่วงที่ระบุเป็น active ranges ในชีตที่ใช้งานอยู่
setActiveSelection(range)Rangeตั้งค่าเขตการเลือกที่ใช้งานอยู่สำหรับชีตนี้
setActiveSelection(a1Notation)Rangeตั้งค่าการเลือกที่ใช้งานอยู่ ตามที่ระบุในรูปแบบ A1 หรือสัญลักษณ์ R1C1
setColumnGroupControlPosition(position)Sheetกำหนดตำแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มคอลัมน์ในชีต
setColumnWidth(columnPosition, width)Sheetตั้งค่าความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล
setColumnWidths(startColumn, numColumns, width)Sheetตั้งค่าความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล
setConditionalFormatRules(rules)voidแทนที่กฎการจัดรูปแบบตามเงื่อนไขที่มีอยู่ทั้งหมดในชีตด้วยกฎอินพุต
setCurrentCell(cell)Rangeตั้งค่าเซลล์ที่ระบุเป็น current cell
setFrozenColumns(columns)voidตรึงจำนวนคอลัมน์ที่ระบุ
setFrozenRows(rows)voidตรึงจำนวนแถวที่ระบุ
setHiddenGridlines(hideGridlines)Sheetซ่อนหรือแสดงเส้นตารางของชีต
setName(name)Sheetตั้งชื่อชีต
setRightToLeft(rightToLeft)Sheetตั้งค่าหรือยกเลิกการตั้งค่าเลย์เอาต์ชีตเป็นแบบขวาไปซ้าย
setRowGroupControlPosition(position)Sheetกำหนดตำแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มแถวในชีต
setRowHeight(rowPosition, height)Sheetกำหนดความสูงของแถวแนวนอนของแถวที่ระบุเป็นพิกเซล
setRowHeights(startRow, numRows, height)Sheetกำหนดความสูงของแถวที่ระบุเป็นพิกเซล
setRowHeightsForced(startRow, numRows, height)Sheetกำหนดความสูงของแถวที่ระบุเป็นพิกเซล
setTabColor(color)Sheetตั้งค่าสีแท็บของชีต
setTabColorObject(color)Sheetตั้งค่าสีแท็บของชีต
showColumns(columnIndex)voidเลิกซ่อนคอลัมน์ที่ดัชนีที่กำหนด
showColumns(columnIndex, numColumns)voidเลิกซ่อนคอลัมน์ตั้งแต่ 1 คอลัมน์ขึ้นไปที่ต่อเนื่องกันโดยเริ่มจากดัชนีที่ระบุ
showRows(rowIndex)voidเลิกซ่อนแถวที่ดัชนีที่กำหนด
showRows(rowIndex, numRows)voidเลิกซ่อนแถวที่ติดกันอย่างน้อย 1 แถวโดยเริ่มจากดัชนีที่ระบุ
showSheet()Sheetทำให้แผ่นงานปรากฏ
sort(columnPosition)Sheetจัดเรียงชีตตามคอลัมน์จากน้อยไปมาก
sort(columnPosition, ascending)Sheetจัดเรียงชีตตามคอลัมน์
unhideColumn(column)voidเลิกซ่อนคอลัมน์ในช่วงที่กำหนด
unhideRow(row)voidเลิกซ่อนแถวในช่วงที่กำหนด
updateChart(chart)voidอัปเดตแผนภูมิในชีตนี้

เอกสารประกอบโดยละเอียด

activate()

เปิดใช้งานชีตนี้ ไม่ได้ปรับเปลี่ยนตัวชีต แต่เป็นเพียงความเห็นของระดับบนสุดเกี่ยวกับชีตที่ใช้งานอยู่

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

รีเทิร์น

Sheet — แผ่นงานใหม่ที่เพิ่งใช้งาน


addDeveloperMetadata(key)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุลงในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addDeveloperMetadata(key, visibility)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์และระดับการเข้าถึงที่ระบุลงในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป
visibilityDeveloperMetadataVisibilityระดับการเข้าถึงข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addDeveloperMetadata(key, value)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่มีคีย์และค่าที่ระบุลงในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป
valueStringค่าสำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addDeveloperMetadata(key, value, visibility)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ ค่า และระดับการเข้าถึงที่ระบุลงในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the
// visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
  'COMPANY',
  'TECH',
  SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป
valueStringค่าสำหรับข้อมูลเมตาใหม่ของนักพัฒนาแอป
visibilityDeveloperMetadataVisibilityระดับการเข้าถึงข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

appendRow(rowContents)

เพิ่มแถวที่ด้านล่างของเขตข้อมูลปัจจุบันในชีต หากเนื้อหาของเซลล์ขึ้นต้นด้วย = ระบบจะตีความว่าเป็นสูตร

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

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowContentsObject[]อาร์เรย์ของค่าที่จะแทรกหลังแถวสุดท้ายในชีต

รีเทิร์น

Sheet — ชีต ซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

asDataSourceSheet()

แสดงผลแผ่นงานเป็น DataSourceSheet หากแผ่นงานเป็นประเภท SheetType.DATASOURCE หรือ null ในกรณีอื่นๆ

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

autoResizeColumn(columnPosition)

ตั้งค่าความกว้างของคอลัมน์ที่ระบุเพื่อให้พอดีกับเนื้อหา

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

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตําแหน่งของคอลัมน์ที่จะปรับขนาด

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

autoResizeColumns(startColumn, numColumns)

ตั้งค่าความกว้างของคอลัมน์ทั้งหมดโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุเพื่อให้พอดีกับเนื้อหา

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startColumnIntegerคอลัมน์เริ่มต้นที่ปรับขนาดอัตโนมัติ
numColumnsIntegerจำนวนคอลัมน์ที่จะปรับขนาดอัตโนมัติ

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

autoResizeRows(startRow, numRows)

กำหนดความสูงของแถวทั้งหมดโดยเริ่มจากตำแหน่งของแถวที่ระบุเพื่อให้พอดีกับเนื้อหา

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startRowIntegerแถวเริ่มต้นที่จะปรับขนาดอัตโนมัติ
numRowsIntegerจำนวนแถวที่จะปรับขนาดอัตโนมัติ

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clear()

ล้างชีตของข้อมูลเนื้อหาและการจัดรูปแบบ

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

รีเทิร์น

Sheet — แผ่นงานที่ล้างแล้ว

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clear(options)

ล้างชีตเนื้อหาและ/หรือรูปแบบตามที่ระบุด้วยตัวเลือกขั้นสูงที่มีให้

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
optionsObjectแผนที่ JavaScript ที่มีตัวเลือกขั้นสูงแสดงด้านล่าง

พารามิเตอร์ขั้นสูง

ชื่อประเภทคำอธิบาย
contentsOnlyBooleanล้างเนื้อหาหรือไม่
formatOnlyBooleanต้องการล้างรูปแบบหรือไม่

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clearConditionalFormatRules()

นำกฎการจัดรูปแบบตามเงื่อนไขทั้งหมดออกจากชีต เทียบเท่ากับการเรียกใช้ setConditionalFormatRules(rules) ที่มีอาร์เรย์ว่างเปล่าเป็นอินพุต

var sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clearContents()

ล้างชีตเนื้อหาแต่ยังรักษาข้อมูลการจัดรูปแบบไว้ได้

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clearFormats()

ล้างชีตการจัดรูปแบบและเก็บเนื้อหาไว้

การจัดรูปแบบหมายถึงการจัดรูปแบบข้อมูลตามที่ได้รับอนุญาตตามตัวเลือกในเมนู "รูปแบบ" (เช่น ตัวหนา ตัวเอียง การจัดรูปแบบตามเงื่อนไข) ไม่ใช่ความกว้างหรือความสูงของเซลล์

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

clearNotes()

ล้างชีตของโน้ตทั้งหมด

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

collapseAllColumnGroups()

ยุบกลุ่มคอลัมน์ทั้งหมดในชีต

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

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

collapseAllRowGroups()

ยุบกลุ่มแถวทั้งหมดในชีต

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

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

copyTo(spreadsheet)

คัดลอกชีตไปยังสเปรดชีตที่ระบุ ซึ่งอาจเป็นสเปรดชีตเดียวกับต้นทาง โดยชีตที่คัดลอกมาจะมีชื่อว่า "สำเนาของ [ชื่อเดิม]"

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
spreadsheetSpreadsheetสเปรดชีตที่จะคัดลอกชีตนี้ไป ซึ่งอาจเป็นสเปรดชีตเดียวกับต้นทาง

รีเทิร์น

Sheet — ชีตใหม่สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

createDeveloperMetadataFinder()

แสดงผล DeveloperMetadataFinder สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของชีตนี้ ข้อมูลเมตาจะอยู่ในขอบเขตของชีตที่เจาะจง หากมีการเชื่อมโยงกับตัวชีตเอง หรือเชื่อมโยงกับแถว คอลัมน์ หรือช่วงในชีตนั้น

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

รีเทิร์น

DeveloperMetadataFinder — เครื่องมือค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์เพื่อค้นหาข้อมูลเมตาในขอบเขตของชีตนี้


createTextFinder(findText)

สร้างเครื่องมือค้นหาข้อความสำหรับชีต ซึ่งสามารถค้นหาและแทนที่ข้อความในชีตได้

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
findTextStringข้อความที่จะค้นหา

รีเทิร์น

TextFinderTextFinder สำหรับชีต


deleteColumn(columnPosition)

ลบคอลัมน์ ณ ตำแหน่งคอลัมน์ที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตำแหน่งของคอลัมน์ โดยเริ่มต้นที่ 1 สำหรับคอลัมน์แรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

deleteColumns(columnPosition, howMany)

ลบคอลัมน์จำนวนหนึ่งโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตำแหน่งของคอลัมน์แรกที่จะลบ
howManyIntegerจำนวนคอลัมน์ที่จะลบ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

deleteRow(rowPosition)

ลบแถวตรงตําแหน่งของแถวที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตำแหน่งของแถว โดยเริ่มที่ 1 สำหรับแถวแรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

deleteRows(rowPosition, howMany)

ลบแถวจำนวนหนึ่งโดยเริ่มจากตำแหน่งของแถวที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตำแหน่งของแถวแรกที่จะลบ
howManyIntegerจำนวนแถวที่จะลบ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

expandAllColumnGroups()

ขยายกลุ่มคอลัมน์ทั้งหมดในชีต วิธีนี้ต้องมีกลุ่มคอลัมน์อย่างน้อย 1 กลุ่ม

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

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

expandAllRowGroups()

ขยายกลุ่มแถวทั้งหมดในชีต วิธีนี้ต้องมีกลุ่มแถวอย่างน้อย 1 กลุ่ม

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

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

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

expandColumnGroupsUpToDepth(groupDepth)

ขยายกลุ่มคอลัมน์ทั้งหมดจนถึงระดับความลึกที่ระบุ และยุบกลุ่มอื่นๆ ทั้งหมด

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
groupDepthIntegerความลึกของกลุ่มขึ้นไปที่เพื่อขยายกลุ่มคอลัมน์

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

expandRowGroupsUpToDepth(groupDepth)

ขยายกลุ่มแถวทั้งหมดจนถึงระดับความลึกที่กำหนด และยุบกลุ่มอื่นๆ ทั้งหมด

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
groupDepthIntegerความลึกของกลุ่มขึ้นไปที่เพื่อขยายกลุ่มแถว

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getActiveCell()

แสดงผลเซลล์ที่ใช้งานอยู่ในชีตนี้

หมายเหตุ: เราขอแนะนำให้ใช้ getCurrentCell() ซึ่งจะแสดงผลเซลล์ที่ไฮไลต์ในปัจจุบัน

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

รีเทิร์น

Range — เซลล์ปัจจุบันที่ใช้งานอยู่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getActiveRange()

แสดงผลช่วงที่เลือกในชีตที่ใช้งานอยู่ หรือแสดงผล null หากไม่มีช่วงที่ใช้งานอยู่ หากเลือกหลายช่วง วิธีนี้จะแสดงผลเฉพาะช่วงที่เลือกล่าสุดเท่านั้น

คำว่า "ช่วงที่มีการใช้งาน" หมายถึงช่วงที่ผู้ใช้เลือกในชีตที่ใช้งานอยู่ แต่ในฟังก์ชันที่กำหนดเอง ช่วงดังกล่าวจะหมายถึงเซลล์ที่มีการคำนวณใหม่อยู่

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

รีเทิร์น

Range — ช่วงที่มีการใช้งาน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม


getActiveRangeList()

แสดงผลรายการช่วงที่ใช้งานอยู่ในชีตที่ใช้งานอยู่หรือ null หากไม่มีช่วงที่ใช้งานอยู่

หากเลือกช่วงเดียวไว้ การดำเนินการนี้จะทำงานเป็นการเรียกใช้ getActiveRange()

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

รีเทิร์น

RangeList — รายการช่วงที่มีการใช้งาน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม


getBandings()

แสดงแถบสีทั้งหมดในชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

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

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

รีเทิร์น

Banding[] — แถบสีทั้งหมดในชีตนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getCharts()

แสดงอาร์เรย์ของแผนภูมิในชีตนี้

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

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

รีเทิร์น

EmbeddedChart[] — อาร์เรย์ของแผนภูมิ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getColumnGroup(columnIndex, groupDepth)

แสดงผลกลุ่มคอลัมน์ที่ดัชนีและความลึกของกลุ่มที่ระบุ

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
var columnGroup = sheet.getColumnGroup(2, 1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีคอลัมน์ของปุ่มสลับการควบคุมกลุ่มหรือดัชนีภายในกลุ่ม
groupDepthIntegerความลึกของกลุ่ม

รีเทิร์น

Group — กลุ่มคอลัมน์ที่ดัชนีและความลึกการควบคุม หรือมีการส่งข้อยกเว้นหากไม่มีกลุ่มดังกล่าว

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getColumnGroupControlPosition()

แสดงผล GroupControlTogglePosition ของกลุ่มคอลัมน์ทั้งหมดในชีต

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

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

รีเทิร์น

GroupControlTogglePositiontrue หากปุ่มสลับควบคุมการจัดกลุ่มคอลัมน์ปรากฏหลังกลุ่มในชีตนี้และ false ในกรณีอื่นๆ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getColumnGroupDepth(columnIndex)

แสดงผลความลึกของกลุ่มของคอลัมน์ที่ดัชนีที่กำหนด

ความลึกของกลุ่มจะระบุจำนวนกลุ่มที่ทับซ้อนกับคอลัมน์ ช่วงนี้ได้ตั้งแต่ 0 ถึง 8

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีของคอลัมน์

รีเทิร์น

Integer — ความลึกของกลุ่มคอลัมน์ที่ดัชนีที่กำหนด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getColumnWidth(columnPosition)

รับความกว้างเป็นพิกเซลของคอลัมน์ที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตําแหน่งของคอลัมน์ที่จะตรวจสอบ

รีเทิร์น

Integer — ความกว้างของคอลัมน์เป็นพิกเซล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getConditionalFormatRules()

รับกฎการจัดรูปแบบตามเงื่อนไขทั้งหมดในชีตนี้

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

รีเทิร์น

ConditionalFormatRule[] — อาร์เรย์ของกฎทั้งหมดในชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getCurrentCell()

แสดงผลเซลล์ปัจจุบันในชีตที่ใช้งานอยู่หรือ null หากไม่มีเซลล์ปัจจุบัน เซลล์ปัจจุบันคือเซลล์ที่โฟกัสใน UI ของ Google ชีตและมีการไฮไลต์ด้วยขอบสีเข้ม ปัจจุบันไม่มีเซลล์ปัจจุบันเกิน 1 เซลล์ เมื่อผู้ใช้เลือกช่วงเซลล์ 1 ช่วงขึ้นไป เซลล์ใดเซลล์หนึ่งในการเลือกจะเป็นเซลล์ปัจจุบัน

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

รีเทิร์น

Range — เซลล์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDataRange()

แสดงผล Range ที่สอดคล้องกับมิติข้อมูลที่มีข้อมูลอยู่

ซึ่งฟังก์ชันนี้จะเทียบเท่ากับการสร้างช่วงที่ล้อมรอบด้วย A1 และ (Sheet.getLastColumn(), Sheet.getLastRow())

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

รีเทิร์น

Range — ช่วงที่ประกอบด้วยข้อมูลทั้งหมดในสเปรดชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDataSourceFormulas()

รับสูตรแหล่งข้อมูลทั้งหมด

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

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

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

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

รีเทิร์น

DataSourceFormula[] — รายการสูตรแหล่งข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDataSourcePivotTables()

รับตาราง Pivot ของแหล่งข้อมูลทั้งหมด

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

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

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

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

รีเทิร์น

DataSourcePivotTable[] — รายการตาราง Pivot ของแหล่งข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDataSourceTables()

รับตารางแหล่งข้อมูลทั้งหมด

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

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

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

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

รีเทิร์น

DataSourceTable[] — รายการตารางแหล่งข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDeveloperMetadata()

รับข้อมูลเมตาทั้งหมดของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

รีเทิร์น

DeveloperMetadata[] — ข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับชีตนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDrawings()

แสดงผลอาร์เรย์ของภาพวาดในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

 // Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

รีเทิร์น

Drawing[] — รายการภาพวาดในชีตนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getFilter()

แสดงผลตัวกรองในชีตนี้ หรือแสดงผล null หากไม่มีตัวกรอง

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

รีเทิร์น

Filter — ตัวกรอง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getFormUrl()

แสดง URL สำหรับแบบฟอร์มที่ส่งคำตอบไปยังชีตนี้ หรือ null หากชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง

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

รีเทิร์น

String — URL สำหรับแบบฟอร์มที่วางคำตอบไว้ในชีตนี้ หรือ null หากชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getFrozenColumns()

แสดงผลจำนวนคอลัมน์ที่ตรึงไว้

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

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

รีเทิร์น

Integer — จำนวนคอลัมน์ที่ตรึงไว้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getFrozenRows()

แสดงผลจำนวนแถวที่ตรึง

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

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

รีเทิร์น

Integer — จำนวนแถวที่ตรึงไว้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getImages()

แสดงรูปภาพเหนือตารางทั้งหมดในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

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

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

รีเทิร์น

OverGridImage[] — อาร์เรย์ของรูปภาพเหนือตาราง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getIndex()

รับตำแหน่งของชีตในสเปรดชีตระดับบนสุด เริ่ม 1

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

รีเทิร์น

Integer — ตำแหน่งของชีตในสเปรดชีตระดับบนสุด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getLastColumn()

แสดงผลตำแหน่งของคอลัมน์สุดท้ายที่มีเนื้อหา

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

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

รีเทิร์น

Integer — คอลัมน์สุดท้ายของชีตที่มีเนื้อหา

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getLastRow()

แสดงผลตำแหน่งของแถวสุดท้ายที่มีเนื้อหา

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

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

รีเทิร์น

Integer — แถวสุดท้ายของชีตที่มีเนื้อหา

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getMaxColumns()

แสดงผลจำนวนคอลัมน์ปัจจุบันในชีตโดยไม่คำนึงถึงเนื้อหา

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

รีเทิร์น

Integer — ความกว้างสูงสุดของชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getMaxRows()

แสดงผลจำนวนแถวปัจจุบันในชีตโดยไม่คำนึงถึงเนื้อหา

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

รีเทิร์น

Integer — ความสูงสูงสุดของชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getName()

แสดงชื่อของชีต

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

รีเทิร์น

String — ชื่อของชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getNamedRanges()

เรียกช่วงที่ตั้งชื่อแล้วทั้งหมดในชีตนี้

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

รีเทิร์น

NamedRange[] — อาร์เรย์ของช่วงที่ตั้งชื่อแล้วทั้งหมดในชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getParent()

แสดงผล Spreadsheet ที่มีชีตนี้

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

รีเทิร์น

Spreadsheet — สเปรดชีตระดับบนสุด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getPivotTables()

แสดงตาราง Pivot ทั้งหมดในชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

รีเทิร์น

PivotTable[] — ตาราง Pivot ในชีตนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getProtections(type)

รับอาร์เรย์ของออบเจ็กต์ที่เป็นตัวแทนช่วงที่มีการป้องกันทั้งหมดในชีต หรืออาร์เรย์องค์ประกอบเดียว ที่แทนการป้องกันในชีต

// Remove all range protections in the spreadsheet that the user has permission to edit.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
typeProtectionTypeประเภทของพื้นที่ที่มีการป้องกัน อาจเป็น SpreadsheetApp.ProtectionType.RANGE หรือ SpreadsheetApp.ProtectionType.SHEET

รีเทิร์น

Protection[] — อาร์เรย์ของออบเจ็กต์ที่แทนช่วงที่มีการป้องกันทั้งหมดในชีต หรืออาร์เรย์องค์ประกอบเดี่ยวที่แทนการป้องกันในตัวของชีตเอง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRange(row, column)

แสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIntegerดัชนีแถวของเซลล์ที่จะส่งคืน การจัดทำดัชนีแถวจะเริ่มต้นด้วย 1
columnIntegerดัชนีคอลัมน์ของเซลล์ที่จะแสดง การจัดทำดัชนีคอลัมน์จะขึ้นต้นด้วย 1

รีเทิร์น

Range — ช่วงที่มีเฉพาะเซลล์นี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRange(row, column, numRows)

แสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ และจำนวนแถวที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIntegerดัชนีแถวเริ่มต้นของช่วง การจัดทำดัชนีแถวจะเริ่มต้นด้วย 1
columnIntegerดัชนีคอลัมน์ของช่วง โดยการจัดทำดัชนีคอลัมน์จะเริ่มต้นด้วย 1
numRowsIntegerจำนวนแถวที่จะแสดงผล

รีเทิร์น

Range — ช่วงที่มีข้อมูลคอลัมน์เดียวซึ่งมีจำนวนแถวที่ระบุไว้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRange(row, column, numRows, numColumns)

แสดงผลช่วงที่มีเซลล์ซ้ายบนสุดตามพิกัดที่ระบุ พร้อมจำนวนแถวและคอลัมน์ที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIntegerดัชนีแถวเริ่มต้นของช่วง การจัดทำดัชนีแถวจะเริ่มต้นด้วย 1
columnIntegerดัชนีคอลัมน์เริ่มต้นของช่วง โดยการจัดทำดัชนีคอลัมน์จะขึ้นต้นด้วย 1
numRowsIntegerจำนวนแถวที่จะแสดงผล
numColumnsIntegerจำนวนคอลัมน์ที่จะแสดงผล

รีเทิร์น

Range — ช่วงที่สอดคล้องกับพื้นที่ที่ระบุ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRange(a1Notation)

แสดงผลช่วงตามที่ระบุในเครื่องหมาย A1 หรือ R1C1

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
a1NotationStringช่วงที่จะส่งคืนตามที่ระบุไว้ในเครื่องหมาย A1 หรือ R1C1

รีเทิร์น

Range — ช่วงในสถานที่ที่กำหนด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRangeList(a1Notations)

แสดงผลคอลเล็กชัน RangeList ที่แสดงถึงช่วงในชีตเดียวกันที่ระบุโดยรายการเครื่องหมาย A1 หรือเครื่องหมาย R1C1 ที่ไม่ว่างเปล่า

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
a1NotationsString[]รายการช่วงที่จะส่งคืน ตามที่ระบุไว้ในเครื่องหมาย A1 หรือ R1C1

รีเทิร์น

RangeList — รายการช่วงในสถานที่ที่กำหนด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRowGroup(rowIndex, groupDepth)

แสดงผลกลุ่มแถวที่ดัชนีและความลึกของกลุ่มที่ระบุ

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
var rowGroup = sheet.getRowGroup(2, 1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีแถวของปุ่มสลับการควบคุมกลุ่มหรือดัชนีภายในกลุ่ม
groupDepthIntegerความลึกของกลุ่ม

รีเทิร์น

Group — กลุ่มแถวที่ดัชนีและความลึกการควบคุม หรือมีการส่งข้อยกเว้นหากไม่มีกลุ่มดังกล่าว

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRowGroupControlPosition()

แสดงผล GroupControlTogglePosition สำหรับกลุ่มแถวทั้งหมดในชีต

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

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

รีเทิร์น

GroupControlTogglePositiontrue หากปุ่มสลับควบคุมการจัดกลุ่มแถวปรากฏหลังกลุ่มในชีตนี้ และจะแสดง false ในกรณีอื่นๆ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRowGroupDepth(rowIndex)

แสดงผลความลึกของกลุ่มของแถวที่ดัชนีที่กำหนด

ความลึกของกลุ่มจะแสดงจํานวนกลุ่มที่ทับซ้อนกันกับแถว ค่าของช่วงนี้จะอยู่ระหว่าง 0 ถึง 8

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีของแถว

รีเทิร์น

Integer — ความลึกของกลุ่มของแถวที่ดัชนีที่กำหนด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRowHeight(rowPosition)

รับความสูงเป็นพิกเซลของแถวที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตําแหน่งของแถวที่จะตรวจสอบ

รีเทิร์น

Integer — ความสูงของแถวเป็นพิกเซล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getSelection()

แสดง Selection ปัจจุบันในสเปรดชีต

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

รีเทิร์น

Selection — ตัวเลือกปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getSheetId()

แสดงผลรหัสของชีตที่แสดงโดยออบเจ็กต์นี้

ซึ่งเป็นรหัสของชีตเฉพาะสำหรับสเปรดชีตนั้นๆ รหัสคือจำนวนเต็มที่เพิ่มขึ้นทีละน้อยซึ่งกำหนด ณ เวลาที่สร้างชีต โดยไม่ขึ้นอยู่กับตำแหน่งชีต ซึ่งจะเป็นประโยชน์เมื่อใช้ร่วมกับเมธอดอย่างเช่น Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) ที่ใช้พารามิเตอร์ gridId แทนที่จะเป็นอินสแตนซ์ Sheet

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

Logger.log(sheet.getSheetId());

รีเทิร์น

Integer — รหัสสำหรับชีตเฉพาะสำหรับสเปรดชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getSheetName()

แสดงชื่อชีต

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

Logger.log(sheet.getSheetName());

รีเทิร์น

String — ชื่อของชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getSheetValues(startRow, startColumn, numRows, numColumns)

แสดงค่าตารางสี่เหลี่ยมผืนผ้าของช่วงนี้โดยเริ่มจากพิกัดที่ระบุ ค่า -1 ที่ระบุเป็นตำแหน่งแถวหรือคอลัมน์จะเท่ากับการได้แถวหรือคอลัมน์สุดท้ายที่มีข้อมูลในชีต

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startRowIntegerตำแหน่งของแถวเริ่มต้น
startColumnIntegerตำแหน่งของคอลัมน์เริ่มต้น
numRowsIntegerจำนวนแถวที่จะแสดงผลค่า
numColumnsIntegerจำนวนคอลัมน์ที่จะแสดงผลค่า

รีเทิร์น

Object[][] — อาร์เรย์ค่า 2 มิติ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getSlicers()

แสดงผลอาร์เรย์ของตัวควบคุมตัวกรองในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

รีเทิร์น

Slicer[] — รายการตัวควบคุมตัวกรองในชีตนี้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getTabColorObject()

ดูสีแท็บชีต หรือnullหากแท็บชีตไม่มีสี

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

รีเทิร์น

Color — สีแท็บชีต หรือ null หากแท็บชีตไม่มีสี

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getType()

แสดงประเภทของแผ่นงาน

ประเภทเริ่มต้นของชีตคือ SheetType.GRID ชีตที่มีออบเจ็กต์เดียวที่ฝังอยู่ เช่น EmbeddedChart คือชีต SheetType.OBJECT

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

รีเทิร์น

SheetType — ประเภทของชีต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hasHiddenGridlines()

แสดงผล true หากเส้นตารางของชีตซ่อนอยู่ ไม่เช่นนั้นจะแสดงผลเป็น 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the console.
console.log(sheet.hasHiddenGridlines());

รีเทิร์น

Booleantrue หากเส้นตารางซ่อนอยู่ false มิฉะนั้น

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideColumn(column)

ซ่อนคอลัมน์ในช่วงที่กำหนด

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnRangeช่วงคอลัมน์ที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideColumns(columnIndex)

ซ่อนคอลัมน์เดียวที่ดัชนีที่กำหนด ใช้ดัชนี 1 สำหรับวิธีนี้

หากต้องการซ่อนคอลัมน์มากกว่า 1 คอลัมน์โดยใช้ดัชนี ให้ใช้ hideColumns(columnIndex, numColumns)

หากต้องการซ่อนคอลัมน์มากกว่า 1 คอลัมน์โดยใช้ช่วง ให้ใช้ hideColumn()

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีของคอลัมน์ที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideColumns(columnIndex, numColumns)

ซ่อนคอลัมน์ที่ต่อเนื่องกันอย่างน้อย 1 คอลัมน์โดยเริ่มจากดัชนีที่กำหนด ใช้ดัชนี 1 สำหรับวิธีนี้

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีเริ่มต้นของคอลัมน์ที่จะซ่อน
numColumnsIntegerจำนวนคอลัมน์ที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideRow(row)

ซ่อนแถวในช่วงที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowRangeช่วงของแถวที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideRows(rowIndex)

ซ่อนแถวที่ดัชนีที่กำหนด

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีของแถวที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideRows(rowIndex, numRows)

ซ่อนแถวติดกันอย่างน้อย 1 แถวที่เริ่มจากดัชนีที่กำหนด

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีเริ่มต้นของแถวที่จะซ่อน
numRowsIntegerจำนวนแถวที่จะซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hideSheet()

ซ่อนแผ่นงานนี้ จะไม่มีผลหากซ่อนแผ่นงานอยู่ ถ้ามีการเรียกเมธอดนี้ในชีตที่มองเห็นได้ เดียว ระบบจะแสดงข้อผิดพลาด

var sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

รีเทิร์น

Sheet — แผ่นงานปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertChart(chart)

เพิ่มแผนภูมิใหม่ไปยังแผ่นงานนี้

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B4"))
    .setPosition(5, 5, 0, 0)
    .setOption("title", "Dynamic Chart")
    .build();
sheet.insertChart(chart);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
chartEmbeddedChartแผนภูมิที่จะแทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumnAfter(afterPosition)

แทรกคอลัมน์หลังตำแหน่งคอลัมน์ที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่หลังจากนั้น

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumnBefore(beforePosition)

แทรกคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerคอลัมน์ก่อนหน้าที่ควรเพิ่มคอลัมน์ใหม่

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumns(columnIndex)

จะแทรกคอลัมน์เปล่าในชีตในตำแหน่งที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีที่ระบุตำแหน่งที่จะแทรกคอลัมน์

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumns(columnIndex, numColumns)

แทรกคอลัมน์ว่างที่ติดกันอย่างน้อย 1 คอลัมน์ในชีตโดยเริ่มจากตำแหน่งที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีที่ระบุตำแหน่งที่จะแทรกคอลัมน์
numColumnsIntegerจำนวนคอลัมน์ที่จะแทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumnsAfter(afterPosition, howMany)

แทรกคอลัมน์ตามจำนวนที่กำหนดหลังตำแหน่งคอลัมน์ที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่หลังจากนั้น
howManyIntegerจำนวนคอลัมน์ที่จะแทรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertColumnsBefore(beforePosition, howMany)

แทรกคอลัมน์จำนวนหนึ่งก่อนตำแหน่งคอลัมน์ที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerคอลัมน์ก่อนหน้าที่ควรเพิ่มคอลัมน์ใหม่
howManyIntegerจำนวนคอลัมน์ที่จะแทรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertImage(blobSource, column, row)

แทรก BlobSource เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่กำหนด ขนาดรูปภาพจะดึงมาจากเนื้อหา Blob ขนาดของ BLOB ที่รองรับคือ 2 MB

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
blobSourceBlobSourceBlob ที่มีเนื้อหารูปภาพ, ประเภท MIME และ (ไม่บังคับ)
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertImage(blobSource, column, row, offsetX, offsetY)

แทรก BlobSource เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่กำหนด พร้อมด้วยออฟเซ็ตพิกเซล ขนาดอิมเมจจะดึงมาจากเนื้อหาของ Blob ขนาดของ BLOB ที่รองรับคือ 2 MB

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
blobSourceBlobSourceBlob ที่มีเนื้อหารูปภาพ, ประเภท MIME และ (ไม่บังคับ)
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว
offsetXIntegerค่าออฟเซ็ตแนวนอนจากมุมของเซลล์ หน่วยเป็นพิกเซล
offsetYIntegerค่าออฟเซ็ตแนวตั้งจากมุมเซลล์ หน่วยเป็นพิกเซล

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertImage(url, column, row)

แทรกรูปภาพในเอกสารตามแถวและคอลัมน์ที่กำหนด

URL ที่ระบุต้องเข้าถึงได้แบบสาธารณะ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของรูปภาพ
columnIntegerตำแหน่งคอลัมน์ของตาราง
rowIntegerตำแหน่งแถวของตาราง

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertImage(url, column, row, offsetX, offsetY)

แทรกรูปภาพในเอกสารตามแถวและคอลัมน์ที่ระบุ โดยมีออฟเซ็ตพิกเซล

URL ที่ระบุต้องเข้าถึงได้แบบสาธารณะ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของรูปภาพ
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว
offsetXIntegerค่าออฟเซ็ตแนวนอนจากมุมของเซลล์ หน่วยเป็นพิกเซล
offsetYIntegerค่าออฟเซ็ตแนวตั้งจากมุมเซลล์ หน่วยเป็นพิกเซล

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRowAfter(afterPosition)

แทรกแถวหลังตำแหน่งของแถวที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerแถวที่ควรเพิ่มแถวใหม่หลังจากนั้น

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRowBefore(beforePosition)

แทรกแถวก่อนตำแหน่งของแถวที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerแถวก่อนหน้าที่ควรเพิ่มแถวใหม่

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRows(rowIndex)

จะแทรกแถวว่างในชีตในตำแหน่งที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีที่ระบุตำแหน่งที่จะแทรกแถว

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRows(rowIndex, numRows)

แทรกแถวว่างที่ติดกันอย่างน้อย 1 แถวในชีตโดยเริ่มจากตำแหน่งที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีที่ระบุตำแหน่งที่จะแทรกแถว
numRowsIntegerจำนวนแถวที่จะแทรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRowsAfter(afterPosition, howMany)

แทรกจำนวนแถวหลังตำแหน่งของแถวที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerแถวที่ควรเพิ่มแถวใหม่หลังจากนั้น
howManyIntegerจำนวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertRowsBefore(beforePosition, howMany)

แทรกจำนวนแถวก่อนตำแหน่งของแถวที่ระบุ

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerแถวก่อนหน้าที่ควรเพิ่มแถวใหม่
howManyIntegerจำนวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertSlicer(range, anchorRowPos, anchorColPos)

เพิ่มตัวควบคุมตัวกรองใหม่ลงในชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

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

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่สร้างตัวควบคุมตัวกรอง
anchorRowPosIntegerด้านบนของตัวควบคุมตัวกรองจะตรึงไว้ในแถวนี้
anchorColPosIntegerที่ด้านบนของตัวควบคุมตัวกรองจะตรึงอยู่ในคอลัมน์นี้

รีเทิร์น

Slicer — ตัวควบคุมตัวกรองที่แทรกใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)

เพิ่มตัวควบคุมตัวกรองใหม่ลงในชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

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

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่สร้างตัวควบคุมตัวกรอง
anchorRowPosIntegerด้านบนของตัวควบคุมตัวกรองจะตรึงไว้ในแถวนี้
anchorColPosIntegerที่ด้านบนของตัวควบคุมตัวกรองจะตรึงอยู่ในคอลัมน์นี้
offsetXIntegerค่าออฟเซ็ตแนวนอนจากมุมของเซลล์ หน่วยเป็นพิกเซล
offsetYIntegerค่าออฟเซ็ตแนวตั้งจากมุมเซลล์ หน่วยเป็นพิกเซล

รีเทิร์น

Slicer — ตัวควบคุมตัวกรองที่แทรกใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

isColumnHiddenByUser(columnPosition)

แสดงผลว่าผู้ใช้ซ่อนคอลัมน์ที่ระบุหรือไม่

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตําแหน่งของคอลัมน์ที่จะตรวจสอบ

รีเทิร์น

Booleantrue หากคอลัมน์ซ่อนอยู่ ให้ false ในกรณีอื่นๆ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

isRightToLeft()

แสดงผล true ถ้าเลย์เอาต์ชีตนี้เป็นแบบขวาไปซ้าย แสดงผล 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to the console.
console.log(sheet.isRightToLeft());

รีเทิร์น

Booleantrue หากอ่านจากขวาไปซ้าย หรืออีก false แถว

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

isRowHiddenByFilter(rowPosition)

แสดงผลว่าแถวที่ระบุถูกซ่อนโดยตัวกรองหรือไม่ (ไม่ใช่มุมมองตัวกรอง)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตําแหน่งของแถวที่จะตรวจสอบ

รีเทิร์น

Booleantrue หากซ่อนแถว ให้ false ในกรณีอื่นๆ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

isRowHiddenByUser(rowPosition)

แสดงผลว่าผู้ใช้ซ่อนแถวที่ระบุหรือไม่

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตําแหน่งของแถวที่จะตรวจสอบ

รีเทิร์น

Booleantrue หากซ่อนแถว ให้ false ในกรณีอื่นๆ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

isSheetHidden()

แสดงผล true หากแผ่นงานซ่อนอยู่

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

รีเทิร์น

Booleantrue หากซ่อนชีตไว้ ให้ false แทน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

moveColumns(columnSpec, destinationIndex)

ย้ายคอลัมน์ที่เลือกโดยช่วงที่ระบุไปยังตำแหน่งที่ระบุโดย destinationIndex ตัว columnSpec ไม่จำเป็นต้องแสดงครบทั้งคอลัมน์หรือกลุ่มคอลัมน์ที่จะย้าย แต่จะเลือกทุกคอลัมน์ที่ครอบคลุมช่วงนั้น

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnSpecRangeช่วงที่ครอบคลุมคอลัมน์ที่ควรย้าย
destinationIndexIntegerดัชนีที่ควรย้ายคอลัมน์ไป โปรดทราบว่าดัชนีนี้อิงจากพิกัดก่อนที่จะย้ายคอลัมน์ ระบบจะย้ายข้อมูลที่มีอยู่ไปทางขวาเพื่อเพิ่มที่ว่างสำหรับคอลัมน์ที่ย้าย และจะมีการนำคอลัมน์แหล่งที่มาออกจากตารางกริด ดังนั้น ข้อมูลอาจลงเอยที่ดัชนีแตกต่างจากที่ระบุไว้แต่แรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

moveRows(rowSpec, destinationIndex)

ย้ายแถวที่เลือกโดยช่วงที่ระบุไปยังตำแหน่งที่ระบุโดย destinationIndex ตัว rowSpec ไม่จำเป็นต้องแสดงครบทั้งแถวหรือกลุ่มแถวที่จะย้าย แต่จะเลือกทุกแถวที่ครอบคลุมช่วงนั้น

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowSpecRangeช่วงที่ครอบคลุมแถวที่ควรย้าย
destinationIndexIntegerดัชนีที่แถวควรย้ายไป โปรดทราบว่าดัชนีนี้จะอิงตามพิกัดก่อนที่จะย้ายแถว ระบบจะย้ายข้อมูลที่มีอยู่ลงเพื่อเพิ่มพื้นที่ให้กับแถวที่ย้าย และจะนําแถวต้นทางออกจากตารางกริด ดังนั้น ข้อมูลอาจลงเอยที่ดัชนีที่ต่างจากที่ระบุไว้แต่แรก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

newChart()

แสดงตัวสร้างเพื่อสร้างแผนภูมิใหม่สำหรับชีตนี้

ตัวอย่างนี้แสดงวิธีสร้างแผนภูมิใหม่

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

รีเทิร์น

EmbeddedChartBuilder — เครื่องมือสร้างแผนภูมิใหม่


protect()

สร้างออบเจ็กต์ที่ป้องกันไม่ให้แก้ไขชีตได้ ยกเว้นผู้ใช้ที่มีสิทธิ์ สิทธิ์จะมิเรอร์รายการของสเปรดชีตจนกว่าสคริปต์จะเปลี่ยนรายชื่อเอดิเตอร์ของชีต (โดยการเรียกใช้ Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) หรือตั้งค่าใหม่สำหรับ Protection.setDomainEdit(editable)) สิทธิ์จะมิเรอร์ของสเปรดชีตนั้น ซึ่งหมายความว่าชีตจะไม่มีการป้องกัน หากชีตมีการป้องกันอยู่แล้ว วิธีนี้จะแสดงผลออบเจ็กต์ที่แสดงการตั้งค่าการป้องกันที่มีอยู่ ชีตที่มีการป้องกันอาจมีส่วนที่ไม่มีการป้องกัน

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

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

รีเทิร์น

Protection — ออบเจ็กต์ที่แสดงการตั้งค่าการป้องกัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

removeChart(chart)

นำแผนภูมิออกจากชีตหลัก

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
chartEmbeddedChartแผนภูมิที่จะนำออก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setActiveRange(range)

ตั้งค่าช่วงที่ระบุเป็น active range ในชีตที่ใช้งานอยู่ โดยเซลล์ซ้ายบนสุดของช่วงเป็น current cell

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่จะตั้งค่าเป็นช่วงที่ใช้งานอยู่

รีเทิร์น

Range — ช่วงที่มีการใช้งานใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setActiveRangeList(rangeList)

ตั้งค่ารายการช่วงที่ระบุเป็น active ranges ในชีตที่ใช้งานอยู่ ช่วงสุดท้ายในรายการถูกตั้งค่าเป็น active range

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeListRangeListรายการช่วงที่จะเลือก

รีเทิร์น

RangeList — รายการช่วงที่เลือกใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setActiveSelection(range)

ตั้งค่าเขตการเลือกที่ใช้งานอยู่สำหรับชีตนี้

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่จะตั้งค่าเป็นการเลือกที่ใช้งานอยู่

รีเทิร์น

Range — ช่วงที่มีการใช้งานใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setActiveSelection(a1Notation)

ตั้งค่าการเลือกที่ใช้งานอยู่ ตามที่ระบุในรูปแบบ A1 หรือสัญลักษณ์ R1C1

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

sheet.setActiveSelection("A1:D4");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
a1NotationStringช่วงที่จะตั้งค่าเป็นใช้งานอยู่ตามที่ระบุไว้ในรูปแบบ A1 หรือ R1C1

รีเทิร์น

Range — ช่วงที่มีการใช้งานใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setColumnGroupControlPosition(position)

กำหนดตำแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มคอลัมน์ในชีต

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
positionGroupControlTogglePositionตําแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มคอลัมน์

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setColumnWidth(columnPosition, width)

ตั้งค่าความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตําแหน่งของคอลัมน์ที่กําหนดที่จะตั้งค่า
widthIntegerความกว้างเป็นพิกเซลที่ต้องการกำหนด

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setColumnWidths(startColumn, numColumns, width)

ตั้งค่าความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startColumnIntegerตำแหน่งคอลัมน์เริ่มต้นที่จะเปลี่ยน
numColumnsIntegerจำนวนคอลัมน์ที่จะเปลี่ยน
widthIntegerความกว้างเป็นพิกเซลที่ต้องการกำหนด

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setConditionalFormatRules(rules)

แทนที่กฎการจัดรูปแบบตามเงื่อนไขที่มีอยู่ทั้งหมดในชีตด้วยกฎอินพุต ระบบจะประเมินกฎตามลำดับการป้อนข้อมูล

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rulesConditionalFormatRule[]กฎการจัดรูปแบบตามเงื่อนไขใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setCurrentCell(cell)

ตั้งค่าเซลล์ที่ระบุเป็น current cell

ถ้าเซลล์ที่ระบุอยู่ในช่วงที่เลือกไว้แล้ว ช่วงนั้นจะกลายเป็นช่วงที่ใช้งานอยู่โดยมีเซลล์นั้นเป็นเซลล์ปัจจุบัน

หากเซลล์ที่ระบุไม่อยู่ในช่วงที่เลือก ระบบจะนำการเลือกที่มีอยู่ออก และเซลล์นั้นจะกลายเป็นเซลล์ปัจจุบันและช่วงที่ใช้งานอยู่

หมายเหตุ:Range ที่ระบุต้องประกอบด้วยเซลล์เดียว มิฉะนั้นจะมีข้อยกเว้น

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
cellRangeเซลล์ที่จะตั้งค่าเป็นเซลล์ปัจจุบัน

รีเทิร์น

Range — เซลล์ปัจจุบันที่ตั้งใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setFrozenColumns(columns)

ตรึงจำนวนคอลัมน์ที่ระบุ หากเป็น 0 จะไม่มีคอลัมน์ที่ตรึงไว้

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnsIntegerจำนวนคอลัมน์ที่จะตรึง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setFrozenRows(rows)

ตรึงจำนวนแถวที่ระบุ หาก 0 จะไม่มีการตรึงแถว

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowsIntegerจำนวนแถวที่จะตรึง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setHiddenGridlines(hideGridlines)

ซ่อนหรือแสดงเส้นตารางของชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
hideGridlinesBooleanหากเป็น true ให้ซ่อนเส้นตารางในชีตนี้ มิเช่นนั้นให้แสดงเส้นตาราง

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setName(name)

ตั้งชื่อชีต

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อใหม่ของชีต

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setRightToLeft(rightToLeft)

ตั้งค่าหรือยกเลิกการตั้งค่าเลย์เอาต์ชีตเป็นแบบขวาไปซ้าย

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

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

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rightToLeftBooleanหากตั้งค่าเป็น true ระบบจะตั้งค่าเลย์เอาต์ชีตเป็นแบบขวาไปซ้าย โดยมีเซลล์ A1 ที่มุมขวาบน หากค่าเป็น false เลย์เอาต์ชีตจะเป็นค่าเริ่มต้นจากซ้ายไปขวา โดยมีเซลล์ A1 อยู่ที่ด้านซ้ายบน

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setRowGroupControlPosition(position)

กำหนดตำแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มแถวในชีต

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
positionGroupControlTogglePositionตําแหน่งของปุ่มเปิด/ปิดการควบคุมกลุ่มแถว

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setRowHeight(rowPosition, height)

กำหนดความสูงของแถวแนวนอนของแถวที่ระบุเป็นพิกเซล โดยค่าเริ่มต้น แถวจะขยายให้พอดีกับเนื้อหาของเซลล์ หากต้องการบังคับให้แถวมีความสูงที่ระบุ ให้ใช้ setRowHeightsForced(startRow, numRows, height)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตําแหน่งของแถวที่จะเปลี่ยน
heightIntegerความสูงเป็นพิกเซลที่จะตั้งค่า

รีเทิร์น

Sheet — ชีต ซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setRowHeights(startRow, numRows, height)

กำหนดความสูงของแถวที่ระบุเป็นพิกเซล โดยค่าเริ่มต้น แถวจะขยายให้พอดีกับเนื้อหาของเซลล์ หากต้องการบังคับให้แถวมีความสูงที่ระบุ ให้ใช้ setRowHeightsForced(startRow, numRows, height)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startRowIntegerตําแหน่งของแถวเริ่มต้นที่จะเปลี่ยน
numRowsIntegerจำนวนแถวที่จะเปลี่ยน
heightIntegerความสูงเป็นพิกเซลที่จะตั้งค่า

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setRowHeightsForced(startRow, numRows, height)

กำหนดความสูงของแถวที่ระบุเป็นพิกเซล โดยค่าเริ่มต้น แถวจะขยายให้พอดีกับเนื้อหาของเซลล์ เมื่อใช้ setRowHeightsForced ระบบจะบังคับแถวตามความสูงที่ระบุแม้ว่าเนื้อหาในเซลล์จะสูงกว่าความสูงของแถว

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startRowIntegerตําแหน่งของแถวเริ่มต้นที่จะเปลี่ยน
numRowsIntegerจำนวนแถวที่จะเปลี่ยน
heightIntegerความสูงเป็นพิกเซลที่จะตั้งค่า

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setTabColor(color)

ตั้งค่าสีแท็บของชีต

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorStringโค้ดสีในรูปแบบ CSS (เช่น '#ffffff' หรือ 'white') หรือ null เพื่อรีเซ็ตสีแท็บ

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setTabColorObject(color)

ตั้งค่าสีแท็บของชีต

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorColorสีแท็บแผ่นงานเพื่อตั้งค่า

รีเทิร์น

Sheet — ชีตนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

showColumns(columnIndex)

เลิกซ่อนคอลัมน์ที่ดัชนีที่กำหนด

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีของคอลัมน์ที่จะเลิกซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

showColumns(columnIndex, numColumns)

เลิกซ่อนคอลัมน์ตั้งแต่ 1 คอลัมน์ขึ้นไปที่ต่อเนื่องกันโดยเริ่มจากดัชนีที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnIndexIntegerดัชนีเริ่มต้นของคอลัมน์ที่จะเลิกซ่อน
numColumnsIntegerจำนวนคอลัมน์ที่จะเลิกซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

showRows(rowIndex)

เลิกซ่อนแถวที่ดัชนีที่กำหนด

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีของแถวที่จะเลิกซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

showRows(rowIndex, numRows)

เลิกซ่อนแถวที่ติดกันอย่างน้อย 1 แถวโดยเริ่มจากดัชนีที่ระบุ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowIndexIntegerดัชนีเริ่มต้นของแถวที่จะเลิกซ่อน
numRowsIntegerจำนวนแถวที่จะเลิกซ่อน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

showSheet()

ทำให้แผ่นงานปรากฏ หากแผ่นงานปรากฏขึ้นอยู่แล้วจะไม่มีผลใดๆ

var sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

รีเทิร์น

Sheet — แผ่นงานปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

sort(columnPosition)

จัดเรียงชีตตามคอลัมน์จากน้อยไปมาก

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerคอลัมน์ที่จะจัดเรียง

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

sort(columnPosition, ascending)

จัดเรียงชีตตามคอลัมน์ ใช้พารามิเตอร์เพื่อระบุจากน้อยไปมากหรือมากไปน้อย

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerคอลัมน์ที่จะจัดเรียง
ascendingBooleantrue สำหรับการเรียงจากน้อยไปมาก false สำหรับมากไปน้อย

รีเทิร์น

Sheet — ชีตซึ่งมีประโยชน์สำหรับการทำเชนเมธอด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

unhideColumn(column)

เลิกซ่อนคอลัมน์ในช่วงที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnRangeช่วงที่จะเลิกซ่อน หากซ่อนไว้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

unhideRow(row)

เลิกซ่อนแถวในช่วงที่กำหนด

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowRangeช่วงที่จะเลิกซ่อน หากซ่อนไว้

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

updateChart(chart)

อัปเดตแผนภูมิในชีตนี้

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
chartEmbeddedChartแผนภูมิที่จะอัปเดต

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

วิธีการที่เลิกใช้งานแล้ว