Class Sheet

Trang tính

Truy cập và sửa đổi các trang tính trong bảng tính. Các thao tác phổ biến là đổi tên trang tính và truy cập vào đối tượng phạm vi từ trang tính.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
activate()SheetKích hoạt trang tính này.
addDeveloperMetadata(key)SheetThêm siêu dữ liệu nhà phát triển có khoá đã chỉ định vào trang tính.
addDeveloperMetadata(key, visibility)SheetThêm siêu dữ liệu nhà phát triển có khoá và chế độ hiển thị được chỉ định vào trang tính.
addDeveloperMetadata(key, value)SheetThêm siêu dữ liệu nhà phát triển có khoá và giá trị đã chỉ định vào trang tính.
addDeveloperMetadata(key, value, visibility)SheetThêm siêu dữ liệu nhà phát triển có khoá, giá trị và chế độ hiển thị được chỉ định vào trang tính.
appendRow(rowContents)SheetThêm một hàng vào cuối vùng dữ liệu hiện tại trong trang tính.
asDataSourceSheet()DataSourceSheetTrả về trang tính dưới dạng DataSourceSheet nếu trang tính thuộc loại SheetType.DATASOURCE hoặc null nếu không.
autoResizeColumn(columnPosition)SheetĐặt chiều rộng của cột đã cho cho phù hợp với nội dung của cột đó.
autoResizeColumns(startColumn, numColumns)SheetĐặt chiều rộng của tất cả các cột bắt đầu từ vị trí cột nhất định để vừa với nội dung của các cột đó.
autoResizeRows(startRow, numRows)SheetĐặt chiều cao của tất cả các hàng bắt đầu từ vị trí hàng nhất định để vừa với nội dung của các hàng đó.
clear()SheetXoá nội dung và thông tin định dạng khỏi trang tính.
clear(options)SheetXoá nội dung và/hoặc định dạng của trang tính, như được chỉ định bằng các tuỳ chọn nâng cao đã cho.
clearConditionalFormatRules()voidXoá tất cả quy tắc định dạng có điều kiện khỏi trang tính.
clearContents()SheetXoá nội dung trang tính, trong khi vẫn giữ lại thông tin định dạng.
clearFormats()SheetXoá định dạng của trang tính, trong khi vẫn giữ lại nội dung.
clearNotes()SheetXoá tất cả ghi chú khỏi trang tính.
collapseAllColumnGroups()SheetThu gọn tất cả các nhóm cột trên trang tính.
collapseAllRowGroups()SheetThu gọn tất cả các nhóm hàng trên trang tính.
copyTo(spreadsheet)SheetSao chép trang tính vào một bảng tính nhất định, có thể là cùng một bảng tính với nguồn.
createDeveloperMetadataFinder()DeveloperMetadataFinderTrả về DeveloperMetadataFinder để tìm siêu dữ liệu nhà phát triển trong phạm vi của trang tính này.
createTextFinder(findText)TextFinderTạo trình tìm kiếm văn bản cho trang tính. Trình tìm kiếm này có thể tìm và thay thế văn bản trong trang tính.
deleteColumn(columnPosition)SheetXoá cột ở vị trí cột đã cho.
deleteColumns(columnPosition, howMany)voidXoá một số cột bắt đầu từ vị trí cột đã cho.
deleteRow(rowPosition)SheetXoá hàng ở vị trí hàng đã cho.
deleteRows(rowPosition, howMany)voidXoá một số hàng bắt đầu từ vị trí hàng đã cho.
expandAllColumnGroups()SheetMở rộng tất cả các nhóm cột trên trang tính.
expandAllRowGroups()SheetMở rộng tất cả các nhóm hàng trên trang tính.
expandColumnGroupsUpToDepth(groupDepth)SheetMở rộng tất cả các nhóm cột đến độ sâu đã cho và thu gọn tất cả các nhóm cột khác.
expandRowGroupsUpToDepth(groupDepth)SheetMở rộng tất cả các nhóm hàng đến độ sâu đã cho và thu gọn tất cả các nhóm khác.
getActiveCell()RangeTrả về ô đang hoạt động trong trang tính này.
getActiveRange()RangeTrả về dải ô đã chọn trong trang tính đang hoạt động hoặc null nếu không có dải ô nào đang hoạt động.
getActiveRangeList()RangeListTrả về danh sách các dải ô đang hoạt động trong trang tính đang hoạt động hoặc null nếu không có dải ô nào đang hoạt động.
getBandings()Banding[]Trả về tất cả các dải trong trang tính này.
getCharts()EmbeddedChart[]Trả về một mảng biểu đồ trên trang tính này.
getColumnGroup(columnIndex, groupDepth)GroupTrả về nhóm cột tại chỉ mục và chiều sâu nhóm đã cho.
getColumnGroupControlPosition()GroupControlTogglePositionTrả về GroupControlTogglePosition cho tất cả các nhóm cột trên trang tính.
getColumnGroupDepth(columnIndex)IntegerTrả về chiều sâu nhóm của cột tại chỉ mục đã cho.
getColumnWidth(columnPosition)IntegerLấy chiều rộng tính bằng pixel của cột đã cho.
getConditionalFormatRules()ConditionalFormatRule[]Lấy tất cả quy tắc định dạng có điều kiện trong trang tính này.
getCurrentCell()RangeTrả về ô hiện tại trong trang tính đang hoạt động hoặc null nếu không có ô hiện tại.
getDataRange()RangeTrả về một Range tương ứng với các phương diện có dữ liệu.
getDataSourceFormulas()DataSourceFormula[]Lấy tất cả công thức nguồn dữ liệu.
getDataSourcePivotTables()DataSourcePivotTable[]Lấy tất cả bảng tổng hợp nguồn dữ liệu.
getDataSourceTables()DataSourceTable[]Lấy tất cả bảng nguồn dữ liệu.
getDeveloperMetadata()DeveloperMetadata[]Lấy tất cả siêu dữ liệu dành cho nhà phát triển được liên kết với trang tính này.
getDrawings()Drawing[]Trả về một mảng các bản vẽ trên trang tính.
getFilter()FilterTrả về bộ lọc trong trang tính này hoặc null nếu không có bộ lọc nào.
getFormUrl()StringTrả về URL của biểu mẫu gửi phản hồi đến trang tính này hoặc null nếu trang tính này không có biểu mẫu liên kết.
getFrozenColumns()IntegerTrả về số lượng cột được cố định.
getFrozenRows()IntegerTrả về số lượng hàng được cố định.
getImages()OverGridImage[]Trả về tất cả hình ảnh nằm ngoài lưới trên trang tính.
getIndex()IntegerLấy vị trí của trang tính trong bảng tính mẹ.
getLastColumn()IntegerTrả về vị trí của cột cuối cùng có nội dung.
getLastRow()IntegerTrả về vị trí của hàng cuối cùng có nội dung.
getMaxColumns()IntegerTrả về số lượng cột hiện tại trong trang tính, bất kể nội dung.
getMaxRows()IntegerTrả về số lượng hàng hiện tại trong trang tính, bất kể nội dung.
getName()StringTrả về tên của trang tính.
getNamedRanges()NamedRange[]Lấy tất cả các dải ô có tên trong trang tính này.
getParent()SpreadsheetTrả về Spreadsheet chứa trang tính này.
getPivotTables()PivotTable[]Trả về tất cả bảng tổng hợp trên trang tính này.
getProtections(type)Protection[]Lấy một mảng đối tượng đại diện cho tất cả các dải ô được bảo vệ trong trang tính hoặc một mảng có một phần tử duy nhất đại diện cho chế độ bảo vệ trên chính trang tính đó.
getRange(row, column)RangeTrả về dải ô có ô trên cùng bên trái tại toạ độ đã cho.
getRange(row, column, numRows)RangeTrả về dải ô có ô trên cùng bên trái tại toạ độ đã cho và có số hàng đã cho.
getRange(row, column, numRows, numColumns)RangeTrả về dải ô có ô trên cùng bên trái tại toạ độ đã cho với số lượng hàng và cột đã cho.
getRange(a1Notation)RangeTrả về dải ô được chỉ định theo ký hiệu A1 hoặc ký hiệu R1C1.
getRangeList(a1Notations)RangeListTrả về tập hợp RangeList đại diện cho các dải ô trong cùng một trang tính được chỉ định bằng danh sách không trống gồm các ký hiệu A1 hoặc R1C1.
getRowGroup(rowIndex, groupDepth)GroupTrả về nhóm hàng tại chỉ mục và chiều sâu nhóm đã cho.
getRowGroupControlPosition()GroupControlTogglePositionTrả về GroupControlTogglePosition cho tất cả các nhóm hàng trên trang tính.
getRowGroupDepth(rowIndex)IntegerTrả về chiều sâu nhóm của hàng tại chỉ mục đã cho.
getRowHeight(rowPosition)IntegerLấy chiều cao tính bằng pixel của hàng đã cho.
getSelection()SelectionTrả về Selection hiện tại trong bảng tính.
getSheetId()IntegerTrả về mã nhận dạng của trang tính do đối tượng này biểu thị.
getSheetName()StringTrả về tên trang tính.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Trả về lưới hình chữ nhật gồm các giá trị cho dải ô này, bắt đầu từ toạ độ đã cho.
getSlicers()Slicer[]Trả về một mảng các công cụ lọc trên trang tính.
getTabColorObject()ColorLấy màu thẻ trang tính hoặc null nếu thẻ trang tính không có màu.
getType()SheetTypeTrả về loại trang tính.
hasHiddenGridlines()BooleanTrả về true nếu đường lưới của trang tính bị ẩn; nếu không thì trả về false.
hideColumn(column)voidẨn cột hoặc các cột trong dải ô đã cho.
hideColumns(columnIndex)voidẨn một cột tại chỉ mục đã cho.
hideColumns(columnIndex, numColumns)voidẨn một hoặc nhiều cột liên tiếp bắt đầu từ chỉ mục đã cho.
hideRow(row)voidẨn các hàng trong dải ô đã cho.
hideRows(rowIndex)voidẨn hàng tại chỉ mục đã cho.
hideRows(rowIndex, numRows)voidẨn một hoặc nhiều hàng liên tiếp bắt đầu từ chỉ mục đã cho.
hideSheet()SheetẨn trang tính này.
insertChart(chart)voidThêm một biểu đồ mới vào trang tính này.
insertColumnAfter(afterPosition)SheetChèn một cột sau vị trí cột đã cho.
insertColumnBefore(beforePosition)SheetChèn một cột trước vị trí cột đã cho.
insertColumns(columnIndex)voidChèn một cột trống vào trang tính tại vị trí đã chỉ định.
insertColumns(columnIndex, numColumns)voidChèn một hoặc nhiều cột trống liên tiếp trong một trang tính bắt đầu từ vị trí đã chỉ định.
insertColumnsAfter(afterPosition, howMany)SheetChèn một số lượng cột nhất định sau vị trí cột đã cho.
insertColumnsBefore(beforePosition, howMany)SheetChèn một số cột trước vị trí cột đã cho.
insertImage(blobSource, column, row)OverGridImageChèn BlobSource dưới dạng hình ảnh trong tài liệu ở một hàng và cột nhất định.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageChèn BlobSource dưới dạng hình ảnh trong tài liệu ở một hàng và cột nhất định, với độ dời pixel.
insertImage(url, column, row)OverGridImageChèn hình ảnh vào tài liệu ở một hàng và cột nhất định.
insertImage(url, column, row, offsetX, offsetY)OverGridImageChèn hình ảnh vào tài liệu ở một hàng và cột nhất định, với độ dời pixel.
insertRowAfter(afterPosition)SheetChèn một hàng sau vị trí hàng đã cho.
insertRowBefore(beforePosition)SheetChèn một hàng trước vị trí hàng đã cho.
insertRows(rowIndex)voidChèn một hàng trống vào trang tính ở vị trí đã chỉ định.
insertRows(rowIndex, numRows)voidChèn một hoặc nhiều hàng trống liên tiếp trong một trang tính bắt đầu từ vị trí đã chỉ định.
insertRowsAfter(afterPosition, howMany)SheetChèn một số hàng sau vị trí hàng đã cho.
insertRowsBefore(beforePosition, howMany)SheetChèn một số hàng trước vị trí hàng đã cho.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerThêm một công cụ lọc mới vào trang tính này.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerThêm một công cụ lọc mới vào trang tính này.
isColumnHiddenByUser(columnPosition)BooleanTrả về kết quả cho biết người dùng có ẩn cột đã cho hay không.
isRightToLeft()BooleanTrả về true nếu bố cục của trang tính này là từ phải sang trái.
isRowHiddenByFilter(rowPosition)BooleanTrả về giá trị cho biết liệu một bộ lọc (không phải chế độ xem bộ lọc) có ẩn hàng đã cho hay không.
isRowHiddenByUser(rowPosition)BooleanTrả về kết quả cho biết người dùng có ẩn hàng đã cho hay không.
isSheetHidden()BooleanTrả về true nếu trang tính hiện đang bị ẩn.
moveColumns(columnSpec, destinationIndex)voidDi chuyển các cột được chọn theo dải ô đã cho sang vị trí do destinationIndex chỉ định.
moveRows(rowSpec, destinationIndex)voidDi chuyển các hàng được chọn theo dải ô đã cho đến vị trí do destinationIndex chỉ định.
newChart()EmbeddedChartBuilderTrả về một trình tạo để tạo biểu đồ mới cho trang tính này.
protect()ProtectionTạo một đối tượng có thể bảo vệ trang tính khỏi bị chỉnh sửa, ngoại trừ những người dùng có quyền.
removeChart(chart)voidXoá một biểu đồ khỏi trang tính mẹ.
setActiveRange(range)RangeĐặt dải ô được chỉ định làm active range trong trang tính đang hoạt động, với ô trên cùng bên trái trong dải ô là current cell.
setActiveRangeList(rangeList)RangeListĐặt danh sách dải ô đã chỉ định làm active ranges trong trang tính đang hoạt động.
setActiveSelection(range)RangeĐặt vùng lựa chọn đang hoạt động cho trang tính này.
setActiveSelection(a1Notation)RangeĐặt lựa chọn đang hoạt động, như được chỉ định trong ký hiệu A1 hoặc ký hiệu R1C1.
setColumnGroupControlPosition(position)SheetĐặt vị trí của nút bật/tắt điều khiển nhóm cột trên trang tính.
setColumnWidth(columnPosition, width)SheetĐặt chiều rộng của cột đã cho tính bằng pixel.
setColumnWidths(startColumn, numColumns, width)SheetĐặt chiều rộng của các cột đã cho tính bằng pixel.
setConditionalFormatRules(rules)voidThay thế tất cả quy tắc định dạng có điều kiện hiện có trong trang tính bằng quy tắc nhập.
setCurrentCell(cell)RangeĐặt ô được chỉ định làm current cell.
setFrozenColumns(columns)voidCố định số cột đã cho.
setFrozenRows(rows)voidKhoá số hàng đã cho.
setHiddenGridlines(hideGridlines)SheetẨn hoặc hiện đường lưới của trang tính.
setName(name)SheetĐặt tên cho trang tính.
setRightToLeft(rightToLeft)SheetĐặt hoặc huỷ đặt bố cục trang tính thành từ phải sang trái.
setRowGroupControlPosition(position)SheetĐặt vị trí của nút bật/tắt điều khiển nhóm hàng trên trang tính.
setRowHeight(rowPosition, height)SheetĐặt chiều cao của hàng cho hàng đã cho theo pixel.
setRowHeights(startRow, numRows, height)SheetĐặt chiều cao của các hàng đã cho tính bằng pixel.
setRowHeightsForced(startRow, numRows, height)SheetĐặt chiều cao của các hàng đã cho tính bằng pixel.
setTabColor(color)SheetĐặt màu cho thẻ trang tính.
setTabColorObject(color)SheetĐặt màu cho thẻ trang tính.
showColumns(columnIndex)voidBỏ ẩn cột tại chỉ mục đã cho.
showColumns(columnIndex, numColumns)voidBỏ ẩn một hoặc nhiều cột liên tiếp bắt đầu từ chỉ mục đã cho.
showRows(rowIndex)voidBỏ ẩn hàng tại chỉ mục đã cho.
showRows(rowIndex, numRows)voidBỏ ẩn một hoặc nhiều hàng liên tiếp bắt đầu từ chỉ mục đã cho.
showSheet()SheetHiển thị trang tính.
sort(columnPosition)SheetSắp xếp trang tính theo cột, tăng dần.
sort(columnPosition, ascending)SheetSắp xếp trang tính theo cột.
unhideColumn(column)voidBỏ ẩn cột trong dải ô đã cho.
unhideRow(row)voidBỏ ẩn hàng trong dải ô đã cho.
updateChart(chart)voidCập nhật biểu đồ trên trang tính này.

