Class Range

ช่วง

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

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
activate()Rangeตั้งค่าช่วงที่ระบุเป็น active range โดยเซลล์ซ้ายบนสุดของช่วงเป็น current cell
activateAsCurrentCell()Rangeตั้งค่าเซลล์ที่ระบุเป็น current cell
addDeveloperMetadata(key)Rangeเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุลงในช่วง
addDeveloperMetadata(key, visibility)Rangeเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุและระดับการเข้าถึงในช่วง
addDeveloperMetadata(key, value)Rangeเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่มีคีย์และค่าที่ระบุลงในช่วง
addDeveloperMetadata(key, value, visibility)Rangeเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่มีคีย์ ค่า และระดับการเข้าถึงที่ระบุไปยังช่วง
applyColumnBanding()Bandingใช้ธีมการรวมกลุ่มคอลัมน์เริ่มต้นกับช่วง
applyColumnBanding(bandingTheme)Bandingใช้ธีมการรวมกลุ่มคอลัมน์ที่ระบุกับช่วง
applyColumnBanding(bandingTheme, showHeader, showFooter)Bandingใช้ธีมแถบคอลัมน์ที่ระบุกับช่วงที่มีการตั้งค่าส่วนหัวและส่วนท้ายที่ระบุไว้
applyRowBanding()Bandingใช้ธีมแถบแถวเริ่มต้นกับช่วง
applyRowBanding(bandingTheme)Bandingใช้ธีมแถบแถวที่ระบุกับช่วง
applyRowBanding(bandingTheme, showHeader, showFooter)Bandingใช้ธีมแถบแถวที่ระบุกับช่วงที่มีการตั้งค่าส่วนหัวและส่วนท้ายที่ระบุ
autoFill(destination, series)voidเติม destinationRange ด้วยข้อมูลตามข้อมูลในช่วงนี้
autoFillToNeighbor(series)voidคำนวณช่วงเพื่อเติมข้อมูลใหม่ตามเซลล์ข้างเคียง และเติมค่าใหม่ในช่วงนั้นโดยอัตโนมัติ ตามข้อมูลที่มีในช่วงนี้
breakApart()Rangeแบ่งเซลล์ที่มีหลายคอลัมน์ในช่วงให้เป็นเซลล์เดี่ยวอีกครั้ง
canEdit()Booleanกำหนดว่าผู้ใช้มีสิทธิ์แก้ไขทุกเซลล์ในช่วงหรือไม่
check()Rangeเปลี่ยนสถานะของช่องทำเครื่องหมายในช่วงเป็น "เลือกแล้ว"
clear()Rangeล้างช่วงเนื้อหาและรูปแบบ
clear(options)Rangeล้างช่วงของเนื้อหา รูปแบบ กฎการตรวจสอบข้อมูล และ/หรือความคิดเห็น ตามที่ระบุด้วยตัวเลือกขั้นสูงที่กำหนด
clearContent()Rangeล้างเนื้อหาของช่วงโดยคงการจัดรูปแบบไว้เหมือนเดิม
clearDataValidations()Rangeล้างกฎการตรวจสอบข้อมูลสำหรับช่วงดังกล่าว
clearFormat()Rangeล้างการจัดรูปแบบสำหรับช่วงนี้
clearNote()Rangeล้างบันทึกในเซลล์ที่ระบุ
collapseGroups()Rangeยุบกลุ่มทั้งหมดที่อยู่ในช่วง
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidคัดลอกการจัดรูปแบบของช่วงไปยังตำแหน่งที่กำหนด
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidคัดลอกการจัดรูปแบบของช่วงไปยังตำแหน่งที่กำหนด
copyTo(destination)voidคัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น
copyTo(destination, copyPasteType, transposed)voidคัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น
copyTo(destination, options)voidคัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidคัดลอกเนื้อหาของช่วงไปยังตําแหน่งที่ระบุ
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidคัดลอกเนื้อหาของช่วงไปยังตําแหน่งที่ระบุ
createDataSourcePivotTable(dataSource)DataSourcePivotTableสร้างตาราง Pivot ของแหล่งข้อมูลที่ว่างเปล่าจากแหล่งข้อมูล โดยตรึงไว้ที่เซลล์แรกของช่วงนี้
createDataSourceTable(dataSource)DataSourceTableสร้างตารางแหล่งข้อมูลที่ว่างเปล่าจากแหล่งข้อมูล โดยตรึงไว้ที่เซลล์แรกในช่วงนี้
createDeveloperMetadataFinder()DeveloperMetadataFinderแสดงผล DeveloperMetadataFinderApi สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของช่วงนี้
createFilter()Filterสร้างตัวกรองและนำไปใช้กับช่วงที่ระบุในชีต
createPivotTable(sourceData)PivotTableสร้างตาราง Pivot เปล่าจาก sourceData ที่ระบุโดยตรึงไว้ที่เซลล์แรกของช่วงนี้
createTextFinder(findText)TextFinderสร้างเครื่องมือค้นหาข้อความสำหรับช่วง ซึ่งสามารถค้นหาและแทนที่ข้อความในช่วงนี้ได้
deleteCells(shiftDimension)voidลบช่วงของเซลล์นี้
expandGroups()Rangeขยายกลุ่มที่ยุบซึ่งมีช่วงหรือปุ่มสลับการควบคุมตัดกับช่วงนี้
getA1Notation()Stringแสดงผลคำอธิบายสตริงของช่วงในรูปแบบ A1
getBackground()Stringแสดงผลสีพื้นหลังของเซลล์ด้านบนซ้ายของช่วง (เช่น '#ffffff')
getBackgroundObject()Colorแสดงผลสีพื้นหลังของเซลล์ด้านบนซ้ายของช่วง
getBackgroundObjects()Color[][]แสดงผลสีพื้นหลังของเซลล์ในช่วง
getBackgrounds()String[][]แสดงผลสีพื้นหลังของเซลล์ในช่วง (เช่น '#ffffff')
getBandings()Banding[]แสดงแถบสีทั้งหมดที่ใช้กับเซลล์ในช่วงนี้
getCell(row, column)Rangeแสดงผลเซลล์ที่ระบุภายในช่วง
getColumn()Integerแสดงผลตำแหน่งคอลัมน์เริ่มต้นสำหรับช่วงนี้
getDataRegion()Rangeแสดงผลสำเนาของช่วงที่ขยายใน Direction คาร์ดินัลทั้ง 4 เซลล์ให้ครอบคลุมเซลล์ที่ใกล้เคียงกันทั้งหมดที่มีข้อมูล
getDataRegion(dimension)Rangeแสดงผลสำเนาของช่วงที่ขยาย Direction.UP และ Direction.DOWN หากมิติข้อมูลที่ระบุคือ Dimension.ROWS หรือ Direction.NEXT และ Direction.PREVIOUS หากมิติข้อมูลเป็น Dimension.COLUMNS
getDataSourceFormula()DataSourceFormulaแสดงผล DataSourceFormula สำหรับเซลล์แรกของช่วง หรือ null หากเซลล์ไม่มีสูตรแหล่งข้อมูล
getDataSourceFormulas()DataSourceFormula[]แสดงผล DataSourceFormula ของเซลล์ในช่วง
getDataSourcePivotTables()DataSourcePivotTable[]เรียกตาราง Pivot ของแหล่งข้อมูลทั้งหมดซ้อนทับกับช่วง
getDataSourceTables()DataSourceTable[]เรียกตารางแหล่งข้อมูลทั้งหมดซ้อนทับกับช่วง
getDataSourceUrl()Stringแสดงผล URL สำหรับข้อมูลในช่วงนี้ ซึ่งสามารถใช้เพื่อสร้างแผนภูมิและข้อความค้นหา
getDataTable()DataTableแสดงผลข้อมูลภายในออบเจ็กต์นี้เป็น DataTable
getDataTable(firstRowIsHeader)DataTableแสดงผลข้อมูลภายในช่วงนี้เป็น DataTable
getDataValidation()DataValidationแสดงผลกฎการตรวจสอบข้อมูลสำหรับเซลล์ซ้ายบนของช่วง
getDataValidations()DataValidation[][]แสดงผลกฎการตรวจสอบข้อมูลสำหรับเซลล์ทั้งหมดในช่วง
getDeveloperMetadata()DeveloperMetadata[]รับข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับช่วงนี้
getDisplayValue()Stringแสดงผลค่าที่แสดงของเซลล์ซ้ายบนของช่วง
getDisplayValues()String[][]แสดงผลค่าตารางกริดสี่เหลี่ยมผืนผ้าสำหรับช่วงนี้
getFilter()Filterแสดงผลตัวกรองในชีตซึ่งมีช่วงนี้ หรือ null หากไม่มีตัวกรองในชีต
getFontColorObject()Colorแสดงผลสีแบบอักษรของเซลล์ที่มุมซ้ายบนของช่วง
getFontColorObjects()Color[][]แสดงผลสีแบบอักษรของเซลล์ในช่วง
getFontFamilies()String[][]แสดงผลชุดแบบอักษรของเซลล์ในช่วง
getFontFamily()Stringแสดงผลชุดแบบอักษรของเซลล์ที่มุมซ้ายบนของช่วง
getFontLine()Stringรับรูปแบบเส้นของเซลล์ที่มุมซ้ายบนของช่วง ('underline', 'line-through' หรือ 'none')
getFontLines()String[][]รับรูปแบบเส้นของเซลล์ในช่วง ('underline', 'line-through' หรือ 'none')
getFontSize()Integerแสดงขนาดแบบอักษรเป็นขนาดจุดของเซลล์ที่มุมซ้ายบนของช่วง
getFontSizes()Integer[][]แสดงขนาดแบบอักษรของเซลล์ในช่วง
getFontStyle()Stringแสดงผลรูปแบบแบบอักษร ('italic' หรือ 'normal') ของเซลล์ที่มุมซ้ายบนของช่วง
getFontStyles()String[][]แสดงผลรูปแบบแบบอักษรของเซลล์ในช่วง
getFontWeight()Stringแสดงน้ำหนักตัวอักษร (ปกติ/ตัวหนา) ของเซลล์ที่มุมบนซ้ายของช่วง
getFontWeights()String[][]แสดงผลน้ำหนักแบบอักษรของเซลล์ในช่วง
getFormula()Stringแสดงผลสูตร (สัญลักษณ์ A1) สำหรับเซลล์ซ้ายบนของช่วง หรือสตริงว่างหากเซลล์ว่างหรือไม่มีสูตร
getFormulaR1C1()Stringจะแสดงผลสูตร (สัญลักษณ์ R1C1) สำหรับเซลล์ที่ระบุหรือ null หากไม่มี
getFormulas()String[][]แสดงผลสูตร (สัญลักษณ์ A1) สำหรับเซลล์ในช่วง
getFormulasR1C1()String[][]แสดงผลสูตร (สัญลักษณ์ R1C1) สำหรับเซลล์ในช่วง
getGridId()Integerแสดงผลรหัสตารางกริดของชีตระดับบนสุดของช่วง
getHeight()Integerแสดงความสูงของช่วง
getHorizontalAlignment()Stringส่งคืนการจัดข้อความแนวนอน (ซ้าย/กลาง/ขวา) ของเซลล์ที่มุมซ้ายบนของช่วง
getHorizontalAlignments()String[][]ส่งคืนการจัดข้อความแนวนอนของเซลล์ในช่วง
getLastColumn()Integerแสดงผลตำแหน่งคอลัมน์สิ้นสุด
getLastRow()Integerแสดงตำแหน่งของแถวสิ้นสุด
getMergedRanges()Range[]แสดงผลอาร์เรย์ของออบเจ็กต์ Range ที่แทนเซลล์ที่ผสานกันซึ่งอยู่ภายในช่วงปัจจุบันทั้งหมด หรือมีอย่างน้อย 1 เซลล์ในช่วงปัจจุบัน
getNextDataCell(direction)Rangeเริ่มจากเซลล์ในคอลัมน์แรกและแถวแรกของช่วง แสดงผลเซลล์ถัดไปในทิศทางที่ระบุซึ่งเป็นขอบของช่วงที่อยู่ต่อเนื่องของเซลล์ที่มีข้อมูลอยู่ในเซลล์นั้น หรือเซลล์ที่ขอบของสเปรดชีตในทิศทางนั้น
getNote()Stringแสดงผลบันทึกที่เชื่อมโยงกับช่วงที่ระบุ
getNotes()String[][]แสดงผลบันทึกที่เชื่อมโยงกับเซลล์ในช่วง
getNumColumns()Integerแสดงผลจำนวนคอลัมน์ในช่วงนี้
getNumRows()Integerแสดงผลจำนวนแถวในช่วงนี้
getNumberFormat()Stringดูการจัดรูปแบบตัวเลขหรือวันที่ในเซลล์ซ้ายบนของช่วงที่ระบุ
getNumberFormats()String[][]แสดงผลรูปแบบตัวเลขหรือวันที่สำหรับเซลล์ในช่วง
getRichTextValue()RichTextValueแสดงผลค่า Rich Text สำหรับเซลล์ซ้ายบนของช่วง หรือ null หากค่าของเซลล์ไม่ใช่ข้อความ
getRichTextValues()RichTextValue[][]แสดงผลค่า Rich Text สำหรับเซลล์ในช่วง
getRow()Integerแสดงตำแหน่งแถวสำหรับช่วงนี้
getRowIndex()Integerแสดงตำแหน่งแถวสำหรับช่วงนี้
getSheet()Sheetแสดงผลแผ่นงานของช่วงนี้
getTextDirection()TextDirectionแสดงทิศทางข้อความในเซลล์ซ้ายบนของช่วง
getTextDirections()TextDirection[][]แสดงผลเส้นทางข้อความสำหรับเซลล์ในช่วง
getTextRotation()TextRotationแสดงผลการตั้งค่าการหมุนข้อความสำหรับเซลล์ซ้ายบนสุดของช่วง
getTextRotations()TextRotation[][]แสดงผลการตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง
getTextStyle()TextStyleแสดงผลรูปแบบข้อความในเซลล์ซ้ายบนสุดของช่วง
getTextStyles()TextStyle[][]แสดงผลรูปแบบข้อความสำหรับเซลล์ในช่วง
getValue()Objectแสดงผลค่าของเซลล์ด้านบนซ้ายของช่วง
getValues()Object[][]แสดงผลค่าตารางกริดสี่เหลี่ยมผืนผ้าสำหรับช่วงนี้
getVerticalAlignment()Stringแสดงผลการจัดแนวแนวตั้ง (บน/กลาง/ล่าง) ของเซลล์ที่มุมบนซ้ายของช่วง
getVerticalAlignments()String[][]ส่งคืนการจัดข้อความแนวตั้งของเซลล์ในช่วง
getWidth()Integerแสดงผลความกว้างของช่วงในคอลัมน์
getWrap()Booleanแสดงผลว่าข้อความในเซลล์ตัดข้อความหรือไม่
getWrapStrategies()WrapStrategy[][]แสดงผลกลยุทธ์การตัดข้อความสำหรับเซลล์ในช่วง
getWrapStrategy()WrapStrategyแสดงกลยุทธ์การตัดข้อความสำหรับเซลล์ซ้ายบนของช่วง
getWraps()Boolean[][]แสดงผลว่าข้อความในเซลล์ตัดข้อมูลหรือไม่
insertCells(shiftDimension)Rangeแทรกเซลล์ว่างในช่วงนี้
insertCheckboxes()Rangeแทรกช่องทำเครื่องหมายลงในแต่ละเซลล์ในช่วง กำหนดค่าด้วย true สำหรับรายการที่เลือก และ false สำหรับการเลือก
insertCheckboxes(checkedValue)Rangeแทรกช่องทำเครื่องหมายลงในแต่ละเซลล์ในช่วง ซึ่งกำหนดค่าด้วยค่าที่กำหนดเองสำหรับการทำเครื่องหมาย และสตริงว่างสำหรับยกเลิกการเลือก
insertCheckboxes(checkedValue, uncheckedValue)Rangeแทรกช่องทำเครื่องหมายลงในแต่ละเซลล์ของช่วง โดยกำหนดค่าด้วยค่าที่กำหนดเองสำหรับสถานะ "เลือกแล้ว" และ "ไม่เลือก"
isBlank()Booleanแสดงผล true หากช่วงว่างเปล่า
isChecked()Booleanจะแสดงผลว่าทุกเซลล์ในช่วงมีสถานะช่องทำเครื่องหมายเป็น "ทำเครื่องหมายแล้ว" หรือไม่
isEndColumnBounded()Booleanกำหนดว่าจุดสิ้นสุดของช่วงเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่งหรือไม่
isEndRowBounded()Booleanกำหนดว่าจุดสิ้นสุดของช่วงเชื่อมโยงกับแถวใดแถวหนึ่งหรือไม่
isPartOfMerge()Booleanแสดงผล true ถ้าเซลล์ในช่วงปัจจุบันซ้อนทับกับเซลล์ที่ผสาน
isStartColumnBounded()Booleanพิจารณาว่าจุดเริ่มต้นของช่วงเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่งหรือไม่
isStartRowBounded()Booleanพิจารณาว่าจุดเริ่มต้นของช่วงเชื่อมโยงกับแถวใดแถวหนึ่งหรือไม่
merge()Rangeผสานเซลล์ในช่วงเข้าด้วยกันเป็นบล็อกเดียว
mergeAcross()Rangeผสานเซลล์ในช่วงระหว่างคอลัมน์ต่างๆ ของช่วง
mergeVertically()Rangeผสานเซลล์ในช่วงเข้าด้วยกัน
moveTo(target)voidตัดและวาง (ทั้งรูปแบบและค่า) จากช่วงนี้ไปยังช่วงเป้าหมาย
offset(rowOffset, columnOffset)Rangeแสดงผลช่วงใหม่ที่มีการออฟเซ็ตจากช่วงนี้ตามจำนวนแถวและคอลัมน์ที่กำหนด (ซึ่งอาจเป็นค่าลบ)
offset(rowOffset, columnOffset, numRows)Rangeแสดงผลช่วงใหม่ที่สัมพันธ์กับช่วงปัจจุบัน ซึ่งมีจุดซ้ายบนชดเชยจากช่วงปัจจุบันตามแถวและคอลัมน์ที่ระบุ และด้วยความสูงที่ระบุในเซลล์
offset(rowOffset, columnOffset, numRows, numColumns)Rangeแสดงผลช่วงใหม่ที่สัมพันธ์กับช่วงปัจจุบัน ซึ่งมีจุดซ้ายบนออฟเซ็ตจากช่วงปัจจุบันด้วยแถวและคอลัมน์ที่ระบุ และด้วยความสูงและความกว้างที่กำหนดในเซลล์
protect()Protectionสร้างออบเจ็กต์ที่ป้องกันไม่ให้แก้ไขช่วงได้ ยกเว้นผู้ใช้ที่มีสิทธิ์
randomize()Rangeสุ่มลำดับของแถวในช่วงที่กำหนด
removeCheckboxes()Rangeนำช่องทำเครื่องหมายทั้งหมดออกจากช่วง
removeDuplicates()Rangeนำแถวภายในช่วงนี้ที่มีค่าซ้ำกับค่าในแถวก่อนหน้าออก
removeDuplicates(columnsToCompare)Rangeนำแถวภายในช่วงนี้ที่มีค่าในคอลัมน์ที่ระบุซึ่งซ้ำกับค่าในแถวก่อนหน้าออก
setBackground(color)Rangeตั้งค่าสีพื้นหลังของทุกเซลล์ในช่วงในรูปแบบสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white')
setBackgroundObject(color)Rangeตั้งค่าสีพื้นหลังของเซลล์ทั้งหมดในช่วง
setBackgroundObjects(color)Rangeตั้งค่าสีพื้นหลังเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setBackgroundRGB(red, green, blue)Rangeตั้งค่าพื้นหลังเป็นสีที่ระบุโดยใช้ค่า RGB (จำนวนเต็มตั้งแต่ 0 ถึง 255)
setBackgrounds(color)Rangeตั้งค่าสีพื้นหลังเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setBorder(top, left, bottom, right, vertical, horizontal)Rangeตั้งค่าคุณสมบัติเส้นขอบ
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Rangeตั้งค่าคุณสมบัติเส้นขอบด้วยสีและ/หรือรูปแบบ
setDataValidation(rule)Rangeตั้งกฎการตรวจสอบข้อมูล 1 ข้อให้กับทุกเซลล์ในช่วง
setDataValidations(rules)Rangeตั้งกฎการตรวจสอบข้อมูลสำหรับเซลล์ทั้งหมดในช่วง
setFontColor(color)Rangeตั้งค่าสีแบบอักษรในรูปแบบ CSS (เช่น '#ffffff' หรือ 'white')
setFontColorObject(color)Rangeตั้งค่าสีแบบอักษรของช่วงที่ระบุ
setFontColorObjects(colors)Rangeตั้งค่าตารางสีแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setFontColors(colors)Rangeตั้งค่าตารางสีแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setFontFamilies(fontFamilies)Rangeตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของชุดแบบอักษร (ต้องตรงกับขนาดของช่วงนี้)
setFontFamily(fontFamily)Rangeตั้งค่าชุดแบบอักษร เช่น "Arial" หรือ "Helvetica"
setFontLine(fontLine)Rangeตั้งค่ารูปแบบเส้นแบบอักษรของช่วงที่ระบุ ('underline', 'line-through' หรือ 'none')
setFontLines(fontLines)Rangeตั้งค่าตารางสี่เหลี่ยมผืนผ้าของรูปแบบเส้น (ต้องตรงกับขนาดของช่วงนี้)
setFontSize(size)Rangeตั้งค่าขนาดแบบอักษร โดยขนาดคือขนาดของจุดที่จะใช้
setFontSizes(sizes)Rangeตั้งค่าขนาดแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setFontStyle(fontStyle)Rangeตั้งค่ารูปแบบตัวอักษรสำหรับช่วงที่ระบุ ('italic' หรือ 'normal')
setFontStyles(fontStyles)Rangeตั้งค่าตารางสี่เหลี่ยมผืนผ้าตามรูปแบบตัวอักษร (ต้องตรงกับขนาดของช่วงนี้)
setFontWeight(fontWeight)Rangeกําหนดน้ำหนักแบบอักษรสําหรับช่วงที่ระบุ (ปกติ/ตัวหนา)
setFontWeights(fontWeights)Rangeตั้งค่าตารางน้ำหนักแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)
setFormula(formula)Rangeอัปเดตสูตรสำหรับช่วงนี้
setFormulaR1C1(formula)Rangeอัปเดตสูตรสำหรับช่วงนี้
setFormulas(formulas)Rangeตั้งค่าตารางสูตรเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติข้อมูลของช่วงนี้)
setFormulasR1C1(formulas)Rangeตั้งค่าตารางสูตรเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติข้อมูลของช่วงนี้)
setHorizontalAlignment(alignment)Rangeตั้งค่าการจัดข้อความแนวนอน (ซ้ายไปขวา) สำหรับช่วงที่ระบุ (ซ้าย/กลาง/ขวา)
setHorizontalAlignments(alignments)Rangeตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าที่มีการจัดข้อความแนวนอน
setNote(note)Rangeตั้งค่าโน้ตเป็นค่าที่ระบุ
setNotes(notes)Rangeตั้งค่าตารางบันทึกสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติของช่วงนี้)
setNumberFormat(numberFormat)Rangeตั้งค่ารูปแบบตัวเลขหรือวันที่เป็นสตริงการจัดรูปแบบที่กำหนด
setNumberFormats(numberFormats)Rangeตั้งค่าตารางรูปสี่เหลี่ยมผืนผ้าของรูปแบบตัวเลขหรือรูปแบบ (ต้องตรงกับมิติข้อมูลของช่วงนี้)
setRichTextValue(value)Rangeตั้งค่า Rich Text สำหรับเซลล์ในช่วง
setRichTextValues(values)Rangeตั้งค่า Rich Text เป็นตารางสี่เหลี่ยมผืนผ้า
setShowHyperlink(showHyperlink)Rangeตั้งค่าว่าช่วงควรแสดงไฮเปอร์ลิงก์หรือไม่
setTextDirection(direction)Rangeกำหนดทิศทางข้อความสำหรับเซลล์ในช่วง
setTextDirections(directions)Rangeตั้งค่าตารางเส้นทางของข้อความเป็นสี่เหลี่ยมผืนผ้า
setTextRotation(degrees)Rangeตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง
setTextRotation(rotation)Rangeตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง
setTextRotations(rotations)Rangeตั้งค่าการหมุนข้อความเป็นสี่เหลี่ยมผืนผ้า
setTextStyle(style)Rangeตั้งค่ารูปแบบข้อความสำหรับเซลล์ในช่วง
setTextStyles(styles)Rangeตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าตามรูปแบบข้อความ
setValue(value)Rangeตั้งค่าของช่วง
setValues(values)Rangeตั้งค่าตารางค่าเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติของช่วงนี้)
setVerticalAlignment(alignment)Rangeตั้งค่าการจัดข้อความแนวตั้ง (บนลงล่าง) สำหรับช่วงที่กำหนด (บน/กลาง/ล่าง)
setVerticalAlignments(alignments)Rangeตั้งค่าตารางสี่เหลี่ยมผืนผ้าของการจัดแนวแนวตั้ง (ต้องตรงกับมิติของช่วงนี้)
setVerticalText(isVertical)Rangeตั้งค่าว่าจะซ้อนข้อความสำหรับเซลล์ในช่วงหรือไม่
setWrap(isWrapEnabled)Rangeตั้งค่าการตัดเซลล์ของช่วงที่ระบุ
setWrapStrategies(strategies)Rangeตั้งค่าตารางกลยุทธ์การตัดข้อความเป็นรูปสี่เหลี่ยมผืนผ้า
setWrapStrategy(strategy)Rangeตั้งค่ากลยุทธ์การตัดข้อความสำหรับเซลล์ในช่วง
setWraps(isWrapEnabled)Rangeตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของนโยบายการตัดคำ (ต้องตรงกับมิติข้อมูลของช่วงนี้)
shiftColumnGroupDepth(delta)Rangeเปลี่ยนความลึกในการจัดกลุ่มคอลัมน์ของช่วงตามจำนวนที่ระบุ
shiftRowGroupDepth(delta)Rangeเปลี่ยนความลึกในการจัดกลุ่มแถวของช่วงตามจำนวนที่ระบุ
sort(sortSpecObj)Rangeจัดเรียงเซลล์ในช่วงที่กำหนดตามคอลัมน์และลำดับที่ระบุ
splitTextToColumns()voidแบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์ตามตัวคั่นที่ตรวจพบอัตโนมัติ
splitTextToColumns(delimiter)voidแบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์โดยใช้สตริงที่ระบุเป็นตัวคั่นที่กำหนดเอง
splitTextToColumns(delimiter)voidแบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์ตามตัวคั่นที่ระบุ
trimWhitespace()Rangeตัดช่องว่าง (เช่น เว้นวรรค แท็บ หรือบรรทัดใหม่) ในทุกเซลล์ในช่วงนี้
uncheck()Rangeเปลี่ยนสถานะของช่องทำเครื่องหมายในช่วงเป็น "ยกเลิกการเลือกแล้ว"

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

