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[][]แสดงผลค่าข้อความที่มีรูปแบบของเซลล์ในช่วง
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กำหนดค่าข้อความที่มีรูปแบบสำหรับเซลล์ในช่วง
setRichTextValues(values)Rangeกำหนดตารางกริดสี่เหลี่ยมผืนผ้าของค่าข้อความที่มีรูปแบบ
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

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

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

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม


activateAsCurrentCell()

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

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

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

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

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

// Gets the cell B5 and sets it as the active cell.
const range = sheet.getRange('B5');
const 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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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(),
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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(),
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const 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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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

const sheet = SpreadsheetApp.getActiveSheet();

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

clear()

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

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

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

พารามิเตอร์

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

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

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

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

clearContent()

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

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

const 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.
const range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

clearFormat()

ล้างการจัดรูปแบบของช่วงนี้

ซึ่งจะล้างการจัดรูปแบบข้อความของเซลล์หรือเซลล์ในแถบ แต่จะไม่รีเซ็ตกฎการจัดรูปแบบตัวเลข

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

clearNote()

ล้างโน้ตในเซลล์ที่ระบุ

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

const range = sheet.getRange('A1:D10');
range.clearNote();

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

collapseGroups()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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()

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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)

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(
    sheet.getRange('F1'),
    SpreadsheetApp.CopyPasteType.PASTE_VALUES,
    false,
);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(sheet.getRange('F1'), {contentsOnly: true});

พารามิเตอร์

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

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

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

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

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

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

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

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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)

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

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

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

พารามิเตอร์

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

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

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

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

createDataSourcePivotTable(dataSource)

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

createDataSourceTable(dataSource)

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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()

const ss = SpreadsheetApp.getActiveSheet();
const 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() {
  const filter = range.getFilter();
  const 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());

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

createTextFinder(findText)

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

TextFinderTextFinder ของช่วง


deleteCells(shiftDimension)

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

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

พารามิเตอร์

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

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

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

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

expandGroups()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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')

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

รีเทิร์น

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

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

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

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