Tài liệu chi tiết

activate()

Kích hoạt trang tính này. Không thay đổi chính trang tính, chỉ thay đổi khái niệm của trang tính mẹ về trang tính đang hoạt động.

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

Cầu thủ trả bóng

Sheet – Trang tính mới đang hoạt động.


addDeveloperMetadata(key)

Thêm siêu dữ liệu nhà phát triển có khoá đã chỉ định vào trang tính.

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

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

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

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

Tham số

TênLoạiMô tả
keyStringKhoá cho siêu dữ liệu nhà phát triển mới.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

addDeveloperMetadata(key, visibility)

Thêm siêu dữ liệu nhà phát triển có khoá và chế độ hiển thị được chỉ định vào trang tính.

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

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

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

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

Tham số

TênLoạiMô tả
keyStringKhoá cho siêu dữ liệu nhà phát triển mới.
visibilityDeveloperMetadataVisibilityChế độ hiển thị của siêu dữ liệu mới của nhà phát triển.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

addDeveloperMetadata(key, value)

Thêm siêu dữ liệu nhà phát triển có khoá và giá trị đã chỉ định vào trang tính.

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

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

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

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

Tham số

TênLoạiMô tả
keyStringKhoá cho siêu dữ liệu nhà phát triển mới.
valueStringGiá trị cho siêu dữ liệu nhà phát triển mới.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