activate()

ตั้งค่าช่วงที่ระบุเป็น active range โดยเซลล์ซ้ายบนสุดของช่วงเป็น current cell

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน


activateAsCurrentCell()

ตั้งค่าเซลล์ที่ระบุเป็น current cell

หากมีเซลล์ที่ระบุในช่วงที่มีอยู่ ช่วงดังกล่าวจะกลายเป็นช่วงที่มีการใช้งานโดยมีเซลล์นั้นเป็นเซลล์ปัจจุบัน

หากเซลล์ที่ระบุไม่อยู่ในช่วงที่มีอยู่ ระบบจะนำการเลือกที่มีอยู่ออก และเซลล์นั้นจะกลายเป็นเซลล์ปัจจุบันและช่วงที่ใช้งานอยู่

หมายเหตุ: Range ที่ระบุต้องประกอบด้วยเซลล์เดียว มิฉะนั้นจะมีข้อยกเว้น

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

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

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

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

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

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

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

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

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

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

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

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

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

applyColumnBanding()

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

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

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

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

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

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

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

รีเทิร์น

Banding — แถบสีแบบใหม่

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

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

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

applyColumnBanding(bandingTheme)

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

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

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
bandingThemeBandingThemeธีมสีที่นำไปใช้กับคอลัมน์ในช่วง