getBackgroundObject()

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

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

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

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

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const 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')

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgrounds();
for (const i in bgColors) {
  for (const 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 (const 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)

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

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

const 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
const cell = range.getCell(1, 1);
Logger.log(cell.getValue());

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

getColumn()

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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() {
  const ss = SpreadsheetApp.openById(
      '1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c',
  );
  const sheet = ss.getSheetByName('ContinentData');
  const range = sheet.getRange('A1:B8');

  const 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

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

// Calling this method with "true" sets the first line to be the title of the
// axes
const 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.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const 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.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

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

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const 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.
const 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 หากไม่มีตัวกรองในชีต

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

รีเทิร์น

Filter — ตัวกรอง

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

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

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

getFontColorObject()

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

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

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

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

const results = range.getFontColorObjects();

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

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

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

const results = range.getFontFamilies();

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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')

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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')

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

const results = range.getFontLines();

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

getFontSize()

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

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

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

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

const results = range.getFontSizes();

for (const i in results) {
  for (const 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') ของเซลล์ที่มุมซ้ายบนของช่วง

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

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

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

const results = range.getFontStyles();

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

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

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

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

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

const results = range.getFontWeights();

for (const i in results) {
  for (const 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) สำหรับเซลล์ซ้ายบนของช่วง หรือสตริงว่างหากเซลล์ว่างเปล่าหรือไม่มีสูตร

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

// This assumes you have a function in B5 that sums up
// B2:B4
const 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 หากไม่มี

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

const range = sheet.getRange('B5');
const 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 มิติจะเป็นสตริงว่างสําหรับเซลล์ที่ไม่มีสูตร

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulas();
for (const i in formulas) {
  for (const 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 สำหรับเซลล์ที่ไม่มีสูตร

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulasR1C1();
for (const i in formulas) {
  for (const 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()

แสดงผลรหัสตารางกริดของชีตหลักของช่วง รหัสคือค่า int แบบสุ่มที่ไม่ใช่ค่าลบ

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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()

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

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

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

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

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

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

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

const results = range.getHorizontalAlignments();

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

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

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

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

แสดงผลตําแหน่งของแถวสุดท้าย

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

const 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 เซลล์ในช่วงปัจจุบัน

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

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

const mergedRanges = range.getMergedRanges();
for (let 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

getNote()

แสดงผลหมายเหตุที่เชื่อมโยงกับช่วงที่กำหนด

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

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

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

const results = range.getNotes();

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

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

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

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

แสดงผลจํานวนแถวในระยะนี้

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

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

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

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

รีเทิร์น

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

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

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

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

getNumberFormats()

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

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

const range = sheet.getRange('B5:C6');
const formats = range.getNumberFormats();
for (const i in formats) {
  for (const 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const 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()

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

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

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

รีเทิร์น

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

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

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

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

getRow()

แสดงผลตําแหน่งแถวของช่วงนี้ เหมือนกับ getRowIndex()

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

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

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

const 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.
const sheet = SpreadsheetApp.getActiveSheet();
const 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
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const directions = range.getTextDirections();

for (let i = 0; i < directions.length; i++) {
  for (let 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.
const sheet = SpreadsheetApp.getActiveSheet();

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

รีเทิร์น

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

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

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

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

getTextRotations()

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

for (const i in results) {
  for (const j in results[i]) {
    const 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const 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
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const styles = range.getTextStyles();

for (let i = 0; i < styles.length; i++) {
  for (let 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.
const 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()

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

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

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

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

const results = range.getVerticalAlignments();

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const strategies = range.getWrapStrategies();

for (let i = 0; i < strategies.length; i++) {
  for (let 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.
const sheet = SpreadsheetApp.getActiveSheet();
const 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()

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

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const 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)

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

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

insertCheckboxes()

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
checkedValueObjectค่าที่เลือกสำหรับการตรวจสอบข้อมูลช่องทำเครื่องหมาย

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
checkedValueObjectค่าที่เลือกสำหรับการตรวจสอบข้อมูลช่องทำเครื่องหมาย
uncheckedValueObjectค่าที่ยกเลิกการเลือกสำหรับการตรวจสอบความถูกต้องของข้อมูลช่องทำเครื่องหมาย

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

isBlank()

แสดงค่า true หากช่วงว่างเปล่าทั้งหมด

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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 หากเลือกเซลล์บางเซลล์ไว้และยกเลิกการเลือกเซลล์ที่เหลือ หรือหากเซลล์บางเซลล์ไม่มีช่องทำเครื่องหมายตรวจสอบข้อมูลที่ถูกต้อง

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

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

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

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

const range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox
// value.
const 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 หากเซลล์ในช่วงปัจจุบันทับซ้อนกับเซลล์ที่ผสาน

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

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

// True if any of the cells in A1:B3 is included in a merge.
const 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()

ผสานเซลล์ในช่วงที่เลือกเข้าด้วยกันเป็นบล็อกเดียว

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

ผสานเซลล์ในช่วงต่างๆ ของคอลัมน์ของช่วง

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

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

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

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

mergeVertically()

ผสานเซลล์ในช่วงเข้าด้วยกัน

const 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
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A1:E').moveTo(sheet.getRange('F1'));

พารามิเตอร์

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

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

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

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

offset(rowOffset, columnOffset)

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

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

const cell = sheet.getRange('A1');

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

พารามิเตอร์

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

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม


offset(rowOffset, columnOffset, numRows)

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

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

const cell = sheet.getRange('A1');

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowOffsetIntegerจำนวนแถวที่เลื่อนลงจากเซลล์ซ้ายบนของช่วง ค่าลบแสดงถึงแถวที่เลื่อนขึ้นจากเซลล์ซ้ายบนของช่วง
columnOffsetIntegerจำนวนคอลัมน์ทางด้านขวาจากเซลล์ซ้ายบนของช่วง ค่าลบแสดงถึงคอลัมน์ทางด้านซ้ายจากเซลล์ซ้ายบนของช่วง
numRowsIntegerความสูงเป็นแถวของช่วงใหม่

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม


offset(rowOffset, columnOffset, numRows, numColumns)

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

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

const cell = sheet.getRange('A1');

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.
const 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()

สุ่มลําดับแถวในช่วงที่ระบุ

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

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

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

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

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

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

นําแถวภายในช่วงนี้ซึ่งมีค่าที่ซ้ำกับค่าในแถวก่อนหน้าออก แถวที่มีค่าเหมือนกันแต่มีตัวอักษรพิมพ์เล็กพิมพ์ใหญ่ การจัดรูปแบบ หรือสูตรต่างกันจะถือว่าเป็นรายการที่ซ้ำกัน นอกจากนี้ วิธีนี้ยังนำแถวที่ซ้ำกันซึ่งซ่อนอยู่ (เช่น เนื่องจากตัวกรอง) ออกด้วย ระบบจะไม่นำเนื้อหาที่อยู่นอกช่วงนี้ออก

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

นําแถวภายในช่วงนี้ที่มีค่าในคอลัมน์ที่ระบุซึ่งซ้ำกันของค่าแถวก่อนหน้าออก แถวที่มีค่าเหมือนกันแต่มีตัวอักษรพิมพ์เล็กพิมพ์ใหญ่ การจัดรูปแบบ หรือสูตรต่างกันจะถือว่าเป็นรายการที่ซ้ำกัน นอกจากนี้ วิธีนี้ยังนำแถวที่ซ้ำกันซึ่งซ่อนอยู่ออกจากมุมมองด้วย (เช่น เนื่องจากตัวกรอง) ระบบจะไม่นำเนื้อหาที่อยู่นอกช่วงนี้ออก

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnsToCompareInteger[]คอลัมน์ที่จะวิเคราะห์หาค่าที่ซ้ำกัน หากไม่ได้ระบุคอลัมน์ ระบบจะวิเคราะห์คอลัมน์ทั้งหมดเพื่อหารายการที่ซ้ำกัน

รีเทิร์น

Range — ช่วงผลลัพธ์หลังจากนํารายการที่ซ้ำกันออก ขนาดของช่วงจะลดลง 1 แถวสําหรับทุกแถวที่นําออก

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

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

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

setBackground(color)

ตั้งค่าสีพื้นหลังของเซลล์ทั้งหมดในช่วงในรูปแบบการเขียน CSS (เช่น '#ffffff' หรือ 'white')

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorStringรหัสสีในเครื่องหมาย CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setBackgroundObject(color)

ตั้งค่าสีพื้นหลังของเซลล์ทั้งหมดในช่วง

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

const range = sheet.getRange('B2:D5');
range.setBackgroundObject(bgColor);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorColorสีพื้นหลังที่จะตั้งค่า ค่า null จะรีเซ็ตสีพื้นหลัง

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setBackgroundObjects(color)

กำหนดตารางกริดสี่เหลี่ยมผืนผ้าของสีพื้นหลัง (ต้องตรงกับมิติข้อมูลของช่วงนี้)

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setBackgroundObjects(colors);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorColor[][]อาร์เรย์ 2 มิติของสี ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setBackgroundRGB(red, green, blue)

ตั้งค่าพื้นหลังเป็นสีที่ระบุโดยใช้ค่า RGB (จำนวนเต็มระหว่าง 0 ถึง 255)

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

const cell = sheet.getRange('B2');

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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')

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

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

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 (ไม่มีการเปลี่ยนแปลง)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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')

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rulesDataValidation[][]อาร์เรย์ 2 มิติของกฎการตรวจสอบข้อมูลที่จะตั้งค่า ค่า null จะนําการตรวจสอบข้อมูลออก

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontColor(color)

กำหนดสีแบบอักษรในเครื่องหมายนิพจน์ CSS (เช่น '#ffffff' หรือ 'white')

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

const cell = sheet.getRange('B2');
cell.setFontColor('red');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorStringสีแบบอักษรในเครื่องหมาย CSS (เช่น '#ffffff' หรือ 'white') ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontColorObject(color)

กำหนดสีแบบอักษรของช่วงที่กำหนด

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

const cell = sheet.getRange('B2');
cell.setFontColor(color);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorColorสีแบบอักษรที่จะตั้งค่า ค่า null จะรีเซ็ตสี

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontColorObjects(colors)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของสีแบบอักษร (ต้องตรงกับมิติข้อมูลของช่วงนี้)

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
colorsColor[][]อาร์เรย์ 2 มิติของสี ค่า null จะรีเซ็ตสีแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontColors(colors)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของสีแบบอักษร (ต้องตรงกับมิติข้อมูลของช่วงนี้) สีอยู่ในรูปแบบการเขียน CSS (เช่น '#ffffff' หรือ 'white')

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

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

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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"

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontFamiliesObject[][]อาร์เรย์ 2 มิติของชุดแบบอักษร ค่า null จะรีเซ็ตชุดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontFamily(fontFamily)

ตั้งค่าชุดแบบอักษร เช่น "Arial" หรือ "Helvetica"

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontFamilyStringชุดแบบอักษรที่จะตั้งค่า ค่า null จะรีเซ็ตชุดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontLine(fontLine)

ตั้งค่ารูปแบบเส้นของแบบอักษรของช่วงที่กำหนด ('underline', 'line-through' หรือ 'none')

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontLineStringรูปแบบบรรทัดแบบอักษร 'underline', 'line-through' หรือ 'none' ค่า null จะรีเซ็ตรูปแบบบรรทัดแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontLines(fontLines)

กำหนดตารางกริดสี่เหลี่ยมผืนผ้าของรูปแบบเส้น (ต้องตรงกับมิติข้อมูลของช่วงนี้)

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

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

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontLinesObject[][]อาร์เรย์ 2 มิติของรูปแบบเส้นแบบอักษร ('underline', 'line-through' หรือ 'none') ค่า null จะรีเซ็ตรูปแบบเส้นแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontSize(size)

กำหนดขนาดแบบอักษร โดยขนาดจะเป็นขนาดจุดที่จะใช้

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sizeIntegerขนาดแบบอักษรเป็นจุด

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontSizes(sizes)

กำหนดตารางกริดสี่เหลี่ยมผืนผ้าของขนาดแบบอักษร (ต้องตรงกับมิติข้อมูลของช่วงนี้) ขนาดจะแสดงเป็นจุด

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

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

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sizesObject[][]อาร์เรย์ขนาด 2 มิติ

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontStyle(fontStyle)

กำหนดรูปแบบแบบอักษรสำหรับช่วงที่กำหนด ('italic' หรือ 'normal')

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontStyleStringรูปแบบแบบอักษร 'italic' หรือ 'normal' ค่า null จะรีเซ็ตรูปแบบแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontStyles(fontStyles)

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

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

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

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontStylesObject[][]อาร์เรย์ 2 มิติของรูปแบบแบบอักษร 'italic' หรือ 'normal' ค่า null จะรีเซ็ตรูปแบบแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontWeight(fontWeight)

กำหนดน้ำหนักแบบอักษรสำหรับช่วงที่กำหนด (ปกติ/หนา)

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontWeightStringน้ำหนักแบบอักษร 'bold' หรือ 'normal' ค่า null จะรีเซ็ตน้ำหนักแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFontWeights(fontWeights)

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fontWeightsObject[][]อาร์เรย์ 2 มิติของน้ำหนักแบบอักษร 'bold' หรือ 'normal' ค่า null จะรีเซ็ตน้ำหนักแบบอักษร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFormula(formula)

อัปเดตสูตรสําหรับช่วงนี้ สูตรที่ระบุต้องอยู่ในรูปแบบ A1

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formulaStringสตริงที่แสดงสูตรที่จะตั้งค่าสําหรับเซลล์

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFormulaR1C1(formula)

อัปเดตสูตรสําหรับช่วงนี้ สูตรที่ระบุต้องอยู่ในรูปแบบ R1C1

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

const 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])');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formulaStringสูตรสตริง

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFormulas(formulas)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของสูตร (ต้องตรงกับมิติข้อมูลของช่วงนี้) สูตรที่ระบุต้องอยู่ในรูปแบบ A1 เมธอดนี้จะรับอาร์เรย์สูตร 2 มิติ โดยจัดทําดัชนีตามแถว แล้วตามด้วยคอลัมน์ ขนาดอาร์เรย์ต้องสอดคล้องกับขนาดช่วง

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formulasString[][]อาร์เรย์สตริง 2 มิติของสูตร

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setFormulasR1C1(formulas)

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

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

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formulasString[][]อาร์เรย์สูตร 2 มิติในรูปแบบ R1C1

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setHorizontalAlignment(alignment)

ตั้งค่าการจัดแนวนอน (ซ้ายไปขวา) สำหรับช่วงที่กำหนด (ซ้าย/กลาง/ขวา)

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
alignmentStringการจัดแนว ซึ่งอาจเป็น 'left', 'center' หรือ 'normal' ค่า null จะรีเซ็ตการจัดแนว

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setHorizontalAlignments(alignments)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของการจัดแนวนอน ดู setHorizontalAlignment(alignment)

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

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

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
alignmentsObject[][]อาร์เรย์ 2 มิติของการจัดแนว ซึ่งอาจเป็น 'left', 'center' หรือ 'normal' ค่า null จะรีเซ็ตการจัดแนว

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

ดูเพิ่มเติม


setNote(note)

ตั้งค่าหมายเหตุเป็นค่าที่ระบุ

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
noteStringค่าหมายเหตุที่จะตั้งค่าสำหรับช่วง ค่า null จะนําหมายเหตุออก

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setNotes(notes)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของโน้ต (ต้องตรงกับขนาดของช่วงนี้)

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

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

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
notesObject[][]อาร์เรย์ 2 มิติของโน้ต ค่า null จะนําโน้ตออก

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

ดูเพิ่มเติม


setNumberFormat(numberFormat)

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
numberFormatStringสตริงรูปแบบตัวเลข

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setNumberFormats(numberFormats)

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

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

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

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
numberFormatsObject[][]อาร์เรย์ 2 มิติของรูปแบบตัวเลข

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setRichTextValue(value)

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
valueRichTextValueค่าข้อความที่มีรูปแบบที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setRichTextValues(values)

กำหนดตารางกริดสี่เหลี่ยมผืนผ้าของค่าข้อความที่มีรูปแบบ

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextDirections());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setTextRotation(45);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();

const rotation = sheet.getRange('A1').getTextRotation();

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextRotations());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('C5:D6');
const style =
    SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build();
range.setTextStyle(style);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const otherStyle = SpreadsheetApp.newTextStyle()
                       .setBold(true)
                       .setUnderline(true)
                       .setItalic(true)
                       .setForegroundColor('#335522')
                       .setFontSize(44)
                       .build();
range.setTextStyles([
  [bold, otherStyle],
  [otherStyle, bold],
]);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
stylesTextStyle[][]รูปแบบข้อความที่ต้องการ

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setValue(value)

ตั้งค่าของช่วง ค่าอาจเป็นตัวเลข สตริง บูลีน หรือวันที่ หากเริ่มต้นด้วย '=' ระบบจะตีความว่าเป็นสูตร

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

const cell = sheet.getRange('B2');
cell.setValue(100);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
valueObjectค่าของช่วง

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setValues(values)

ตั้งค่าตารางกริดสี่เหลี่ยมผืนผ้าของค่า (ต้องตรงกับมิติข้อมูลของช่วงนี้) หากค่าขึ้นต้นด้วย = ระบบจะตีความค่านั้นเป็นสูตร

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

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

const range = sheet.getRange('B2:D2');
range.setValues(values);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
valuesObject[][]อาร์เรย์ค่า 2 มิติ

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setVerticalAlignment(alignment)

ตั้งค่าการจัดแนวแนวตั้ง (จากบนลงล่าง) สำหรับช่วงที่กำหนด (บน/กลาง/ล่าง)

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
alignmentStringการจัดแนว ซึ่งอาจเป็น 'top', 'middle' หรือ 'bottom' ค่า null จะรีเซ็ตการจัดแนว

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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

setVerticalAlignments(alignments)

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

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

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

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
isVerticalBooleanเลือกว่าจะซ้อนข้อความหรือไม่

รีเทิร์น

Range — ช่วงนี้สําหรับการต่อเชื่อม

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

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

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