addDeveloperMetadata(key, value, visibility)

Thêm siêu dữ liệu nhà phát triển có khoá, giá trị và chế độ hiển thị được chỉ định vào trang tính.

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

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

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

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

Tham số

TênLoạiMô tả
keyStringKhoá cho siêu dữ liệu nhà phát triển mới.
valueStringGiá trị cho siêu dữ liệu nhà phát triển mới.
visibilityDeveloperMetadataVisibilityChế độ hiển thị của siêu dữ liệu mới của nhà phát triển.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

appendRow(rowContents)

Thêm một hàng vào cuối vùng dữ liệu hiện tại trong trang tính. Nếu nội dung của một ô bắt đầu bằng =, thì nội dung đó sẽ được diễn giải là một công thức.

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

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

Tham số

TênLoạiMô tả
rowContentsObject[]Một mảng giá trị để chèn sau hàng cuối cùng trong trang tính.

Cầu thủ trả bóng

Sheet – Trang tính, hữu ích cho việc tạo chuỗi phương thức.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

asDataSourceSheet()

Trả về trang tính dưới dạng DataSourceSheet nếu trang tính thuộc loại SheetType.DATASOURCE hoặc null nếu không.

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

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

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

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

Cầu thủ trả bóng

DataSourceSheet – Trang tính nguồn dữ liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

autoResizeColumn(columnPosition)

Đặt chiều rộng của cột đã cho cho phù hợp với nội dung của cột đó.

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

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

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

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột đã cho để đổi kích thước.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

autoResizeColumns(startColumn, numColumns)

Đặt chiều rộng của tất cả các cột bắt đầu từ vị trí cột nhất định để vừa với nội dung của các cột đó.

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

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

Tham số

TênLoạiMô tả
startColumnIntegerCột bắt đầu để tự động đổi kích thước.
numColumnsIntegerSố lượng cột cần tự động đổi kích thước.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

autoResizeRows(startRow, numRows)

Đặt chiều cao của tất cả các hàng bắt đầu từ vị trí hàng nhất định để vừa với nội dung của các hàng đó.

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

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

Tham số

TênLoạiMô tả
startRowIntegerHàng bắt đầu để tự động đổi kích thước.
numRowsIntegerSố hàng cần tự động đổi kích thước.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clear()

Xoá nội dung và thông tin định dạng khỏi trang tính.

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

Cầu thủ trả bóng

Sheet – Trang tính đã xoá.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clear(options)

Xoá nội dung và/hoặc định dạng của trang tính, như được chỉ định bằng các tuỳ chọn nâng cao đã cho.

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

Tham số

TênLoạiMô tả
optionsObjectMột bản đồ JavaScript chứa các tuỳ chọn nâng cao, được liệt kê bên dưới.

Thông số nâng cao

TênLoạiMô tả
contentsOnlyBooleanLiệu có xoá nội dung hay không.
formatOnlyBooleanXoá định dạng hay không.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clearConditionalFormatRules()

Xoá tất cả quy tắc định dạng có điều kiện khỏi trang tính. Tương đương với việc gọi setConditionalFormatRules(rules) với một mảng trống làm dữ liệu đầu vào.

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

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clearContents()

Xoá nội dung trang tính, trong khi vẫn giữ lại thông tin định dạng.

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clearFormats()

Xoá định dạng của trang tính, trong khi vẫn giữ lại nội dung.

Định dạng đề cập đến cách dữ liệu được định dạng theo các lựa chọn được cho phép trong trình đơn "Định dạng" (ví dụ: in đậm, in nghiêng, định dạng có điều kiện) chứ không phải chiều rộng hoặc chiều cao của ô.

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

clearNotes()

Xoá tất cả ghi chú khỏi trang tính.

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

collapseAllColumnGroups()

Thu gọn tất cả các nhóm cột trên trang tính.

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

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

collapseAllRowGroups()

Thu gọn tất cả các nhóm hàng trên trang tính.

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

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

copyTo(spreadsheet)

Sao chép trang tính vào một bảng tính nhất định, có thể là cùng một bảng tính với nguồn. Trang tính đã sao chép có tên là "Bản sao của [tên ban đầu]".

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

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

Tham số

TênLoạiMô tả
spreadsheetSpreadsheetBảng tính để sao chép trang tính này vào, có thể là cùng một bảng tính với bảng tính nguồn.

Cầu thủ trả bóng

Sheet – Trang tính mới, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

createDeveloperMetadataFinder()

Trả về DeveloperMetadataFinder để tìm siêu dữ liệu nhà phát triển trong phạm vi của trang tính này. Siêu dữ liệu nằm trong phạm vi của một trang tính cụ thể nếu siêu dữ liệu đó được liên kết với chính trang tính hoặc được liên kết với một hàng, cột hoặc dải ô trên trang tính đó.

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

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

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

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

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

Cầu thủ trả bóng

DeveloperMetadataFinder – Trình tìm siêu dữ liệu nhà phát triển để tìm siêu dữ liệu trong phạm vi của trang tính này.


createTextFinder(findText)

Tạo trình tìm kiếm văn bản cho trang tính. Trình tìm kiếm này có thể tìm và thay thế văn bản trong trang tính.

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

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

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

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

Tham số

TênLoạiMô tả
findTextStringVăn bản cần tìm kiếm.

Cầu thủ trả bóng

TextFinderTextFinder cho trang tính.


deleteColumn(columnPosition)

Xoá cột ở vị trí cột đã cho.

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

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột, bắt đầu từ 1 cho cột đầu tiên.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