รีเทิร์น

Banding — แถบสีแบบใหม่

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

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

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

ใช้ธีมแถบคอลัมน์ที่ระบุกับช่วงที่มีการตั้งค่าส่วนหัวและส่วนท้ายที่ระบุไว้

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

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

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

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
bandingThemeBandingThemeธีมสีที่นำไปใช้กับคอลัมน์ในช่วง
showHeaderBooleanหากเป็น true สีส่วนหัวของธีมการกำหนดช่วงสีจะมีผลกับคอลัมน์แรก
showFooterBooleanหากตั้งค่าเป็น true สีส่วนท้ายของธีมการกำหนดช่วงสีจะมีผลกับคอลัมน์สุดท้าย

รีเทิร์น

Banding — แถบสีแบบใหม่

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

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

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

applyRowBanding()

ใช้ธีมแถบแถวเริ่มต้นกับช่วง โดยค่าเริ่มต้น แถบจะมีสีส่วนหัวและไม่มีสีส่วนท้าย

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

รีเทิร์น

Banding — แถบสี

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

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

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

applyRowBanding(bandingTheme)

ใช้ธีมแถบแถวที่ระบุกับช่วง โดยค่าเริ่มต้น แถบจะมีสีส่วนหัวและไม่มีสีส่วนท้าย

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
bandingThemeBandingThemeธีมสีที่นำไปใช้กับแถวในช่วง

รีเทิร์น

Banding — แถบสีแบบใหม่

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

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

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

applyRowBanding(bandingTheme, showHeader, showFooter)

ใช้ธีมแถบแถวที่ระบุกับช่วงที่มีการตั้งค่าส่วนหัวและส่วนท้ายที่ระบุ

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
bandingThemeBandingThemeธีมสีที่นำไปใช้กับแถวในช่วง
showHeaderBooleanหากเป็น true สีส่วนหัวของธีมการกำหนดแถบสีจะมีผลกับแถวแรก
showFooterBooleanหากเป็น true สีส่วนท้ายของธีมการกำหนดแถบสีจะมีผลกับแถวสุดท้าย

รีเทิร์น

Banding — แถบสีแบบใหม่

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

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

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

autoFill(destination, series)

เติม destinationRange ด้วยข้อมูลตามข้อมูลในช่วงนี้ ค่าใหม่จะกำหนดโดยประเภท series ที่ระบุด้วย ช่วงปลายทางต้องมีช่วงนี้และขยายออกไปในทิศทางเดียวเท่านั้น ตัวอย่างต่อไปนี้จะเติม A1:A20 ด้วยชุดตัวเลขที่เพิ่มขึ้นตามค่าปัจจุบันใน A1:A4

var sheet = SpreadsheetApp.getActiveSheet();

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
destinationRangeช่วงที่จะป้อนค่าโดยอัตโนมัติ ช่วงปลายทางควรมีช่วงนี้และขยายออกไปในทิศทางเดียวเท่านั้น (ขึ้น ลง ซ้าย หรือขวา)
seriesAutoFillSeriesประเภทของชุดการป้อนอัตโนมัติที่ควรใช้ในการคำนวณค่าใหม่ ผลลัพธ์ของชุดข้อมูลนี้จะแตกต่างกันไปตามประเภทและปริมาณข้อมูลต้นฉบับ

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

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

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

autoFillToNeighbor(series)

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

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

เช่น หาก A1:A20 เต็มไปด้วยชุดตัวเลขที่เพิ่มขึ้น และมีการเรียกเมธอดนี้ในช่วง B1:B4 ซึ่งมีชุดวันที่ ระบบจะแทรกค่าใหม่ลงใน B5:B20 เท่านั้น ด้วยวิธีนี้ ค่าใหม่เหล่านี้จะ "คงที่" กับเซลล์ที่มีค่าในคอลัมน์ A

var sheet = SpreadsheetApp.getActiveSheet();

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
seriesAutoFillSeriesประเภทของชุดการป้อนอัตโนมัติที่ควรใช้ในการคำนวณค่าใหม่ ผลลัพธ์ของชุดข้อมูลนี้จะแตกต่างกันไปตามประเภทและปริมาณข้อมูลต้นฉบับ

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

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

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

breakApart()

แบ่งเซลล์ที่มีหลายคอลัมน์ในช่วงให้เป็นเซลล์เดี่ยวอีกครั้ง

การเรียกใช้ฟังก์ชันนี้บนช่วงเทียบเท่ากับการเลือกช่วงและคลิก จัดรูปแบบ > ผสานเซลล์ > ยกเลิกการผสาน

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

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

canEdit()

กำหนดว่าผู้ใช้มีสิทธิ์แก้ไขทุกเซลล์ในช่วงหรือไม่ เจ้าของสเปรดชีตจะสามารถแก้ไขช่วงและชีตที่มีการป้องกันได้เสมอ

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

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

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

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

รีเทิร์น

Booleantrue หากผู้ใช้มีสิทธิ์แก้ไขทุกเซลล์ในช่วง มิเช่นนั้นจะเป็น false

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

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

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

check()

เปลี่ยนสถานะของช่องทำเครื่องหมายในช่วงเป็น "ทำเครื่องหมายแล้ว" ไม่สนใจเซลล์ในช่วงซึ่งขณะนี้ไม่มีค่าที่เลือกหรือไม่เลือกที่กำหนดค่าไว้

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clear()

ล้างช่วงเนื้อหาและรูปแบบ

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clear(options)

ล้างช่วงของเนื้อหา รูปแบบ กฎการตรวจสอบข้อมูล และ/หรือความคิดเห็น ตามที่ระบุด้วยตัวเลือกขั้นสูงที่กำหนด ระบบจะล้างข้อมูลทั้งหมดโดยค่าเริ่มต้น

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงดังที่แสดงด้านล่าง

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

ชื่อTypeคำอธิบาย
commentsOnlyBooleanล้างเฉพาะความคิดเห็นหรือไม่
contentsOnlyBooleanต้องการล้างเฉพาะเนื้อหาหรือไม่
formatOnlyBooleanไม่ว่าจะล้างเฉพาะรูปแบบหรือไม่ก็ตาม โปรดทราบว่าการล้างรูปแบบจะล้างกฎการตรวจสอบข้อมูลด้วย
validationsOnlyBooleanต้องการล้างเฉพาะกฎการตรวจสอบข้อมูลไหม
skipFilteredRowsBooleanหลีกเลี่ยงการล้างแถวที่กรองหรือไม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clearContent()

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clearDataValidations()

ล้างกฎการตรวจสอบข้อมูลสำหรับช่วงดังกล่าว

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clearFormat()

ล้างการจัดรูปแบบสำหรับช่วงนี้

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

clearNote()

ล้างบันทึกในเซลล์ที่ระบุ

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

collapseGroups()

ยุบกลุ่มทั้งหมดที่อยู่ในช่วง หากไม่มีกลุ่มที่อยู่ในช่วงอย่างสมบูรณ์ ระบบจะยุบกลุ่มขยายที่ลึกที่สุดที่อยู่ในช่วงดังกล่าวบางส่วน

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

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

คัดลอกการจัดรูปแบบของช่วงไปยังตำแหน่งที่กำหนด หากปลายทางมีขนาดใหญ่กว่าหรือเล็กกว่าช่วงต้นทาง ระบบจะเล่นซ้ำหรือตัดต้นทางให้สอดคล้องกัน โปรดทราบว่าวิธีนี้ จะคัดลอกเฉพาะการจัดรูปแบบเท่านั้น

ดูคำอธิบายโดยละเอียดของพารามิเตอร์ gridId ได้ที่ getGridId()

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
gridIdIntegerรหัสที่ไม่ซ้ำกันของแผ่นงานในสเปรดชีต โดยไม่คำนึงถึงตำแหน่ง
columnIntegerคอลัมน์แรกของช่วงเป้าหมาย
columnEndIntegerคอลัมน์สุดท้ายของช่วงเป้าหมาย
rowIntegerแถวเริ่มต้นของช่วงเป้าหมาย
rowEndIntegerแถวสุดท้ายของช่วงเป้าหมาย

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

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

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

ดูเพิ่มเติม


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

คัดลอกการจัดรูปแบบของช่วงไปยังตำแหน่งที่กำหนด หากปลายทางมีขนาดใหญ่กว่าหรือเล็กกว่าช่วงต้นทาง ระบบจะเล่นซ้ำหรือตัดต้นทางให้สอดคล้องกัน โปรดทราบว่าวิธีนี้ จะคัดลอกเฉพาะการจัดรูปแบบเท่านั้น

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
sheetSheetชีตเป้าหมาย
columnIntegerคอลัมน์แรกของช่วงเป้าหมาย
columnEndIntegerคอลัมน์สุดท้ายของช่วงเป้าหมาย
rowIntegerแถวเริ่มต้นของช่วงเป้าหมาย
rowEndIntegerแถวสุดท้ายของช่วงเป้าหมาย

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

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

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

copyTo(destination)

คัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น ระบบจะคัดลอกทั้งค่าและการจัดรูปแบบ

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
destinationRangeช่วงปลายทางที่จะคัดลอกไป ที่เกี่ยวข้องเฉพาะตำแหน่งของเซลล์ด้านบนซ้ายเท่านั้น

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

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

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

copyTo(destination, copyPasteType, transposed)

คัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
destinationRangeช่วงปลายทางที่จะคัดลอกไป ที่เกี่ยวข้องเฉพาะตำแหน่งของเซลล์ด้านบนซ้ายเท่านั้น
copyPasteTypeCopyPasteTypeประเภทที่ระบุวิธีวางเนื้อหาของช่วงไปยังปลายทาง
transposedBooleanควรวางช่วงในการวางแนวสลับกันหรือไม่

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

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

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

copyTo(destination, options)

