Class DataSourceSheet

DataSourceSheet

Truy cập và sửa đổi trang tính nguồn dữ liệu hiện có. Để tạo trang tính nguồn dữ liệu mới, hãy sử dụng Spreadsheet.insertDataSourceSheet(spec).

Chỉ sử dụng lớp này với dữ liệu được kết nối với cơ sở dữ liệu.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
addFilter(columnName, filterCriteria)DataSourceSheetThêm một bộ lọc được áp dụng vào trang tính nguồn dữ liệu.
asSheet()SheetTrả về trang tính nguồn dữ liệu dưới dạng một đối tượng trang tính thông thường.
autoResizeColumn(columnName)DataSourceSheetTự động đổi kích thước chiều rộng của cột được chỉ định.
autoResizeColumns(columnNames)DataSourceSheetTự động đổi kích thước chiều rộng của cột được chỉ định.
cancelDataRefresh()DataSourceSheetHuỷ quá trình làm mới dữ liệu được liên kết với đối tượng này nếu đối tượng hiện đang chạy.
forceRefreshData()DataSourceSheetLàm mới dữ liệu của đối tượng này bất kể trạng thái hiện tại.
getColumnWidth(columnName)IntegerTrả về chiều rộng của cột được chỉ định.
getDataSource()DataSourceLấy nguồn dữ liệu liên kết với đối tượng.
getFilters()DataSourceSheetFilter[]Trả về tất cả bộ lọc áp dụng cho trang tính nguồn dữ liệu.
getSheetValues(columnName)Object[]Trả về tất cả giá trị cho trang tính nguồn dữ liệu cho tên cột đã cho.
getSheetValues(columnName, startRow, numRows)Object[]Trả về tất cả giá trị cho trang tính nguồn dữ liệu cho tên cột đã cung cấp từ hàng bắt đầu đã cung cấp (dựa trên-1) cho đến numRows đã cung cấp.
getSortSpecs()SortSpec[]Lấy tất cả thông số sắp xếp trong trang tính nguồn dữ liệu.
getStatus()DataExecutionStatusXem trạng thái thực thi dữ liệu của đối tượng.
refreshData()DataSourceSheetLàm mới dữ liệu của đối tượng.
removeFilters(columnName)DataSourceSheetXoá tất cả bộ lọc được áp dụng cho cột trang tính nguồn dữ liệu.
removeSortSpec(columnName)DataSourceSheetXoá thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.
setColumnWidth(columnName, width)DataSourceSheetĐặt chiều rộng của cột đã chỉ định.
setColumnWidths(columnNames, width)DataSourceSheetĐặt chiều rộng của cột đã chỉ định.
setSortSpec(columnName, ascending)DataSourceSheetĐặt thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.
setSortSpec(columnName, sortOrder)DataSourceSheetĐặt thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.
waitForCompletion(timeoutInSeconds)DataExecutionStatusChờ cho đến khi quá trình thực thi hiện tại hoàn tất, hết thời gian chờ sau số giây đã cung cấp.

Tài liệu chi tiết

addFilter(columnName, filterCriteria)

Thêm bộ lọc được áp dụng cho trang tính nguồn dữ liệu.

Thông số

TênLoạiMô tả
columnNameStringTên của cột để áp dụng bộ lọc này.
filterCriteriaFilterCriteriaTiêu chí bộ lọc để áp dụng.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu, để tạo chuỗi phương thức.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

asSheet()

Trả về trang tính nguồn dữ liệu dưới dạng một đối tượng trang tính thông thường.

Cầu thủ trả bóng

Sheet — Trang tính thông thường.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnName)

Tự động đổi kích thước chiều rộng của cột đã chỉ định.

Thông số

TênLoạiMô tả
columnNameStringTên cột.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu này, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnNames)

Tự động đổi kích thước chiều rộng của cột được chỉ định.

Thông số

TênLoạiMô tả
columnNamesString[]Danh sách tên cột cần cập nhật.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu này, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

cancelDataRefresh()

Huỷ làm mới dữ liệu liên kết với đối tượng này nếu đối tượng đó đang chạy.

Ví dụ này cho thấy cách huỷ làm mới công thức. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Gửi một trường hợp ngoại lệ nếu loại nguồn dữ liệu không được bật. Sử dụng các phương thức SpreadsheetApp#enable...Execution() để cho phép thực thi dữ liệu đối với nguồn dữ liệu cụ thể loại.

Cầu thủ trả bóng

DataSourceSheet – Đối tượng dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

forceRefreshData()

Làm mới dữ liệu của đối tượng này bất kể trạng thái hiện tại. Hãy xem refreshData() để biết thêm thông tin chi tiết. Nếu bạn muốn huỷ quá trình làm mới hiện đang chạy của đối tượng này, hãy xem cancelDataRefresh().

Gửi một trường hợp ngoại lệ nếu loại nguồn dữ liệu không được bật. Sử dụng các phương thức SpreadsheetApp#enable...Execution() để cho phép thực thi dữ liệu đối với nguồn dữ liệu cụ thể loại.

Cầu thủ trả bóng

DataSourceSheet – Đối tượng 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