deleteColumns(columnPosition, howMany)

Xoá một số cột bắt đầu từ vị trí cột đã cho.

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

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột đầu tiên cần xoá.
howManyIntegerSố lượng cột cần xoá.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

deleteRow(rowPosition)

Xoá hàng ở vị trí hàng đã cho.

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

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí của hàng, bắt đầu từ 1 cho hàng đầu tiên.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

deleteRows(rowPosition, howMany)

Xoá một số hàng bắt đầu từ vị trí hàng đã cho.

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

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí của hàng đầu tiên cần xoá.
howManyIntegerSố hàng cần xoá.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

expandAllColumnGroups()

Mở rộng tất cả các nhóm cột trên trang tính. Phương thức này yêu cầu ít nhất một nhóm cột.

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

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

expandAllRowGroups()

Mở rộng tất cả các nhóm hàng trên trang tính. Phương thức này yêu cầu ít nhất một nhóm hàng.

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

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

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

expandColumnGroupsUpToDepth(groupDepth)

Mở rộng tất cả các nhóm cột đến độ sâu đã cho và thu gọn tất cả các nhóm cột khác.

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

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

Tham số

TênLoạiMô tả
groupDepthIntegerChiều sâu nhóm tối đa để mở rộng các nhóm cột.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

expandRowGroupsUpToDepth(groupDepth)

Mở rộng tất cả các nhóm hàng đến độ sâu đã cho và thu gọn tất cả các nhóm khác.

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

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

Tham số

TênLoạiMô tả
groupDepthIntegerChiều sâu nhóm tối đa để mở rộng các nhóm hàng.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getActiveCell()

Trả về ô đang hoạt động trong trang tính này.

Lưu ý: Bạn nên sử dụng getCurrentCell() để trả về ô được làm nổi bật hiện tại.

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

Cầu thủ trả bóng

Range – ô đang hoạt động hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getActiveRange()

Trả về dải ô đã chọn trong trang tính đang hoạt động hoặc null nếu không có dải ô nào đang hoạt động. Nếu bạn chọn nhiều dải ô, phương thức này sẽ chỉ trả về dải ô được chọn gần đây nhất.

Thuật ngữ "dải ô đang hoạt động" đề cập đến dải ô mà người dùng đã chọn trong trang tính đang hoạt động, nhưng trong hàm tuỳ chỉnh, thuật ngữ này đề cập đến ô đang được tính toán lại.

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

Cầu thủ trả bóng

Range – dải ô đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Xem thêm


getActiveRangeList()

Trả về danh sách các dải ô đang hoạt động trong trang tính đang hoạt động hoặc null nếu không có dải ô nào đang hoạt động.

Nếu bạn chỉ chọn một dải ô, thì thao tác này sẽ hoạt động như một lệnh gọi getActiveRange().

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

Cầu thủ trả bóng

RangeList – danh sách các dải ô đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Xem thêm


getBandings()

Trả về tất cả các dải trong trang tính này.

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

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

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

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

Cầu thủ trả bóng

Banding[] – Tất cả các dải trong trang tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getCharts()

Trả về một mảng biểu đồ trên trang tính này.

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

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

Cầu thủ trả bóng

EmbeddedChart[] – Một mảng biểu đồ.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getColumnGroup(columnIndex, groupDepth)

Trả về nhóm cột tại chỉ mục và chiều sâu nhóm đã cho.

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

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục cột của nút bật/tắt điều khiển nhóm hoặc chỉ mục trong nhóm.
groupDepthIntegerĐộ sâu của nhóm.

Cầu thủ trả bóng

Group – Nhóm cột ở chỉ mục và chiều sâu điều khiển, hoặc gửi một ngoại lệ nếu nhóm không tồn tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getColumnGroupControlPosition()

Trả về GroupControlTogglePosition cho tất cả các nhóm cột trên trang tính.

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

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

Cầu thủ trả bóng

GroupControlTogglePositiontrue nếu nút bật/tắt điều khiển nhóm cột xuất hiện sau nhóm trên trang tính này và false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getColumnGroupDepth(columnIndex)

Trả về chiều sâu nhóm của cột tại chỉ mục đã cho.

Độ sâu nhóm cho biết số lượng nhóm trùng lặp với cột. Giá trị này có thể nằm trong khoảng từ 0 đến 8.

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

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục của cột.

Cầu thủ trả bóng

Integer – Chiều sâu nhóm của cột tại chỉ mục đã cho.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getColumnWidth(columnPosition)

Lấy chiều rộng tính bằng pixel của cột đã cho.

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

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

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột cần kiểm tra.

Cầu thủ trả bóng

Integer – chiều rộng cột tính bằng pixel

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getConditionalFormatRules()

Lấy tất cả quy tắc định dạng có điều kiện trong trang tính này.

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

Cầu thủ trả bóng

ConditionalFormatRule[] – Một mảng chứa tất cả các quy tắc trong trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getCurrentCell()

Trả về ô hiện tại trong trang tính đang hoạt động hoặc null nếu không có ô hiện tại. Ô hiện tại là ô có tiêu điểm trong giao diện người dùng của Google Trang tính và được đánh dấu bằng đường viền màu tối. Không bao giờ có nhiều hơn một ô hiện tại. Khi người dùng chọn một hoặc nhiều dải ô, một trong các ô trong vùng chọn sẽ là ô hiện tại.

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

Cầu thủ trả bóng

Range – ô hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDataRange()

Trả về một Range tương ứng với các phương diện có dữ liệu.

Việc này tương đương về mặt chức năng với việc tạo một Dải ô được giới hạn bởi A1 và (Sheet.getLastColumn(), Sheet.getLastRow()).

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

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

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

Cầu thủ trả bóng

Range – một dải ô bao gồm tất cả dữ liệu trong bảng tính

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDataSourceFormulas()

Lấy tất cả công thức nguồn dữ liệu.

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

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

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

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

Cầu thủ trả bóng

DataSourceFormula[] – Danh sách công thức nguồn dữ liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDataSourcePivotTables()

Lấy tất cả bảng tổng hợp nguồn dữ liệu.

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

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

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

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

Cầu thủ trả bóng

DataSourcePivotTable[] – Danh sách bảng tổng hợp nguồn dữ liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDataSourceTables()

Lấy tất cả bảng nguồn dữ liệu.

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

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

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

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

Cầu thủ trả bóng

DataSourceTable[] – Danh sách các bảng nguồn dữ liệu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDeveloperMetadata()

Lấy tất cả siêu dữ liệu dành cho nhà phát triển liên kết với trang tính này.

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

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

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

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

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

Cầu thủ trả bóng

DeveloperMetadata[] – Siêu dữ liệu nhà phát triển liên kết với trang tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getDrawings()

Trả về một mảng các bản vẽ trên trang tính.

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

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

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

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

Cầu thủ trả bóng

Drawing[] – Danh sách bản vẽ trên trang tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getFilter()

Trả về bộ lọc trong trang tính này hoặc null nếu không có bộ lọc nào.

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

Cầu thủ trả bóng

Filter – Bộ lọc.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getFormUrl()

Trả về URL của biểu mẫu gửi phản hồi đến trang tính này hoặc null nếu trang tính này không có biểu mẫu liên kết. Gửi một ngoại lệ nếu người dùng không có quyền chỉnh sửa bảng tính.

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

Cầu thủ trả bóng

String – URL của biểu mẫu đặt các câu trả lời trong trang tính này hoặc null nếu trang tính này không có biểu mẫu được liên kết.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getFrozenColumns()

Trả về số lượng cột được cố định.

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

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

Cầu thủ trả bóng

Integer – số lượng cột được cố định

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getFrozenRows()

Trả về số lượng hàng được cố định.

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

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

Cầu thủ trả bóng

Integer – số lượng hàng được cố định

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getImages()

Trả về tất cả hình ảnh nằm ngoài lưới trên trang tính.

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

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

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

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