คัดลอกข้อมูลจากช่วงของเซลล์ไปยังช่วงของเซลล์อื่น โดยค่าเริ่มต้น ระบบจะคัดลอกทั้งค่าและการจัดรูปแบบ แต่สามารถลบล้างได้โดยใช้อาร์กิวเมนต์ขั้นสูง

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
destinationRangeช่วงปลายทางที่จะคัดลอกไป ที่เกี่ยวข้องเฉพาะตำแหน่งของเซลล์ด้านบนซ้ายเท่านั้น
optionsObjectออบเจ็กต์ JavaScript ที่ระบุพารามิเตอร์ขั้นสูงดังที่แสดงด้านล่าง

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

ชื่อTypeคำอธิบาย
formatOnlyBooleanกำหนดว่าควรคัดลอกเฉพาะรูปแบบนั้น
contentsOnlyBooleanกำหนดว่าควรคัดลอกเฉพาะเนื้อหา

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

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

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

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

คัดลอกเนื้อหาของช่วงไปยังตําแหน่งที่ระบุ หากปลายทางมีขนาดใหญ่กว่าหรือเล็กกว่าช่วงต้นทาง ระบบจะเล่นซ้ำหรือตัดต้นทางให้สอดคล้องกัน

ดูคำอธิบายโดยละเอียดของพารามิเตอร์ gridId ได้ที่ getGridId()

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
gridIdIntegerรหัสที่ไม่ซ้ำกันของแผ่นงานในสเปรดชีต โดยไม่คำนึงถึงตำแหน่ง
columnIntegerคอลัมน์แรกของช่วงเป้าหมาย
columnEndIntegerคอลัมน์สุดท้ายของช่วงเป้าหมาย
rowIntegerแถวเริ่มต้นของช่วงเป้าหมาย
rowEndIntegerแถวสุดท้ายของช่วงเป้าหมาย

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

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

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

ดูเพิ่มเติม


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

คัดลอกเนื้อหาของช่วงไปยังตําแหน่งที่ระบุ หากปลายทางมีขนาดใหญ่กว่าหรือเล็กกว่าช่วงต้นทาง ระบบจะเล่นซ้ำหรือตัดต้นทางให้สอดคล้องกัน

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
sheetSheetชีตเป้าหมาย
columnIntegerคอลัมน์แรกของช่วงเป้าหมาย
columnEndIntegerคอลัมน์สุดท้ายของช่วงเป้าหมาย
rowIntegerแถวเริ่มต้นของช่วงเป้าหมาย
rowEndIntegerแถวสุดท้ายของช่วงเป้าหมาย

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

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

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

createDataSourcePivotTable(dataSource)

สร้างตาราง Pivot ของแหล่งข้อมูลที่ว่างเปล่าจากแหล่งข้อมูล โดยตรึงไว้ที่เซลล์แรกของช่วงนี้

ตัวอย่างนี้แสดงวิธีสร้างและกำหนดค่าตาราง Pivot ของแหล่งข้อมูลใหม่

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
dataSourceDataSourceแหล่งข้อมูลที่จะสร้างตาราง Pivot

รีเทิร์น

DataSourcePivotTable — ตาราง Pivot ของแหล่งข้อมูลที่สร้างขึ้นใหม่

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

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

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

createDataSourceTable(dataSource)

สร้างตารางแหล่งข้อมูลที่ว่างเปล่าจากแหล่งข้อมูล โดยตรึงไว้ที่เซลล์แรกในช่วงนี้

ตัวอย่างนี้แสดงวิธีสร้างและกำหนดค่าตารางแหล่งข้อมูลใหม่

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
dataSourceDataSourceแหล่งข้อมูลที่จะสร้างตาราง Pivot

รีเทิร์น

DataSourceTable — ตารางแหล่งข้อมูลที่สร้างขึ้นใหม่

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

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

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

createDeveloperMetadataFinder()

แสดงผล DeveloperMetadataFinderApi สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของช่วงนี้ ข้อมูลเมตาจะอยู่ภายในขอบเขตของช่วงก็ต่อเมื่อมีข้อมูลครบถ้วนภายในช่วงดังกล่าว เช่น ข้อมูลเมตาที่เชื่อมโยงกับแถว "3:3" ไม่อยู่ในขอบเขตของช่วง "A1:D5" แต่อยู่ในขอบเขตของช่วง "1:5"

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

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

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

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

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

รีเทิร์น

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


createFilter()

สร้างตัวกรองและนำไปใช้กับช่วงที่ระบุในชีต คุณไม่สามารถสร้างตัวกรองมากกว่า 1 รายการในชีต หากต้องการเข้าถึงและแก้ไขตัวกรองหลังจากสร้างตัวกรองแล้ว ให้ใช้ getFilter() หรือ Sheet.getFilter()

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

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
ใช้วิธีนี้ในการสร้างตัวกรองสำหรับชีต Grid ซึ่งเป็นประเภทเริ่มต้นของชีต ชีตตารางกริดคือชีตที่ไม่ได้เชื่อมต่อกับฐานข้อมูล หากต้องการสร้างตัวกรองประเภทอื่นๆ โปรดดูข้อมูลต่อไปนี้

รีเทิร์น

Filter — ตัวกรองใหม่

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

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

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

createPivotTable(sourceData)

สร้างตาราง Pivot เปล่าจาก sourceData ที่ระบุโดยตรึงไว้ที่เซลล์แรกของช่วงนี้

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

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

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
sourceDataRangeข้อมูลที่จะใช้สร้างตาราง Pivot

รีเทิร์น

PivotTablePivotTable ที่สร้างขึ้นใหม่

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

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

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

createTextFinder(findText)

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

TextFinderTextFinder สำหรับช่วง


deleteCells(shiftDimension)

ลบช่วงของเซลล์นี้ ข้อมูลที่มีอยู่ในชีตตามมิติข้อมูลที่ให้ไว้จะเลื่อนไปยังช่วงที่ถูกลบ

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
shiftDimensionDimensionมิติข้อมูลที่จะเปลี่ยนข้อมูลที่มีอยู่

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

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

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

expandGroups()

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

getA1Notation()

แสดงผลคำอธิบายสตริงของช่วงในรูปแบบ A1

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

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

รีเทิร์น

String — คำอธิบายสตริงของช่วงในรูปแบบ A1

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

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

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

getBackground()

แสดงผลสีพื้นหลังของเซลล์ด้านบนซ้ายของช่วง (เช่น '#ffffff')

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

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

รีเทิร์น

String — รหัสสีของพื้นหลัง

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

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

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

getBackgroundObject()

แสดงผลสีพื้นหลังของเซลล์ด้านบนซ้ายของช่วง

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

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

รีเทิร์น

Color — สีพื้นหลังของเซลล์ด้านบนซ้ายของช่วง

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

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

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

getBackgroundObjects()

แสดงผลสีพื้นหลังของเซลล์ในช่วง

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

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

รีเทิร์น

Color[][] — สีพื้นหลังแบบอาร์เรย์ 2 มิติ

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

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

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

getBackgrounds()

แสดงผลสีพื้นหลังของเซลล์ในช่วง (เช่น '#ffffff')

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

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของรหัสสีของพื้นหลัง

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

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

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

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

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

รีเทิร์น

Banding[] — แถบทั้งหมดที่มีผลกับเซลล์ในช่วงนี้

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

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

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

getCell(row, column)

แสดงผลเซลล์ที่ระบุภายในช่วง

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
rowIntegerแถวของเซลล์ที่สัมพันธ์กับช่วง
columnIntegerคอลัมน์ของเซลล์ที่สัมพันธ์กับช่วง

รีเทิร์น

Range — ช่วงที่มีเซลล์เดียวตามพิกัดที่ระบุ

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

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

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

getColumn()

แสดงผลตำแหน่งคอลัมน์เริ่มต้นสำหรับช่วงนี้

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

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

รีเทิร์น

Integer — ตำแหน่งคอลัมน์เริ่มต้นของช่วงในสเปรดชีต

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

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

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

getDataRegion()

แสดงผลสำเนาของช่วงที่ขยายใน Direction คาร์ดินัลทั้ง 4 เซลล์ให้ครอบคลุมเซลล์ที่ใกล้เคียงกันทั้งหมดที่มีข้อมูล ถ้าช่วงถูกล้อมรอบด้วยเซลล์ว่างที่ไม่มีเซลล์ในเส้นทแยงมุม ระบบจะแสดงผลช่วงนั้นเอง ซึ่งคล้ายกับการเลือกช่วงและ การพิมพ์ Ctrl+A ในตัวแก้ไข

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

รีเทิร์น

Range — เขตข้อมูลของช่วงหรือช่วงของทั้งสเปรดชีต

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

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

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

getDataRegion(dimension)

แสดงผลสำเนาของช่วงที่ขยาย Direction.UP และ Direction.DOWN หากมิติข้อมูลที่ระบุคือ Dimension.ROWS หรือ Direction.NEXT และ Direction.PREVIOUS หากมิติข้อมูลเป็น Dimension.COLUMNS การขยายช่วงจะขึ้นอยู่กับการตรวจหาข้อมูลถัดจากช่วงที่มีการจัดระเบียบเหมือนตาราง ช่วงที่ขยายนี้จะครอบคลุมเซลล์ที่อยู่ติดกันทั้งหมดพร้อมข้อมูลที่อยู่ในมิติข้อมูลตามมิติข้อมูลที่ระบุ รวมถึงขอบเขตของตาราง หากช่วงเดิมถูกล้อมรอบด้วยเซลล์ว่างตามมิติข้อมูลที่ระบุ ระบบจะแสดงผลช่วงนั้นเอง วิธีนี้คล้ายกับการเลือกช่วงและพิมพ์ Ctrl+Space สําหรับคอลัมน์หรือ Shift+Space ของแถวในเครื่องมือแก้ไข

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
dimensionDimensionมิติข้อมูลที่จะขยายช่วง

รีเทิร์น

Range — เขตข้อมูลของช่วงหรือช่วงที่ครอบคลุมแต่ละคอลัมน์หรือแต่ละแถวที่ครอบคลุมโดยช่วงเดิม

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

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

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

getDataSourceFormula()

แสดงผล DataSourceFormula สำหรับเซลล์แรกของช่วง หรือ null หากเซลล์ไม่มีสูตรแหล่งข้อมูล

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

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

// Gets the range A1 on Sheet1.
const range = sheet.getRange('A1');

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

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

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

รีเทิร์น

DataSourceFormulaDataSourceFormula สำหรับเซลล์

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

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

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

getDataSourceFormulas()

แสดงผล DataSourceFormula ของเซลล์ในช่วง

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

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

// Gets the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

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

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

รีเทิร์น

DataSourceFormula[] — อาร์เรย์ของ 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

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

รีเทิร์น

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

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

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

รีเทิร์น

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

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

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

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

getDataSourceUrl()

แสดงผล URL สำหรับข้อมูลในช่วงนี้ ซึ่งสามารถใช้เพื่อสร้างแผนภูมิและข้อความค้นหา

Code.gs

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

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

piechart.html

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

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

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

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

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

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

รีเทิร์น

String — URL สำหรับช่วงนี้เป็นแหล่งข้อมูลที่ส่งต่อไปยัง API อื่นๆ เช่น แผนภูมิได้

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

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

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

getDataTable()

แสดงผลข้อมูลภายในออบเจ็กต์นี้เป็น DataTable

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

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

// Gets the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

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

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

รีเทิร์น

DataTable — ข้อมูลในรูปแบบตารางข้อมูล


getDataTable(firstRowIsHeader)

แสดงผลข้อมูลภายในช่วงนี้เป็น DataTable

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
firstRowIsHeaderBooleanกำหนดว่าจะใช้แถวแรกเป็นส่วนหัวหรือไม่

รีเทิร์น

DataTable — ข้อมูลเป็นตารางข้อมูล

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

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

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

getDataValidation()

แสดงผลกฎการตรวจสอบข้อมูลสำหรับเซลล์ซ้ายบนของช่วง หากไม่ได้ตั้งค่าการตรวจสอบข้อมูลในเซลล์ไว้ เมธอดนี้จะแสดง null

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

รีเทิร์น

DataValidation — กฎการตรวจสอบข้อมูลสำหรับเซลล์ซ้ายบนของช่วง

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

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

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

getDataValidations()

แสดงผลกฎการตรวจสอบข้อมูลสำหรับเซลล์ทั้งหมดในช่วง หากไม่ได้ตั้งค่าการตรวจสอบข้อมูลในเซลล์ใด เมธอดนี้จะแสดงผล null สำหรับตำแหน่งเซลล์นั้นในอาร์เรย์

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

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

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

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

รีเทิร์น

DataValidation[][] — อาร์เรย์ 2 มิติของกฎการตรวจสอบข้อมูลที่เชื่อมโยงกับเซลล์ในช่วง

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

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

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

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

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

รีเทิร์น

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

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

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

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

getDisplayValue()

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

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

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

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

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

รีเทิร์น

String — ค่าที่แสดงในเซลล์นี้

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

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

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

getDisplayValues()

แสดงผลค่าตารางกริดสี่เหลี่ยมผืนผ้าสำหรับช่วงนี้

