Hãy dùng lớp này để sửa đổi các bộ lọc hiện có trên trang tính Grid
, loại trang tính mặc định. Trang tính lưới là trang tính thông thường có dữ liệu không liên kết với cơ sở dữ liệu.
Nếu trang tính chưa có bộ lọc, hãy tạo một bộ lọc bằng Range.createFilter()
.
Để sử dụng lớp này, trước tiên, bạn phải truy cập vào bộ lọc trang tính lưới bằng cách sử dụng Range.getFilter()
hoặc Sheet.getFilter()
.
Các cách dùng phổ biến
Xoá bộ lọc
Mẫu dưới đây lấy bộ lọc trên trang tính đang hoạt động và xoá bộ lọc đó.let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Removes the filter from the active sheet. filter.remove();
Lấy phạm vi áp dụng bộ lọc
Mẫu dưới đây lấy bộ lọc trên trang tính đang hoạt động, sau đó sử dụng phương thứcgetRange()
từ lớp này để ghi lại dải ô áp dụng bộ lọc.
let ss = SpreadsheetApp.getActiveSheet(); // Gets the existing filter on the active sheet. let filter = ss.getFilter(); // Logs the range that the filter applies to in A1 notation. console.log(filter.getRange().getA1Notation());
Phương thức
Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | Lấy tiêu chí lọc trên cột đã chỉ định hoặc null nếu cột chưa áp dụng
tiêu chí lọc. |
getRange() | Range | Lấy phạm vi áp dụng bộ lọc này. |
remove() | void | Xoá bộ lọc này. |
removeColumnFilterCriteria(columnPosition) | Filter | Xóa tiêu chí lọc khỏi cột đã chỉ định. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | Đặt tiêu chí lọc cho cột được chỉ định. |
sort(columnPosition, ascending) | Filter | Sắp xếp dải ô được lọc theo cột được chỉ định, loại trừ hàng đầu tiên (hàng tiêu đề) trong dải ô áp dụng bộ lọc này. |
Tài liệu chi tiết
getColumnFilterCriteria(columnPosition)
Lấy tiêu chí lọc trên cột đã chỉ định hoặc null
nếu cột chưa áp dụng
tiêu chí lọc.
Để biết thêm thông tin chi tiết về các tiêu chí lọc, hãy liên kết phương thức này với các phương thức từ lớp
FilterCriteria
.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Gets the filter criteria applied to column B of the active sheet // and logs the hidden values. let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues(); console.log(filterCriteria);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
columnPosition | Integer | Vị trí được lập chỉ mục của cột. Ví dụ: chỉ mục của cột B là 2. |
Cầu thủ trả bóng
FilterCriteria
– Tiêu chí lọc.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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()
Lấy phạm vi áp dụng bộ lọc này.
// Gets the existing filter on the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Logs the range that the filter applies to in A1 notation. console.log(filter.getRange().getA1Notation());
Cầu thủ trả bóng
Range
– Phạm vi của bộ lọc. Để lấy dải ô trong ký hiệu A1, hãy liên kết phương thức này với Range.getA1Notation()
.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
remove()
Xoá bộ lọc này.
// Removes the filter from the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); filter.remove();
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
removeColumnFilterCriteria(columnPosition)
Xóa tiêu chí lọc khỏi cột đã chỉ định.
// Removes the filter criteria from column B. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); filter.removeColumnFilterCriteria(2);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
columnPosition | Integer | Vị trí được lập chỉ mục của cột. Ví dụ: chỉ mục của cột B là 2. |
Cầu thủ trả bóng
Filter
– Bộ lọc để tạo chuỗi.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
setColumnFilterCriteria(columnPosition, filterCriteria)
Đặt tiêu chí lọc cho cột được chỉ định. Trước tiên, hãy tạo trình tạo tiêu chí lọc bằng cách sử dụng SpreadsheetApp.newFilterCriteria()
. Sau đó, thêm tiêu chí vào trình tạo
bằng cách sử dụng lớp FilterCriteriaBuilder
. Sau khi bạn tạo tiêu chí, hãy đặt tiêu chí đó làm
tham số filterCriteria
cho phương thức này.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Builds the filter criteria to use as a parameter for setColumnFilterCriteria. const criteria = SpreadsheetApp.newFilterCriteria() .setHiddenValues(["Hello", "World"]) .build(); // Sets the filter criteria for column C. filter.setColumnFilterCriteria(3, criteria);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
columnPosition | Integer | Vị trí được lập chỉ mục của cột. Ví dụ: chỉ mục của cột B là 2. |
filterCriteria | FilterCriteria | Tiêu chí lọc cần đặt. Nếu bạn đặt tiêu chí thành null , thì thao tác này sẽ xoá tiêu chí lọc khỏi cột được chỉ định. Bạn cũng có thể sử dụng removeColumnFilterCriteria(columnPosition) . |
Cầu thủ trả bóng
Filter
– Bộ lọc để tạo chuỗi.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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 dải ô được lọc theo cột được chỉ định, loại trừ hàng đầu tiên (hàng tiêu đề) trong dải ô áp dụng bộ lọc này.
// Gets the existing filter and sorts it by column B in ascending order. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); filter.sort(2, true);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
columnPosition | Integer | Vị trí được lập chỉ mục của cột. Ví dụ: chỉ mục của cột B là 2. |
ascending | Boolean | Nếu là true , hãy sắp xếp dải ô được lọc theo thứ tự tăng dần; nếu là false , hãy sắp xếp dải ô được lọc theo thứ tự giảm dần. |
Cầu thủ trả bóng
Filter
– Bộ lọc để tạo chuỗi.
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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