Cầu thủ trả bóng

OverGridImage[] – Một mảng gồm các hình ảnh đè lên lưới.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getIndex()

Lấy vị trí của trang tính trong bảng tính mẹ. Bắt đầu từ 1.

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

Cầu thủ trả bóng

Integer – Vị trí của trang tính trong bảng tính mẹ.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getLastColumn()

Trả về vị trí của cột cuối cùng có nội dung.

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

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

Cầu thủ trả bóng

Integer – cột cuối cùng của trang tính chứa nội dung

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getLastRow()

Trả về vị trí của hàng cuối cùng có nội dung.

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

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

Cầu thủ trả bóng

Integer – hàng cuối cùng của trang tính chứa nội dung

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getMaxColumns()

Trả về số lượng cột hiện tại trong trang tính, bất kể nội dung.

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

Cầu thủ trả bóng

Integer – Chiều rộng tối đa của trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getMaxRows()

Trả về số lượng hàng hiện tại trong trang tính, bất kể nội dung.

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

Cầu thủ trả bóng

Integer – Chiều cao tối đa của trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getName()

Trả về tên của trang tính.

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

Cầu thủ trả bóng

String – Tên của trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getNamedRanges()

Lấy tất cả các dải ô có tên trong trang tính này.

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

Cầu thủ trả bóng

NamedRange[] – Một mảng gồm tất cả các dải ô có tên trong trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getParent()

Trả về Spreadsheet chứa trang tính này.

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

Cầu thủ trả bóng

Spreadsheet – Bảng tính mẹ.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getPivotTables()

Trả về tất cả bảng tổng hợp trên trang tính này.

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

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

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

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

Cầu thủ trả bóng

PivotTable[] – Các bảng tổng hợp trên trang tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getProtections(type)

Lấy một mảng đối tượng đại diện cho tất cả các dải ô được bảo vệ trong trang tính hoặc một mảng có một phần tử duy nhất đại diện cho chế độ bảo vệ trên chính trang tính đó.

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

Tham số

TênLoạiMô tả
typeProtectionTypeLoại khu bảo tồn, SpreadsheetApp.ProtectionType.RANGE hoặc SpreadsheetApp.ProtectionType.SHEET.

Cầu thủ trả bóng

Protection[] – Một mảng đối tượng đại diện cho tất cả các dải ô được bảo vệ trong trang tính hoặc một mảng có một phần tử duy nhất đại diện cho chế độ bảo vệ trên chính trang tính đó.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRange(row, column)

Trả về dải ô có ô trên cùng bên trái tại toạ độ đã cho.

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

Tham số

TênLoạiMô tả
rowIntegerChỉ mục hàng của ô cần trả về; chỉ mục hàng bắt đầu từ 1.
columnIntegerChỉ mục cột của ô cần trả về; việc lập chỉ mục cột bắt đầu từ 1.

Cầu thủ trả bóng

Range – Một dải ô chỉ chứa ô này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRange(row, column, numRows)

Trả về dải ô có ô trên cùng bên trái tại toạ độ đã cho và có số hàng đã cho.

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

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

Tham số

TênLoạiMô tả
rowIntegerChỉ mục hàng bắt đầu của dải ô; việc lập chỉ mục hàng bắt đầu từ 1.
columnIntegerChỉ mục cột của dải ô; việc lập chỉ mục cột bắt đầu từ 1.
numRowsIntegerSố lượng hàng sẽ trả về.

Cầu thủ trả bóng

Range – Một dải ô chứa một cột dữ liệu với số lượng hàng được chỉ định.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRange(row, column, numRows, numColumns)

Trả về dải ô có ô trên cùng bên trái tại toạ độ đã cho với số hàng và cột đã cho.

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

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

Tham số

TênLoạiMô tả
rowIntegerChỉ mục hàng bắt đầu của dải ô; việc lập chỉ mục hàng bắt đầu từ 1.
columnIntegerChỉ mục cột bắt đầu của dải ô; việc lập chỉ mục cột bắt đầu từ 1.
numRowsIntegerSố lượng hàng sẽ trả về.
numColumnsIntegerSố lượng cột sẽ trả về.

Cầu thủ trả bóng

Range – Một dải tương ứng với khu vực được chỉ định.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRange(a1Notation)

Trả về dải ô được chỉ định theo ký hiệu A1 hoặc ký hiệu R1C1.

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

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

Tham số

TênLoạiMô tả
a1NotationStringDải ô cần trả về, được chỉ định theo ký hiệu A1 hoặc ký hiệu R1C1.

Cầu thủ trả bóng

Range – dải ô tại vị trí được chỉ định

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRangeList(a1Notations)

Trả về tập hợp RangeList đại diện cho các dải ô trong cùng một trang tính được chỉ định bằng một danh sách không trống gồm các ký hiệu A1 hoặc R1C1.

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

Tham số

TênLoạiMô tả
a1NotationsString[]Danh sách các dải ô cần trả về, được chỉ định theo ký hiệu A1 hoặc ký hiệu R1C1.

Cầu thủ trả bóng

RangeList – danh sách dải ô tại vị trí được chỉ định

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRowGroup(rowIndex, groupDepth)

Trả về nhóm hàng tại chỉ mục và chiều sâu nhóm đã cho.

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

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục hàng của nút bật/tắt điều khiển nhóm hoặc chỉ mục trong nhóm.
groupDepthIntegerĐộ sâu của nhóm.

Cầu thủ trả bóng

Group – Nhóm hàng ở chỉ mục và chiều sâu điều khiển, hoặc gửi một ngoại lệ nếu nhóm không tồn tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRowGroupControlPosition()

Trả về GroupControlTogglePosition cho tất cả các nhóm hàng trên trang tính.

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

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

Cầu thủ trả bóng

GroupControlTogglePositiontrue nếu nút bật/tắt điều khiển nhóm hàng xuất hiện sau nhóm trên trang tính này và false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRowGroupDepth(rowIndex)

Trả về chiều sâu nhóm của hàng tại chỉ mục đã cho.

Độ sâu nhóm cho biết số lượng nhóm trùng lặp với hàng. Giá trị này có thể nằm trong khoảng từ 0 đến 8.

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

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục của hàng.

Cầu thủ trả bóng

Integer – Chiều sâu nhóm của hàng tại chỉ mục đã cho.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getRowHeight(rowPosition)

Lấy chiều cao tính bằng pixel của hàng đã cho.

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

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

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí của hàng cần kiểm tra.

Cầu thủ trả bóng

Integer – chiều cao hàng tính bằng pixel

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getSelection()

Trả về Selection hiện tại trong bảng tính.

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

Cầu thủ trả bóng

Selection – lựa chọn hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getSheetId()

Trả về mã nhận dạng của trang tính do đối tượng này biểu thị.

Đây là mã nhận dạng duy nhất của trang tính. Mã nhận dạng là một số nguyên tăng dần được chỉ định tại thời điểm tạo trang tính, độc lập với vị trí của trang tính. Điều này rất hữu ích khi kết hợp với các phương thức như Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) lấy tham số gridId thay vì thực thể Sheet.

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

Logger.log(sheet.getSheetId());

Cầu thủ trả bóng

Integer – mã nhận dạng duy nhất của trang tính trong bảng tính

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getSheetName()

Trả về tên trang tính.

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

Logger.log(sheet.getSheetName());

Cầu thủ trả bóng

String – tên của trang tính

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Trả về lưới hình chữ nhật gồm các giá trị cho dải ô này, bắt đầu từ toạ độ đã cho. Giá trị -1 được cung cấp dưới dạng vị trí hàng hoặc cột tương đương với việc lấy hàng hoặc cột cuối cùng có dữ liệu trong trang tính.

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

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

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

Tham số

TênLoạiMô tả
startRowIntegerVị trí của hàng bắt đầu.
startColumnIntegerVị trí của cột bắt đầu.
numRowsIntegerSố hàng cần trả về giá trị.
numColumnsIntegerSố lượng cột cần trả về giá trị.