แสดงผลอาร์เรย์ 2 มิติของค่าที่แสดง จัดทำดัชนีตามแถว และตามคอลัมน์ ค่าจะเป็นออบเจ็กต์ String รายการ ค่าที่แสดงจะคำนึงถึงการจัดรูปแบบวันที่ เวลา และสกุลเงิน รวมถึงรูปแบบที่การตั้งค่าภาษาของสเปรดชีตใช้โดยอัตโนมัติ เซลล์ว่างจะแสดงด้วยสตริงว่างในอาร์เรย์ โปรดทราบว่าแม้ดัชนีช่วงจะเริ่มต้นที่ 1, 1 แต่อาร์เรย์ JavaScript จะจัดทำดัชนีจาก [0][0]

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

รีเทิร์น

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

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

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

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

getFilter()

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

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

รีเทิร์น

Filter — ตัวกรอง

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

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

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

getFontColorObject()

แสดงผลสีแบบอักษรของเซลล์ที่มุมซ้ายบนของช่วง

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

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

รีเทิร์น

Color — สีแบบอักษรของเซลล์ซ้ายบนของช่วง

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

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

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

getFontColorObjects()

แสดงผลสีแบบอักษรของเซลล์ในช่วง

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

var results = range.getFontColorObjects();

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

รีเทิร์น

Color[][] — อาร์เรย์ 2 มิติของสีแบบอักษรที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFontFamilies()

แสดงผลชุดแบบอักษรของเซลล์ในช่วง

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

var results = range.getFontFamilies();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของชุดแบบอักษรที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFontFamily()

แสดงผลชุดแบบอักษรของเซลล์ที่มุมซ้ายบนของช่วง

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

Logger.log(range.getFontFamily());

รีเทิร์น

String — ชุดแบบอักษรของเซลล์

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

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

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

getFontLine()

รับรูปแบบเส้นของเซลล์ที่มุมซ้ายบนของช่วง ('underline', 'line-through' หรือ 'none')

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

Logger.log(range.getFontLine());

รีเทิร์น

String — บรรทัดแบบอักษร

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

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

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

getFontLines()

รับรูปแบบเส้นของเซลล์ในช่วง ('underline', 'line-through' หรือ 'none')

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

var results = range.getFontLines();

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

รีเทิร์น

String[][] — อาร์เรย์สองมิติของบรรทัดแบบอักษรที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFontSize()

แสดงขนาดแบบอักษรเป็นขนาดจุดของเซลล์ที่มุมซ้ายบนของช่วง

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

Logger.log(range.getFontSize());

รีเทิร์น

Integer — ขนาดแบบอักษรในขนาดจุด

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

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

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

getFontSizes()

แสดงขนาดแบบอักษรของเซลล์ในช่วง

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

var results = range.getFontSizes();

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

รีเทิร์น

Integer[][] — อาร์เรย์ 2 มิติตัวอักษรของข้อความที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFontStyle()

แสดงผลรูปแบบแบบอักษร ('italic' หรือ 'normal') ของเซลล์ที่มุมซ้ายบนของช่วง

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

Logger.log(range.getFontStyle());

รีเทิร์น

String — รูปแบบตัวอักษรของข้อความในเซลล์

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

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

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

getFontStyles()

แสดงผลรูปแบบแบบอักษรของเซลล์ในช่วง

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

var results = range.getFontStyles();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติตัวอักษรของข้อความที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFontWeight()

แสดงน้ำหนักตัวอักษร (ปกติ/ตัวหนา) ของเซลล์ที่มุมบนซ้ายของช่วง

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

Logger.log(range.getFontWeight());

รีเทิร์น

String — น้ำหนักแบบอักษรของข้อความในเซลล์

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

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

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

getFontWeights()

แสดงผลน้ำหนักแบบอักษรของเซลล์ในช่วง

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

var results = range.getFontWeights();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติตัวอักษรของข้อความที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getFormula()

แสดงผลสูตร (สัญลักษณ์ A1) สำหรับเซลล์ซ้ายบนของช่วง หรือสตริงว่างหากเซลล์ว่างหรือไม่มีสูตร

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

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

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

รีเทิร์น

String — สูตรสำหรับเซลล์

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

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

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

getFormulaR1C1()

จะแสดงผลสูตร (สัญลักษณ์ R1C1) สำหรับเซลล์ที่ระบุหรือ null หากไม่มี

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

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

รีเทิร์น

String — สูตรในเครื่องหมาย R1C1

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

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

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

getFormulas()

แสดงผลสูตร (สัญลักษณ์ A1) สำหรับเซลล์ในช่วง รายการในอาร์เรย์ 2 มิติ เป็นสตริงว่างเปล่าสำหรับเซลล์ที่ไม่มีสูตร

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

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของสูตรในรูปแบบสตริง

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

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

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

getFormulasR1C1()

แสดงผลสูตร (สัญลักษณ์ R1C1) สำหรับเซลล์ในช่วง รายการในอาร์เรย์ 2 มิติคือ null สำหรับเซลล์ที่ไม่มีสูตร

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

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของสูตรในรูปแบบ R1C1

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

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

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

getGridId()

แสดงผลรหัสตารางกริดของชีตระดับบนสุดของช่วง รหัสคือค่าจำนวนเต็มที่ไม่ติดลบแบบสุ่ม

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

Logger.log(range.getGridId());

รีเทิร์น

Integer — รหัสตารางกริดของชีตหลัก

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

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

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

getHeight()

แสดงความสูงของช่วง

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

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

รีเทิร์น

Integer — ความสูงของช่วง

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

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

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

getHorizontalAlignment()

ส่งคืนการจัดข้อความแนวนอน (ซ้าย/กลาง/ขวา) ของเซลล์ที่มุมซ้ายบนของช่วง

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

Logger.log(range.getHorizontalAlignment());

รีเทิร์น

String — การจัดข้อความแนวนอนในเซลล์

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

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

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

getHorizontalAlignments()

ส่งคืนการจัดข้อความแนวนอนของเซลล์ในช่วง

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

var results = range.getHorizontalAlignments();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของการจัดแนวข้อความในแนวนอนที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getLastColumn()

แสดงผลตำแหน่งคอลัมน์สิ้นสุด

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

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

รีเทิร์น

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

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

รีเทิร์น

Integer — ตำแหน่งแถวสิ้นสุดของช่วงในสเปรดชีต

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

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

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

getMergedRanges()

แสดงผลอาร์เรย์ของออบเจ็กต์ Range ที่แทนเซลล์ที่ผสานกันซึ่งอยู่ภายในช่วงปัจจุบันทั้งหมด หรือมีอย่างน้อย 1 เซลล์ในช่วงปัจจุบัน

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

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

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

รีเทิร์น

Range[] — อาร์เรย์ของออบเจ็กต์ Range รายการ โดยแทนเซลล์ที่ผสานทับซ้อนกับช่วง


getNextDataCell(direction)

เริ่มจากเซลล์ในคอลัมน์แรกและแถวแรกของช่วง แสดงผลเซลล์ถัดไปในทิศทางที่ระบุซึ่งเป็นขอบของช่วงที่อยู่ต่อเนื่องของเซลล์ที่มีข้อมูลอยู่ในเซลล์นั้น หรือเซลล์ที่ขอบของสเปรดชีตในทิศทางนั้น ซึ่งเทียบเท่ากับการพิมพ์ Ctrl+[arrow key] ในเครื่องมือแก้ไข

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
directionDirectionทิศทางที่จะหาเซลล์ Edge ของเขตข้อมูลถัดไป

รีเทิร์น

Range — เซลล์ Edge ของเขตข้อมูลหรือเซลล์ที่ขอบของสเปรดชีต

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

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

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

getNote()

แสดงผลบันทึกที่เชื่อมโยงกับช่วงที่ระบุ

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

Logger.log(range.getNote());

รีเทิร์น

String — โน้ตที่เกี่ยวข้องกับเซลล์ที่ระบุ

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

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

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

getNotes()

แสดงผลบันทึกที่เชื่อมโยงกับเซลล์ในช่วง

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

var results = range.getNotes();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของบันทึกที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getNumColumns()

แสดงผลจำนวนคอลัมน์ในช่วงนี้

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

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

รีเทิร์น

Integer — จำนวนคอลัมน์ในช่วงนี้

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

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

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

getNumRows()

แสดงผลจำนวนแถวในช่วงนี้

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

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

รีเทิร์น

Integer — จำนวนแถวในช่วงนี้

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

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

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

getNumberFormat()

ดูการจัดรูปแบบตัวเลขหรือวันที่ในเซลล์ซ้ายบนของช่วงที่ระบุ โปรดดูคำอธิบายรูปแบบที่แสดงได้ในเอกสารประกอบเกี่ยวกับ ชีต API

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

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

รีเทิร์น

String — รูปแบบตัวเลขในเซลล์ซ้ายบนของช่วง

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

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

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

getNumberFormats()

แสดงผลรูปแบบตัวเลขหรือวันที่สำหรับเซลล์ในช่วง รูปแบบของรูปแบบที่แสดงผลได้จะอธิบายไว้ในเอกสารประกอบของ Sheets API

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

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของรูปแบบตัวเลข

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

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

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

getRichTextValue()

แสดงผลค่า Rich Text สำหรับเซลล์ซ้ายบนของช่วง หรือ null หากค่าของเซลล์ไม่ใช่ข้อความ

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

รีเทิร์น

RichTextValue — ค่า Rich Text ของเซลล์ซ้ายบนสุดในช่วง หรือ null หากค่าของเซลล์ไม่ใช่ข้อความ

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

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

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

getRichTextValues()

แสดงผลค่า Rich Text สำหรับเซลล์ในช่วง

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

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

รีเทิร์น

RichTextValue[][] — อาร์เรย์ 2 มิติของค่า Rich Text

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

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

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

getRow()

แสดงตำแหน่งแถวสำหรับช่วงนี้ เหมือนกับ getRowIndex()

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

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

รีเทิร์น

Integer — ตำแหน่งแถวของช่วง

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

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

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

getRowIndex()

แสดงตำแหน่งแถวสำหรับช่วงนี้ เหมือนกับ getRow()

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

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

รีเทิร์น

Integer — ตำแหน่งแถวของช่วง

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

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

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

ดูเพิ่มเติม


getSheet()

แสดงผลแผ่นงานของช่วงนี้

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

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

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

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

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

รีเทิร์น

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

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

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

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

getTextDirection()

แสดงทิศทางข้อความในเซลล์ซ้ายบนของช่วง แสดงผล null หากทิศทางข้อความในเซลล์กำหนดด้วยการตรวจจับอัตโนมัติ

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

รีเทิร์น

TextDirection — ทิศทางข้อความของเซลล์ซ้ายบนสุดของช่วง

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

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

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

getTextDirections()

แสดงผลเส้นทางข้อความสำหรับเซลล์ในช่วง รายการในอาร์เรย์ 2 มิติมีค่า null สำหรับเซลล์ที่ใช้การตรวจหาอัตโนมัติ

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

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

รีเทิร์น

TextDirection[][] — อาร์เรย์ 2 มิติของเส้นทางข้อความ

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

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

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

getTextRotation()

แสดงผลการตั้งค่าการหมุนข้อความสำหรับเซลล์ซ้ายบนสุดของช่วง

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

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

รีเทิร์น

TextRotation — การตั้งค่าการหมุนข้อความ

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

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

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

getTextRotations()

แสดงผลการตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง

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

var results = range.getTextRotations();

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

รีเทิร์น

TextRotation[][] — อาร์เรย์ 2 มิติของการหมุนข้อความที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getTextStyle()

แสดงผลรูปแบบข้อความในเซลล์ซ้ายบนสุดของช่วง

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

รีเทิร์น

TextStyle — รูปแบบข้อความของเซลล์ซ้ายบนสุดของช่วง

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

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

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

getTextStyles()

แสดงผลรูปแบบข้อความสำหรับเซลล์ในช่วง

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

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

รีเทิร์น

TextStyle[][] — อาร์เรย์ 2 มิติของรูปแบบข้อความ

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

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

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

getValue()

แสดงผลค่าของเซลล์ด้านบนซ้ายของช่วง ค่าอาจเป็นประเภท Number, Boolean, Date หรือ String ขึ้นอยู่กับค่าของเซลล์ ส่วนเซลล์ว่างจะแสดงสตริงว่าง

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

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

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

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

รีเทิร์น

Object — ค่าในเซลล์นี้

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

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

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

getValues()

แสดงผลค่าตารางกริดสี่เหลี่ยมผืนผ้าสำหรับช่วงนี้