getColumnWidth(columnName)

Trả về chiều rộng của cột được chỉ định.

Thông số

TênLoạiMô tả
columnNameStringTên cột.

Cầu thủ trả bóng

Integer – Chiều rộng của cột hoặc null nếu cột sử dụng chiều rộng mặc định.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

getDataSource()

Lấy nguồn dữ liệu liên kết với đối tượng.

Cầu thủ trả bóng

DataSource — Nguồn dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

getFilters()

Trả về tất cả bộ lọc áp dụng cho trang tính nguồn dữ liệu.

Cầu thủ trả bóng

DataSourceSheetFilter[] – Một mảng gồm tất cả các bộ lọc được áp dụng cho trang tính nguồn dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnName)

Trả về tất cả giá trị cho trang tính nguồn dữ liệu cho tên cột đã cho.

Thông số

TênLoạiMô tả
columnNameStringTên cột nguồn dữ liệu để tìm nạp giá trị.

Cầu thủ trả bóng

Object[] – Một mảng giá trị một chiều.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnName, startRow, numRows)

Trả về tất cả giá trị cho trang tính nguồn dữ liệu cho tên cột đã cung cấp từ hàng bắt đầu đã cung cấp (dựa trên-1) cho đến numRows đã cung cấp.

Thông số

TênLoạiMô tả
columnNameStringTên cột nguồn dữ liệu để tìm nạp giá trị.
startRowIntegerVị trí hàng để bắt đầu tìm nạp các giá trị.
numRowsIntegerSố hàng cần tìm nạp.

Cầu thủ trả bóng

Object[] – Một mảng giá trị một chiề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

getSortSpecs()

Lấy tất cả thông số sắp xếp trong trang tính nguồn dữ liệu.

Cầu thủ trả bóng

SortSpec[] – Danh sách các thông số sắp xếp.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

getStatus()

Xem trạng thái thực thi dữ liệu của đối tượng.

Cầu thủ trả bóng

DataExecutionStatus – Trạng thái thực thi dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

refreshData()

Làm mới dữ liệu của đối tượng.

Gửi một ngoại lệ nếu hiện đang ở trạng thái error. Sử dụng DataSource#updateSpec() để cập nhật thông số kỹ thuật. Phương thức là được ưu tiên hơn forceRefreshData() để ngăn các chỉnh sửa không mong muốn đối với nguồn dữ liệu.

Gửi một trường hợp ngoại lệ nếu loại nguồn dữ liệu không được bật. Sử dụng các phương thức SpreadsheetApp#enable...Execution() để cho phép thực thi dữ liệu đối với nguồn dữ liệu cụ thể loại.

Cầu thủ trả bóng

DataSourceSheet – Đối tượng dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

removeFilters(columnName)

Xoá tất cả bộ lọc được áp dụng cho cột trang tính nguồn dữ liệu.

Thông số

TênLoạiMô tả
columnNameStringTên của cột cần xoá bộ lọc.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu, để tạo chuỗi phương thức.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

removeSortSpec(columnName)

Xoá thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.

Thông số

TênLoạiMô tả
columnNameStringTên của cột.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnName, width)

Đặt chiều rộng của cột được chỉ định.

Thông số

TênLoạiMô tả
columnNameStringTên cột.
widthIntegerChiều rộng mới cho cột.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu này, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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(columnNames, width)

Đặt chiều rộng của các cột đã chỉ định.

Thông số

TênLoạiMô tả
columnNamesString[]Danh sách tên cột cần cập nhật.
widthIntegerChiều rộng mới cho cột.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu 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

setSortSpec(columnName, ascending)

Đặt thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.

Thông số

TênLoạiMô tả
columnNameStringTên của cột cần sắp xếp.
ascendingBooleanNếu là true, hãy sắp xếp cột theo thứ tự tăng dần; nếu là false, hãy sắp xếp cột theo thứ tự giảm dần.

Cầu thủ trả bóng

DataSourceSheet – Trang tính nguồn dữ liệu, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

setSortSpec(columnName, sortOrder)

Đặt thông số sắp xếp trên một cột trong trang tính nguồn dữ liệu.

Thông số

TênLoạiMô tả
columnNameStringTên của cột cần sắp xếp.
sortOrderSortOrderThứ tự sắp xếp.

Cầu thủ trả bóng

DataSourceSheet — Trang tính nguồn dữ liệu, để tạo chuỗi.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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

waitForCompletion(timeoutInSeconds)

Chờ cho đến khi quá trình thực thi hiện tại hoàn tất, hết thời gian chờ sau số giây đã cho. Gửi một ngoại lệ nếu quá trình thực thi không hoàn tất khi hết thời gian chờ, nhưng không huỷ thực thi dữ liệu.

Thông số

TênLoạiMô tả
timeoutInSecondsIntegerThời gian để chờ thực thi dữ liệu, tính bằng giây. Thời lượng tối đa là 300 giây.

Cầu thủ trả bóng

DataExecutionStatus – Trạng thái thực thi dữ liệu.

Ủy quyền

Tập lệnh sử dụng phương thức này yêu cầu ủy 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