Cầu thủ trả bóng

Object[][] – một mảng hai chiều gồm các giá trị

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getSlicers()

Trả về một mảng các công cụ lọc trên trang tính.

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

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

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

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

Cầu thủ trả bóng

Slicer[] – Danh sách các công cụ lọc trên trang tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getTabColorObject()

Lấy màu thẻ trang tính hoặc null nếu thẻ trang tính không có màu.

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

Cầu thủ trả bóng

Color – Màu của thẻ trang tính hoặc null nếu thẻ trang tính không có màu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getType()

Trả về loại trang tính.

Loại trang tính mặc định là SheetType.GRID. Trang tính chứa một đối tượng được nhúng duy nhất, chẳng hạn như EmbeddedChart, là trang tính SheetType.OBJECT.

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

Cầu thủ trả bóng

SheetType – Loại trang tính.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hasHiddenGridlines()

Trả về true nếu đường lưới của trang tính bị ẩn; nếu không thì trả về false. Theo mặc định, đường lưới sẽ hiển thị.

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

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

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

Cầu thủ trả bóng

Booleantrue nếu đường lưới bị ẩn; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideColumn(column)

Ẩn cột hoặc các cột trong dải ô đã cho.

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

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

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

Tham số

TênLoạiMô tả
columnRangeDải ô cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideColumns(columnIndex)

Ẩn một cột tại chỉ mục đã cho. Sử dụng chỉ mục 1 cho phương thức này.

Để ẩn nhiều cột bằng chỉ mục, hãy sử dụng hideColumns(columnIndex, numColumns).

Để ẩn nhiều cột bằng một dải ô, hãy sử dụng hideColumn().

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục của cột cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideColumns(columnIndex, numColumns)

Ẩn một hoặc nhiều cột liên tiếp bắt đầu từ chỉ mục đã cho. Sử dụng chỉ mục 1 cho phương thức này.

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục bắt đầu của các cột cần ẩn.
numColumnsIntegerSố lượng cột cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideRow(row)

Ẩn các hàng trong dải ô đã cho.

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

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

Tham số

TênLoạiMô tả
rowRangeDải ô cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideRows(rowIndex)

Ẩn hàng tại chỉ mục đã cho.

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục của hàng cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideRows(rowIndex, numRows)

Ẩn một hoặc nhiều hàng liên tiếp bắt đầu từ chỉ mục đã cho.

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục bắt đầu của các hàng cần ẩn.
numRowsIntegerSố hàng cần ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

hideSheet()

Ẩn trang tính này. Không có hiệu lực nếu trang tính đã bị ẩn. Nếu phương thức này được gọi trên bảng hiển thị duy nhất, thì phương thức này sẽ gửi một ngoại lệ.

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

Cầu thủ trả bóng

Sheet – Trang tính hiện tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertChart(chart)

Thêm một biểu đồ mới vào trang tính này.

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

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

Tham số

TênLoạiMô tả
chartEmbeddedChartBiểu đồ cần chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumnAfter(afterPosition)

Chèn một cột sau vị trí cột đã cho.

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

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

Tham số

TênLoạiMô tả
afterPositionIntegerCột mà bạn muốn thêm cột mới vào sau đó.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumnBefore(beforePosition)

Chèn một cột trước vị trí cột đã cho.

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

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

Tham số

TênLoạiMô tả
beforePositionIntegerCột trước cột mới cần thêm.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumns(columnIndex)

Chèn một cột trống vào trang tính tại vị trí đã chỉ định.

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục cho biết vị trí chèn cột.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumns(columnIndex, numColumns)

Chèn một hoặc nhiều cột trống liên tiếp trong một trang tính bắt đầu từ vị trí đã chỉ định.

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

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục cho biết vị trí chèn cột.
numColumnsIntegerSố lượng cột cần chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumnsAfter(afterPosition, howMany)

Chèn một số lượng cột nhất định sau vị trí cột đã cho.

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

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

Tham số

TênLoạiMô tả
afterPositionIntegerCột mà bạn muốn thêm cột mới vào sau đó.
howManyIntegerSố lượng cột cần chèn.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertColumnsBefore(beforePosition, howMany)

Chèn một số cột trước vị trí cột đã cho.

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

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

Tham số

TênLoạiMô tả
beforePositionIntegerCột trước cột mới cần thêm.
howManyIntegerSố lượng cột cần chèn.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertImage(blobSource, column, row)

Chèn BlobSource dưới dạng hình ảnh trong tài liệu ở một hàng và cột nhất định. Kích thước hình ảnh được truy xuất từ nội dung blob. Kích thước blob tối đa được hỗ trợ là 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Tham số

TênLoạiMô tả
blobSourceBlobSourceBlob chứa nội dung hình ảnh, loại MIME và tên (không bắt buộc).
columnIntegerVị trí cột.
rowIntegerVị trí hàng.

Cầu thủ trả bóng

OverGridImage – Hình ảnh đã chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

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

Chèn BlobSource dưới dạng hình ảnh trong tài liệu ở một hàng và cột nhất định, với độ dời pixel. Kích thước hình ảnh được truy xuất từ nội dung blob. Kích thước tối đa của blob được hỗ trợ là 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Tham số

TênLoạiMô tả
blobSourceBlobSourceBlob chứa nội dung hình ảnh, loại MIME và tên (không bắt buộc).
columnIntegerVị trí cột.
rowIntegerVị trí hàng.
offsetXIntegerĐộ lệch theo chiều ngang từ góc ô tính bằng pixel.
offsetYIntegerĐộ lệch dọc từ góc ô tính bằng pixel.

Cầu thủ trả bóng

OverGridImage – Hình ảnh đã chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertImage(url, column, row)

Chèn hình ảnh vào tài liệu ở một hàng và cột nhất định.

URL bạn cung cấp phải có thể truy cập công khai.

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

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

Tham số

TênLoạiMô tả
urlStringURL của hình ảnh.
columnIntegerVị trí cột lưới.
rowIntegerVị trí hàng lưới.

Cầu thủ trả bóng

OverGridImage – Hình ảnh đã chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

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

Chèn hình ảnh vào tài liệu ở một hàng và cột nhất định, với độ dời pixel.

URL được cung cấp phải có thể truy cập công khai.

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

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

Tham số

TênLoạiMô tả
urlStringURL của hình ảnh.
columnIntegerVị trí cột.
rowIntegerVị trí hàng.
offsetXIntegerĐộ lệch theo chiều ngang từ góc ô tính bằng pixel.
offsetYIntegerĐộ lệch dọc từ góc ô tính bằng pixel.

Cầu thủ trả bóng

OverGridImage – Hình ảnh đã chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRowAfter(afterPosition)

Chèn một hàng sau vị trí hàng đã cho.

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

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

Tham số

TênLoạiMô tả
afterPositionIntegerHàng mà sau đó hàng mới sẽ được thêm vào.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRowBefore(beforePosition)

Chèn một hàng trước vị trí hàng đã cho.

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

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

Tham số

TênLoạiMô tả
beforePositionIntegerHàng trước hàng mới cần thêm.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRows(rowIndex)

Chèn một hàng trống vào trang tính ở vị trí đã chỉ định.

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục cho biết vị trí chèn hàng.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRows(rowIndex, numRows)

Chèn một hoặc nhiều hàng trống liên tiếp trong một trang tính bắt đầu từ vị trí đã chỉ định.

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

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục cho biết vị trí chèn hàng.
numRowsIntegerSố hàng cần chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRowsAfter(afterPosition, howMany)

Chèn một số hàng sau vị trí hàng đã cho.

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

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

Tham số

TênLoạiMô tả
afterPositionIntegerHàng mà sau đó các hàng mới sẽ được thêm vào.
howManyIntegerSố hàng cần chèn.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertRowsBefore(beforePosition, howMany)