แสดงผลอาร์เรย์ 2 มิติของค่า โดยจัดทำดัชนีตามแถว และตามคอลัมน์ ค่าอาจเป็นประเภท Number, Boolean, Date หรือ String ขึ้นอยู่กับค่าของเซลล์ เซลล์ว่างจะแสดงด้วยสตริงว่างในอาร์เรย์ โปรดทราบว่าในขณะที่ดัชนีช่วงเริ่มต้นที่ 1, 1 แต่อาร์เรย์ JavaScript จะจัดทำดัชนีจาก [0][0]

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
ในเว็บแอป ค่า Date ไม่ใช่พารามิเตอร์ทางกฎหมาย getValues() ไม่แสดงผลข้อมูลไปยังเว็บแอปหากช่วงมีเซลล์ที่มีค่า Date แต่ให้แปลงค่าทั้งหมดที่ดึงมาจากชีตเป็น JavaScript แบบพื้นฐานที่รองรับ เช่น Number, Boolean หรือ String

รีเทิร์น

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

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

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

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

getVerticalAlignment()

แสดงผลการจัดแนวแนวตั้ง (บน/กลาง/ล่าง) ของเซลล์ที่มุมบนซ้ายของช่วง

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

Logger.log(range.getVerticalAlignment());

รีเทิร์น

String — การจัดข้อความแนวตั้งในเซลล์

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

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

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

getVerticalAlignments()

ส่งคืนการจัดข้อความแนวตั้งของเซลล์ในช่วง

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

var results = range.getVerticalAlignments();

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

รีเทิร์น

String[][] — อาร์เรย์ 2 มิติของการจัดแนวข้อความตามแนวตั้งที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

getWidth()

แสดงผลความกว้างของช่วงในคอลัมน์

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

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

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

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

รีเทิร์น

Integer — จำนวนคอลัมน์ในช่วง

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

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

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

getWrap()

แสดงผลว่าข้อความในเซลล์ตัดข้อความหรือไม่ หากต้องการดูกลยุทธ์การรวมที่ละเอียดยิ่งขึ้น โปรดใช้ getWrapStrategy()

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

Logger.log(range.getWrap());

รีเทิร์น

Boolean — ตัดข้อความในเซลล์นี้หรือไม่

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

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

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

getWrapStrategies()

แสดงผลกลยุทธ์การตัดข้อความสำหรับเซลล์ในช่วง

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

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

รีเทิร์น

WrapStrategy[][] — กลยุทธ์การตัดข้อความแบบ 2 มิติ

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

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

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

getWrapStrategy()

แสดงกลยุทธ์การตัดข้อความสำหรับเซลล์ซ้ายบนของช่วง

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

รีเทิร์น

WrapStrategy — กลยุทธ์การตัดข้อความของเซลล์ซ้ายบนสุดในช่วง

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

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

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

getWraps()

แสดงผลว่าข้อความในเซลล์ตัดข้อมูลหรือไม่ หากต้องการดูกลยุทธ์การรวมที่ละเอียดยิ่งขึ้น โปรดใช้ getWrapStrategies()

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

var results = range.getVerticalAlignments();

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

รีเทิร์น

Boolean[][] — อาร์เรย์ 2 มิติของการจัดแนวข้อความตามแนวตั้งที่เชื่อมโยงกับเซลล์ในช่วง

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

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

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

insertCells(shiftDimension)

แทรกเซลล์ว่างในช่วงนี้ เซลล์ใหม่จะยังคงมีการจัดรูปแบบใดๆ ที่มีอยู่ในเซลล์ที่ใช้ช่วงนี้อยู่ ข้อมูลที่มีอยู่ในชีตตามมิติข้อมูลที่ให้ไว้จะย้ายออกจากช่วงที่แทรกไว้

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
shiftDimensionDimensionมิติข้อมูลที่จะเปลี่ยนข้อมูลที่มีอยู่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

insertCheckboxes()

แทรกช่องทำเครื่องหมายลงในแต่ละเซลล์ในช่วง กำหนดค่าด้วย true สำหรับรายการที่เลือก และ false สำหรับการเลือก ตั้งค่าของทุกเซลล์ในช่วงเป็น false

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

insertCheckboxes(checkedValue)

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
checkedValueObjectค่าที่ทำเครื่องหมายสำหรับการตรวจสอบข้อมูลของช่องทำเครื่องหมาย

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

insertCheckboxes(checkedValue, uncheckedValue)

แทรกช่องทำเครื่องหมายลงในแต่ละเซลล์ของช่วง โดยกำหนดค่าด้วยค่าที่กำหนดเองสำหรับสถานะ "เลือกแล้ว" และ "ไม่เลือก" ตั้งค่าของแต่ละเซลล์ในช่วงเป็นค่าที่ไม่ได้ทำเครื่องหมายแบบกำหนดเอง

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
checkedValueObjectค่าที่ทำเครื่องหมายสำหรับการตรวจสอบข้อมูลของช่องทำเครื่องหมาย
uncheckedValueObjectค่าที่ยกเลิกการเลือกสำหรับการตรวจสอบข้อมูลในช่องทำเครื่องหมาย

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

isBlank()

แสดงผล true หากช่วงว่างเปล่า

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

Logger.log(range.isBlank());

รีเทิร์น

Booleantrue หากช่วงว่างเปล่า มิฉะนั้นจะเป็น false

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

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

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

isChecked()

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

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

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

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

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

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

รีเทิร์น

Booleantrue ถ้าเลือกทุกเซลล์ในช่วงไว้ ระบบจะ false หากไม่ได้เลือกเซลล์ทั้งหมดในช่วง หรือกด null ถ้าไม่ได้เลือกเซลล์ใดเซลล์หนึ่งไว้ หรือไม่มีการตรวจสอบข้อมูลในช่องทำเครื่องหมาย

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

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

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

isEndColumnBounded()

กำหนดว่าจุดสิ้นสุดของช่วงเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่งหรือไม่ ตัวอย่างเช่น สำหรับช่วง A1:B10 หรือ B:B ซึ่งผูกกับคอลัมน์ที่อยู่ท้ายช่วง เมธอดนี้จะแสดงผล true สำหรับช่วง 3:7 หรือ A1:5 ที่ผูกกับแถวใดแถวหนึ่งที่ส่วนท้ายของช่วงเท่านั้น เมธอดนี้จะแสดงค่า false

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

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

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

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

รีเทิร์น

Booleantrue หากจุดสิ้นสุดของช่วงเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่ง จะเป็น false ในกรณีอื่นๆ

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

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

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

isEndRowBounded()

กำหนดว่าจุดสิ้นสุดของช่วงเชื่อมโยงกับแถวใดแถวหนึ่งหรือไม่ ตัวอย่างเช่น สำหรับช่วง A1:B10 หรือ 3:7 ที่ผูกกับแถวที่ท้ายช่วง เมธอดนี้จะแสดงผล true สำหรับช่วง B:B หรือ A1:C ที่ผูกกับคอลัมน์ใดคอลัมน์หนึ่งที่ส่วนท้ายของช่วงเท่านั้น เมธอดนี้จะแสดงค่า false

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

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

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

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

รีเทิร์น

Booleantrue หากจุดสิ้นสุดของช่วงเชื่อมโยงกับแถวใดแถวหนึ่ง false ในกรณีอื่นๆ

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

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

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

isPartOfMerge()

แสดงผล true ถ้าเซลล์ในช่วงปัจจุบันซ้อนทับกับเซลล์ที่ผสาน

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

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

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

รีเทิร์น

Booleantrue หากช่วงทับซ้อนกับเซลล์ที่ผสาน มิฉะนั้นจะแสดงผล false


isStartColumnBounded()

พิจารณาว่าจุดเริ่มต้นของช่วงเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่งหรือไม่ ตัวอย่างเช่น สำหรับช่วง A1:B10 หรือ B:B ซึ่งผูกกับคอลัมน์ที่ตำแหน่งเริ่มต้นของช่วง เมธอดนี้จะแสดงผล true สำหรับช่วง 3:7 ซึ่งผูกกับแถวที่จุดเริ่มต้นของช่วงเท่านั้น เมธอดนี้จะแสดงค่า false

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

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

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

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

รีเทิร์น

Booleantrue หากจุดเริ่มต้นของช่วงถูกเชื่อมโยงกับคอลัมน์ใดคอลัมน์หนึ่ง มิฉะนั้นจะเป็น false

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

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

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

isStartRowBounded()

พิจารณาว่าจุดเริ่มต้นของช่วงเชื่อมโยงกับแถวใดแถวหนึ่งหรือไม่ ตัวอย่างเช่น สำหรับช่วง A1:B10 หรือ 3:7 ซึ่งผูกกับแถวที่จุดเริ่มต้นของช่วง เมธอดนี้จะแสดงค่า true สำหรับช่วง B:B ซึ่งผูกกับคอลัมน์ใดคอลัมน์หนึ่งที่จุดเริ่มต้นของช่วงเท่านั้น เมธอดนี้จะแสดงค่า false

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

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

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

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

รีเทิร์น

Booleantrue หากจุดเริ่มต้นของช่วงถูกเชื่อมโยงกับแถวใดแถวหนึ่ง false ในกรณีอื่นๆ

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

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

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

merge()

ผสานเซลล์ในช่วงเข้าด้วยกันเป็นบล็อกเดียว

var sheet = SpreadsheetApp.getActiveSheet();

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

mergeAcross()

ผสานเซลล์ในช่วงระหว่างคอลัมน์ต่างๆ ของช่วง

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

mergeVertically()

ผสานเซลล์ในช่วงเข้าด้วยกัน

var sheet = SpreadsheetApp.getActiveSheet();

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

moveTo(target)

ตัดและวาง (ทั้งรูปแบบและค่า) จากช่วงนี้ไปยังช่วงเป้าหมาย

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
targetRangeช่วงเป้าหมายที่จะคัดลอกช่วงนี้ไป ระบบจะเกี่ยวข้องเฉพาะตำแหน่งของเซลล์ด้านบนซ้ายเท่านั้น

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

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

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

offset(rowOffset, columnOffset)

แสดงผลช่วงใหม่ที่มีการออฟเซ็ตจากช่วงนี้ตามจำนวนแถวและคอลัมน์ที่กำหนด (ซึ่งอาจเป็นค่าลบ) ช่วงใหม่จะมีขนาดเท่ากับช่วงเดิม

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
rowOffsetIntegerจำนวนแถวจากเซลล์ด้านบนซ้ายของช่วง ค่าลบแสดงถึงแถวที่ขึ้นจากเซลล์ด้านบนซ้ายของช่วง
columnOffsetIntegerจำนวนคอลัมน์จากเซลล์ด้านบนซ้ายของช่วง ค่าลบหมายถึงคอลัมน์ทางด้านซ้ายของเซลล์ด้านบนซ้ายของช่วง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน


offset(rowOffset, columnOffset, numRows)

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
rowOffsetIntegerจำนวนแถวจากเซลล์ด้านบนซ้ายของช่วง ค่าลบแสดงถึงแถวที่ขึ้นจากเซลล์ด้านบนซ้ายของช่วง
columnOffsetIntegerจำนวนคอลัมน์จากเซลล์ด้านบนซ้ายของช่วง ค่าลบหมายถึงคอลัมน์ทางด้านซ้ายของเซลล์ด้านบนซ้ายของช่วง
numRowsIntegerความสูงเป็นแถวของช่วงใหม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
rowOffsetIntegerจำนวนแถวจากเซลล์ด้านบนซ้ายของช่วง ค่าลบแสดงถึงแถวที่ขึ้นจากเซลล์ด้านบนซ้ายของช่วง
columnOffsetIntegerจำนวนคอลัมน์จากเซลล์ด้านบนซ้ายของช่วง ค่าลบหมายถึงคอลัมน์ทางด้านซ้ายของเซลล์ด้านบนซ้ายของช่วง
numRowsIntegerความสูงเป็นแถวของช่วงใหม่
numColumnsIntegerความกว้างเป็นคอลัมน์ของช่วงใหม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน


protect()

สร้างออบเจ็กต์ที่ป้องกันไม่ให้แก้ไขช่วงได้ ยกเว้นผู้ใช้ที่มีสิทธิ์ สิทธิ์จะมิเรอร์รายการของสเปรดชีตจนกว่าสคริปต์จะเปลี่ยนแปลงรายชื่อของช่วงดังกล่าว (โดยการเรียกใช้ Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) หรือตั้งค่าใหม่สำหรับ Protection.setDomainEdit(editable)) หากช่วงได้รับการป้องกันแล้ว วิธีนี้จะสร้างช่วงที่มีการป้องกันใหม่ที่ซ้อนทับช่วงที่มีอยู่ หากเซลล์ได้รับการป้องกันด้วยช่วงที่ป้องกันไว้หลายช่วง และช่วงใดช่วงหนึ่งป้องกันไม่ให้ผู้ใช้บางรายแก้ไขเซลล์ ผู้ใช้รายนั้นก็จะไม่มีสิทธิ์แก้ไขเซลล์

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

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

รีเทิร์น

Protection — ออบเจ็กต์ที่แสดงการตั้งค่าการป้องกัน

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

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

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

randomize()

สุ่มลำดับของแถวในช่วงที่กำหนด

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

// Randomizes the range
range.randomize();

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

removeCheckboxes()

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

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

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

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

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

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

removeDuplicates()

นำแถวภายในช่วงนี้ที่มีค่าซ้ำกับค่าในแถวก่อนหน้าออก แถวที่มีค่าเหมือนกันแต่มีตัวอักษรพิมพ์เล็กพิมพ์ใหญ่ การจัดรูปแบบ หรือสูตรต่างกันจะถือว่าเป็นรายการที่ซ้ำกัน วิธีนี้จะนำแถวที่ซ้ำกันซึ่งซ่อนไม่ให้เห็นออกด้วย (เช่น เนื่องจากตัวกรอง) ระบบจะไม่นำเนื้อหาที่อยู่นอกช่วงนี้ออก

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

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

รีเทิร์น

Range — ช่วงที่ได้ข้อมูลหลังจากนำรายการที่ซ้ำออก ขนาดของช่วงจะลดลง 1 แถวต่อแถวที่นำออก

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

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

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

removeDuplicates(columnsToCompare)

นำแถวภายในช่วงนี้ที่มีค่าในคอลัมน์ที่ระบุซึ่งซ้ำกับค่าในแถวก่อนหน้าออก แถวที่มีค่าเหมือนกันแต่มีตัวอักษรพิมพ์เล็กพิมพ์ใหญ่ การจัดรูปแบบ หรือสูตรต่างกันจะถือว่าเป็นรายการที่ซ้ำกัน วิธีนี้จะนำแถวที่ซ้ำกันซึ่งซ่อนอยู่ออกจากมุมมองด้วย (เช่น เนื่องจากตัวกรอง) ระบบจะไม่นำเนื้อหาที่อยู่นอกช่วงนี้ออก

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnsToCompareInteger[]คอลัมน์ที่จะวิเคราะห์หาค่าที่ซ้ำกัน หากไม่ได้ระบุคอลัมน์ไว้ ระบบจะวิเคราะห์คอลัมน์ทั้งหมดเพื่อหารายการที่ซ้ำกัน

รีเทิร์น

Range — ช่วงที่ได้ข้อมูลหลังจากนำรายการที่ซ้ำออก ขนาดของช่วงจะลดลง 1 แถวต่อแถวที่นำออก

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

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

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

setBackground(color)

ตั้งค่าสีพื้นหลังของทุกเซลล์ในช่วงในรูปแบบสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white')

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorStringรหัสสีในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setBackgroundObject(color)

ตั้งค่าสีพื้นหลังของเซลล์ทั้งหมดในช่วง

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorColorสีพื้นหลังที่ตั้งค่า ค่า null จะรีเซ็ตสีพื้นหลัง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setBackgroundObjects(color)

ตั้งค่าสีพื้นหลังเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorColor[][]อาร์เรย์สองมิติของสี ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setBackgroundRGB(red, green, blue)

ตั้งค่าพื้นหลังเป็นสีที่ระบุโดยใช้ค่า RGB (จำนวนเต็มตั้งแต่ 0 ถึง 255)

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
redIntegerค่าสีแดงในรูปแบบ RGB
greenIntegerค่าสีเขียวในรูปแบบ RGB
blueIntegerค่าสีน้ำเงินในรูปแบบ RGB

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setBackgrounds(color)

ตั้งค่าสีพื้นหลังเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้) สีจะอยู่ในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white')

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorString[][]อาร์เรย์ 2 มิติของสีในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

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

ตั้งค่าคุณสมบัติเส้นขอบ ค่าที่ใช้ได้คือ true (เปิด), false (ปิด) และ null (ไม่มีการเปลี่ยนแปลง)

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
topBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
leftBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
bottomBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
rightBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
verticalBooleantrue สำหรับเส้นขอบแนวตั้งภายใน, false สำหรับไม่มี, null สำหรับไม่มีการเปลี่ยนแปลง
horizontalBooleantrue สำหรับเส้นขอบแนวนอนภายใน false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

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

ตั้งค่าคุณสมบัติเส้นขอบด้วยสีและ/หรือรูปแบบ ค่าที่ใช้ได้คือ true (เปิด), false (ปิด) และ null (ไม่มีการเปลี่ยนแปลง) สำหรับสี ให้ใช้สีในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white')

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
topBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
leftBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
bottomBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
rightBooleantrue สำหรับเส้นขอบ false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
verticalBooleantrue สำหรับเส้นขอบแนวตั้งภายใน, false สำหรับไม่มี, null สำหรับไม่มีการเปลี่ยนแปลง
horizontalBooleantrue สำหรับเส้นขอบแนวนอนภายใน false สำหรับไม่มี และ null สำหรับไม่มีการเปลี่ยนแปลง
colorStringสีในรูปแบบ CSS (เช่น '#ffffff' หรือ 'white'), null สำหรับสีเริ่มต้น (สีดำ)
styleBorderStyleรูปแบบเส้นขอบ null สำหรับรูปแบบเริ่มต้น (ทึบ)

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setDataValidation(rule)

ตั้งกฎการตรวจสอบข้อมูล 1 ข้อให้กับทุกเซลล์ในช่วง

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
ruleDataValidationกฎการตรวจสอบข้อมูลที่จะตั้งค่า หรือnullเพื่อนำการตรวจสอบข้อมูลออก

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setDataValidations(rules)

ตั้งกฎการตรวจสอบข้อมูลสำหรับเซลล์ทั้งหมดในช่วง วิธีนี้ใช้อาร์เรย์ 2 มิติในการตรวจสอบข้อมูล โดยจัดทำดัชนีตามแถวและตามคอลัมน์ มิติข้อมูลของอาร์เรย์ต้อง สอดคล้องกับมิติข้อมูลช่วง

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
rulesDataValidation[][]อาร์เรย์ 2 มิติของกฎการตรวจสอบข้อมูลที่จะตั้งค่า ค่า null จะนำการตรวจสอบข้อมูลออก

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontColor(color)

ตั้งค่าสีแบบอักษรในรูปแบบ CSS (เช่น '#ffffff' หรือ 'white')

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorStringสีแบบอักษรในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontColorObject(color)

ตั้งค่าสีแบบอักษรของช่วงที่ระบุ

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorColorสีแบบอักษรที่จะตั้งค่า ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontColorObjects(colors)

ตั้งค่าตารางสีแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้)

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

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorsColor[][]อาร์เรย์ 2 มิติของสี ค่า null จะรีเซ็ตสีแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontColors(colors)

ตั้งค่าตารางสีแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้) สีจะอยู่ในระบบ CSS (เช่น '#ffffff' หรือ 'white')

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
colorsObject[][]อาร์เรย์ 2 มิติของสีในสัญลักษณ์ CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontFamilies(fontFamilies)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของชุดแบบอักษร (ต้องตรงกับขนาดของช่วงนี้) ตัวอย่างของชุดแบบอักษร ได้แก่ "Arial" หรือ "Helvetica"

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontFamiliesObject[][]อาร์เรย์ 2 มิติของชุดแบบอักษร ค่า null จะรีเซ็ตชุดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

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

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

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

setFontFamily(fontFamily)

ตั้งค่าชุดแบบอักษร เช่น "Arial" หรือ "Helvetica"

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontFamilyStringชุดแบบอักษรที่จะตั้งค่า ค่า null จะรีเซ็ตชุดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontLine(fontLine)

ตั้งค่ารูปแบบเส้นแบบอักษรของช่วงที่ระบุ ('underline', 'line-through' หรือ 'none')

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontLineStringรูปแบบเส้นแบบอักษร 'underline', 'line-through' หรือ 'none' และค่า null จะรีเซ็ตรูปแบบบรรทัดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontLines(fontLines)

ตั้งค่าตารางสี่เหลี่ยมผืนผ้าของรูปแบบเส้น (ต้องตรงกับขนาดของช่วงนี้)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontLinesObject[][]อาร์เรย์ 2 มิติของรูปแบบเส้นแบบอักษร ('underline', 'line-through' หรือ 'none') ค่า null จะรีเซ็ตรูปแบบเส้นแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontSize(size)

ตั้งค่าขนาดแบบอักษร โดยขนาดคือขนาดของจุดที่จะใช้

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontSize(20);

พารามิเตอร์

ชื่อTypeคำอธิบาย
sizeIntegerขนาดแบบอักษรในขนาดจุด

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontSizes(sizes)

ตั้งค่าขนาดแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้) ขนาดจะเป็นจุด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

พารามิเตอร์

ชื่อTypeคำอธิบาย
sizesObject[][]อาร์เรย์สองมิติของขนาด

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontStyle(fontStyle)

ตั้งค่ารูปแบบตัวอักษรสำหรับช่วงที่ระบุ ('italic' หรือ 'normal')

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontStyleStringรูปแบบแบบอักษร 'italic' หรือ 'normal' และค่า null จะรีเซ็ตรูปแบบตัวอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontStyles(fontStyles)

ตั้งค่าตารางสี่เหลี่ยมผืนผ้าตามรูปแบบตัวอักษร (ต้องตรงกับขนาดของช่วงนี้)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontStylesObject[][]อาร์เรย์ 2 มิติของรูปแบบตัวอักษร ระหว่าง 'italic' หรือ 'normal' ค่า null จะรีเซ็ตรูปแบบตัวอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontWeight(fontWeight)

กําหนดน้ำหนักแบบอักษรสําหรับช่วงที่ระบุ (ปกติ/ตัวหนา)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontWeightStringน้ำหนักแบบอักษร 'bold' หรือ 'normal' ค่า null จะรีเซ็ตน้ำหนักแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontWeights(fontWeights)

ตั้งค่าตารางน้ำหนักแบบอักษรเป็นสี่เหลี่ยมผืนผ้า (ต้องตรงกับขนาดของช่วงนี้) ตัวอย่างของน้ำหนักตัวอักษรคือ "bold"

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

พารามิเตอร์

ชื่อTypeคำอธิบาย
fontWeightsObject[][]อาร์เรย์ 2 มิติของน้ำหนักแบบอักษร อาจเป็น 'bold' หรือ 'normal' และค่า null จะรีเซ็ตน้ำหนักแบบอักษร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormula(formula)

อัปเดตสูตรสำหรับช่วงนี้ โดยสูตรที่ระบุต้องอยู่ในรูปแบบ A1

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

พารามิเตอร์

ชื่อTypeคำอธิบาย
formulaStringสตริงแทนสูตรที่จะตั้งเป็นเซลล์

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulaR1C1(formula)

อัปเดตสูตรสำหรับช่วงนี้ สูตรที่ระบุต้องอยู่ในรูปแบบ R1C1

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

พารามิเตอร์

ชื่อTypeคำอธิบาย
formulaStringสูตรสตริง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulas(formulas)

ตั้งค่าตารางสูตรเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติข้อมูลของช่วงนี้) โดยสูตรที่ระบุ ต้องอยู่ในรูปแบบ A1 วิธีนี้ใช้อาร์เรย์ 2 มิติของสูตร โดยจัดทำดัชนีตามแถว และตามคอลัมน์ มิติข้อมูลของอาร์เรย์ต้องสอดคล้องกับมิติข้อมูลช่วง

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

พารามิเตอร์

ชื่อTypeคำอธิบาย
formulasString[][]อาร์เรย์สตริงสองมิติของสูตร

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulasR1C1(formulas)

ตั้งค่าตารางสูตรเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติข้อมูลของช่วงนี้) สูตรที่ระบุ ต้องอยู่ในรูปแบบ R1C1

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

พารามิเตอร์

ชื่อTypeคำอธิบาย
formulasString[][]อาร์เรย์สองมิติของสูตรในรูปแบบ R1C1

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHorizontalAlignment(alignment)

ตั้งค่าการจัดข้อความแนวนอน (ซ้ายไปขวา) สำหรับช่วงที่ระบุ (ซ้าย/กลาง/ขวา)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

พารามิเตอร์

ชื่อTypeคำอธิบาย
alignmentStringการปรับแนว ได้แก่ 'left', 'center' หรือ 'normal' และค่า null จะรีเซ็ตการปรับแนว

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHorizontalAlignments(alignments)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าที่มีการจัดข้อความแนวนอน ดูsetHorizontalAlignment(alignment)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

พารามิเตอร์

ชื่อTypeคำอธิบาย
alignmentsObject[][]การจัดแนวอาร์เรย์ 2 มิติ ได้แก่ 'left', 'center' หรือ 'normal' และค่า null จะรีเซ็ตการปรับแนว

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

ดูเพิ่มเติม


setNote(note)

ตั้งค่าโน้ตเป็นค่าที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

พารามิเตอร์

ชื่อTypeคำอธิบาย
noteStringค่าหมายเหตุที่จะตั้งเป็นช่วง ค่า null จะลบหมายเหตุออก

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNotes(notes)

ตั้งค่าตารางบันทึกสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติของช่วงนี้)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

พารามิเตอร์