Chèn một số hàng trước vị trí hàng đã cho.

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

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

Tham số

TênLoạiMô tả
beforePositionIntegerHàng trước hàng cần thêm.
howManyIntegerSố hàng cần chèn.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

insertSlicer(range, anchorRowPos, anchorColPos)

Thêm một công cụ lọc mới vào trang tính này.

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

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

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

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

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

Tham số

TênLoạiMô tả
rangeRangePhạm vi tạo lát cắt.
anchorRowPosIntegerCạnh trên cùng của công cụ cắt được neo trong hàng này.
anchorColPosIntegerCạnh trên của công cụ cắt được neo trong cột này.

Cầu thủ trả bóng

Slicer – Bộ cắt mới được chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

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

Thêm một công cụ lọc mới vào trang tính này.

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

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

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

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

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

Tham số

TênLoạiMô tả
rangeRangePhạm vi tạo lát cắt.
anchorRowPosIntegerCạnh trên cùng của công cụ cắt được neo trong hàng này.
anchorColPosIntegerCạnh trên của công cụ cắt được neo trong cột này.
offsetXIntegerĐộ lệch theo chiều ngang từ góc ô tính bằng pixel.
offsetYIntegerĐộ lệch dọc từ góc ô tính bằng pixel.

Cầu thủ trả bóng

Slicer – Bộ cắt mới được chèn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isColumnHiddenByUser(columnPosition)

Trả về kết quả cho biết người dùng có ẩn cột đã cho hay không.

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

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

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột cần kiểm tra.

Cầu thủ trả bóng

Booleantrue nếu cột bị ẩn, false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isRightToLeft()

Trả về true nếu bố cục của trang tính này là từ phải sang trái. Trả về false nếu trang tính sử dụng bố cục mặc định từ trái sang phải.

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

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

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

Cầu thủ trả bóng

Booleantrue nếu từ phải sang trái; false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isRowHiddenByFilter(rowPosition)

Trả về giá trị cho biết liệu một bộ lọc (không phải chế độ xem bộ lọc) có ẩn hàng đã cho hay không.

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

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

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí của hàng cần kiểm tra.

Cầu thủ trả bóng

Booleantrue nếu hàng bị ẩn, false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isRowHiddenByUser(rowPosition)

Trả về kết quả cho biết người dùng có ẩn hàng đã cho hay không.

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

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

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí của hàng cần kiểm tra.

Cầu thủ trả bóng

Booleantrue nếu hàng bị ẩn, false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isSheetHidden()

Trả về true nếu trang tính hiện đang bị ẩn.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Cầu thủ trả bóng

Booleantrue nếu trang tính bị ẩn, false nếu không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

moveColumns(columnSpec, destinationIndex)

Di chuyển các cột được chọn theo dải ô đã cho đến vị trí do destinationIndex chỉ định. Bản thân columnSpec không nhất thiết phải đại diện chính xác cho toàn bộ cột hoặc nhóm cột để di chuyển – nó sẽ chọn tất cả các cột mà dải ô trải dài.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Tham số

TênLoạiMô tả
columnSpecRangeMột dải ô bao gồm các cột cần di chuyển.
destinationIndexIntegerChỉ mục mà các cột sẽ được di chuyển đến. Xin lưu ý rằng chỉ mục này dựa trên toạ độ trước khi di chuyển các cột. Dữ liệu hiện có được dịch sang phải để tạo không gian cho các cột đã di chuyển, trong khi các cột nguồn sẽ bị xoá khỏi lưới. Do đó, dữ liệu có thể kết thúc ở một chỉ mục khác với chỉ mục được chỉ định ban đầu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

moveRows(rowSpec, destinationIndex)

Di chuyển các hàng được chọn theo dải ô đã cho đến vị trí do destinationIndex chỉ định. Bản thân rowSpec không nhất thiết phải đại diện chính xác cho toàn bộ hàng hoặc nhóm hàng cần di chuyển – hàm này sẽ chọn tất cả các hàng mà dải ô trải dài.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Tham số

TênLoạiMô tả
rowSpecRangeMột dải ô bao gồm các hàng cần di chuyển.
destinationIndexIntegerChỉ mục mà các hàng sẽ được di chuyển đến. Xin lưu ý rằng chỉ mục này dựa trên toạ độ trước khi các hàng được di chuyển. Dữ liệu hiện có được dịch chuyển xuống để tạo chỗ cho các hàng đã di chuyển trong khi các hàng nguồn bị xoá khỏi lưới. Do đó, dữ liệu có thể kết thúc ở một chỉ mục khác với chỉ mục được chỉ định ban đầu.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

newChart()

Trả về một trình tạo để tạo biểu đồ mới cho trang tính này.

Ví dụ này cho thấy cách tạo một biểu đồ mới:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

Cầu thủ trả bóng

EmbeddedChartBuilder – Trình tạo để tạo biểu đồ mới.


protect()

Tạo một đối tượng có thể bảo vệ trang tính khỏi bị chỉnh sửa, ngoại trừ những người dùng có quyền. Cho đến khi tập lệnh thực sự thay đổi danh sách trình chỉnh sửa cho trang tính (bằng cách gọi Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) hoặc đặt giá trị mới cho Protection.setDomainEdit(editable)), các quyền sẽ phản ánh các quyền của chính trang tính, nghĩa là trang tính vẫn không được bảo vệ. Nếu trang tính đã được bảo vệ, phương thức này sẽ trả về một đối tượng đại diện cho các chế độ cài đặt bảo vệ hiện có của trang tính. Một trang tính được bảo vệ có thể bao gồm các vùng không được bảo vệ.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

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

Cầu thủ trả bóng

Protection – Một đối tượng đại diện cho chế độ cài đặt bảo vệ.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

removeChart(chart)

Xoá một biểu đồ khỏi trang tính mẹ.

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

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

Tham số

TênLoạiMô tả
chartEmbeddedChartBiểu đồ cần xoá.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setActiveRange(range)

Đặt dải ô được chỉ định làm active range trong trang tính đang hoạt động, với ô trên cùng bên trái trong dải ô là current cell.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Tham số

TênLoạiMô tả
rangeRangeDải ô cần đặt làm dải ô đang hoạt động.

Cầu thủ trả bóng

Range – dải ô mới hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setActiveRangeList(rangeList)

Đặt danh sách dải ô đã chỉ định làm active ranges trong trang tính đang hoạt động. Phạm vi cuối cùng trong danh sách được đặt thành active range.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Tham số

TênLoạiMô tả
rangeListRangeListDanh sách các dải ô cần chọn.

Cầu thủ trả bóng

RangeList – danh sách các dải ô mới được chọn

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setActiveSelection(range)

Đặt vùng lựa chọn đang hoạt động cho trang tính này.

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

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

Tham số

TênLoạiMô tả
rangeRangePhạm vi cần đặt làm lựa chọn đang hoạt động.

Cầu thủ trả bóng

Range – dải ô mới hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setActiveSelection(a1Notation)

Đặt lựa chọn đang hoạt động, như được chỉ định trong ký hiệu A1 hoặc ký hiệu R1C1.

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

sheet.setActiveSelection('A1:D4');

Tham số

TênLoạiMô tả
a1NotationStringDải ô cần đặt thành đang hoạt động, như được chỉ định trong ký hiệu A1 hoặc ký hiệu R1C1.

Cầu thủ trả bóng

Range – dải ô mới hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setColumnGroupControlPosition(position)

Đặt vị trí của nút bật/tắt điều khiển nhóm cột trên trang tính.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Tham số

TênLoạiMô tả
positionGroupControlTogglePositionVị trí của nút bật/tắt điều khiển nhóm cột.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setColumnWidth(columnPosition, width)

Đặt chiều rộng của cột đã cho tính bằng pixel.

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Tham số

TênLoạiMô tả
columnPositionIntegerVị trí của cột đã cho cần đặt.
widthIntegerChiều rộng tính bằng pixel để đặt chiều rộng.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setColumnWidths(startColumn, numColumns, width)