ชื่อTypeคำอธิบาย
notesObject[][]อาร์เรย์ 2 มิติของบันทึก ค่า null จะลบบันทึก

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

ดูเพิ่มเติม


setNumberFormat(numberFormat)

ตั้งค่ารูปแบบตัวเลขหรือวันที่เป็นสตริงการจัดรูปแบบที่กำหนด โปรดดูรูปแบบรูปแบบที่ยอมรับไว้ในเอกสารประกอบของ Sheets API

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

พารามิเตอร์

ชื่อTypeคำอธิบาย
numberFormatStringสตริงรูปแบบตัวเลข

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNumberFormats(numberFormats)

ตั้งค่าตารางรูปสี่เหลี่ยมผืนผ้าของรูปแบบตัวเลขหรือรูปแบบ (ต้องตรงกับมิติข้อมูลของช่วงนี้) ค่าดังกล่าวเป็นสตริงรูปแบบตามที่อธิบายไว้ใน เอกสารประกอบของ Sheets API

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

พารามิเตอร์

ชื่อTypeคำอธิบาย
numberFormatsObject[][]อาร์เรย์สองมิติของรูปแบบตัวเลข

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValue(value)

ตั้งค่า Rich Text สำหรับเซลล์ในช่วง

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

พารามิเตอร์

ชื่อTypeคำอธิบาย
valueRichTextValueค่า Rich Text ที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValues(values)

ตั้งค่า Rich Text เป็นตารางสี่เหลี่ยมผืนผ้า

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

พารามิเตอร์

ชื่อTypeคำอธิบาย
valuesRichTextValue[][]ค่า Rich Text ที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

ตั้งค่าว่าช่วงควรแสดงไฮเปอร์ลิงก์หรือไม่

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

พารามิเตอร์

ชื่อTypeคำอธิบาย
showHyperlinkBooleanแสดงไฮเปอร์ลิงก์หรือไม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirection(direction)

กำหนดทิศทางข้อความสำหรับเซลล์ในช่วง หากทิศทางที่ระบุคือ null ระบบจะอนุมานทิศทางนั้นแล้วกำหนด

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

พารามิเตอร์

ชื่อTypeคำอธิบาย
directionTextDirectionทิศทางข้อความที่ต้องการ หาก null มีการอนุมานทิศทางก่อนการตั้งค่า

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirections(directions)

ตั้งค่าตารางเส้นทางของข้อความเป็นสี่เหลี่ยมผืนผ้า หากทิศทางที่ระบุคือ null ระบบจะอนุมานแล้วกำหนดทิศทาง

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

พารามิเตอร์

ชื่อTypeคำอธิบาย
directionsTextDirection[][]ทิศทางข้อความที่ต้องการ หากทิศทางที่ระบุคือ null ระบบจะอนุมานไว้ก่อนการตั้งค่า

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(degrees)

ตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง อินพุตที่สอดคล้องกับมุมระหว่างการวางแนวข้อความมาตรฐานและการวางแนวที่ต้องการ เมื่อป้อนค่าเป็น 0 แสดงว่า ข้อความมีการตั้งค่าเป็นการวางแนวมาตรฐาน

สำหรับทิศทางข้อความจากซ้ายไปขวา มุมบวกจะอยู่ในทิศทางทวนเข็มนาฬิกา ขณะที่มุมขวาไปซ้ายจะอยู่ในทิศทางตามเข็มนาฬิกา

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

พารามิเตอร์

ชื่อTypeคำอธิบาย
degreesIntegerมุมที่ต้องการระหว่างการวางแนวมาตรฐานและการวางแนวที่ต้องการ สำหรับข้อความจากซ้ายไปขวา มุมบวกจะอยู่ในทิศทางทวนเข็มนาฬิกา

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(rotation)

ตั้งค่าการหมุนข้อความสำหรับเซลล์ในช่วง

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

พารามิเตอร์

ชื่อTypeคำอธิบาย
rotationTextRotationการตั้งค่าการหมุนข้อความที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotations(rotations)

ตั้งค่าการหมุนข้อความเป็นสี่เหลี่ยมผืนผ้า

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

พารามิเตอร์

ชื่อTypeคำอธิบาย
rotationsTextRotation[][]การตั้งค่าการหมุนข้อความที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyle(style)

ตั้งค่ารูปแบบข้อความสำหรับเซลล์ในช่วง

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

พารามิเตอร์

ชื่อTypeคำอธิบาย
styleTextStyleรูปแบบข้อความที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyles(styles)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าตามรูปแบบข้อความ

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

พารามิเตอร์

ชื่อTypeคำอธิบาย
stylesTextStyle[][]รูปแบบข้อความที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

ตั้งค่าของช่วง ค่าอาจเป็นตัวเลข สตริง บูลีน หรือวันที่ หากขึ้นต้นด้วย '=' ระบบจะตีความว่าเป็นสูตร

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setValue(100);

พารามิเตอร์

ชื่อTypeคำอธิบาย
valueObjectค่าของช่วง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValues(values)

ตั้งค่าตารางค่าเป็นรูปสี่เหลี่ยมผืนผ้า (ต้องตรงกับมิติของช่วงนี้) หากค่าเริ่มต้นด้วย = ระบบจะตีความว่าเป็นสูตร

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

พารามิเตอร์

ชื่อTypeคำอธิบาย
valuesObject[][]อาร์เรย์สองมิติของค่า

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignment(alignment)

ตั้งค่าการจัดข้อความแนวตั้ง (บนลงล่าง) สำหรับช่วงที่กำหนด (บน/กลาง/ล่าง)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

พารามิเตอร์

ชื่อTypeคำอธิบาย
alignmentStringการปรับแนว ได้แก่ 'top', 'middle' หรือ 'bottom' และค่า null จะรีเซ็ตการปรับแนว

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignments(alignments)

ตั้งค่าตารางสี่เหลี่ยมผืนผ้าของการจัดแนวแนวตั้ง (ต้องตรงกับมิติของช่วงนี้)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

พารามิเตอร์

ชื่อTypeคำอธิบาย
alignmentsObject[][]การจัดแนวอาร์เรย์ 2 มิติ ได้แก่ 'top', 'middle' หรือ 'bottom' และค่า null จะรีเซ็ตการปรับแนว

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

ดูเพิ่มเติม


setVerticalText(isVertical)

ตั้งค่าว่าจะซ้อนข้อความสำหรับเซลล์ในช่วงหรือไม่ หากข้อความเรียงซ้อนกันในแนวตั้ง ระบบจะไม่สนใจการตั้งค่าการหมุนข้อความองศา

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

พารามิเตอร์

ชื่อTypeคำอธิบาย
isVerticalBooleanเลือกว่าจะซ้อนข้อความหรือไม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrap(isWrapEnabled)

ตั้งค่าการตัดเซลล์ของช่วงที่ระบุ

ปรับขนาดเซลล์ที่เปิดใช้การตัดข้อความ (ค่าเริ่มต้น) เพื่อแสดงเนื้อหาทั้งหมด เซลล์ที่ปิดใช้การตัดข้อความจะแสดงขึ้นมาให้มากที่สุดภายในเซลล์โดยไม่มีการปรับขนาดหรือเรียกใช้เป็นหลายบรรทัด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setWrap(true);

พารามิเตอร์

ชื่อTypeคำอธิบาย
isWrapEnabledBooleanตัดข้อความขึ้นบรรทัดใหม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategies(strategies)

ตั้งค่าตารางกลยุทธ์การตัดข้อความเป็นรูปสี่เหลี่ยมผืนผ้า

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

พารามิเตอร์

ชื่อTypeคำอธิบาย
strategiesWrapStrategy[][]กลยุทธ์การสรุปที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategy(strategy)

ตั้งค่ากลยุทธ์การตัดข้อความสำหรับเซลล์ในช่วง

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

พารามิเตอร์

ชื่อTypeคำอธิบาย
strategyWrapStrategyกลยุทธ์การสรุปที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWraps(isWrapEnabled)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของนโยบายการตัดคำ (ต้องตรงกับมิติข้อมูลของช่วงนี้) ปรับขนาดเซลล์ที่เปิดใช้การตัดข้อความ (ค่าเริ่มต้น) เพื่อแสดงเนื้อหาทั้งหมด เซลล์ที่ปิดใช้การตัดข้อความจะแสดงขึ้นมาให้มากที่สุดเท่าที่จะทำได้ในเซลล์โดยไม่มีการปรับขนาดหรือเรียกใช้เป็นหลายบรรทัด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

พารามิเตอร์

ชื่อTypeคำอธิบาย
isWrapEnabledObject[][]อาร์เรย์ 2 มิติของตัวแปรการรวมที่กำหนดว่าจะตัดข้อความในเซลล์หรือไม่

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

ดูเพิ่มเติม


shiftColumnGroupDepth(delta)

เปลี่ยนความลึกในการจัดกลุ่มคอลัมน์ของช่วงตามจำนวนที่ระบุ

การดำเนินการนี้จะสร้าง แก้ไข หรือลบกลุ่มที่ตัดกับช่วง สำหรับเดลต้าเชิงบวก จะมีการสร้างและ/หรือแก้ไขกลุ่ม สำหรับเดลต้าเชิงลบ กลุ่มจะถูกทำลายและ/หรือแก้ไข

การดำเนินการนี้จะไม่มีผลเมื่อลดความลึกของกลุ่มให้ต่ำกว่า 0 หรือสูงกว่า 8

หาก column group control position คือ BEFORE ระบบจะแสดงข้อผิดพลาดเมื่อพยายามปรับความลึกของแถวแรก

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

พารามิเตอร์

ชื่อTypeคำอธิบาย
deltaIntegerจำนวนที่จะเปลี่ยนความลึกของกลุ่มคอลัมน์ของช่วงนี้

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การขว้าง

Error — เมื่อพยายามเลื่อนความลึกของคอลัมน์แรกเมื่อตำแหน่งควบคุมคือ GroupControlTogglePosition.BEFORE

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

shiftRowGroupDepth(delta)

เปลี่ยนความลึกในการจัดกลุ่มแถวของช่วงตามจำนวนที่ระบุ

การดำเนินการนี้จะสร้าง แก้ไข หรือลบกลุ่มที่ตัดกับช่วง สำหรับเดลต้าเชิงบวก จะมีการสร้างและ/หรือแก้ไขกลุ่ม สำหรับเดลต้าเชิงลบ กลุ่มจะถูกทำลายและ/หรือแก้ไข

การดำเนินการนี้จะไม่มีผลเมื่อลดความลึกของกลุ่มให้ต่ำกว่า 0 หรือสูงกว่า 8

หาก row group control position คือ BEFORE ระบบจะแสดงข้อผิดพลาดเมื่อพยายามเปลี่ยนความลึกของแถวแรก

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

พารามิเตอร์

ชื่อTypeคำอธิบาย
deltaIntegerจำนวนที่ใช้เปลี่ยนความลึกของกลุ่มแถวของช่วงนี้

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การขว้าง

Error — เมื่อพยายามเลื่อนความลึกของแถวแรกเมื่อตำแหน่งควบคุมคือ GroupControlTogglePosition.BEFORE

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(sortSpecObj)

จัดเรียงเซลล์ในช่วงที่กำหนดตามคอลัมน์และลำดับที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

พารามิเตอร์

ชื่อTypeคำอธิบาย
sortSpecObjObjectคอลัมน์ที่จะจัดเรียง

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns()

แบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์ตามตัวคั่นที่ตรวจพบอัตโนมัติ

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

แบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์โดยใช้สตริงที่ระบุเป็นตัวคั่นที่กำหนดเอง

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

พารามิเตอร์

ชื่อTypeคำอธิบาย
delimiterStringตัวคั่นที่กำหนดเองที่จะแยก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

แบ่งคอลัมน์ข้อความออกเป็นหลายคอลัมน์ตามตัวคั่นที่ระบุ

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

พารามิเตอร์

ชื่อTypeคำอธิบาย
delimiterTextToColumnsDelimiterตัวคั่นที่กำหนดไว้ล่วงหน้าที่จะแยก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

trimWhitespace()

ตัดช่องว่าง (เช่น เว้นวรรค แท็บ หรือบรรทัดใหม่) ในทุกเซลล์ในช่วงนี้ นำช่องว่างทั้งหมดออกจากจุดเริ่มต้นและจุดสิ้นสุดของข้อความของแต่ละเซลล์ และลดลำดับต่อจากอักขระช่องว่างที่เหลืออยู่เป็นการเว้นวรรคครั้งเดียว

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

uncheck()

เปลี่ยนสถานะของช่องทำเครื่องหมายในช่วงเป็น "ยกเลิกการเลือกแล้ว" ไม่สนใจเซลล์ในช่วงซึ่งขณะนี้ไม่มีค่าที่เลือกหรือไม่เลือกที่กำหนดค่าไว้

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

รีเทิร์น

Range — ช่วงนี้สำหรับการทำเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

วิธีการที่เลิกใช้งานแล้ว