Đặt chiều rộng của các cột đã cho tính bằng pixel.

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Tham số

TênLoạiMô tả
startColumnIntegerVị trí cột bắt đầu cần thay đổi.
numColumnsIntegerSố lượng cột cần thay đổi.
widthIntegerChiều rộng tính bằng pixel để đặt.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setConditionalFormatRules(rules)

Thay thế tất cả quy tắc định dạng có điều kiện hiện có trong trang tính bằng quy tắc nhập. Các quy tắc được đánh giá theo thứ tự nhập.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Tham số

TênLoạiMô tả
rulesConditionalFormatRule[]Quy tắc định dạng có điều kiện mới.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setCurrentCell(cell)

Đặt ô được chỉ định làm current cell.

Nếu ô được chỉ định nằm trong một dải ô đã chọn, thì dải ô đó sẽ trở thành dải ô đang hoạt động với ô đó là ô hiện tại.

Nếu ô được chỉ định không có trong bất kỳ dải ô nào đã chọn, thì mọi lựa chọn hiện có sẽ bị xoá và ô đó sẽ trở thành ô hiện tại và dải ô đang hoạt động.

Lưu ý: Range được chỉ định phải bao gồm một ô, nếu không, hàm này sẽ gửi một ngoại lệ.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Tham số

TênLoạiMô tả
cellRangeÔ cần đặt làm ô hiện tại.

Cầu thủ trả bóng

Range – ô hiện tại mới được đặt

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setFrozenColumns(columns)

Cố định số cột đã cho. Nếu bằng 0, thì không có cột nào bị khoá.

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

// Freezes the first column
sheet.setFrozenColumns(1);

Tham số

TênLoạiMô tả
columnsIntegerSố lượng cột cần cố định.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setFrozenRows(rows)

Khoá số hàng đã cho. Nếu bằng 0, thì không có hàng nào bị đóng băng.

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

// Freezes the first row
sheet.setFrozenRows(1);

Tham số

TênLoạiMô tả
rowsIntegerSố hàng cần cố định.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setHiddenGridlines(hideGridlines)

Ẩn hoặc hiện đường lưới của trang tính.

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Tham số

TênLoạiMô tả
hideGridlinesBooleanNếu true, hãy ẩn đường lưới trong trang tính này; nếu không, hãy hiển thị đường lưới.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setName(name)

Đặt tên cho trang tính.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

Tham số

TênLoạiMô tả
nameStringTên mới cho trang tính.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setRightToLeft(rightToLeft)

Đặt hoặc huỷ đặt bố cục trang tính thành từ phải sang trái.

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

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

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Tham số

TênLoạiMô tả
rightToLeftBooleanNếu là true, bố cục trang tính sẽ được đặt thành từ phải sang trái, với ô A1 ở góc trên cùng bên phải. Nếu là false, bố cục trang tính sẽ được đặt thành chế độ mặc định từ trái sang phải, với ô A1 ở trên cùng bên trái.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setRowGroupControlPosition(position)

Đặt vị trí của nút bật/tắt điều khiển nhóm hàng trên trang tính.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Tham số

TênLoạiMô tả
positionGroupControlTogglePositionVị trí của nút bật/tắt điều khiển nhóm hàng.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setRowHeight(rowPosition, height)

Đặt chiều cao của hàng cho hàng đã cho theo pixel. Theo mặc định, các hàng sẽ tăng lên để vừa với nội dung của ô. Nếu bạn muốn buộc các hàng có chiều cao được chỉ định, hãy sử dụng setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Tham số

TênLoạiMô tả
rowPositionIntegerVị trí hàng cần thay đổi.
heightIntegerChiều cao tính bằng pixel để đặt chiều cao.

Cầu thủ trả bóng

Sheet – Trang tính, hữu ích cho việc tạo chuỗi phương thức.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setRowHeights(startRow, numRows, height)

Đặt chiều cao của các hàng đã cho tính bằng pixel. Theo mặc định, các hàng sẽ tăng lên để vừa với nội dung của ô. Nếu bạn muốn buộc các hàng có chiều cao được chỉ định, hãy sử dụng setRowHeightsForced(startRow, numRows, height).

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Tham số

TênLoạiMô tả
startRowIntegerVị trí hàng bắt đầu cần thay đổi.
numRowsIntegerSố hàng cần thay đổi.
heightIntegerChiều cao tính bằng pixel để đặt chiều cao.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setRowHeightsForced(startRow, numRows, height)

Đặt chiều cao của các hàng đã cho tính bằng pixel. Theo mặc định, các hàng sẽ tăng lên để vừa với nội dung của ô. Khi bạn sử dụng setRowHeightsForced, các hàng sẽ buộc phải có chiều cao được chỉ định ngay cả khi nội dung ô cao hơn chiều cao hàng.

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Tham số

TênLoạiMô tả
startRowIntegerVị trí hàng bắt đầu cần thay đổi.
numRowsIntegerSố hàng cần thay đổi.
heightIntegerChiều cao tính bằng pixel để đặt chiều cao.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setTabColor(color)

Đặt màu cho thẻ trang tính.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

Tham số

TênLoạiMô tả
colorStringMã màu theo ký hiệu CSS (chẳng hạn như '#ffffff' hoặc 'white') hoặc null để đặt lại màu thẻ.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setTabColorObject(color)

Đặt màu cho thẻ trang tính.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

Tham số

TênLoạiMô tả
colorColorMàu sắc của thẻ trang tính cần đặt.

Cầu thủ trả bóng

Sheet – Trang tính này, để tạo chuỗi.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

showColumns(columnIndex)

Bỏ ẩn cột tại chỉ mục đã cho.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục của cột cần hiện.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

showColumns(columnIndex, numColumns)

Bỏ ẩn một hoặc nhiều cột liên tiếp bắt đầu từ chỉ mục đã cho.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Tham số

TênLoạiMô tả
columnIndexIntegerChỉ mục bắt đầu của các cột cần bỏ ẩn.
numColumnsIntegerSố cột cần bỏ ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

showRows(rowIndex)

Bỏ ẩn hàng tại chỉ mục đã cho.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục của hàng cần hiện.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

showRows(rowIndex, numRows)

Bỏ ẩn một hoặc nhiều hàng liên tiếp bắt đầu từ chỉ mục đã cho.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Tham số

TênLoạiMô tả
rowIndexIntegerChỉ mục bắt đầu của các hàng cần bỏ ẩn.
numRowsIntegerSố hàng cần bỏ ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

showSheet()

Hiển thị trang tính. Không có hiệu lực nếu trang tính đã hiển thị.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

Cầu thủ trả bóng

Sheet – Trang tính hiện tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

sort(columnPosition)

Sắp xếp trang tính theo cột, tăng dần.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Tham số

TênLoạiMô tả
columnPositionIntegerCột để sắp xếp.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

sort(columnPosition, ascending)

Sắp xếp trang tính theo cột. Nhận một tham số để chỉ định tăng dần hoặc giảm dần.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Tham số

TênLoạiMô tả
columnPositionIntegerCột để sắp xếp.
ascendingBooleantrue để sắp xếp tăng dần, false để sắp xếp giảm dần.

Cầu thủ trả bóng

Sheet – trang tính, hữu ích cho việc tạo chuỗi phương thức

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

unhideColumn(column)

Bỏ ẩn cột trong dải ô đã cho.

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Tham số

TênLoạiMô tả
columnRangeDải ô cần bỏ ẩn, nếu bị ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

unhideRow(row)

Bỏ ẩn hàng trong dải ô đã cho.

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Tham số

TênLoạiMô tả
rowRangeDải ô cần bỏ ẩn, nếu bị ẩn.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

updateChart(chart)

Cập nhật biểu đồ trên trang tính này.

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

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

Tham số

TênLoạiMô tả
chartEmbeddedChartBiểu đồ cần cập nhật.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Các phương thức ngừng hoạt động